From 956f400da6fca8d904c96f6958c3ea3a5beab9d9 Mon Sep 17 00:00:00 2001
From: Nico Schottelius <nico@bento.schottelius.org>
Date: Tue, 30 Apr 2013 15:15:22 +0200
Subject: [PATCH] re-arrange for future cleanup

Signed-off-by: Nico Schottelius <nico@bento.schottelius.org>
---
 cdist/config_install.py |  77 ++++++++++--------
 cdist/resolver.py       | 175 ----------------------------------------
 2 files changed, 42 insertions(+), 210 deletions(-)
 delete mode 100644 cdist/resolver.py

diff --git a/cdist/config_install.py b/cdist/config_install.py
index 7e8eb0f1..b62af3e0 100644
--- a/cdist/config_install.py
+++ b/cdist/config_install.py
@@ -63,20 +63,16 @@ class ConfigInstall(object):
             shutil.rmtree(destination)
         shutil.move(self.context.local.out_path, destination)
 
-    def deploy_to(self):
-        """Mimic the old deploy to: Deploy to one host"""
+    def deploy_and_cleanup(self):
+        """Do what is most often done: deploy & cleanup"""
+        start_time = time.time()
 
         # Old Code
-        # self.stage_prepare()
-        # self.stage_run()
+        #self.deploy_to()
 
         # New Code
         self.run()
 
-    def deploy_and_cleanup(self):
-        """Do what is most often done: deploy & cleanup"""
-        start_time = time.time()
-        self.deploy_to()
         self.cleanup()
         self.log.info("Finished successful run in %s seconds",
             time.time() - start_time)
@@ -151,10 +147,48 @@ class ConfigInstall(object):
             raise cdist.Error("The requirements of the following objects could not be resolved: %s" %
                 ("; ".join(info_string)))
 
+    ###################################################################### 
+    # Code required by both methods (which will stay)
+    #
+
+    def object_run(self, cdist_object, dry_run=False):
+        """Run gencode and code for an object"""
+        self.log.debug("Trying to run object " + cdist_object.name)
+        if cdist_object.state == core.CdistObject.STATE_DONE:
+            raise cdist.Error("Attempting to run an already finished object: %s", cdist_object)
+
+        cdist_type = cdist_object.cdist_type
+
+        # Generate
+        self.log.info("Generating and executing code for " + cdist_object.name)
+        cdist_object.code_local = self.code.run_gencode_local(cdist_object)
+        cdist_object.code_remote = self.code.run_gencode_remote(cdist_object)
+        if cdist_object.code_local or cdist_object.code_remote:
+            cdist_object.changed = True
+
+        # Execute
+        if not dry_run:
+            if cdist_object.code_local:
+                self.code.run_code_local(cdist_object)
+            if cdist_object.code_remote:
+                self.code.transfer_code_remote(cdist_object)
+                self.code.run_code_remote(cdist_object)
+
+        # Mark this object as done
+        self.log.debug("Finishing run of " + cdist_object.name)
+        cdist_object.state = core.CdistObject.STATE_DONE
+
+
     ###################################################################### 
     # Stages based code
     #
 
+    def deploy_to(self):
+        """Mimic the old deploy to: Deploy to one host"""
+        self.stage_prepare()
+        self.stage_run()
+
+
     def stage_prepare(self):
         """Do everything for a deploy, minus the actual code stage"""
         self.explorer.run_global_explorers(self.context.local.global_explorer_out_path)
@@ -183,33 +217,6 @@ class ConfigInstall(object):
         self.manifest.run_type_manifest(cdist_object)
         cdist_object.state = core.CdistObject.STATE_PREPARED
 
-    def object_run(self, cdist_object, dry_run=False):
-        """Run gencode and code for an object"""
-        self.log.debug("Trying to run object " + cdist_object.name)
-        if cdist_object.state == core.CdistObject.STATE_DONE:
-            raise cdist.Error("Attempting to run an already finished object: %s", cdist_object)
-
-        cdist_type = cdist_object.cdist_type
-
-        # Generate
-        self.log.info("Generating and executing code for " + cdist_object.name)
-        cdist_object.code_local = self.code.run_gencode_local(cdist_object)
-        cdist_object.code_remote = self.code.run_gencode_remote(cdist_object)
-        if cdist_object.code_local or cdist_object.code_remote:
-            cdist_object.changed = True
-
-        # Execute
-        if not dry_run:
-            if cdist_object.code_local:
-                self.code.run_code_local(cdist_object)
-            if cdist_object.code_remote:
-                self.code.transfer_code_remote(cdist_object)
-                self.code.run_code_remote(cdist_object)
-
-        # Mark this object as done
-        self.log.debug("Finishing run of " + cdist_object.name)
-        cdist_object.state = core.CdistObject.STATE_DONE
-
     def stage_run(self):
         """The final (and real) step of deployment"""
         self.log.info("Generating and executing code")
