Rajaram/Vinkesh|Default xmlns for extension serialization can be overriden, added default factory for extension middleware

3 files changed, 44 insertions, 21 deletions

diff --git a/etc/openstack-common.conf.test b/etc/openstack-common.conf.test
index 89bdf2d..4206bff 100644
--- a/etc/openstack-common.conf.test
+++ b/etc/openstack-common.conf.test
@@ -18,6 +18,9 @@ log_file = /tmp/openstack-common.log
 # Send logs to syslog (/dev/log) instead of to file specified by `log_file`
 use_syslog = False
 
+# Path to the extensions
+api_extensions_path = tests/unit/extensions
+
 [pipeline:extensions_app_with_filter]
 pipeline = extensions extensions_test_app
 
diff --git a/openstack/common/extensions.py b/openstack/common/extensions.py
index d2fab36..162a02a 100644
--- a/openstack/common/extensions.py
+++ b/openstack/common/extensions.py
@@ -206,6 +206,13 @@ class ExtensionsResource(wsgi.Resource):
 class ExtensionMiddleware(wsgi.Middleware):
     """Extensions middleware for WSGI."""
 
+    @classmethod
+    def factory(cls, global_config, **local_config):
+        """Paste factory."""
+        def _factory(app):
+            return cls(app, global_config, **local_config)
+        return _factory
+
     def _action_ext_resources(self, application, ext_mgr, mapper):
         """Return a dict of ActionExtensionResource-s by collection."""
         action_resources = {}
@@ -245,9 +252,9 @@ class ExtensionMiddleware(wsgi.Middleware):
 
         return request_ext_resources
 
-    def __init__(self, application, ext_mgr):
-        self.ext_mgr = ext_mgr
-
+    def __init__(self, application, config, ext_mgr=None):
+        ext_mgr = ext_mgr or ExtensionManager(
+                                 config['api_extensions_path'])
         mapper = routes.Mapper()
 
         # extended resources
@@ -493,15 +500,16 @@ class ResourceExtension(object):
 
 class ExtensionsXMLSerializer(wsgi.XMLDictSerializer):
 
-    NSMAP = {None: DEFAULT_XMLNS, 'atom': XMLNS_ATOM}
+    def __init__(self):
+        self.nsmap = {None: DEFAULT_XMLNS, 'atom': XMLNS_ATOM}
 
     def show(self, ext_dict):
-        ext = etree.Element('extension', nsmap=self.NSMAP)
+        ext = etree.Element('extension', nsmap=self.nsmap)
         self._populate_ext(ext, ext_dict['extension'])
         return self._to_xml(ext)
 
     def index(self, exts_dict):
-        exts = etree.Element('extensions', nsmap=self.NSMAP)
+        exts = etree.Element('extensions', nsmap=self.nsmap)
         for ext_dict in exts_dict['extensions']:
             ext = etree.SubElement(exts, 'extension')
             self._populate_ext(ext, ext_dict)
diff --git a/tests/unit/test_extensions.py b/tests/unit/test_extensions.py
index 841bf4d..fb5fdb1 100644
--- a/tests/unit/test_extensions.py
+++ b/tests/unit/test_extensions.py
@@ -19,22 +19,15 @@ from lxml import etree
 import os.path
 import routes
 import unittest
-
 from webtest import TestApp
 
-
-from openstack.common import wsgi
 from openstack.common import config
 from openstack.common import extensions
-from tests.unit.extension_stubs import (StubExtension,
-                                        StubBaseAppController)
-from openstack.common.extensions import (ExtensionManager,
-                                       ExtensionMiddleware)
-
+from openstack.common import wsgi
+from tests.unit import extension_stubs
 
 test_conf_file = os.path.join(os.path.dirname(__file__), os.pardir,
                               os.pardir, 'etc', 'openstack-common.conf.test')
-extensions_path = os.path.join(os.path.dirname(__file__), "extensions")
 
 NS = "{http://docs.openstack.org/}"
 ATOMNS = "{http://www.w3.org/2005/Atom}"
@@ -44,7 +37,7 @@ class ExtensionsTestApp(wsgi.Router):
 
     def __init__(self, options={}):
         mapper = routes.Mapper()
-        controller = StubBaseAppController()
+        controller = extension_stubs.StubBaseAppController()
         mapper.resource("dummy_resource", "/dummy_resources",
                         controller=controller.create_resource())
         super(ExtensionsTestApp, self).__init__(mapper)
@@ -296,9 +289,9 @@ class ExtensionManagerTest(unittest.TestCase):
             def get_alias(self):
                 return "invalid_extension"
 
-        ext_mgr = ExtensionManager('')
+        ext_mgr = extensions.ExtensionManager('')
         ext_mgr.add_extension(InvalidExtension())
-        ext_mgr.add_extension(StubExtension("valid_extension"))
+        ext_mgr.add_extension(extension_stubs.StubExtension("valid_extension"))
 
         self.assertTrue('valid_extension' in ext_mgr.extensions)
         self.assertFalse('invalid_extension' in ext_mgr.extensions)
@@ -376,6 +369,27 @@ class ExtensionControllerTest(unittest.TestCase):
             'The Fox In Socks Extension')
 
 
+class DefaultXmlnsTest(unittest.TestCase):
+
+    def setUp(self):
+        super(DefaultXmlnsTest, self).setUp()
+        self.original_default_xmlns = extensions.DEFAULT_XMLNS
+        extensions.DEFAULT_XMLNS = "http://blah"
+        self.test_app = setup_extensions_test_app()
+
+    def test_default_xmlns_can_be_changed(self):
+        response = self.test_app.get("/extensions/FOXNSOX.xml")
+        self.assertEqual(200, response.status_int)
+        xml = response.body
+
+        root = etree.XML(xml)
+        self.assertEqual(root.tag.split('extension')[0], "{http://blah}")
+
+    def tearDown(self):
+        super(DefaultXmlnsTest, self).tearDown()
+        extensions.DEFAULT_XMLNS = self.original_default_xmlns
+
+
 class ExtensionsXMLSerializerTest(unittest.TestCase):
 
     def test_serialize_extenstion(self):
@@ -467,11 +481,9 @@ def setup_base_app():
 
 
 def setup_extensions_middleware(extension_manager=None):
-    extension_manager = (extension_manager or
-                         ExtensionManager(extensions_path))
     options = {'config_file': test_conf_file}
     conf, app = config.load_paste_app('extensions_test_app', options, None)
-    return ExtensionMiddleware(app, extension_manager)
+    return extensions.ExtensionMiddleware(app, conf, extension_manager)
 
 
 def setup_extensions_test_app(extension_manager=None):