Merge lp:~bcwaldon/nova/osapi-versions-links into lp:~hudson-openstack/nova/trunk

[Brian Waldon]

- add a "links" container to versions entities for Openstack API v1.1
- add testing for the openstack api versions resource and create a view builder

- add a "links" container to versions entities for Openstack API v1.1
- add testing for the openstack api versions resource and create a view builder
- Resubmitted without prerequisite.

[Mark Washenberger (markwash)]

LGTM -

but I'd like to see some ViewBuilder unit tests in the future.

review: Approve

[Matt Dietz (cerberus)]

Looks like you've got some conflicts in fakes.py

166 +<<<<<<< TREE
167 from nova.api.openstack import limits
168 +=======
169 +from nova.api.openstack import ratelimiting
170 +from nova.api.openstack import versions
171 +>>>>>>> MERGE-SOURCE

43 +# Copyright 2010 United States Government as represented by the
44 +# Administrator of the National Aeronautics and Space Administration.

Shouldn't this be the Openstack copyright, and be 2011?

Like Mark said, a few unit tests for ViewBuilder wouldn't hurt.

191) Same deal. Shouldn't it be 2011?

I'd check out the pep8 result too. There was a whitespace complaint in test_versions

review: Needs Fixing

[Brian Waldon (bcwaldon)]

> Looks like you've got some conflicts in fakes.py
>
> 166 +<<<<<<< TREE
> 167 from nova.api.openstack import limits
> 168 +=======
> 169 +from nova.api.openstack import ratelimiting
> 170 +from nova.api.openstack import versions
> 171 +>>>>>>> MERGE-SOURCE
>
>
> 43 +# Copyright 2010 United States Government as represented by the
> 44 +# Administrator of the National Aeronautics and Space Administration.
>
> Shouldn't this be the Openstack copyright, and be 2011?
>
> Like Mark said, a few unit tests for ViewBuilder wouldn't hurt.
>
> 191) Same deal. Shouldn't it be 2011?
>
> I'd check out the pep8 result too. There was a whitespace complaint in
> test_versions

Fixed!

[Matt Dietz (cerberus)]

I still see the NASA copyright on that file... is this intentional?

review: Needs Fixing

[Brian Waldon (bcwaldon)]

> I still see the NASA copyright on that file... is this intentional?

Oh, I'm sorry. I just saw "Shouldn't this be the Openstack copyright, and be 2011?" and changed it to 2011. I guess I read too fast. Should be good to go now.

[Matt Dietz (cerberus)]

187 +# Copyright 2010 OpenStack LLC.

Missed the other, too ;-) Should be 2010 - 2011

Otherwise lgtm. Just fix that last little nit

[Matt Dietz (cerberus)]

\o/

review: Approve

[Mark Washenberger (markwash)]

Even better than before.

review: Approve

[Rick Clark (dendrobates)]

lgtm

review: Approve

[OpenStack Infra (hudson-openstack)]

Attempt to merge into lp:nova failed due to conflicts:

text conflict in nova/api/openstack/__init__.py

[lp:~bcwaldon/nova/osapi-versions-links]

814. By Brian Waldon on 2011-03-25

merging trunk, resolving conflicts

[Paul Voccio (pvo)]

merged cleanly, tests passed. lgtm.

review: Approve

=== modified file 'etc/api-paste.ini'
--- etc/api-paste.ini	2011-03-24 22:47:36 +0000
+++ etc/api-paste.ini	2011-03-25 14:37:25 +0000
@@ -98,4 +98,4 @@
 pipeline = faultwrap osversionapp
 
 [app:osversionapp]
-paste.app_factory = nova.api.openstack:Versions.factory
+paste.app_factory = nova.api.openstack.versions:Versions.factory

=== modified file 'nova/api/openstack/__init__.py'
--- nova/api/openstack/__init__.py	2011-03-25 14:21:03 +0000
+++ nova/api/openstack/__init__.py	2011-03-25 14:37:25 +0000
@@ -158,21 +158,3 @@
         mapper.resource("flavor", "flavors",
                         controller=flavors.ControllerV11(),
                         collection={'detail': 'GET'})
-
-
-class Versions(wsgi.Application):
-    @webob.dec.wsgify(RequestClass=wsgi.Request)
-    def __call__(self, req):
-        """Respond to a request for all OpenStack API versions."""
-        response = {
-            "versions": [
-                dict(status="DEPRECATED", id="v1.0"),
-                dict(status="CURRENT", id="v1.1"),
-            ],
-        }
-        metadata = {
-            "application/xml": {
-                "attributes": dict(version=["status", "id"])}}
-
-        content_type = req.best_match_content_type()
-        return wsgi.Serializer(metadata).serialize(response, content_type)

