PkgVars: Add new plugin to set vars for packages

This plugins allows the setting of varius flags per package. It should
be used f.e. to specify pinnings for debian packages.

6 files changed, 137 insertions, 8 deletions

diff --git a/schemas/pkgvars.xsd b/schemas/pkgvars.xsd
new file mode 100644
index 000000000..dbd02726d
--- /dev/null
+++ b/schemas/pkgvars.xsd
@@ -0,0 +1,43 @@
+<xsd:schema xmlns:xsd='http://www.w3.org/2001/XMLSchema'
+            xmlns:py="http://genshi.edgewall.org/">
+
+  <xsd:annotation>
+    <xsd:documentation>
+      XML-Schema-Definition für PkgVars/*.xml
+      Alexander Sulfrian
+    </xsd:documentation>
+  </xsd:annotation>
+
+  <xsd:import namespace="http://genshi.edgewall.org/"
+              schemaLocation="genshi.xsd"/>
+
+  <xsd:complexType name='pkgVarType'>
+    <xsd:attribute type='xsd:string' name='name'/>
+
+    <xsd:attribute type='xsd:string' name='pin'/>
+    <xsd:attribute type='xsd:string' name='use'/>
+    <xsd:attribute type='xsd:string' name='keywords'/>
+
+    <xsd:attributeGroup ref="py:genshiAttrs"/>
+  </xsd:complexType>
+
+  <xsd:complexType name='containerType'>
+    <xsd:choice maxOccurs='unbounded'>
+      <xsd:element name='Package' type='pkgVarType'/>
+      <xsd:element name='Client' type='containerType'/>
+      <xsd:element name='Group' type='containerType'/>
+    </xsd:choice>
+    <xsd:attribute name='name' type='xsd:string' use='required'/>
+    <xsd:attribute name='negate' type='xsd:boolean'/>
+  </xsd:complexType>
+
+  <xsd:complexType name='pkgVarsType'>
+    <xsd:choice minOccurs='0' maxOccurs='unbounded'>
+      <xsd:element name='Package' type='pkgVarType'/>
+      <xsd:element name='Client' type='containerType'/>
+      <xsd:element name='Group' type='containerType'/>
+    </xsd:choice>
+  </xsd:complexType>
+
+  <xsd:element name='PkgVars' type='pkgVarsType'/>
+</xsd:schema>
diff --git a/src/lib/Bcfg2/Server/Lint/Validate.py b/src/lib/Bcfg2/Server/Lint/Validate.py
index d6f18afbb..146f18b0c 100644
--- a/src/lib/Bcfg2/Server/Lint/Validate.py
+++ b/src/lib/Bcfg2/Server/Lint/Validate.py
@@ -61,7 +61,8 @@ class Validate(Bcfg2.Server.Lint.ServerlessPlugin):
              "AWSTags/config.xml": "awstags.xsd",
              "NagiosGen/config.xml": "nagiosgen.xsd",
              "FileProbes/config.xml": "fileprobes.xsd",
-             "GroupLogic/groups.xml": "grouplogic.xsd"
+             "GroupLogic/groups.xml": "grouplogic.xsd",
+             "PkgVars/*.xml": "pkgvars.xsd"
              }
 
         self.filelists = {}
diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py b/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py
index 004e27874..ccb526a19 100644
--- a/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py
+++ b/src/lib/Bcfg2/Server/Plugins/Packages/Collection.py
@@ -289,7 +289,7 @@ class Collection(list, Debuggable):
         return any(source.is_virtual_package(self.metadata, package)
                    for source in self)
 
-    def get_deps(self, package, recs=None):
+    def get_deps(self, package, recs=None, pinnings=None):
         """ Get a list of the dependencies of the given package.
 
         The base implementation simply aggregates the results of
@@ -297,16 +297,35 @@ class Collection(list, Debuggable):
 
         :param package: The name of the symbol, but see :ref:`pkg-objects`
         :type package: string
+        :param pinnings: Mapping from package names to source names.
+        :type pinnings: dict
         :returns: list of strings, but see :ref:`pkg-objects`
         """
         recommended = None
         if recs and package in recs:
             recommended = recs[package]
 
+        pin_found = False
+        pin_source = None
+        if pinnings and package in pinnings:
+            pin_source = pinnings[package]
+
         for source in self:
+            if pin_source and pin_source != source.name:
+                continue
+            pin_found = True
+
             if source.is_package(self.metadata, package):
                 return source.get_deps(self.metadata, package, recommended)
 
+        if not pin_found:
+            if pin_source:
+                self.logger.error("Packages: Source '%s' for package '%s' not found" %
+                                  (pin_source, package))
+            else:
+                self.logger.error("Packages: No source found for package '%s'" %
+                                  package);
+
         return []
 
     def get_essential(self):
@@ -471,12 +490,14 @@ class Collection(list, Debuggable):
 
     @track_statistics()
     def complete(self, packagelist,  # pylint: disable=R0912,R0914
-                 recommended=None):
+                 recommended=None, pinnings=None):
         """ Build a complete list of all packages and their dependencies.
 
         :param packagelist: Set of initial packages computed from the
                             specification.
         :type packagelist: set of strings, but see :ref:`pkg-objects`
+        :param pinnings: Mapping from package names to source names.
+        :type pinnings: dict
         :returns: tuple of sets - The first element contains a set of
                   strings (but see :ref:`pkg-objects`) describing the
                   complete package list, and the second element is a
@@ -535,7 +556,7 @@ class Collection(list, Debuggable):
                 self.debug_log("Packages: handling package requirement %s" %
                                (current,))
                 packages.add(current)
-                deps = self.get_deps(current, recommended)
+                deps = self.get_deps(current, recommended, pinnings)
                 newdeps = set(deps).difference(examined)
                 if newdeps:
                     self.debug_log("Packages: Package %s added requirements %s"
diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/Yum.py b/src/lib/Bcfg2/Server/Plugins/Packages/Yum.py
index 846fb89cd..acb11f1ab 100644
--- a/src/lib/Bcfg2/Server/Plugins/Packages/Yum.py
+++ b/src/lib/Bcfg2/Server/Plugins/Packages/Yum.py
@@ -850,7 +850,7 @@ class YumCollection(Collection):
         return new
 
     @track_statistics()
-    def complete(self, packagelist, recommended=None):
+    def complete(self, packagelist, recommended=None, pinnings=None):
         """ Build a complete list of all packages and their dependencies.
 
         When using the Python yum libraries, this defers to the
@@ -868,7 +868,8 @@ class YumCollection(Collection):
                   resolved.
         """
         if not self.use_yum:
-            return Collection.complete(self, packagelist, recommended)
+            return Collection.complete(self, packagelist, recommended,
+                                       pinnings)
 
         lock = FileLock(os.path.join(self.cachefile, "lock"))
         slept = 0
diff --git a/src/lib/Bcfg2/Server/Plugins/Packages/__init__.py b/src/lib/Bcfg2/Server/Plugins/Packages/__init__.py
index fd9131db4..d888af965 100644
--- a/src/lib/Bcfg2/Server/Plugins/Packages/__init__.py
+++ b/src/lib/Bcfg2/Server/Plugins/Packages/__init__.py
@@ -328,6 +328,10 @@ class Packages(Bcfg2.Server.Plugin.Plugin,
         groups = []
         recommended = dict()
 
+        pinned_src = dict()
+        if hasattr(metadata, 'PkgVars'):
+            pinned_src = metadata.PkgVars['pin']
+
         for struct in structures:
             for pkg in struct.xpath('//Package | //BoundPackage'):
                 if pkg.get("name"):
@@ -369,11 +373,11 @@ class Packages(Bcfg2.Server.Plugin.Plugin,
         base.update(collection.get_essential())
 
         # check for this set of packages in the package cache
-        pkey = hash(tuple(base))
+        pkey = hash((tuple(base), tuple(recommended), tuple(pinned_src)))
         pcache = Bcfg2.Server.Cache.Cache("Packages", "pkg_sets",
                                           collection.cachekey)
         if pkey not in pcache:
-            pcache[pkey] = collection.complete(base, recommended)
+            pcache[pkey] = collection.complete(base, recommended, pinned_src)
         packages, unknown = pcache[pkey]
         if unknown:
             self.logger.info("Packages: Got %d unknown entries" % len(unknown))
diff --git a/src/lib/Bcfg2/Server/Plugins/PkgVars.py b/src/lib/Bcfg2/Server/Plugins/PkgVars.py
new file mode 100644
index 000000000..a085ea17e
--- /dev/null
+++ b/src/lib/Bcfg2/Server/Plugins/PkgVars.py
@@ -0,0 +1,59 @@
+import os
+import re
+import sys
+import copy
+import logging
+import lxml.etree
+import Bcfg2.Server.Plugin
+
+logger = logging.getLogger('Bcfg2.Plugins.PkgVars')
+vars = ['pin', 'use', 'keywords']
+
+class PkgVarsFile(Bcfg2.Server.Plugin.StructFile):
+    def get_additional_data(self, meta):
+        data = self.Match(meta)
+        results = {}
+        for d in data:
+            name = d.get('name', '')
+
+            for v in vars:
+                value = d.get(v, None)
+                if value:
+                    results[v][name] = value
+
+        return results
+
+class PkgVarsDirectoryBacked(Bcfg2.Server.Plugin.DirectoryBacked):
+    __child__ = PkgVarsFile
+    patterns = re.compile(r'.*\.xml$')
+
+    def get_additional_data(self, meta):
+        results = {}
+        for v in vars:
+            results[v] = {}
+
+        for files in self.entries:
+            new = self.entries[files].get_additional_data(meta)
+            for x in vars:
+                results[x].update(new[x])
+
+        return results
+
+class PkgVars(Bcfg2.Server.Plugin.Plugin,
+              Bcfg2.Server.Plugin.Connector):
+    name = 'PkgVars'
+    version = '$Revision$'
+
+    def __init__(self, core):
+        Bcfg2.Server.Plugin.Plugin.__init__(self, core)
+        Bcfg2.Server.Plugin.Connector.__init__(self)
+        try:
+            self.store = PkgVarsDirectoryBacked(self.data)
+        except OSError:
+            e = sys.exc_info()[1]
+            self.logger.error("Error while creating PkgVars store: %s %s" %
+                              (e.strerror, e.filename))
+            raise Bcfg2.Server.Plugin.PluginInitError
+
+    def get_additional_data(self, meta):
+        return self.store.get_additional_data(meta)