First pass at Jinja2 support for Cfg.

5 files changed, 120 insertions, 2 deletions

diff --git a/src/lib/Bcfg2/Server/Lint/Comments.py b/src/lib/Bcfg2/Server/Lint/Comments.py
index e2d1ec597..fc4506c12 100644
--- a/src/lib/Bcfg2/Server/Lint/Comments.py
+++ b/src/lib/Bcfg2/Server/Lint/Comments.py
@@ -9,6 +9,7 @@ from Bcfg2.Server.Plugins.Cfg.CfgPlaintextGenerator \
     import CfgPlaintextGenerator
 from Bcfg2.Server.Plugins.Cfg.CfgGenshiGenerator import CfgGenshiGenerator
 from Bcfg2.Server.Plugins.Cfg.CfgCheetahGenerator import CfgCheetahGenerator
+from Bcfg2.Server.Plugins.Cfg.CfgJinja2Generator import CfgJinja2Generator
 from Bcfg2.Server.Plugins.Cfg.CfgInfoXML import CfgInfoXML
 
 
@@ -76,6 +77,14 @@ class Comments(Bcfg2.Server.Lint.ServerPlugin):
             type=Bcfg2.Options.Types.comma_list, default=[],
             help="Required comments for Cheetah-templated Cfg files"),
         Bcfg2.Options.Option(
+            cf=("Comments", "jinja2_keywords"),
+            type=Bcfg2.Options.Types.comma_list, default=[],
+            help="Required keywords for Jinja2-templated Cfg files"),
+        Bcfg2.Options.Option(
+            cf=("Comments", "jinja2_comments"),
+            type=Bcfg2.Options.Types.comma_list, default=[],
+            help="Required comments for Jinja2-templated Cfg files"),
+        Bcfg2.Options.Option(
             cf=("Comments", "infoxml_keywords"),
             type=Bcfg2.Options.Types.comma_list, default=[],
             help="Required keywords for info.xml files"),
@@ -235,6 +244,8 @@ class Comments(Bcfg2.Server.Lint.ServerPlugin):
                         rtype = "cfg"
                     elif isinstance(entry, CfgCheetahGenerator):
                         rtype = "cheetah"
