bcfg2-lint: New ValidateJSON plugin

This plugin validates the JSON files that can be used by Properties
and Ohai.

1 files changed, 70 insertions, 0 deletions

diff --git a/src/lib/Bcfg2/Server/Lint/ValidateJSON.py b/src/lib/Bcfg2/Server/Lint/ValidateJSON.py
new file mode 100644
index 000000000..c4a82a5d2
--- /dev/null
+++ b/src/lib/Bcfg2/Server/Lint/ValidateJSON.py
@@ -0,0 +1,70 @@
+"""Ensure that all JSON files in the Bcfg2 repository are
+valid. Currently, the only plugins that uses JSON are Ohai and
+Properties."""
+
+import os
+import sys
+import glob
+import fnmatch
+import Bcfg2.Server.Lint
+
+try:
+    import json
+except ImportError:
+    import simplejson as json
+
+
+class ValidateJSON(Bcfg2.Server.Lint.ServerlessPlugin):
+    """Ensure that all JSON files in the Bcfg2 repository are
+    valid. Currently, the only plugins that uses JSON are Ohai and
+    Properties. """
+
+    def __init__(self, *args, **kwargs):
+        Bcfg2.Server.Lint.ServerlessPlugin.__init__(self, *args, **kwargs)
+
+        #: A list of file globs that give the path to JSON files.  The
+        #: globs are extended :mod:`fnmatch` globs that also support
+        #: ``**``, which matches any number of any characters,
+        #: including forward slashes.
+        self.globs = ["Properties/*.json", "Ohai/*.json"]
+        self.files = self.get_files()
+
+    def Run(self):
+        for path in self.files:
+            self.logger.debug("Validating JSON in %s" % path)
+            try:
+                json.load(open(path))
+            except ValueError:
+                self.LintError("json-failed-to-parse",
+                               "%s does not contain valid JSON: %s" %
+                               (path, sys.exc_info()[1]))
+
+    @classmethod
+    def Errors(cls):
+        return {"json-failed-to-parse": "error"}
+
+    def get_files(self):
+        """Return a list of all JSON files to validate, based on
+        :attr:`Bcfg2.Server.Lint.ValidateJSON.ValidateJSON.globs`. """
+        if self.files is not None:
+            listfiles = lambda p: fnmatch.filter(self.files,
+                                                 os.path.join('*', p))
+        else:
+            listfiles = lambda p: glob.glob(os.path.join(self.config['repo'],
+                                                         p))
+
+        rv = []
+        for path in self.globs:
+            if '/**/' in path:
+                if self.files is not None:
+                    rv.extend(listfiles(path))
+                else:  # self.files is None
+                    fpath, fname = path.split('/**/')
+                    for root, _, files in \
+                            os.walk(os.path.join(self.config['repo'],
+                                                 fpath)):
+                        rv.extend([os.path.join(root, f)
+                                   for f in files if f == fname])
+            else:
+                rv.extend(listfiles(path))
+        return rv