Merge from trunk

4 files changed, 287 insertions, 47 deletions

diff --git a/nova/api/openstack/__init__.py b/nova/api/openstack/__init__.py
index 05baa0721..9ab8aeb58 100644
--- a/nova/api/openstack/__init__.py
+++ b/nova/api/openstack/__init__.py
@@ -40,6 +40,7 @@ from nova.api.openstack import servers
 from nova.api.openstack import server_metadata
 from nova.api.openstack import shared_ip_groups
 from nova.api.openstack import users
+from nova.api.openstack import versions
 from nova.api.openstack import wsgi
 from nova.api.openstack import zones
 
@@ -116,6 +117,10 @@ class APIRouter(base_wsgi.Router):
                                     'select': 'POST',
                                     'boot': 'POST'})
 
+        mapper.connect("versions", "/",
+                    controller=versions.create_resource(version),
+                    action='show')
+
         mapper.resource("console", "consoles",
                     controller=consoles.create_resource(),
                     parent_resource=dict(member_name='server',
diff --git a/nova/api/openstack/versions.py b/nova/api/openstack/versions.py
index df7a94b7e..3ef72b7f6 100644
--- a/nova/api/openstack/versions.py
+++ b/nova/api/openstack/versions.py
@@ -24,7 +24,66 @@ import nova.api.openstack.views.versions
 from nova.api.openstack import wsgi
 
 
-ATOM_XMLNS = "http://www.w3.org/2005/Atom"
+VERSIONS = {
+    "v1.0": {
+        "id": "v1.0",
+        "status": "DEPRECATED",
+        "updated": "2011-01-21T11:33:21Z",
+        "links": [
+            {
+                "rel": "describedby",
+                "type": "application/pdf",
+                "href": "http://docs.rackspacecloud.com/"
+                        "servers/api/v1.0/cs-devguide-20110125.pdf"
+            },
+            {
+                "rel": "describedby",
+                "type": "application/vnd.sun.wadl+xml",
+                "href": "http://docs.rackspacecloud.com/"
+                        "servers/api/v1.0/application.wadl"
+            },
+        ],
+        "media-types": [
+            {
+                "base": "application/xml",
+                "type": "application/vnd.openstack.compute-v1.0+xml"
+            },
+            {
+                "base": "application/json",
+                "type": "application/vnd.openstack.compute-v1.0+json"
+            }
+        ],
+    },
+    "v1.1": {
+        "id": "v1.1",
+        "status": "CURRENT",
+        "updated": "2011-01-21T11:33:21Z",
+        "links": [
+            {
+                "rel": "describedby",
+                "type": "application/pdf",
+                "href": "http://docs.rackspacecloud.com/"
+                        "servers/api/v1.1/cs-devguide-20110125.pdf"
+            },
+            {
+                "rel": "describedby",
+                "type": "application/vnd.sun.wadl+xml",
+                "href": "http://docs.rackspacecloud.com/"
+                        "servers/api/v1.1/application.wadl"
+            },
+        ],
+        "media-types": [
+            {
+                "base": "application/xml",
+                "type": "application/vnd.openstack.compute-v1.1+xml"
+            },
+            {
+                "base": "application/json",
+                "type": "application/vnd.openstack.compute-v1.1+json"
+            }
+        ],
+    },
+}
 
 
 class Versions(wsgi.Resource):
@@ -36,16 +95,20 @@ class Versions(wsgi.Resource):
             }
         }
 
+        headers_serializer = VersionsHeadersSerializer()
+
         body_serializers = {
             'application/atom+xml': VersionsAtomSerializer(metadata=metadata),
             'application/xml': VersionsXMLSerializer(metadata=metadata),
         }
-        serializer = wsgi.ResponseSerializer(body_serializers)
+        serializer = wsgi.ResponseSerializer(
+            body_serializers=body_serializers,
+            headers_serializer=headers_serializer)
 
         supported_content_types = ('application/json',
                                    'application/xml',
                                    'application/atom+xml')
