added module-level OptionParser to avoid passing it as an argument or global all over

9 files changed, 57 insertions, 88 deletions

diff --git a/src/lib/Bcfg2/Server/Plugins/Bundler.py b/src/lib/Bcfg2/Server/Plugins/Bundler.py
index b200346bc..6dc3c2b1d 100644
--- a/src/lib/Bcfg2/Server/Plugins/Bundler.py
+++ b/src/lib/Bcfg2/Server/Plugins/Bundler.py
@@ -1,15 +1,15 @@
 """This provides bundle clauses with translation functionality."""
 
-import copy
-import logging
-import lxml.etree
 import os
-import os.path
 import re
 import sys
+import copy
+import logging
+import lxml.etree
 import Bcfg2.Server
 import Bcfg2.Server.Plugin
 import Bcfg2.Server.Lint
+from Bcfg2.Options import get_option_parser
 
 try:
     import genshi.template.base
@@ -19,9 +19,6 @@ except ImportError:
     HAS_GENSHI = False
 
 
-SETUP = None
-
-
 class BundleFile(Bcfg2.Server.Plugin.StructFile):
     """ Representation of a bundle XML file """
     def get_xml_value(self, metadata):
@@ -52,8 +49,9 @@ if HAS_GENSHI:
                 msg = "No parsed template information for %s" % self.name
                 self.logger.error(msg)
                 raise Bcfg2.Server.Plugin.PluginExecutionError(msg)