=== added file 'nova/api/openstack/versions.py'
--- nova/api/openstack/versions.py	1970-01-01 00:00:00 +0000
+++ nova/api/openstack/versions.py	2011-03-25 14:37:25 +0000
@@ -0,0 +1,54 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import webob.dec
+import webob.exc
+
+from nova import wsgi
+import nova.api.openstack.views.versions
+
+
+class Versions(wsgi.Application):
+    @webob.dec.wsgify(RequestClass=wsgi.Request)
+    def __call__(self, req):
+        """Respond to a request for all OpenStack API versions."""
+        version_objs = [
+            {
+                "id": "v1.1",
+                "status": "CURRENT",
+            },
+            {
+                "id": "v1.0",
+                "status": "DEPRECATED",
+            },
+        ]
+
+        builder = nova.api.openstack.views.versions.get_view_builder(req)
+        versions = [builder.build(version) for version in version_objs]
+        response = dict(versions=versions)
+
+        metadata = {
+            "application/xml": {
+                "attributes": {
+                    "version": ["status", "id"],
+                    "link": ["rel", "href"],
+                }
+            }
+        }
+
+        content_type = req.best_match_content_type()
+        return wsgi.Serializer(metadata).serialize(response, content_type)

=== added file 'nova/api/openstack/views/versions.py'
--- nova/api/openstack/views/versions.py	1970-01-01 00:00:00 +0000
+++ nova/api/openstack/views/versions.py	2011-03-25 14:37:25 +0000
@@ -0,0 +1,59 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2010-2011 OpenStack LLC.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import os
+
+
+def get_view_builder(req):
+    base_url = req.application_url
+    return ViewBuilder(base_url)
+
+
+class ViewBuilder(object):
+
+    def __init__(self, base_url):
+        """
+        :param base_url: url of the root wsgi application
+        """
+        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"],
+            "links": self._build_links(version_data),
+        }
+
+        return version
+
+    def _build_links(self, version_data):
+        """Generate a container of links that refer to the provided version."""
+        href = self.generate_href(version_data["id"])
+
+        links = [
+            {
+                "rel": "self",
+                "href": href,
+            },
+        ]
+
+        return links
+
+    def generate_href(self, version_number):
+        """Create an url that refers to a specific version_number."""
+        return os.path.join(self.base_url, version_number)

=== modified file 'nova/tests/api/openstack/fakes.py'
--- nova/tests/api/openstack/fakes.py	2011-03-24 22:47:36 +0000
+++ nova/tests/api/openstack/fakes.py	2011-03-25 14:37:25 +0000
@@ -35,6 +35,7 @@
 import nova.api.openstack.auth
 from nova.api import openstack
 from nova.api.openstack import auth
+from nova.api.openstack import versions
 from nova.api.openstack import limits
 from nova.auth.manager import User, Project
 from nova.image import glance
@@ -85,7 +86,7 @@
               limits.RateLimitingMiddleware(inner_app11)))
     mapper['/v1.0'] = api10
     mapper['/v1.1'] = api11
-    mapper['/'] = openstack.FaultWrapper(openstack.Versions())
+    mapper['/'] = openstack.FaultWrapper(versions.Versions())
     return mapper
 
 

=== added file 'nova/tests/api/openstack/test_versions.py'
--- nova/tests/api/openstack/test_versions.py	1970-01-01 00:00:00 +0000
+++ nova/tests/api/openstack/test_versions.py	2011-03-25 14:37:25 +0000
@@ -0,0 +1,97 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2010-2011 OpenStack LLC.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import json
+import webob
+
+from nova import context
+from nova import test
+from nova.tests.api.openstack import fakes
+from nova.api.openstack import views
+
+
+class VersionsTest(test.TestCase):
+    def setUp(self):
+        super(VersionsTest, self).setUp()
+        self.context = context.get_admin_context()
+
+    def tearDown(self):
+        super(VersionsTest, self).tearDown()
+
+    def test_get_version_list(self):
+        req = webob.Request.blank('/')
+        res = req.get_response(fakes.wsgi_app())
+        self.assertEqual(res.status_int, 200)
+        versions = json.loads(res.body)["versions"]
+        expected = [
+            {
+                "id": "v1.1",
+                "status": "CURRENT",
+                "links": [
+                    {
+                        "rel": "self",
+                        "href": "http://localhost/v1.1",
+                    }
+                ],
+            },
+            {
+                "id": "v1.0",
+                "status": "DEPRECATED",
+                "links": [
+                    {
+                        "rel": "self",
+                        "href": "http://localhost/v1.0",
+                    }
+                ],
+            },
+        ]
+        self.assertEqual(versions, expected)
+
+    def test_view_builder(self):
+        base_url = "http://example.org/"
+
+        version_data = {
+            "id": "3.2.1",
+            "status": "CURRENT",
+        }
+
+        expected = {
+            "id": "3.2.1",
+            "status": "CURRENT",
+            "links": [
+                {
+                    "rel": "self",
+                    "href": "http://example.org/3.2.1",
+                },
+            ],
+        }
+
+        builder = views.versions.ViewBuilder(base_url)
+        output = builder.build(version_data)
+
+        self.assertEqual(output, expected)
+
+    def test_generate_href(self):
+        base_url = "http://example.org/app/"
+        version_number = "v1.4.6"
+
+        expected = "http://example.org/app/v1.4.6"
+
+        builder = views.versions.ViewBuilder(base_url)
+        actual = builder.generate_href(version_number)
+
+        self.assertEqual(actual, expected)