Add patching QA configuration files on buildbots
authorPetr Pudlak <pudlak@google.com>
Thu, 21 Nov 2013 14:06:41 +0000 (15:06 +0100)
committerMichele Tartara <mtartara@google.com>
Fri, 7 Mar 2014 11:59:51 +0000 (12:59 +0100)
In order to work, it is necessary:
* Write a JSON Patch to file "qa/qa-patch.json" in a source repository.
  (And be careful not to commit it!) The file must conform to RFC6902
  and describes what changes should be done to the QA JSON
  configuration. This is simple as
   [
     { "op": "add",
       "path": "default",
       "value": false },
     { "op": "add",
       "path": "/tests/instance-add-file",
       "value": true }
   ]

* Install "jsonpatch" and "jsonpointer" modules on the machines QA is
  running on. Either using "easy_install" or as Debian packages using
  "pypi-install".

QA only loads the modules if the patch file is present and non-empty.
Therefore no changes to buildbots are needed, if the feature is not
used.

It's advisable to add a git pre-commit hook for the main repository to
prevent changes to "qa/patch.json", keeping it to "[]". Suggestion for
such a hook:

  # Exit code 1 if the patch file isn't just "[]":
  python -c 'import json, sys; \
    exit(0 if json.load(open("qa/qa-patch.json", "r")) == [] else 1)'

Locally it's possible to tell git not to track changes to the file at
all (see https://help.github.com/articles/ignoring-files):

  git update-index --assume-unchanged qa/qa-patch.json

Cherry-pick of e5398c3afde43e9165e96ab5cc8e0426519ad8ad from stable-2.11.

Signed-off-by: Petr Pudlak <pudlak@google.com>
Signed-off-by: Michele Tartara <mtartara@google.com>
Reviewed-by: Jose A. Lopes <jabolopes@google.com>

qa/qa-patch.json [new file with mode: 0644]
qa/qa_config.py

diff --git a/qa/qa-patch.json b/qa/qa-patch.json
new file mode 100644 (file)
index 0000000..fe51488
--- /dev/null
@@ -0,0 +1 @@
+[]
index 4e0d5f5..92f9584 100644 (file)
@@ -40,6 +40,10 @@ _VCLUSTER_MASTER_KEY = "vcluster-master"
 _VCLUSTER_BASEDIR_KEY = "vcluster-basedir"
 _ENABLED_DISK_TEMPLATES_KEY = "enabled-disk-templates"
 
+# The path of an optional JSON Patch file (as per RFC6902) that modifies QA's
+# configuration.
+_PATCH_JSON = os.path.join(os.path.dirname(__file__), "qa-patch.json")
+
 #: QA configuration (L{_QaConfig})
 _config = None
 
@@ -261,6 +265,20 @@ class _QaConfig(object):
     """
     data = serializer.LoadJson(utils.ReadFile(filename))
 
+    # Patch the document using JSON Patch (RFC6902) in file _PATCH_JSON, if
+    # available
+    try:
+      patch = serializer.LoadJson(utils.ReadFile(_PATCH_JSON))
+      if patch:
+        mod = __import__("jsonpatch", fromlist=[])
+        data = mod.apply_patch(data, patch)
+    except IOError:
+      pass
+    except ImportError:
+      raise qa_error.Error("If you want to use the QA JSON patching feature,"
+                           " you need to install Python modules"
+                           " 'jsonpatch' and 'jsonpointer'.")
+
     result = cls(dict(map(_ConvertResources,
                           data.items()))) # pylint: disable=E1103
     result.Validate()