multi choice XML responses with tests

2 files changed, 88 insertions, 14 deletions

diff --git a/nova/api/openstack/versions.py b/nova/api/openstack/versions.py
index 58c767d5c..9909d8d0d 100644
--- a/nova/api/openstack/versions.py
+++ b/nova/api/openstack/versions.py
@@ -25,6 +25,7 @@ from nova.api.openstack import wsgi
 
 
 ATOM_XMLNS = "http://www.w3.org/2005/Atom"
+OS_XMLNS_BASE = "http://docs.openstack.org/common/api/"
 VERSIONS = {
     "v1.0": {
         "version" : {
@@ -226,8 +227,10 @@ class VersionsXMLSerializer(wsgi.XMLDictSerializer):
         self._add_xmlns(node, has_atom)
         return node.toxml(encoding='UTF-8')
 
-    def _versions_to_xml(self, versions):
-        root = self._xml_doc.createElement('versions')
+    def _versions_to_xml(self, versions, name="versions", xmlns=None):
+        root = self._xml_doc.createElement(name)
+        root.setAttribute("xmlns", "%sv1.0" % OS_XMLNS_BASE)
+        root.setAttribute("xmlns:atom", ATOM_XMLNS)
 
         for version in versions:
             root.appendChild(self._create_version_node(version))
@@ -247,14 +250,15 @@ class VersionsXMLSerializer(wsgi.XMLDictSerializer):
     def _create_version_node(self, version, create_ns=False):
         version_node = self._xml_doc.createElement('version')
         if create_ns:
-            xmlns = "http://docs.openstack.org/common/api/%s" % version['id']
+            xmlns = "%s%s" % (OS_XMLNS_BASE, version['id'])
             xmlns_atom = "http://www.w3.org/2005/Atom"
             version_node.setAttribute('xmlns', xmlns)
             version_node.setAttribute('xmlns:atom', xmlns_atom)
 
         version_node.setAttribute('id', version['id'])
         version_node.setAttribute('status', version['status'])
-        version_node.setAttribute('updated', version['updated'])
+        if 'updated' in version:
+            version_node.setAttribute('updated', version['updated'])
 
         if 'media-types' in version:
             media_types = self._create_media_types(version['media-types'])
@@ -285,7 +289,8 @@ class VersionsXMLSerializer(wsgi.XMLDictSerializer):
 
     def multi(self, data):
         self._xml_doc = minidom.Document()
-        node = self._versions_to_xml(data['versions'])
+        node = self._versions_to_xml(data['choices'], 'choices',
+                         xmlns="%sv1.0" % OS_XMLNS_BASE)
 
         return self.to_xml_string(node)
 
diff --git a/nova/tests/api/openstack/test_versions.py b/nova/tests/api/openstack/test_versions.py
index d8d6cebe2..dce8e38f1 100644
--- a/nova/tests/api/openstack/test_versions.py
+++ b/nova/tests/api/openstack/test_versions.py
@@ -27,6 +27,9 @@ from nova.tests.api.openstack import fakes
 from nova.api.openstack import versions
 from nova.api.openstack import views
 
+ATOM_XMLNS = versions.ATOM_XMLNS
+OS_XMLNS_BASE = versions.OS_XMLNS_BASE
+
 
 class VersionsTest(test.TestCase):
     def setUp(self):
@@ -170,7 +173,7 @@ class VersionsTest(test.TestCase):
         root = xml.etree.ElementTree.XML(res.body)
         self.assertEqual(root.tag.split('}')[1], "version")
         self.assertEqual(root.tag.split('}')[0].strip('{'),
-                         "http://docs.openstack.org/common/api/v1.0")
+                         "%sv1.0" % OS_XMLNS_BASE)
 
         children = list(root)
         media_types = children[0]
@@ -184,7 +187,7 @@ class VersionsTest(test.TestCase):
         expected = """
         <version id="v1.0" status="DEPRECATED"
              updated="2011-01-21T11:33:21Z"
-             xmlns="http://docs.openstack.org/common/api/v1.0"
+             xmlns="%sv1.0"
              xmlns:atom="http://www.w3.org/2005/Atom">
 
             <media-types>
@@ -206,7 +209,7 @@ class VersionsTest(test.TestCase):
                 api/v1.0/application.wadl"
                  rel="describedby"
                  type="application/vnd.sun.wadl+xml"/>
-        </version>""".replace("  ", "").replace("\n", "")
+        </version>""".replace("  ", "").replace("\n", "") % OS_XMLNS_BASE
 
         actual = res.body.replace("  ", "").replace("\n", "")
         self.assertEqual(expected, actual)
@@ -220,7 +223,7 @@ class VersionsTest(test.TestCase):
         expected = """
         <version id="v1.1" status="CURRENT"
              updated="2011-01-21T11:33:21Z"
-             xmlns="http://docs.openstack.org/common/api/v1.1"
+             xmlns="%sv1.1"
              xmlns:atom="http://www.w3.org/2005/Atom">
 
             <media-types>
@@ -242,7 +245,8 @@ class VersionsTest(test.TestCase):
                 api/v1.1/application.wadl"
                  rel="describedby"
                  type="application/vnd.sun.wadl+xml"/>
-        </version>""".replace("  ", "").replace("\n", "")
+        </version>""".replace("  ", "").replace("\n", "") % OS_XMLNS_BASE
+
 
         actual = res.body.replace("  ", "").replace("\n", "")
         self.assertEqual(expected, actual)
@@ -254,7 +258,8 @@ class VersionsTest(test.TestCase):
         self.assertEqual(res.status_int, 200)
         self.assertEqual(res.content_type, "application/xml")
 
-        expected = """<versions>
+        expected = """
+        <versions xmlns="%sv1.0" xmlns:atom="%s">
             <version id="v1.1" status="CURRENT" updated="2011-07-18T11:30:00Z">
                 <atom:link href="http://localhost/v1.1/" rel="self"/>
             </version>
@@ -262,7 +267,8 @@ class VersionsTest(test.TestCase):
                  updated="2010-10-09T11:30:00Z">
                 <atom:link href="http://localhost/v1.0/" rel="self"/>
             </version>
-        </versions>""".replace("  ", "").replace("\n", "")
+        </versions>""".replace("  ", "").replace("\n", "") % (OS_XMLNS_BASE,
+                                                              ATOM_XMLNS)
 
         actual = res.body.replace("  ", "").replace("\n", "")
 
@@ -437,6 +443,36 @@ class VersionsTest(test.TestCase):
 
         self.assertDictMatch(expected, json.loads(res.body))
 
+    def test_multi_choice_image_xml(self):
+        req = webob.Request.blank('/images/1')
+        req.accept = "application/xml"
+        res = req.get_response(fakes.wsgi_app())
+        self.assertEqual(res.status_int, 300)
+        self.assertEqual(res.content_type, "application/xml")
+
+        expected = """
+        <choices xmlns="%sv1.0" xmlns:atom="%s">
+          <version id="v1.1" status="CURRENT">
+            <media-types>
+              <media-type base="application/xml"
+                 type="application/vnd.openstack.compute-v1.1+xml"/>
+              <media-type base="application/json"
+                 type="application/vnd.openstack.compute-v1.1+json"/>
+            </media-types>
+            <atom:link href="http://localhost:80/v1.1/images/1" rel="self"/>
+          </version>
+          <version id="v1.0" status="DEPRECATED">
+            <media-types>
+              <media-type base="application/xml"
+                 type="application/vnd.openstack.compute-v1.0+xml"/>
+              <media-type base="application/json"
+                 type="application/vnd.openstack.compute-v1.0+json"/>
+            </media-types>
+            <atom:link href="http://localhost:80/v1.0/images/1" rel="self"/>
+          </version>
+        </choices>""".replace("  ", "").replace("\n","") % (OS_XMLNS_BASE,
+                                                            ATOM_XMLNS)
+
     def test_multi_choice_server(self):
         req = webob.Request.blank('/servers/2')
         req.accept = "application/json"
@@ -544,18 +580,51 @@ class VersionsTest(test.TestCase):
         }
 
         expected = """
-            <versions>
+            <versions xmlns="%sv1.0" xmlns:atom="%s">
                 <version id="2.7.1" status="DEPRECATED"
                  updated="2011-07-18T11:30:00Z">
                     <atom:link href="http://test/2.7.1" rel="self"/>
                 </version>
-            </versions>""".replace("  ", "").replace("\n", "")
+            </versions>""".replace("  ", "").replace("\n", "") % (
+                OS_XMLNS_BASE,ATOM_XMLNS)
 
         serializer = versions.VersionsXMLSerializer()
         response = serializer.index(versions_data)
         response = response.replace("  ", "").replace("\n", "")
         self.assertEqual(expected, response)
 
+    def test_versions_multi_xml_serializer(self):
+        versions_data = {
+            'choices': [
+                {
+                    "id": "2.7.1",
+                    "updated": "2011-07-18T11:30:00Z",
+                    "status": "DEPRECATED",
+                    "links": [
+                        {
+                            "rel": "self",
+                            "href": "http://test/2.7.1/images",
+                        },
+                    ],
+                },
+            ]
+        }
+
+        expected = """
+        <choices xmlns="%sv1.0" xmlns:atom="%s">
+            <version id="2.7.1" status="DEPRECATED"
+             updated="2011-07-18T11:30:00Z">
+                <atom:link href="http://test/2.7.1/images" rel="self"/>
+            </version>
+        </choices>""".replace("  ", "").replace("\n", "") % (OS_XMLNS_BASE,
+                                                              ATOM_XMLNS)
+
+        serializer = versions.VersionsXMLSerializer()
+        response = serializer.multi(versions_data)
+        response = response.replace("  ", "").replace("\n", "")
+        self.assertEqual(expected, response)
+
+
     def test_version_detail_xml_serializer(self):
         version_data = {
             "version" : {