Merge branch '1.4.x'

Conflicts:
	debian/bcfg2-server.install
	doc/server/plugins/grouping/metadata.txt
	src/lib/Bcfg2/Client/Client.py
	src/lib/Bcfg2/Client/Tools/Portage.py
	src/lib/Bcfg2/Client/Tools/RcUpdate.py
	src/lib/Bcfg2/Client/Tools/YUM24.py
	src/lib/Bcfg2/Client/Tools/__init__.py
	src/lib/Bcfg2/Client/Tools/launchd.py
	src/lib/Bcfg2/Options.py
	src/lib/Bcfg2/Server/Core.py
	src/lib/Bcfg2/Server/Plugin/helpers.py
	src/lib/Bcfg2/Server/Plugins/Metadata.py
	src/lib/Bcfg2/Server/models.py
	src/lib/Bcfg2/Utils.py
	src/sbin/bcfg2-info
	src/sbin/bcfg2-test
	testsuite/Testsrc/Testlib/TestClient/TestTools/Test_init.py
	testsuite/Testsrc/test_code_checks.py

2 files changed, 39 insertions, 111 deletions

diff --git a/src/lib/Bcfg2/Server/FileMonitor/Fam.py b/src/lib/Bcfg2/Server/FileMonitor/Fam.py
deleted file mode 100644
index 253bb2801..000000000
--- a/src/lib/Bcfg2/Server/FileMonitor/Fam.py
+++ /dev/null
@@ -1,105 +0,0 @@
-""" File monitor backend with support for the `File Alteration Monitor
-<http://oss.sgi.com/projects/fam/>`_.  The FAM backend is deprecated. """
-
-import os
-import _fam
-import stat
-import logging
-from time import time
-from Bcfg2.Server.FileMonitor import FileMonitor
-
-LOGGER = logging.getLogger(__name__)
-
-
-class Fam(FileMonitor):
-    """ **Deprecated** file monitor backend with support for the `File
-    Alteration Monitor <http://oss.sgi.com/projects/fam/>`_ (also
-    abbreviated "FAM")."""
-
-    #: FAM is the worst actual monitor backend, so give it a low
-    #: priority.
-    __priority__ = 10
-
-    def __init__(self, ignore=None, debug=False):
-        FileMonitor.__init__(self, ignore=ignore, debug=debug)
-        self.filemonitor = _fam.open()
-        self.users = {}
-        LOGGER.warning("The Fam file monitor backend is deprecated. Please "
-                       "switch to a supported file monitor.")
-    __init__.__doc__ = FileMonitor.__init__.__doc__
-
-    def fileno(self):
-        return self.filemonitor.fileno()
-    fileno.__doc__ = FileMonitor.fileno.__doc__
-
-    def handle_event_set(self, _=None):
-        self.Service()
-    handle_event_set.__doc__ = FileMonitor.handle_event_set.__doc__
-
-    def handle_events_in_interval(self, interval):
-        now = time()
-        while (time() - now) < interval:
-            if self.Service():
-                now = time()
-    handle_events_in_interval.__doc__ = \
-        FileMonitor.handle_events_in_interval.__doc__
-
-    def AddMonitor(self, path, obj, _=None):
-        mode = os.stat(path)[stat.ST_MODE]
-        if stat.S_ISDIR(mode):
-            handle = self.filemonitor.monitorDirectory(path, None)
-        else:
-            handle = self.filemonitor.monitorFile(path, None)
-        self.handles[handle.requestID()] = handle
-        if obj != None:
-            self.users[handle.requestID()] = obj
-        return handle.requestID()
-    AddMonitor.__doc__ = FileMonitor.AddMonitor.__doc__
-
-    def Service(self, interval=0.50):
-        """ Handle events for the specified period of time (in
-        seconds).  This call will block for ``interval`` seconds.
-
-        :param interval: The interval, in seconds, during which events
-                         should be handled.  Any events that are
-                         already pending when :func:`Service` is
-                         called will also be handled.
-        :type interval: int
-        :returns: None
-        """
-        count = 0
-        collapsed = 0
-        rawevents = []
-        start = time()
-        now = time()
-        while (time() - now) < interval:
-            if self.filemonitor.pending():
-                while self.filemonitor.pending():
-                    count += 1
-                    rawevents.append(self.filemonitor.nextEvent())
-                now = time()
-        unique = []
-        bookkeeping = []
-        for event in rawevents:
-            if self.should_ignore(event):
-                continue
-            if event.code2str() != 'changed':
-                # process all non-change events
-                unique.append(event)
-            else:
-                if (event.filename, event.requestID) not in bookkeeping:
-                    bookkeeping.append((event.filename, event.requestID))
-                    unique.append(event)
-                else:
-                    collapsed += 1
-        for event in unique:
-            if event.requestID in self.users:
-                try:
-                    self.users[event.requestID].HandleEvent(event)
-                except:  # pylint: disable=W0702
-                    LOGGER.error("Handling event for file %s" % event.filename,
-                                 exc_info=1)
-        end = time()
-        LOGGER.info("Processed %s fam events in %03.03f seconds. "
-                    "%s coalesced" % (count, (end - start), collapsed))
-        return count
diff --git a/src/lib/Bcfg2/Server/FileMonitor/__init__.py b/src/lib/Bcfg2/Server/FileMonitor/__init__.py
index e430e3160..522ddb705 100644
--- a/src/lib/Bcfg2/Server/FileMonitor/__init__.py
+++ b/src/lib/Bcfg2/Server/FileMonitor/__init__.py
@@ -325,6 +325,45 @@ class FileMonitor(Debuggable):
         return rv
 
 
+#: A module-level FAM object that all plugins, etc., can use.  This
+#: should not be used directly, but retrieved via :func:`get_fam`.
+_FAM = None
+
+
+def load_fam(filemonitor='default', ignore=None, debug=False):
+    """ Load a new :class:`Bcfg2.Server.FileMonitor.FileMonitor`
+    object, caching it in :attr:`_FAM` for later retrieval via
+    :func:`get_fam`.
+
+    :param filemonitor: Which filemonitor backend to use
+    :type filemonitor: string
+    :param ignore: A list of filenames to ignore
+    :type ignore: list of strings (filename globs)
+    :param debug: Produce debugging information
+    :type debug: bool
+    :returns: :class:`Bcfg2.Server.FileMonitor.FileMonitor`
+    """
+    global _FAM  # pylint: disable=W0603
+    if _FAM is None:
+        if ignore is None:
+            ignore = []
+        _FAM = available[filemonitor](ignore=ignore, debug=debug)
+    return _FAM
+
+
+def get_fam():
+    """ Get an already-created
+    :class:`Bcfg2.Server.FileMonitor.FileMonitor` object.  If
+    :attr:`_FAM` has not been populated, then a new default
+    FileMonitor will be created.
+
+    :returns: :class:`Bcfg2.Server.FileMonitor.FileMonitor`
+    """
+    if _FAM is None:
+        return load_fam('default')
+    return _FAM
+
+
 #: A dict of all available FAM backends.  Keys are the human-readable
 #: names of the backends, which are used in bcfg2.conf to select a
 #: backend; values are the backend classes.  In addition, the
@@ -337,12 +376,6 @@ from Bcfg2.Server.FileMonitor.Pseudo import Pseudo
 available['pseudo'] = Pseudo
 
 try:
-    from Bcfg2.Server.FileMonitor.Fam import Fam
-    available['fam'] = Fam
-except ImportError:
-    pass
-
-try:
     from Bcfg2.Server.FileMonitor.Gamin import Gamin
     available['gamin'] = Gamin
 except ImportError: