Include an archetype preface template in the plenary object

- Only if object_declarations_template option is true: default=false
  (true in aqd.conf.noms)
- Template must be archetype/declarations (intended to define LOADPATH mainly)
- It is the first executed template in the plenary object
- Implemented for host, cluster and metacluster

Fixes #86

Change-Id: I7e57401fc82bfbc5af21d3d07efe543e999c23e6

etc/aqd.conf.defaults

@@ -346,6 +346,7 @@ gzip_output = false
 # only used if gzip_output = true
 transparent_gzip = true
 template_extension = .tpl
+object_declarations_template = false
 
 [tool_timeout]
 # If set to True, timeout will be set to 'default_value' for any tools run via subprocess

etc/aqd.conf.noms

@@ -84,6 +84,10 @@ location_uri_validator = /bin/true
 # in raw mode and set the version variable itself.
 pan_compiler = /usr/lib/panc.jar
 
+# Include a preface template in the object template if true
+object_declarations_template = true
+
+
 ###############################################################################
 
 [site]

lib/aquilon/worker/templates/cluster.py

@@ -188,7 +188,17 @@ def get_key(self, exclusive=True):
         return CompileKey.merge(keylist)
 
     def body(self, lines):
+        # Allow settings such as loadpath to be modified by the archetype before anything else happens
+        # Included only if object_declarations_template option is true
+        # It the option is true, the template MUST exist
+        if self.config.getboolean("panc", "object_declarations_template"):
+            pan_include(lines, "archetype/declarations")
+            lines.append("")
+
         pan_include(lines, ["pan/units", "pan/functions"])
+        lines.append("")
+
+        # Okay, here's the real content
         path = PlenaryClusterData.template_name(self.dbobj)
         pan_assign(lines, "/",
                    StructureTemplate(path,

lib/aquilon/worker/templates/host.py

@@ -374,10 +374,17 @@ def body(self, lines):
         services.sort()
         provides.sort()
 
-        # Okay, here's the real content
+        # Allow settings such as loadpath to be modified by the archetype before anything else happens
+        # Included only if object_declarations_template option is true
+        # It the option is true, the template MUST exist
+        if self.config.getboolean("panc", "object_declarations_template"):
+            pan_include(lines, "archetype/declarations")
+            lines.append("")
+
         pan_include(lines, ["pan/units", "pan/functions"])
         lines.append("")
 
+        # Okay, here's the real content
         path = PlenaryHostData.template_name(self.dbobj)
         pan_assign(lines, "/",
                    StructureTemplate(path,

lib/aquilon/worker/templates/metacluster.py

@@ -117,7 +117,17 @@ def get_key(self, exclusive=True):
         return CompileKey.merge(keylist)
 
     def body(self, lines):
+        # Allow settings such as loadpath to be modified by the archetype before anything else happens
+        # Included only if object_declarations_template option is true
+        # It the option is true, the template MUST exist
+        if self.config.getboolean("panc", "object_declarations_template"):
+            pan_include(lines, "archetype/declarations")
+            lines.append("")
+
         pan_include(lines, ["pan/units", "pan/functions"])
+        lines.append("")
+
+        # Okay, here's the real content
         pan_assign(lines, "/",
                    StructureTemplate("clusterdata/%s" % self.dbobj.name,
                                      {"metadata": PanValue("/metadata")}))