-            stream = self.template.generate(metadata=metadata,
-                                            repo=SETUP['repo']).filter(
+            stream = self.template.generate(
+                metadata=metadata,
+                repo=get_option_parser()['repo']).filter(
                 Bcfg2.Server.Plugins.TGenshi.removecomment)
             data = lxml.etree.XML(stream.render('xml',
                                                 strip_whitespace=False),
@@ -102,9 +100,6 @@ class Bundler(Bcfg2.Server.Plugin.Plugin,
             self.logger.error(msg)
             raise Bcfg2.Server.Plugin.PluginInitError(msg)
 
-        global SETUP
-        SETUP = core.setup
-
     def template_dispatch(self, name, _):
         """ Add the correct child entry type to Bundler depending on
         whether the XML file in question is a plain XML file or a
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgAuthorizedKeysGenerator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgAuthorizedKeysGenerator.py
index 824d01023..11c60ad2c 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgAuthorizedKeysGenerator.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgAuthorizedKeysGenerator.py
@@ -4,7 +4,7 @@ access. """
 
 import lxml.etree
 from Bcfg2.Server.Plugin import StructFile, PluginExecutionError
-from Bcfg2.Server.Plugins.Cfg import CfgGenerator, SETUP, CFG
+from Bcfg2.Server.Plugins.Cfg import CfgGenerator, CFG
 from Bcfg2.Server.Plugins.Metadata import ClientMetadata
 
 
@@ -35,9 +35,9 @@ class CfgAuthorizedKeysGenerator(CfgGenerator, StructFile):
     def category(self):
         """ The name of the metadata category that generated keys are
         specific to """
-        if (SETUP.cfp.has_section("sshkeys") and
-            SETUP.cfp.has_option("sshkeys", "category")):
-            return SETUP.cfp.get("sshkeys", "category")
+        if (self.setup.cfp.has_section("sshkeys") and
+            self.setup.cfp.has_option("sshkeys", "category")):
+            return self.setup.cfp.get("sshkeys", "category")
         return None
 
     def handle_event(self, event):
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgCheetahGenerator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgCheetahGenerator.py
index 724164cf5..4c8adceec 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgCheetahGenerator.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgCheetahGenerator.py
@@ -3,7 +3,7 @@
 :ref:`server-plugins-generators-cfg` files. """
 
 from Bcfg2.Server.Plugin import PluginExecutionError
-from Bcfg2.Server.Plugins.Cfg import CfgGenerator, SETUP
+from Bcfg2.Server.Plugins.Cfg import CfgGenerator
 
 try:
     from Cheetah.Template import Template
@@ -40,6 +40,6 @@ class CfgCheetahGenerator(CfgGenerator):
         template.name = entry.get('realname', entry.get('name'))
         template.path = entry.get('realname', entry.get('name'))
         template.source_path = self.name
-        template.repo = SETUP['repo']
+        template.repo = self.setup['repo']
         return template.respond()
     get_data.__doc__ = CfgGenerator.get_data.__doc__
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenerator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenerator.py
index 3b4703ddb..3b3b95ff5 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenerator.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenerator.py
@@ -2,10 +2,9 @@
 :ref:`server-plugins-generators-cfg` files on the server. """
 
 from Bcfg2.Server.Plugin import PluginExecutionError
-from Bcfg2.Server.Plugins.Cfg import CfgGenerator, SETUP
+from Bcfg2.Server.Plugins.Cfg import CfgGenerator
 try:
-    from Bcfg2.Encryption import bruteforce_decrypt, EVPError, \
-        get_algorithm
+    from Bcfg2.Encryption import bruteforce_decrypt, EVPError
     HAS_CRYPTO = True
 except ImportError:
     HAS_CRYPTO = False
@@ -34,8 +33,7 @@ class CfgEncryptedGenerator(CfgGenerator):
             return
         # todo: let the user specify a passphrase by name
         try:
-            self.data = bruteforce_decrypt(self.data, setup=SETUP,
-                                           algorithm=get_algorithm(SETUP))
+            self.data = bruteforce_decrypt(self.data)
         except EVPError:
             raise PluginExecutionError("Failed to decrypt %s" % self.name)
     handle_event.__doc__ = CfgGenerator.handle_event.__doc__
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenshiGenerator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenshiGenerator.py
index 130652aef..215e4c1f1 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenshiGenerator.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgEncryptedGenshiGenerator.py
@@ -3,11 +3,10 @@ files) """
 
 from Bcfg2.Compat import StringIO
 from Bcfg2.Server.Plugin import PluginExecutionError
-from Bcfg2.Server.Plugins.Cfg import SETUP
 from Bcfg2.Server.Plugins.Cfg.CfgGenshiGenerator import CfgGenshiGenerator
 
 try:
-    from Bcfg2.Encryption import bruteforce_decrypt, get_algorithm
+    from Bcfg2.Encryption import bruteforce_decrypt
     HAS_CRYPTO = True
 except ImportError:
     HAS_CRYPTO = False
@@ -24,9 +23,7 @@ class EncryptedTemplateLoader(TemplateLoader):
     the data on the fly as it's read in using
     :func:`Bcfg2.Encryption.bruteforce_decrypt` """
     def _instantiate(self, cls, fileobj, filepath, filename, encoding=None):
-        plaintext = \
-            StringIO(bruteforce_decrypt(fileobj.read(),
-                                        algorithm=get_algorithm(SETUP)))
+        plaintext = StringIO(bruteforce_decrypt(fileobj.read()))
         return TemplateLoader._instantiate(self, cls, plaintext, filepath,
                                            filename, encoding=encoding)
 
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgGenshiGenerator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgGenshiGenerator.py
index 73550cd9d..b58349fe0 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgGenshiGenerator.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgGenshiGenerator.py
@@ -6,7 +6,7 @@ import re
 import sys
 import traceback
 from Bcfg2.Server.Plugin import PluginExecutionError
-from Bcfg2.Server.Plugins.Cfg import CfgGenerator, SETUP
+from Bcfg2.Server.Plugins.Cfg import CfgGenerator
 
 try:
     import genshi.core
@@ -102,12 +102,12 @@ class CfgGenshiGenerator(CfgGenerator):
 
     def get_data(self, entry, metadata):
         fname = entry.get('realname', entry.get('name'))
-        stream = \
-            self.template.generate(name=fname,
-                                   metadata=metadata,
-                                   path=self.name,
-                                   source_path=self.name,
-                                   repo=SETUP['repo']).filter(removecomment)
+        stream = self.template.generate(
+            name=fname,
+            metadata=metadata,
+            path=self.name,
+            source_path=self.name,
+            repo=self.setup['repo']).filter(removecomment)
         try:
             try:
                 return stream.render('text', encoding=self.encoding,
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgPrivateKeyCreator.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgPrivateKeyCreator.py
index aaeb65cd6..54fa75b41 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgPrivateKeyCreator.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgPrivateKeyCreator.py
@@ -4,8 +4,9 @@ import os
 import shutil
 import tempfile
 import subprocess
+from Bcfg2.Options import get_option_parser
 from Bcfg2.Server.Plugin import PluginExecutionError, StructFile
-from Bcfg2.Server.Plugins.Cfg import CfgCreator, CfgCreationError, SETUP
+from Bcfg2.Server.Plugins.Cfg import CfgCreator, CfgCreationError
 from Bcfg2.Server.Plugins.Cfg.CfgPublicKeyCreator import CfgPublicKeyCreator
 try:
     import Bcfg2.Encryption
@@ -31,24 +32,25 @@ class CfgPrivateKeyCreator(CfgCreator, StructFile):
         pubkey_path = os.path.dirname(self.name) + ".pub"
         pubkey_name = os.path.join(pubkey_path, os.path.basename(pubkey_path))
         self.pubkey_creator = CfgPublicKeyCreator(pubkey_name)
+        self.setup = get_option_parser()
     __init__.__doc__ = CfgCreator.__init__.__doc__
 
     @property
     def category(self):
         """ The name of the metadata category that generated keys are
         specific to """
-        if (SETUP.cfp.has_section("sshkeys") and
-            SETUP.cfp.has_option("sshkeys", "category")):
-            return SETUP.cfp.get("sshkeys", "category")
+        if (self.setup.cfp.has_section("sshkeys") and
+            self.setup.cfp.has_option("sshkeys", "category")):
+            return self.setup.cfp.get("sshkeys", "category")
         return None
 
     @property
     def passphrase(self):
         """ The passphrase used to encrypt private keys """
         if (HAS_CRYPTO and
-            SETUP.cfp.has_section("sshkeys") and
-            SETUP.cfp.has_option("sshkeys", "passphrase")):
-            return Bcfg2.Encryption.get_passphrases(SETUP)[SETUP.cfp.get(
+            self.setup.cfp.has_section("sshkeys") and
+            self.setup.cfp.has_option("sshkeys", "passphrase")):
+            return Bcfg2.Encryption.get_passphrases()[self.setup.cfp.get(
                     "sshkeys",
                     "passphrase")]
         return None
@@ -196,10 +198,8 @@ class CfgPrivateKeyCreator(CfgCreator, StructFile):
             privkey = open(filename).read()
             if HAS_CRYPTO and self.passphrase:
                 self.debug_log("Cfg: Encrypting key data at %s" % filename)
-                privkey = Bcfg2.Encryption.ssl_encrypt(
-                    privkey,
-                    self.passphrase,
-                    algorithm=Bcfg2.Encryption.get_algorithm(SETUP))
+                privkey = Bcfg2.Encryption.ssl_encrypt(privkey,
+                                                       self.passphrase)
                 specificity['ext'] = '.crypt'
 
             self.write_data(privkey, **specificity)
@@ -239,22 +239,16 @@ class CfgPrivateKeyCreator(CfgCreator, StructFile):
         """ Decrypt a single encrypted element """
         if not element.text or not element.text.strip():
             return
-        passes = Bcfg2.Encryption.get_passphrases(SETUP)
+        passes = Bcfg2.Encryption.get_passphrases()
         try:
             passphrase = passes[element.get("encrypted")]
             try:
-                return Bcfg2.Encryption.ssl_decrypt(
-                    element.text,
-                    passphrase,
-                    algorithm=Bcfg2.Encryption.get_algorithm(SETUP))
+                return Bcfg2.Encryption.ssl_decrypt(element.text, passphrase)
             except Bcfg2.Encryption.EVPError:
                 # error is raised below
                 pass
         except KeyError:
             # bruteforce_decrypt raises an EVPError with a sensible
             # error message, so we just let it propagate up the stack
-            return Bcfg2.Encryption.bruteforce_decrypt(
-                element.text,
-                passphrases=passes.values(),
-                algorithm=Bcfg2.Encryption.get_algorithm(SETUP))
+            return Bcfg2.Encryption.bruteforce_decrypt(element.text)
         raise Bcfg2.Encryption.EVPError("Failed to decrypt")
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py b/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py
index fcfaa393b..53cc90094 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/__init__.py
@@ -16,17 +16,6 @@ from Bcfg2.Compat import u_str, unicode, b64encode, walk_packages, \
     any, oct_mode
 # pylint: enable=W0622
 
-#: SETUP contains a reference to the
-#: :class:`Bcfg2.Options.OptionParser` created by the Bcfg2 core for
-#: parsing command-line and config file options.
-#: :class:`Bcfg2.Server.Plugins.Cfg.Cfg` stores it in a module global
-#: so that the handler objects can access it, because there is no other
-#: facility for passing a setup object from a
-#: :class:`Bcfg2.Server.Plugin.helpers.GroupSpool` to its
-#: :class:`Bcfg2.Server.Plugin.helpers.EntrySet` objects and thence to
-#: the EntrySet children.
-SETUP = None
-
 #: CFG is a reference to the :class:`Bcfg2.Server.Plugins.Cfg.Cfg`
 #: plugin object created by the Bcfg2 core.  This is provided so that
 #: the handler objects can access it as necessary, since the existing
@@ -86,6 +75,7 @@ class CfgBaseFileMatcher(Bcfg2.Server.Plugin.SpecificData,
                                                   encoding)
         Bcfg2.Server.Plugin.Debuggable.__init__(self)
         self.encoding = encoding
+        self.setup = Bcfg2.Options.get_option_parser()
     __init__.__doc__ = Bcfg2.Server.Plugin.SpecificData.__init__.__doc__ + \
 """
 .. -----
@@ -442,11 +432,11 @@ class CfgDefaultInfo(CfgInfo):
     bind_info_to_entry.__doc__ = CfgInfo.bind_info_to_entry.__doc__
 
 #: A :class:`CfgDefaultInfo` object instantiated with
-#: :attr:`Bcfg2.Server.Plugin.helper.DEFAULT_FILE_METADATA` as its
+#: :func:`Bcfg2.Server.Plugin.helper.default_path_metadata` as its
 #: default metadata.  This is used to set a default file metadata set
 #: on an entry before a "real" :class:`CfgInfo` handler applies its
 #: metadata to the entry.
-DEFAULT_INFO = CfgDefaultInfo(Bcfg2.Server.Plugin.DEFAULT_FILE_METADATA)
+DEFAULT_INFO = CfgDefaultInfo(Bcfg2.Server.Plugin.default_path_metadata())
 
 
 class CfgEntrySet(Bcfg2.Server.Plugin.EntrySet,
@@ -460,6 +450,7 @@ class CfgEntrySet(Bcfg2.Server.Plugin.EntrySet,
         Bcfg2.Server.Plugin.Debuggable.__init__(self)
         self.specific = None
         self._handlers = None
+        self.setup = Bcfg2.Options.get_option_parser()
     __init__.__doc__ = Bcfg2.Server.Plugin.EntrySet.__doc__
 
     def set_debug(self, debug):
@@ -585,7 +576,7 @@ class CfgEntrySet(Bcfg2.Server.Plugin.EntrySet,
         for fltr in self.get_handlers(metadata, CfgFilter):
             data = fltr.modify_data(entry, metadata, data)
 
-        if SETUP['validate']:
+        if self.setup['validate']:
             try:
                 self._validate_data(entry, metadata, data)
             except CfgVerificationError:
@@ -833,16 +824,16 @@ class Cfg(Bcfg2.Server.Plugin.GroupSpool,
     es_child_cls = Bcfg2.Server.Plugin.SpecificData
 
     def __init__(self, core, datastore):
-        global SETUP, CFG  # pylint: disable=W0603
+        global CFG  # pylint: disable=W0603
         Bcfg2.Server.Plugin.GroupSpool.__init__(self, core, datastore)
         Bcfg2.Server.Plugin.PullTarget.__init__(self)
 
         CFG = self
 
-        SETUP = core.setup
-        if 'validate' not in SETUP:
-            SETUP.add_option('validate', Bcfg2.Options.CFG_VALIDATION)
-            SETUP.reparse()
+        setup = Bcfg2.Options.get_option_parser()
+        if 'validate' not in setup:
+            setup.add_option('validate', Bcfg2.Options.CFG_VALIDATION)
+            setup.reparse()
     __init__.__doc__ = Bcfg2.Server.Plugin.GroupSpool.__init__.__doc__
 
     def has_generator(self, entry, metadata):
diff --git a/src/lib/Bcfg2/Server/Plugins/Properties.py b/src/lib/Bcfg2/Server/Plugins/Properties.py
index a51dd8adc..c5b5ea2d1 100644
--- a/src/lib/Bcfg2/Server/Plugins/Properties.py
+++ b/src/lib/Bcfg2/Server/Plugins/Properties.py
@@ -7,6 +7,7 @@ import sys
 import copy
 import logging
 import lxml.etree
+from Bcfg2.Options import get_option_parser
 import Bcfg2.Server.Plugin
 from Bcfg2.Server.Plugin import PluginExecutionError
 try:
@@ -33,8 +34,6 @@ except ImportError:
 
 LOGGER = logging.getLogger(__name__)
 
-SETUP = None
-
 
 class PropertyFile(object):
     """ Base Properties file handler """
@@ -46,13 +45,14 @@ class PropertyFile(object):
         .. automethod:: _write
         """
         self.name = name
+        self.setup = get_option_parser()
 
     def write(self):
         """ Write the data in this data structure back to the property
         file. This public method performs checking to ensure that
         writing is possible and then calls :func:`_write`. """
-        if not SETUP.cfp.getboolean("properties", "writes_enabled",
-                                    default=True):
+        if not self.setup.cfp.getboolean("properties", "writes_enabled",
+                                         default=True):
             msg = "Properties files write-back is disabled in the " + \
                 "configuration"
             LOGGER.error(msg)
@@ -232,26 +232,22 @@ class XMLPropertyFile(Bcfg2.Server.Plugin.StructFile, PropertyFile):
         """ Decrypt a single encrypted properties file element """
         if not element.text or not element.text.strip():
             return
-        passes = Bcfg2.Encryption.get_passphrases(SETUP)
+        passes = Bcfg2.Encryption.get_passphrases()
         try:
             passphrase = passes[element.get("encrypted")]
             try:
-                return Bcfg2.Encryption.ssl_decrypt(
-                    element.text, passphrase,
-                    algorithm=Bcfg2.Encryption.get_algorithm(SETUP))
+                return Bcfg2.Encryption.ssl_decrypt(element.text, passphrase)
             except Bcfg2.Encryption.EVPError:
                 # error is raised below
                 pass
         except KeyError:
             # bruteforce_decrypt raises an EVPError with a sensible
             # error message, so we just let it propagate up the stack
-            return Bcfg2.Encryption.bruteforce_decrypt(
-                element.text, passphrases=passes.values(),
-                algorithm=Bcfg2.Encryption.get_algorithm(SETUP))
+            return Bcfg2.Encryption.bruteforce_decrypt(element.text)
         raise Bcfg2.Encryption.EVPError("Failed to decrypt")
 
     def get_additional_data(self, metadata):
-        if SETUP.cfp.getboolean("properties", "automatch", default=False):
+        if self.setup.cfp.getboolean("properties", "automatch", default=False):
             default_automatch = "true"
         else:
             default_automatch = "false"
@@ -323,10 +319,8 @@ class Properties(Bcfg2.Server.Plugin.Plugin,
     instances. """
 
     def __init__(self, core, datastore):
-        global SETUP  # pylint: disable=W0603
         Bcfg2.Server.Plugin.Plugin.__init__(self, core, datastore)
         Bcfg2.Server.Plugin.Connector.__init__(self)
-        SETUP = core.setup
         try:
             self.store = PropDirectoryBacked(self.data, core.fam)
         except OSError: