made bcfg2-lint load lint plugins from server plugins where appropriate

5 files changed, 211 insertions, 2 deletions

diff --git a/src/lib/Bcfg2/Server/Plugins/Bundler.py b/src/lib/Bcfg2/Server/Plugins/Bundler.py
index cbaa85089..6289439c6 100644
--- a/src/lib/Bcfg2/Server/Plugins/Bundler.py
+++ b/src/lib/Bcfg2/Server/Plugins/Bundler.py
@@ -8,6 +8,7 @@ import re
 import sys
 import Bcfg2.Server
 import Bcfg2.Server.Plugin
+import Bcfg2.Server.Lint
 
 try:
     import genshi.template.base
@@ -91,3 +92,52 @@ class Bundler(Bcfg2.Server.Plugin.Plugin,
                 self.logger.error("Bundler: Unexpected bundler error for %s" %
                                   bundlename, exc_info=1)
         return bundleset
+
+class BundlerLint(Bcfg2.Server.Lint.ServerPlugin):
+    """ Perform various bundle checks """
+    def Run(self):
+        """ run plugin """
+        self.missing_bundles()
+        for bundle in self.core.plugins['Bundler'].entries.values():
+            if (self.HandlesFile(bundle.name) and
+                (not have_genshi or type(bundle) is not SGenshiTemplateFile)):
+                    self.bundle_names(bundle)
+
+    @classmethod
+    def Errors(cls):
+        return {"bundle-not-found":"error",
+                "inconsistent-bundle-name":"warning"}
+
+    def missing_bundles(self):
+        """ find bundles listed in Metadata but not implemented in Bundler """
+        if self.files is None:
+            # when given a list of files on stdin, this check is
+            # useless, so skip it
+            groupdata = self.metadata.groups_xml.xdata
+            ref_bundles = set([b.get("name")
+                               for b in groupdata.findall("//Bundle")])
+
+            allbundles = self.core.plugins['Bundler'].entries.keys()
+            for bundle in ref_bundles:
+                xmlbundle = "%s.xml" % bundle
+                genshibundle = "%s.genshi" % bundle
+                if (xmlbundle not in allbundles and
+                    genshibundle not in allbundles):
+                    self.LintError("bundle-not-found",
+                                   "Bundle %s referenced, but does not exist" %
+                                   bundle)
+
+    def bundle_names(self, bundle):
+        """ verify bundle name attribute matches filename """
+        try:
+            xdata = lxml.etree.XML(bundle.data)
+        except AttributeError:
+            # genshi template
+            xdata = lxml.etree.parse(bundle.template.filepath).getroot()
+
+        fname = bundle.name.split('Bundler/')[1].split('.')[0]
+        bname = xdata.get('name')
+        if fname != bname:
+            self.LintError("inconsistent-bundle-name",
+                           "Inconsistent bundle name: filename is %s, "
+                           "bundle name is %s" % (fname, bname))
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py b/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py
index af6e1c7b1..15fd71644 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py
@@ -11,6 +11,7 @@ import lxml.etree
 import Bcfg2.Options
 import Bcfg2.Server.Plugin
 from Bcfg2.Bcfg2Py3k import u_str
+import Bcfg2.Server.Lint
 
 logger = logging.getLogger(__name__)
 
@@ -412,3 +413,23 @@ class Cfg(Bcfg2.Server.Plugin.GroupSpool,
         return self.entries[new_entry.get('name')].write_update(specific,
                                                                 new_entry,
                                                                 log)
+
+class CfgLint(Bcfg2.Server.Lint.ServerPlugin):
+    def Run(self):
+        # about usage of .cat and .diff files
+        self.check_deltas()
+
+    @classmethod
+    def Errors(cls):
+        return {"cat-file-used":"warning",
+                "diff-file-used":"warning"}
+
+    def check_entry(self, basename, entry):
+        cfg = self.core.plugins['Cfg']
+        for basename, entry in list(cfg.entries.items()):
+            for fname, processor in entry.entries.items():
+                if self.HandlesFile(fname) and isinstance(processor, CfgFilter):
+                    extension = fname.split(".")[-1]
+                    self.LintError("%s-file-used" % extension,
+                                   "%s file used on %s: %s" %
+                                   (extension, basename, fname))
diff --git a/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py b/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py
index 58b4d4afb..e883143ec 100644
--- a/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py
+++ b/src/lib/Bcfg2/Server/Plugins/GroupPatterns.py
@@ -1,6 +1,8 @@
 import re
+import sys
 import logging
 import lxml.etree
+import Bcfg2.Server.Lint
 import Bcfg2.Server.Plugin
 
 class PackedDigitRange(object):
@@ -122,3 +124,33 @@ class GroupPatterns(Bcfg2.Server.Plugin.Plugin,
 
     def get_additional_groups(self, metadata):
         return self.config.process_patterns(metadata.hostname)
+
+
+class GroupPatternsLint(Bcfg2.Server.Lint.ServerPlugin):
+    def Run(self):
+        """ run plugin """
+        cfg = self.core.plugins['GroupPatterns'].config
+        for entry in cfg.xdata.xpath('//GroupPattern'):
+            groups = [g.text for g in entry.findall('Group')]
+            self.check(entry, groups, ptype='NamePattern')
+            self.check(entry, groups, ptype='NameRange')
+
+    @classmethod
+    def Errors(cls):
+        return {"pattern-fails-to-initialize":"error"}
+
+    def check(self, entry, groups, ptype="NamePattern"):
+        if ptype == "NamePattern":
+            pmap = lambda p: PatternMap(p, None, groups)
+        else:
+            pmap = lambda p: PatternMap(None, p, groups)
+
+        for el in entry.findall(ptype):
+            pat = el.text
+            try:
+                pmap(pat)
+            except:
+                err = sys.exc_info()[1]
+                self.LintError("pattern-fails-to-initialize",
+                               "Failed to initialize %s %s for %s: %s" %
+                               (ptype, pat, entry.get('pattern'), err))
diff --git a/src/lib/Bcfg2/Server/Plugins/Pkgmgr.py b/src/lib/Bcfg2/Server/Plugins/Pkgmgr.py
index 8d6d85ef2..fcf2045a7 100644
--- a/src/lib/Bcfg2/Server/Plugins/Pkgmgr.py
+++ b/src/lib/Bcfg2/Server/Plugins/Pkgmgr.py
@@ -1,9 +1,12 @@
 '''This module implements a package management scheme for all images'''
 
-import logging
 import re
+import glob
+import logging
+import lxml.etree
 import Bcfg2.Server.Plugin
-import lxml
+import Bcfg2.Server.Lint
+
 try:
     set
 except NameError:
@@ -169,3 +172,40 @@ class Pkgmgr(Bcfg2.Server.Plugin.PrioDir):
 
     def HandleEntry(self, entry, metadata):
         self.BindEntry(entry, metadata)
+
+
+class PkgmgrLint(Bcfg2.Server.Lint.ServerlessPlugin):
+    """ find duplicate Pkgmgr entries with the same priority """
+    def Run(self):
+        pset = set()
+        for pfile in glob.glob(os.path.join(self.config['repo'], 'Pkgmgr',
+                                            '*.xml')):
+            if self.HandlesFile(pfile):
+                xdata = lxml.etree.parse(pfile).getroot()
+                # get priority, type, group
+                priority = xdata.get('priority')
+                ptype = xdata.get('type')
+                for pkg in xdata.xpath("//Package"):
+                    if pkg.getparent().tag == 'Group':
+                        grp = pkg.getparent().get('name')
+                        if (type(grp) is not str and
+                            grp.getparent().tag == 'Group'):
+                            pgrp = grp.getparent().get('name')
+                        else:
+                            pgrp = 'none'
+                    else:
+                        grp = 'none'
+                        pgrp = 'none'
+                    ptuple = (pkg.get('name'), priority, ptype, grp, pgrp)
+                    # check if package is already listed with same
+                    # priority, type, grp
+                    if ptuple in pset:
+                        self.LintError("duplicate-package",
+                                       "Duplicate Package %s, priority:%s, type:%s" %
+                                         (pkg.get('name'), priority, ptype))
+                    else:
+                        pset.add(ptuple)
+    
+    @classmethod
+    def Errors(cls):
+        return {"duplicate-packages":"error"}
diff --git a/src/lib/Bcfg2/Server/Plugins/TemplateHelper.py b/src/lib/Bcfg2/Server/Plugins/TemplateHelper.py
index 2c0ee03e0..3712506d6 100644
--- a/src/lib/Bcfg2/Server/Plugins/TemplateHelper.py
+++ b/src/lib/Bcfg2/Server/Plugins/TemplateHelper.py
@@ -1,7 +1,9 @@
 import re
 import imp
 import sys
+import glob
 import logging
+import Bcfg2.Server.Lint
 import Bcfg2.Server.Plugin
 
 logger = logging.getLogger(__name__)
@@ -81,3 +83,67 @@ class TemplateHelper(Bcfg2.Server.Plugin.Plugin,
     def get_additional_data(self, metadata):
         return dict([(h._module_name, h)
                      for h in list(self.helpers.entries.values())])
+
+
+class TemplateHelperLint(Bcfg2.Server.Lint.ServerlessPlugin):
+    """ find duplicate Pkgmgr entries with the same priority """
+    def __init__(self, *args, **kwargs):
+        Bcfg2.Server.Lint.ServerlessPlugin.__init__(self, *args, **kwargs)
+        hm = HelperModule("foo.py", None, None)
+        self.reserved_keywords = dir(hm)
+
+    def Run(self):
+        for helper in glob.glob(os.path.join(self.config['repo'],
+                                             "TemplateHelper",
+                                             "*.py")):
+            if not self.HandlesFile(helper):
+                continue
+            self.check_helper(helper)
+
+    def check_helper(self, helper):
+        match = HelperModule._module_name_re.search(helper)
+        if match:
+            module_name = match.group(1)
+        else:
+            module_name = helper
+
+        try:
+            module = imp.load_source(module_name, helper)
+        except:
+            err = sys.exc_info()[1]
+            self.LintError("templatehelper-import-error",
+                           "Failed to import %s: %s" %
+                           (helper, err))
+            continue
+
+        if not hasattr(module, "__export__"):
+            self.LintError("templatehelper-no-export",
+                           "%s has no __export__ list" % helper)
+            continue
+        elif not isinstance(module.__export__, list):
+            self.LintError("templatehelper-nonlist-export",
+                           "__export__ is not a list in %s" % helper)
+            continue
+
+        for sym in module.__export__:
+            if not hasattr(module, sym):
+                self.LintError("templatehelper-nonexistent-export",
+                               "%s: exported symbol %s does not exist" %
+                               (helper, sym))
+            elif sym in self.reserved_keywords:
+                self.LintError("templatehelper-reserved-export",
+                               "%s: exported symbol %s is reserved" %
+                               (helper, sym))
+            elif sym.startswith("_"):
+                self.LintError("templatehelper-underscore-export",
+                               "%s: exported symbol %s starts with underscore" %
+                               (helper, sym))
+
+    @classmethod
+    def Errors(cls):
+        return {"templatehelper-import-error":"error",
+                "templatehelper-no-export":"error",
+                "templatehelper-nonlist-export":"error",
+                "templatehelper-nonexistent-export":"error",
+                "templatehelper-reserved-export":"error",
+                "templatehelper-underscore-export":"warning"}