Wrap config module and require manual setup (bug 1143998)

This moves keystone.config to keystone.common.config, which requires
.configure() to be called manually in order for options to be
registered.

keystone.config preserves the existing behavior of automatically
registering options when imported.

keystone.middleware.auth_token and it's dependencies within keystone no
longer cause config options to be automatically registered.

This is an alternative to https://review.openstack.org/#/c/24251/

Change-Id: If9eb5799bf77595ecb71f2000f8b6d1610ea9700

1 files changed, 25 insertions, 0 deletions

diff --git a/tests/_test_import_auth_token.py b/tests/_test_import_auth_token.py
new file mode 100644
index 00000000..4e16f9a4
--- /dev/null
+++ b/tests/_test_import_auth_token.py
@@ -0,0 +1,25 @@
+"""This is an isolated test to prevent unexpected imports.
+
+This module must be run in isolation, e.g.:
+
+  $ ./run_tests.sh _test_import_auth_token.py
+
+This module can be removed when keystone.middleware.auth_token is removed.
+
+"""
+
+import unittest
+
+
+class TestAuthToken(unittest.TestCase):
+    def test_import(self):
+        # a consuming service like nova would import oslo.config first
+        from oslo.config import cfg
+        conf = cfg.CONF
+
+        # define some config options
+        conf.register_opt(cfg.BoolOpt('debug', default=False))
+
+        # and then import auth_token as a filter
+        from keystone.middleware import auth_token
+        self.assertTrue(auth_token)