diff --git a/cdist/resolver.py b/cdist/resolver.py
deleted file mode 100644
index ddcf382e..00000000
--- a/cdist/resolver.py
+++ /dev/null
@@ -1,175 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# 2011 Steven Armstrong (steven-cdist at armstrong.cc)
-#
-# This file is part of cdist.
-#
-# cdist is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# cdist is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with cdist. If not, see <http://www.gnu.org/licenses/>.
-#
-#
-
-import logging
-import os
-import itertools
-import fnmatch
-import pprint
-
-import cdist
-
-log = logging.getLogger(__name__)
-
-
-class CircularReferenceError(cdist.Error):
-    def __init__(self, cdist_object, required_object):
-        self.cdist_object = cdist_object
-        self.required_object = required_object
-
-    def __str__(self):
-        return 'Circular reference detected: %s -> %s' % (self.cdist_object.name, self.required_object.name)
-
-
-class RequirementNotFoundError(cdist.Error):
-    def __init__(self, requirement):
-        self.requirement = requirement
-
-    def __str__(self):
-        return 'Requirement could not be found: %s' % self.requirement
-
-
-class DependencyResolver(object):
-    """Cdist's dependency resolver.
-
-    Usage:
-    >> resolver = DependencyResolver(list_of_objects)
-    # Easy access to the objects we are working with
-    >> resolver.objects['__some_type/object_id']
-    <CdistObject __some_type/object_id>
-    # Easy access to a specific objects dependencies
-    >> resolver.dependencies['__some_type/object_id']
-    [<CdistObject __other_type/dependency>, <CdistObject __some_type/object_id>]
-    # Pretty print the dependency graph
-    >> from pprint import pprint
-    >> pprint(resolver.dependencies)
-    # Iterate over all existing objects in the correct order
-    >> for cdist_object in resolver:
-    >>     do_something_with(cdist_object)
-    """
-    def __init__(self, objects, logger=None):
-        self.objects = dict((o.name, o) for o in objects)
-        self._dependencies = None
-        self.log = logger or log
-
-    @property
-    def dependencies(self):
-        """Build the dependency graph.
-
-        Returns a dict where the keys are the object names and the values are
-        lists of all dependencies including the key object itself.
-        """
-        if self._dependencies is None:
-            self.log.info("Resolving dependencies...")
-            self._dependencies = {}
-            self._preprocess_requirements()
-            for name,cdist_object in self.objects.items():
-                resolved = []
-                unresolved = []
-                self._resolve_object_dependencies(cdist_object, resolved, unresolved)
-                self._dependencies[name] = resolved
-            self.log.debug(self._dependencies)
-        return self._dependencies
-
-    def find_requirements_by_name(self, requirements):
-        """Takes a list of requirement patterns and returns a list of matching object instances.
-
-        Patterns are expected to be Unix shell-style wildcards for use with fnmatch.filter.
-
-        find_requirements_by_name(['__type/object_id', '__other_type/*']) -> 
-            [<Object __type/object_id>, <Object __other_type/any>, <Object __other_type/match>]
-        """
-        object_names = self.objects.keys()
-        for pattern in requirements:
-            found = False
-            for requirement in fnmatch.filter(object_names, pattern):
-                found = True
-                yield self.objects[requirement]
-            if not found:
-                # FIXME: get rid of the singleton object_id, it should be invisible to the code -> hide it in Object
-                singleton = os.path.join(pattern, 'singleton')
-                if singleton in self.objects:
-                    yield self.objects[singleton]
-                else:
-                    raise RequirementNotFoundError(pattern)
-
-    def _preprocess_requirements(self):
-        """Find all autorequire dependencies and merge them to be just requirements
-        for further processing.
-        """
-        for cdist_object in self.objects.values():
-            if cdist_object.autorequire:
-                # The objects (children) that this cdist_object (parent) defined
-                # in it's type manifest shall inherit all explicit requirements 
-                # that the parent has so that user defined requirements are 
-                # fullfilled and processed in the expected order.
-                for auto_requirement in self.find_requirements_by_name(cdist_object.autorequire):
-                    for requirement in self.find_requirements_by_name(cdist_object.requirements):
-                        requirement_object_all_requirements = list(requirement.requirements) + list(requirement.autorequire)
-                        if (requirement.name not in auto_requirement.requirements
-                            and auto_requirement.name not in requirement_object_all_requirements):
-                            self.log.debug('Adding %s to %s.requirements', requirement.name, auto_requirement)
-                            auto_requirement.requirements.append(requirement.name)
-                # On the other hand the parent shall depend on all the children
-                # it created so that the user can setup dependencies on it as a 
-                # whole without having to know anything about the parents 
-                # internals.
-                cdist_object.requirements.extend(cdist_object.autorequire)
-                # As we changed the object on disc, we have to ensure it is not 
-                # preprocessed again if someone would call us multiple times.
-                cdist_object.autorequire = []
-
-    def _resolve_object_dependencies(self, cdist_object, resolved, unresolved):
-        """Resolve all dependencies for the given cdist_object and store them
-        in the list which is passed as the 'resolved' arguments.
-
-        e.g.
-        resolved = []
-        unresolved = []
-        resolve_object_dependencies(some_object, resolved, unresolved)
-        print("Dependencies for %s: %s" % (some_object, resolved))
-        """
-        self.log.debug('Resolving dependencies for: %s' % cdist_object.name)
-        try:
-            unresolved.append(cdist_object)
-            for required_object in self.find_requirements_by_name(cdist_object.requirements):
-                self.log.debug("Object %s requires %s", cdist_object, required_object)
-                if required_object not in resolved:
-                    if required_object in unresolved:
-                        error = CircularReferenceError(cdist_object, required_object)
-                        self.log.error('%s: %s', error, pprint.pformat(self._dependencies))
-                        raise error
-                    self._resolve_object_dependencies(required_object, resolved, unresolved)
-            resolved.append(cdist_object)
-            unresolved.remove(cdist_object)
-        except RequirementNotFoundError as e:
-            raise cdist.CdistObjectError(cdist_object, "requires non-existing " + e.requirement)
-
-    def __iter__(self):
-        """Iterate over all unique objects and yield them in the correct order.
-        """
-        iterable = itertools.chain(*self.dependencies.values())
-        # Keep record of objects that have already been seen
-        seen = set()
-        seen_add = seen.add
-        for cdist_object in itertools.filterfalse(seen.__contains__, iterable):
-            seen_add(cdist_object)
-            yield cdist_object