Merge lp:~harlowja/cloud-init/schema-validate into lp:~cloud-init-dev/cloud-init/trunk

[Joshua Harlow]

Add a tiny initial usage of jsonschema to validate config modules input configuration before handlers start using it via a decorator that handlers can choose or not choose to use on there handle() function.

[lp:~harlowja/cloud-init/schema-validate]

1001. By Joshua Harlow on 2014-08-22

Makes the jsonschema usage optional

1002. By Joshua Harlow on 2014-08-22

Fix wording

[Server Team CI bot (server-team-bot)]

FAILED: Continuous integration, rev:1002
https://server-team-jenkins.canonical.com/job/cloud-init-ci/49/
Executed test runs:
    None: https://server-team-jenkins.canonical.com/job/lp-vote-on-merge/23/console

Click here to trigger a rebuild:
https://server-team-jenkins.canonical.com/job/cloud-init-ci/49/rebuild

review: Needs Fixing (continuous-integration)

[Scott Moser (smoser)]

Hello,
Thank you for taking the time to contribute to cloud-init. Cloud-init has moved its revision control system to git. As a result, we are marking all bzr merge proposals as 'rejected'. If you would like to re-submit this proposal for review, please do so by following the current HACKING documentation at http://cloudinit.readthedocs.io/en/latest/topics/hacking.html .

I'm going to mark this as 'merged', because I think it is actually
upstream at
https://git.launchpad.net/cloud-init/commit/?id=0a448dd034

=== modified file 'cloudinit/config/__init__.py'
--- cloudinit/config/__init__.py	2013-01-15 21:08:43 +0000
+++ cloudinit/config/__init__.py	2014-08-22 19:02:06 +0000
@@ -19,6 +19,15 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+import functools
+
+try:
+    import jsonschema
+    VALIDATION_AVAILABLE = True
+except ImportError:
+    VALIDATION_AVAILABLE = False
+
+
 from cloudinit.settings import (PER_INSTANCE, FREQUENCIES)
 
 from cloudinit import log as logging
@@ -31,6 +40,27 @@
 # name in the lookup path...
 MOD_PREFIX = "cc_"
 
+# Special jsonschema validation types/adjustments.
+_SCHEMA_TYPES = {
+    # See: https://github.com/Julian/jsonschema/issues/148
+    'array': (list, tuple),
+}
+
+
+def validator(schema):
+
+    def decorator(handler):
+
+        @functools.wraps(handler)
+        def wrapper(name, cfg, cloud, log, args):
+            if VALIDATION_AVAILABLE:
+                jsonschema.validate(cfg, schema, types=_SCHEMA_TYPES)
+            return handler(name, cfg, cloud, log, args)
+
+        return wrapper
+
+    return decorator
+
 
 def form_module_name(name):
     canon_name = name.replace("-", "_")
 
=== modified file 'cloudinit/config/cc_final_message.py'
--- cloudinit/config/cc_final_message.py	2014-03-12 14:59:13 +0000
+++ cloudinit/config/cc_final_message.py	2014-08-22 19:02:06 +0000
@@ -18,6 +18,7 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+from cloudinit import config
 from cloudinit import templater
 from cloudinit import util
 from cloudinit import version
@@ -30,7 +31,17 @@
 FINAL_MESSAGE_DEF = ("Cloud-init v. ${version} finished at ${timestamp}."
                      " Datasource ${datasource}.  Up ${uptime} seconds")
 
-
+SCHEMA = {
+    "type": "object",
+    'properties': {
+        'final_message': {
+            "type": "string",
+        },
+    },
+}
+
+
[e-mail](SCHEMA)
 def handle(_name, cfg, cloud, log, args):
 
     msg_in = ''
 
=== modified file 'requirements.txt'
--- requirements.txt	2014-03-05 23:05:59 +0000
+++ requirements.txt	2014-08-22 19:02:06 +0000
@@ -32,3 +32,8 @@
 
 # For patching pieces of cloud-config together
 jsonpatch
+
+# For validating config modules desired configuration (optional, if not
+# avaiable then validation will not occur and config modules will be passed
+# the unvalidated configuration).
+jsonschema