+                    elif isinstance(entry, CfgJinja2Generator):
+                        rtype = "jinja2"
                     elif isinstance(entry, CfgInfoXML):
                         self.check_xml(entry.infoxml.name,
                                        entry.infoxml.pnode.data,
diff --git a/src/lib/Bcfg2/Server/Lint/Jinja2.py b/src/lib/Bcfg2/Server/Lint/Jinja2.py
new file mode 100755
index 000000000..3112d2a6e
--- /dev/null
+++ b/src/lib/Bcfg2/Server/Lint/Jinja2.py
@@ -0,0 +1,40 @@
+""" Check Jinja2 templates for syntax errors. """
+
+import sys
+import Bcfg2.Server.Lint
+from jinja2 import Template, TemplateSyntaxError
+from Bcfg2.Server.Plugins.Cfg.CfgJinja2Generator import CfgJinja2Generator
+
+
+class Jinja2(Bcfg2.Server.Lint.ServerPlugin):
+    """ Check Jinja2 templates for syntax errors. """
+
+    def Run(self):
+        if 'Cfg' in self.core.plugins:
+            self.check_cfg()
+
+    @classmethod
+    def Errors(cls):
+        return {"jinja2-syntax-error": "error",
+                "unknown-jinja2-error": "error"}
+
+    def check_template(self, entry):
+        """ Generic check for all jinja2 templates (XML and text) """
+        try:
+            Template(entry.data.decode(entry.encoding))
+        except TemplateSyntaxError:
+            err = sys.exc_info()[1]
+            self.LintError("jinja2-syntax-error",
+                           "Jinja2 syntax error in %s: %s" % (entry.name, err))
+        except:
+            err = sys.exc_info()[1]
+            self.LintError("unknown-jinja2-error",
+                           "Unknown Jinja2 error in %s: %s" % (entry.name, err))
+
+    def check_cfg(self):
+        """ Check jinja2 templates in Cfg for syntax errors. """
+        for entryset in self.core.plugins['Cfg'].entries.values():
+            for entry in entryset.entries.values():
+                if (self.HandlesFile(entry.name) and
+                        isinstance(entry, CfgJinja2Generator)):
+                    self.check_template(entry)
diff --git a/src/lib/Bcfg2/Server/Lint/TemplateAbuse.py b/src/lib/Bcfg2/Server/Lint/TemplateAbuse.py
index 202a1487d..5a80a5884 100644
--- a/src/lib/Bcfg2/Server/Lint/TemplateAbuse.py
+++ b/src/lib/Bcfg2/Server/Lint/TemplateAbuse.py
@@ -8,16 +8,20 @@ from Bcfg2.Server.Plugin import default_path_metadata
 from Bcfg2.Server.Plugins.Cfg.CfgInfoXML import CfgInfoXML
 from Bcfg2.Server.Plugins.Cfg.CfgGenshiGenerator import CfgGenshiGenerator
 from Bcfg2.Server.Plugins.Cfg.CfgCheetahGenerator import CfgCheetahGenerator
+from Bcfg2.Server.Plugins.Cfg.CfgJinja2Generator import CfgJinja2Generator
 from Bcfg2.Server.Plugins.Cfg.CfgEncryptedGenshiGenerator import \
     CfgEncryptedGenshiGenerator
 from Bcfg2.Server.Plugins.Cfg.CfgEncryptedCheetahGenerator import \
     CfgEncryptedCheetahGenerator
+from Bcfg2.Server.Plugins.Cfg.CfgEncryptedJinja2Generator import \
+    CfgEncryptedJinja2Generator
 
 
 class TemplateAbuse(Bcfg2.Server.Lint.ServerPlugin):
     """ Check for templated scripts or executables. """
-    templates = [CfgGenshiGenerator, CfgCheetahGenerator,
-                 CfgEncryptedGenshiGenerator, CfgEncryptedCheetahGenerator]
+    templates = [CfgGenshiGenerator, CfgCheetahGenerator, CfgJinja2Generator,
+                 CfgEncryptedGenshiGenerator, CfgEncryptedCheetahGenerator,
+                 CfgEncryptedJinja2Generator]
     extensions = [".pl", ".py", ".sh", ".rb"]
 
     def Run(self):
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedJinja2Generator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedJinja2Generator.py
new file mode 100644
index 000000000..c8da84ae0
--- /dev/null
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedJinja2Generator.py
@@ -0,0 +1,25 @@
+""" Handle encrypted Jinja2 templates (.crypt.jinja2 or
+.jinja2.crypt files)"""
+
+from Bcfg2.Server.Plugins.Cfg.CfgJinja2Generator import CfgJinja2Generator
+from Bcfg2.Server.Plugins.Cfg.CfgEncryptedGenerator \
+    import CfgEncryptedGenerator
+
+
+class CfgEncryptedJinja2Generator(CfgJinja2Generator, CfgEncryptedGenerator):
+    """ CfgEncryptedJinja2Generator lets you encrypt your Jinja2
+    :ref:`server-plugins-generators-cfg` files on the server """
+
+    #: handle .crypt.jinja2 or .jinja2.crypt files
+    __extensions__ = ['jinja2.crypt', 'crypt.jinja2']
+
+    #: Override low priority from parent class
+    __priority__ = 0
+
+    def handle_event(self, event):
+        CfgEncryptedGenerator.handle_event(self, event)
+    handle_event.__doc__ = CfgEncryptedGenerator.handle_event.__doc__
+
+    def get_data(self, entry, metadata):
+        return CfgJinja2Generator.get_data(self, entry, metadata)
+    get_data.__doc__ = CfgJinja2Generator.get_data.__doc__
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgJinja2Generator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgJinja2Generator.py
new file mode 100644
index 000000000..aaf9f4fc0
--- /dev/null
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgJinja2Generator.py
@@ -0,0 +1,38 @@
+""" The CfgJinja2Generator allows you to use the `Jinja2
+<http://jinja.pocoo.org/>`_ templating system to generate
+:ref:`server-plugins-generators-cfg` files. """
+
+from Bcfg2.Server.Plugin import PluginExecutionError
+from Bcfg2.Server.Plugins.Cfg import CfgGenerator, SETUP
+
+try:
+    from jinja2 import Template
+    HAS_JINJA2 = True
+except ImportError:
+    HAS_JINJA2 = False
+
+
+class CfgJinja2Generator(CfgGenerator):
+    """ The CfgJinja2Generator allows you to use the `Jinja2
+    <http://jinja.pocoo.org/>`_ templating system to generate
+    :ref:`server-plugins-generators-cfg` files. """
+
+    #: Handle .jinja2 files
+    __extensions__ = ['jinja2']
+
+    #: Low priority to avoid matching host- or group-specific
+    #: .crypt.jinja2 files
+    __priority__ = 50
+
+    def __init__(self, fname, spec, encoding):
+        CfgGenerator.__init__(self, fname, spec, encoding)
+        if not HAS_JINJA2:
+            raise PluginExecutionError("Jinja2 is not available")
+    __init__.__doc__ = CfgGenerator.__init__.__doc__
+
+    def get_data(self, entry, metadata):
+        template = Template(self.data.decode(self.encoding))
+        name = entry.get('realname', entry.get('name'))
+        return template.render(metadata=metadata, name=name, path=name,
+                               source_path=name, repo=SETUP['repo'])
+    get_data.__doc__ = CfgGenerator.get_data.__doc__