-        deserializer = wsgi.RequestDeserializer(
+        deserializer = VersionsRequestDeserializer(
             supported_content_types=supported_content_types)
 
         wsgi.Resource.__init__(self, None, serializer=serializer,
@@ -53,60 +116,131 @@ class Versions(wsgi.Resource):
 
     def dispatch(self, request, *args):
         """Respond to a request for all OpenStack API versions."""
-        version_objs = [
-            {
-                "id": "v1.1",
-                "status": "CURRENT",
-                #TODO(wwolf) get correct value for these
-                "updated": "2011-07-18T11:30:00Z",
-            },
-            {
-                "id": "v1.0",
-                "status": "DEPRECATED",
-                #TODO(wwolf) get correct value for these
-                "updated": "2010-10-09T11:30:00Z",
-            },
-        ]
-
         builder = nova.api.openstack.views.versions.get_view_builder(request)
-        versions = [builder.build(version) for version in version_objs]
-        return dict(versions=versions)
+        if request.path == '/':
+            # List Versions
+            return builder.build_versions(VERSIONS)
+        else:
+            # Versions Multiple Choice
+            return builder.build_choices(VERSIONS, request)
+
+
+class VersionV10(object):
+    def show(self, req):
+        builder = nova.api.openstack.views.versions.get_view_builder(req)
+        return builder.build_version(VERSIONS['v1.0'])
+
+
+class VersionV11(object):
+    def show(self, req):
+        builder = nova.api.openstack.views.versions.get_view_builder(req)
+        return builder.build_version(VERSIONS['v1.1'])
+
+
+class VersionsRequestDeserializer(wsgi.RequestDeserializer):
+    def get_expected_content_type(self, request):
+        supported_content_types = list(self.supported_content_types)
+        if request.path != '/':
+            # Remove atom+xml accept type for 300 responses
+            if 'application/atom+xml' in supported_content_types:
+                supported_content_types.remove('application/atom+xml')
+
+        return request.best_match_content_type(supported_content_types)
+
+    def get_action_args(self, request_environment):
+        """Parse dictionary created by routes library."""
+        args = {}
+        if request_environment['PATH_INFO'] == '/':
+            args['action'] = 'index'
+        else:
+            args['action'] = 'multi'
+
+        return args
 
 
 class VersionsXMLSerializer(wsgi.XMLDictSerializer):
-    def _versions_to_xml(self, versions):
-        root = self._xml_doc.createElement('versions')
+    #TODO(wwolf): this is temporary until we get rid of toprettyxml
+    # in the base class (XMLDictSerializer), which I plan to do in
+    # another branch
+    def to_xml_string(self, node, has_atom=False):
+        self._add_xmlns(node, has_atom)
+        return node.toxml(encoding='UTF-8')
+
+    def _versions_to_xml(self, versions, name="versions", xmlns=None):
+        root = self._xml_doc.createElement(name)
+        root.setAttribute("xmlns", wsgi.XMLNS_V11)
+        root.setAttribute("xmlns:atom", wsgi.XMLNS_ATOM)
 
         for version in versions:
             root.appendChild(self._create_version_node(version))
 
         return root
 
-    def _create_version_node(self, version):
+    def _create_media_types(self, media_types):
+        base = self._xml_doc.createElement('media-types')
+        for type in media_types:
+            node = self._xml_doc.createElement('media-type')
+            node.setAttribute('base', type['base'])
+            node.setAttribute('type', type['type'])
+            base.appendChild(node)
+
+        return base
+
+    def _create_version_node(self, version, create_ns=False):
         version_node = self._xml_doc.createElement('version')
+        if create_ns:
+            xmlns = wsgi.XMLNS_V11
+            xmlns_atom = wsgi.XMLNS_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'])
+            version_node.appendChild(media_types)
 
-        for link in version['links']:
-            link_node = self._xml_doc.createElement('atom:link')
-            link_node.setAttribute('rel', link['rel'])
-            link_node.setAttribute('href', link['href'])
-            version_node.appendChild(link_node)
+        link_nodes = self._create_link_nodes(self._xml_doc, version['links'])
+        for link in link_nodes:
+            version_node.appendChild(link)
 
         return version_node
 
-    def default(self, data):
+    def index(self, data):
         self._xml_doc = minidom.Document()
         node = self._versions_to_xml(data['versions'])
 
         return self.to_xml_string(node)
 
+    def show(self, data):
+        self._xml_doc = minidom.Document()
+        node = self._create_version_node(data['version'], True)
+
+        return self.to_xml_string(node)
+
+    def multi(self, data):
+        self._xml_doc = minidom.Document()
+        node = self._versions_to_xml(data['choices'], 'choices',
+                         xmlns=wsgi.XMLNS_V11)
+
+        return self.to_xml_string(node)
+
 
 class VersionsAtomSerializer(wsgi.XMLDictSerializer):
+    #TODO(wwolf): this is temporary until we get rid of toprettyxml
+    # in the base class (XMLDictSerializer), which I plan to do in
+    # another branch
+    def to_xml_string(self, node, has_atom=False):
+        self._add_xmlns(node, has_atom)
+        return node.toxml(encoding='UTF-8')
+
     def __init__(self, metadata=None, xmlns=None):
+        self.metadata = metadata or {}
         if not xmlns:
-            self.xmlns = ATOM_XMLNS
+            self.xmlns = wsgi.XMLNS_ATOM
         else:
             self.xmlns = xmlns
 
@@ -135,8 +269,33 @@ class VersionsAtomSerializer(wsgi.XMLDictSerializer):
         link_href = link_href.rstrip('/')
         return link_href.rsplit('/', 1)[0] + '/'
 
-    def _create_meta(self, root, versions):
-        title = self._create_text_elem('title', 'Available API Versions',
+    def _create_detail_meta(self, root, version):
+        title = self._create_text_elem('title', "About This Version",
+                                       type='text')
+
+        updated = self._create_text_elem('updated', version['updated'])
+
+        uri = version['links'][0]['href']
+        id = self._create_text_elem('id', uri)
+
+        link = self._xml_doc.createElement('link')
+        link.setAttribute('rel', 'self')
+        link.setAttribute('href', uri)
+
+        author = self._xml_doc.createElement('author')
+        author_name = self._create_text_elem('name', 'Rackspace')
+        author_uri = self._create_text_elem('uri', 'http://www.rackspace.com/')
+        author.appendChild(author_name)
+        author.appendChild(author_uri)
+
+        root.appendChild(title)
+        root.appendChild(updated)
+        root.appendChild(id)
+        root.appendChild(author)
+        root.appendChild(link)
+
+    def _create_list_meta(self, root, versions):
+        title = self._create_text_elem('title', "Available API Versions",
                                        type='text')
         # Set this updated to the most recently updated version
         recent = self._get_most_recent_update(versions)
@@ -144,6 +303,7 @@ class VersionsAtomSerializer(wsgi.XMLDictSerializer):
 
         base_url = self._get_base_url(versions[0]['links'][0]['href'])
         id = self._create_text_elem('id', base_url)
+
         link = self._xml_doc.createElement('link')
         link.setAttribute('rel', 'self')
         link.setAttribute('href', base_url)
@@ -178,7 +338,10 @@ class VersionsAtomSerializer(wsgi.XMLDictSerializer):
                 link_node = self._xml_doc.createElement('link')
                 link_node.setAttribute('rel', link['rel'])
                 link_node.setAttribute('href', link['href'])
-            entry.appendChild(link_node)
+                if 'type' in link:
+                    link_node.setAttribute('type', link['type'])
+
+                entry.appendChild(link_node)
 
             content = self._create_text_elem('content',
                 'Version %s %s (%s)' %
@@ -190,10 +353,45 @@ class VersionsAtomSerializer(wsgi.XMLDictSerializer):
             entry.appendChild(content)
             root.appendChild(entry)
 
-    def default(self, data):
+    def index(self, data):
         self._xml_doc = minidom.Document()
         node = self._xml_doc.createElementNS(self.xmlns, 'feed')
-        self._create_meta(node, data['versions'])
+        self._create_list_meta(node, data['versions'])
         self._create_version_entries(node, data['versions'])
 
         return self.to_xml_string(node)
+
+    def show(self, data):
+        self._xml_doc = minidom.Document()
+        node = self._xml_doc.createElementNS(self.xmlns, 'feed')
+        self._create_detail_meta(node, data['version'])
+        self._create_version_entries(node, [data['version']])
+
+        return self.to_xml_string(node)
+
+
+class VersionsHeadersSerializer(wsgi.ResponseHeadersSerializer):
+    def multi(self, response, data):
+        response.status_int = 300
+
+
+def create_resource(version='1.0'):
+    controller = {
+        '1.0': VersionV10,
+        '1.1': VersionV11,
+    }[version]()
+
+    body_serializers = {
+        'application/xml': VersionsXMLSerializer(),
+        'application/atom+xml': VersionsAtomSerializer(),
+    }
+    serializer = wsgi.ResponseSerializer(body_serializers)
+
+    supported_content_types = ('application/json',
+                               'application/xml',
+                               'application/atom+xml')
+    deserializer = wsgi.RequestDeserializer(
+        supported_content_types=supported_content_types)
+
+    return wsgi.Resource(controller, serializer=serializer,
+                         deserializer=deserializer)
diff --git a/nova/api/openstack/views/versions.py b/nova/api/openstack/views/versions.py
index 9fa8f49dc..547289034 100644
--- a/nova/api/openstack/views/versions.py
+++ b/nova/api/openstack/views/versions.py
@@ -15,6 +15,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import copy
 import os
 
 
@@ -31,16 +32,44 @@ class ViewBuilder(object):
         """
         self.base_url = base_url
 
-    def build(self, version_data):
-        """Generic method used to generate a version entity."""
-        version = {
-            "id": version_data["id"],
-            "status": version_data["status"],
-            "updated": version_data["updated"],
-            "links": self._build_links(version_data),
-        }
+    def build_choices(self, VERSIONS, req):
+        version_objs = []
+        for version in VERSIONS:
+            version = VERSIONS[version]
+            version_objs.append({
+                "id": version['id'],
+                "status": version['status'],
+                "links": [
+                    {
+                        "rel": "self",
+                        "href": self.generate_href(version['id'], req.path)
+                    }
+                ],
+                "media-types": version['media-types']
+            })
 
-        return version
+        return dict(choices=version_objs)
+
+    def build_versions(self, versions):
+        version_objs = []
+        for version in versions:
+            version = versions[version]
+            version_objs.append({
+                "id": version['id'],
+                "status": version['status'],
+                "updated": version['updated'],
+                "links": self._build_links(version),
+            })
+
+        return dict(versions=version_objs)
+
+    def build_version(self, version):
+        reval = copy.deepcopy(version)
+        reval['links'].insert(0, {
+            "rel": "self",
+            "href": self.base_url.rstrip('/') + '/',
+        })
+        return dict(version=reval)
 
     def _build_links(self, version_data):
         """Generate a container of links that refer to the provided version."""
@@ -55,6 +84,11 @@ class ViewBuilder(object):
 
         return links
 
-    def generate_href(self, version_number):
+    def generate_href(self, version_number, path=None):
         """Create an url that refers to a specific version_number."""
-        return os.path.join(self.base_url, version_number) + '/'
+        version_number = version_number.strip('/')
+        if path:
+            path = path.strip('/')
+            return os.path.join(self.base_url, version_number, path)
+        else:
+            return os.path.join(self.base_url, version_number) + '/'
diff --git a/nova/api/openstack/wsgi.py b/nova/api/openstack/wsgi.py
index 53dab22e8..0eb47044e 100644
--- a/nova/api/openstack/wsgi.py
+++ b/nova/api/openstack/wsgi.py
@@ -13,6 +13,7 @@ from nova import wsgi
 
 XMLNS_V10 = 'http://docs.rackspacecloud.com/servers/api/v1.0'
 XMLNS_V11 = 'http://docs.openstack.org/compute/api/v1.1'
+
 XMLNS_ATOM = 'http://www.w3.org/2005/Atom'
 
 LOG = logging.getLogger('nova.api.openstack.wsgi')
@@ -386,6 +387,8 @@ class XMLDictSerializer(DictSerializer):
             link_node = xml_doc.createElement('atom:link')
             link_node.setAttribute('rel', link['rel'])
             link_node.setAttribute('href', link['href'])
+            if 'type' in link:
+                link_node.setAttribute('type', link['type'])
             link_nodes.append(link_node)
         return link_nodes