Add Version plugin type

The following changes were made:
 * Remove VCS logic out of the Core
 * Add Git/Svn plugins
 * Remove config file directive in bcfg2.conf

Use of the plugins are enabled by adding Git or Svn (or both)
to the plugins line of bcfg2.conf

Signed-off-by: Sol Jerome <solj@ices.utexas.edu>


git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@5044 ce84e21b-d406-0410-9b95-82705330c041

6 files changed, 104 insertions, 47 deletions

diff --git a/src/lib/Server/Admin/Minestruct.py b/src/lib/Server/Admin/Minestruct.py
index 350833080..743641bc6 100644
--- a/src/lib/Server/Admin/Minestruct.py
+++ b/src/lib/Server/Admin/Minestruct.py
@@ -51,7 +51,6 @@ class Minestruct(Bcfg2.Server.Admin.StructureMode):
             for source in self.bcore.pull_sources:
                 for item in source.GetExtra(client):
                     extra.add(item)
-            print extra
         except:
             self.log.error("Failed to find extra entry info for client %s" %
                             client)
diff --git a/src/lib/Server/Core.py b/src/lib/Server/Core.py
index b7a187c57..ad5573201 100644
--- a/src/lib/Server/Core.py
+++ b/src/lib/Server/Core.py
@@ -1,10 +1,6 @@
 '''Bcfg2.Server.Core provides the runtime support for bcfg2 modules'''
 __revision__ = '$Revision$'
 
-from ConfigParser import ConfigParser, NoSectionError, NoOptionError
-c = ConfigParser()
-c.read('/etc/bcfg2.conf')
-
 from time import time
 
 from Bcfg2.Server.Plugin import PluginInitError, PluginExecutionError
@@ -28,7 +24,7 @@ class CoreInitError(Exception):
 class Core(object):
     '''The Core object is the container for all Bcfg2 Server logic, and modules'''
 
