Merge "Improve config handling"

doc/source/usage.rst

@@ -29,15 +29,18 @@ oslo.upgradecheck also includes a basic implementation of command line argument
 handling that can be used to provide the minimum processing needed to implement
 a ``$SERVICE-status upgrade check`` command. To make use of it, write a method
 that creates an instance of the class created above, then pass that class's
-``check`` method into :func:`oslo_upgradecheck.upgradecheck.main`. For
-example::
+``check`` function into :func:`oslo_upgradecheck.upgradecheck.main`. The
+project's ConfigOpts instance must also be passed. In most projects this will
+just be cfg.CONF. For example::
+
+    from oslo_config import cfg
 
     def main():
         inst = ProjectSpecificUpgradeCommands()
-        return upgradecheck.main(inst.check)
+        return upgradecheck.main(cfg.CONF, inst.check)
 
 The entry point for the ``$SERVICE-status`` command should then point at this
-method.
+function.
 
 Alternatively, if a project has its own CLI code that it would prefer to reuse,
 it simply needs to ensure that the ``inst.check`` method is called when the

oslo_upgradecheck/__main__.py

@@ -16,6 +16,7 @@
 
 import sys
 
+from oslo_config import cfg
 from oslo_upgradecheck import upgradecheck
 
 
@@ -34,7 +35,7 @@ class Checks(upgradecheck.UpgradeCommands):
 
 def main():
     inst = Checks()
-    return upgradecheck.main(inst.check)
+    return upgradecheck.main(cfg.CONF, inst.check)
 
 
 if __name__ == '__main__':

oslo_upgradecheck/tests/test_upgradecheck.py

@@ -22,6 +22,7 @@ Tests for `upgradecheck` module.
 import sys
 
 import mock
+from oslo_config import cfg
 from oslotest import base
 
 from oslo_upgradecheck import upgradecheck
@@ -73,8 +74,9 @@ class TestUpgradeCommands(base.BaseTestCase):
 class TestMain(base.BaseTestCase):
     def _run_test(self, func, expected):
         mock_argv = ['test-status', 'upgrade', 'check']
+        conf = cfg.ConfigOpts()
         with mock.patch.object(sys, 'argv', mock_argv, create=True):
-            result = upgradecheck.main(func)
+            result = upgradecheck.main(conf, func)
             self.assertEqual(expected, result)
 
     def test_main(self):

oslo_upgradecheck/upgradecheck.py

@@ -139,21 +139,31 @@ def _add_parsers(subparsers, check_callback):
     upgrade_action.set_defaults(action_fn=check_callback)
 
 
-def main(check_callback):
+def _init_config(conf):
+    conf(sys.argv[1:])
+
+
+def main(conf, check_callback, config_callback=_init_config):
     """Simple implementation of main for upgrade checks
 
     This can be used in upgrade check commands to provide the minimum
     necessary parameter handling and logic.
 
+    :param conf: An oslo.confg ConfigOpts instance on which to register the
+                 upgrade check arguments.
     :param check_callback: The check function from the concrete implementation
                            of UpgradeCommands.
+    :param config_callback: A function that initializes the conf object.
+                            It must take a single argument that is the conf
+                            object to be initialized. The default
+                            implementation simply runs
+                            conf(sys.argv[1:])
     """
     add_parsers = functools.partial(_add_parsers,
                                     check_callback=check_callback)
     opt = cfg.SubCommandOpt('category', handler=add_parsers)
-    conf = cfg.ConfigOpts()
     conf.register_cli_opt(opt)
-    conf(sys.argv[1:])
+    config_callback(conf)
 
     try:
         return conf.category.action_fn()