Replaced XMLSrc with StructFile

XMLSrc and StructFile were very different implementations of basically
the same thing.  StructFile has gotten lots and lots of improvements,
while XMLSrc, with its wonky, unintuitive interface, has floundered.
This replaces XMLSrc with StructFile (nearly) everywhere, and rebases
everything that inherited from XMLSrc with StructFile.

XMLSrc lives on somewhat in the Pkgmgr plugin's PNode and PkgSrc
objects, where originally inherited from the XMLSrc and INode objects
but are now the only implementation of that older interface.  Pkgmgr
was left as-is because a) it's a little-used plugin; b) it's in need
of a rewrite anyway; and c) it has deep, deep hooks into the guts of
XMLSrc and INode, and rewriting it with StructFile was deeply
nontrivial.

1 files changed, 29 insertions, 57 deletions

diff --git a/src/lib/Bcfg2/Server/Plugins/Deps.py b/src/lib/Bcfg2/Server/Plugins/Deps.py
index d3a1ee871..312b03bae 100644
--- a/src/lib/Bcfg2/Server/Plugins/Deps.py
+++ b/src/lib/Bcfg2/Server/Plugins/Deps.py
@@ -1,35 +1,12 @@
 """This plugin provides automatic dependency handling."""
 
 import lxml.etree
-
 import Bcfg2.Server.Plugin
-
-
-class DNode(Bcfg2.Server.Plugin.INode):
-    """DNode provides supports for single predicate types for dependencies."""
-    def _load_children(self, data, idict):
-        for item in data.getchildren():
-            if item.tag in self.containers:
-                self.children.append(self.__class__(item, idict, self))
-            else:
-                data = [(child.tag, child.get('name'))
-                        for child in item.getchildren()]
-                try:
-                    self.contents[item.tag][item.get('name')] = data
-                except KeyError:
-                    self.contents[item.tag] = {item.get('name'): data}
-
-
-class DepXMLSrc(Bcfg2.Server.Plugin.XMLSrc):
-    __node__ = DNode
+from Bcfg2.Server.Plugin import PluginExecutionError
 
 
 class Deps(Bcfg2.Server.Plugin.PrioDir,
            Bcfg2.Server.Plugin.StructureValidator):
-    name = 'Deps'
-    __author__ = 'bcfg-dev@mcs.anl.gov'
-    __child__ = DepXMLSrc
-
     # Override the default sort_order (of 500) so that this plugin
     # gets handled after others running at the default. In particular,
     # we want to run after Packages, so we can see the final set of
@@ -55,63 +32,58 @@ class Deps(Bcfg2.Server.Plugin.PrioDir,
                 tag = entry.tag
                 if tag.startswith('Bound'):
                     tag = tag[5:]
-                if (tag, entry.get('name')) not in entries \
-                        and not isinstance(entry, lxml.etree._Comment):
+                if ((tag, entry.get('name')) not in entries
+                    and not isinstance(entry, lxml.etree._Comment)):
                     entries.append((tag, entry.get('name')))
         entries.sort()
         entries = tuple(entries)
-        gdata = list(metadata.groups)
-        gdata.sort()
-        gdata = tuple(gdata)
+        groups = list(metadata.groups)
+        groups.sort()
+        groups = tuple(groups)
 
         # Check to see if we have cached the prereqs already
-        if (entries, gdata) in self.cache:
-            prereqs = self.cache[(entries, gdata)]
+        if (entries, groups) in self.cache:
+            prereqs = self.cache[(entries, groups)]
         else:
             prereqs = self.calculate_prereqs(metadata, entries)
-            self.cache[(entries, gdata)] = prereqs
+            self.cache[(entries, groups)] = prereqs
 
         newstruct = lxml.etree.Element("Independent")
         for tag, name in prereqs:
-            try:
-                lxml.etree.SubElement(newstruct, tag, name=name)
-            except:
-                self.logger.error("Failed to add dep entry for %s:%s" % (tag, name))
+            lxml.etree.SubElement(newstruct, tag, name=name)
         structures.append(newstruct)
 
-
     def calculate_prereqs(self, metadata, entries):
         """Calculate the prerequisites defined in Deps for the passed
         set of entries.
         """
         prereqs = []
-        [src.Cache(metadata) for src in self.entries.values()]
-
         toexamine = list(entries[:])
         while toexamine:
             entry = toexamine.pop()
-            matching = [src for src in list(self.entries.values())
-                        if src.cache and entry[0] in src.cache[1]
-                        and entry[1] in src.cache[1][entry[0]]]
+            # tuples of (PriorityStructFile, element) for each
+            # matching element and the structfile that contains it
+            matching = []
+            for deps in self.entries.values():
+                el = deps.find("/%s[name='%s']" % (entry.tag,
+                                                   entry.get("name")))
+                if el:
+                    matching.append((deps, el))
             if len(matching) > 1:
-                prio = [int(src.priority) for src in matching]
+                prio = [int(m[0].priority) for m in matching]
                 if prio.count(max(prio)) > 1:
-                    self.logger.error("Found conflicting %s sources with same priority for %s, pkg %s" %
-                                      (entry[0].lower(), metadata.hostname, entry[1]))
-                    raise Bcfg2.Server.Plugin.PluginExecutionError
+                    raise PluginExecutionError(
+                            "Deps: Found conflicting dependencies with same "
+                            "priority for %s:%s for %s: %s" %
+                            (entry.tag, entry.get("name"),
+                             metadata.hostname, [m[0].name for m in matching]))
                 index = prio.index(max(prio))
                 matching = [matching[index]]
-            elif len(matching) == 1:
-                for prq in matching[0].cache[1][entry[0]][entry[1]]:
-                    # XML comments seem to show up in the cache as a
-                    # tuple with item 0 being callable. The logic
-                    # below filters them out. Would be better to
-                    # exclude them when we load the cache in the first
-                    # place.
-                    if prq not in prereqs and prq not in entries and not callable(prq[0]):
-                        toexamine.append(prq)
-                        prereqs.append(prq)
-            else:
+            if not matching:
                 continue
+            for prq in matching[0][1].getchildren():
+                if prq not in prereqs and prq not in entries:
+                    toexamine.append(prq)
+                    prereqs.append(prq)
 
         return prereqs