-    def __init__(self, repo, plugins, password, vcs, encoding,
+    def __init__(self, repo, plugins, password, encoding,
                  filemonitor='default'):
         object.__init__(self)
         self.datastore = repo
@@ -46,14 +42,6 @@ class Core(object):
         self.revision = '-1'
         self.password = password
         self.encoding = encoding
-        try:
-            self.vcs = c.get('server', 'vcs')
-            if self.vcs == 'svn':
-                self.read_svn_revision()
-            elif self.vcs == 'git':
-                self.read_git_revision()
-        except:
-            self.vcs = 'none'
 
         if '' in plugins:
             plugins.remove('')
@@ -224,37 +212,11 @@ class Core(object):
         '''Perform periodic update tasks'''
         count = self.fam.Service()
         if count:
-            if self.vcs == 'svn':
-                self.read_svn_revision()
-            elif self.vcs == 'git':
-                self.read_git_revision()
-
-    def read_git_revision(self):
-        try:
-            data = os.popen("env LC_ALL=C git ls-remote %s" %
-                            (self.datastore)).readlines()
-            revline = [line.split('\t')[0].strip() for line in data if \
-                       line.split('\t')[1].strip() == 'refs/heads/master'][-1]
-            self.revision = revline
-        except IndexError:
-            logger.error("Failed to read git ls-remote; disabling git support")
-            logger.error('''Ran command "git ls-remote %s"''' % (self.datastore))
-            logger.error("Got output: %s" % data)
-            self.vcs = 'none'
-            
-    def read_svn_revision(self):
-        '''Read svn revision information for the bcfg2 repository'''
-        try:
-            data = os.popen("env LC_ALL=C svn info %s" \
-                            % (self.datastore)).readlines()
-            revline = [line.split(': ')[1].strip() for line in data \
-                       if line[:9] == 'Revision:'][-1]
-            self.revision = revline
-        except IndexError:
-            logger.error("Failed to read svn info; disabling svn support")
-            logger.error('''Ran command "svn info %s"''' % (self.datastore))
-            logger.error("Got output: %s" % data)
-            self.vcs = 'none'
+            for plugin in self.plugins.values():
+                if isinstance(plugin, Bcfg2.Server.Plugin.Version):
+                    self.revision = plugin.get_revision()
+                else:
+                    self.revision = -1
 
     def GetDecisions(self, metadata, mode):
         result = []
diff --git a/src/lib/Server/Plugin.py b/src/lib/Server/Plugin.py
index 8d702d435..21699657f 100644
--- a/src/lib/Server/Plugin.py
+++ b/src/lib/Server/Plugin.py
@@ -137,6 +137,13 @@ class GoalValidator(object):
     def validate_goals(self, metadata, goals):
         raise ValidationError, "not implemented"
 
+class Version(object):
+    '''Interact with various version control systems'''
+    def get_revision(self):
+        return []
+    def commit_data(self):
+        pass
+
 # the rest of the file contains classes for coherent file caching
 
 class FileBacked(object):
diff --git a/src/lib/Server/Plugins/Git.py b/src/lib/Server/Plugins/Git.py
new file mode 100644
index 000000000..1c17c8e47
--- /dev/null
+++ b/src/lib/Server/Plugins/Git.py
@@ -0,0 +1,45 @@
+import os
+import Bcfg2.Server.Plugin
+
+# for debugging output only
+import logging
+logger = logging.getLogger('Bcfg2.Plugins.Git')
+
+class Git(Bcfg2.Server.Plugin.Plugin,
+          Bcfg2.Server.Plugin.Version):
+    name = 'Git'
+    __version__ = '$Id$'
+    __author__ = 'bcfg-dev@mcs.anl.gov'
+
+    def __init__(self, core, datastore):
+        Bcfg2.Server.Plugin.Plugin.__init__(self, core, datastore)
+        self.core = core
+        self.datastore = datastore
+
+        # path to git directory for bcfg2 repo
+        git_dir = "%s/.git" % datastore
+
+        # Read revision from bcfg2 repo
+        if os.path.isdir(git_dir):
+            self.get_revision()
+        else:
+            logger.error("%s is not a directory" % git_dir)
+            raise Bcfg2.Server.Plugin.PluginInitError
+
+        logger.debug("Initialized git plugin with git directory = %s" % git_dir)
+
+    def get_revision(self):
+        '''Read git revision information for the bcfg2 repository'''
+        try:
+            data = os.popen("env LC_ALL=C git ls-remote %s" %
+                            (self.datastore)).readlines()
+            revline = [line.split('\t')[0].strip() for line in data if \
+                       line.split('\t')[1].strip() == 'refs/heads/master'][-1]
+            revision = revline
+        except IndexError:
+            logger.error("Failed to read git ls-remote; disabling git support")
+            logger.error('''Ran command "git ls-remote %s"''' % \
+                            (self.datastore))
+            logger.error("Got output: %s" % data)
+            raise Bcfg2.Server.Plugin.PluginInitError
+        return revision
diff --git a/src/lib/Server/Plugins/Svn.py b/src/lib/Server/Plugins/Svn.py
new file mode 100644
index 000000000..269c3173b
--- /dev/null
+++ b/src/lib/Server/Plugins/Svn.py
@@ -0,0 +1,44 @@
+import os
+import Bcfg2.Server.Plugin
+
+# for debugging output only
+import logging
+logger = logging.getLogger('Bcfg2.Plugins.Svn')
+
+class Svn(Bcfg2.Server.Plugin.Plugin,
+          Bcfg2.Server.Plugin.Version):
+    name = 'Svn'
+    __version__ = '$Id$'
+    __author__ = 'bcfg-dev@mcs.anl.gov'
+
+    def __init__(self, core, datastore):
+        Bcfg2.Server.Plugin.Plugin.__init__(self, core, datastore)
+        self.core = core
+        self.datastore = datastore
+
+        # path to svn directory for bcfg2 repo
+        svn_dir = "%s/.svn" % datastore
+
+        # Read revision from bcfg2 repo
+        if os.path.isdir(svn_dir):
+            self.get_revision()
+        else:
+            logger.error("%s is not a directory" % svn_dir)
+            raise Bcfg2.Server.Plugin.PluginInitError
+
+        logger.debug("Initialized svn plugin with svn directory = %s" % svn_dir)
+
+    def get_revision(self):
+        '''Read svn revision information for the bcfg2 repository'''
+        try:
+            data = os.popen("env LC_ALL=C svn info %s" \
+                            % (self.datastore)).readlines()
+            revline = [line.split(': ')[1].strip() for line in data \
+                       if line[:9] == 'Revision:'][-1]
+            revision = revline
+        except IndexError:
+            logger.error("Failed to read svn info; disabling svn support")
+            logger.error('''Ran command "svn info %s"''' % (self.datastore))
+            logger.error("Got output: %s" % data)
+            raise Bcfg2.Server.Plugin.PluginInitError
+        return revision
diff --git a/src/lib/Server/Plugins/__init__.py b/src/lib/Server/Plugins/__init__.py
index 1e5c122c8..6382adbaf 100644
--- a/src/lib/Server/Plugins/__init__.py
+++ b/src/lib/Server/Plugins/__init__.py
@@ -1,7 +1,7 @@
 '''imports for Bcfg2.Server.Plugins'''
 __revision__ = '$Revision$'
 
-__all__ = ['Account', 'Base', 'Bundler', 'Cfg', 'Decisions', 'GBundler',
+__all__ = ['Account', 'Base', 'Bundler', 'Cfg', 'Decisions', 'GBundler', 'Git',
            'Hostbase', 'Metadata', 'NagiosGen', 'Packages', 'Properties',
            'Probes', 'Pkgmgr', 'Rules', 'SSHbase', 'Statistics', 'Svcmgr',
-           'TCheetah', 'SGenshi', 'TGenshi', 'Vhost']
+           'Svn', 'TCheetah', 'SGenshi', 'TGenshi', 'Vhost']