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

[Brian Waldon]

Adding links container to openstack api v1.1 servers entities.

Adding links container to openstack api v1.1 servers entities. Resubmitted without prerequisite.

[Matt Dietz (cerberus)]

You've got some conflicts you need to look at

review: Needs Fixing

[Brian Waldon (bcwaldon)]

> You've got some conflicts you need to look at

Resolved. The branch got a little stale while I was looking at other things.

[Matt Dietz (cerberus)]

115 +import re
116 +from nova import exception
117 +from webob import exc

Pep8 says modules should be ordered as such:

1. standard library imports
2. related third party imports
3. local application/library specific imports

So it should be re, webob and finally nova. Most people seem to be leaving a line of whitespace between each "tier" of module import

519 + if inst.get('instance_type') != None:

A little nit-picky, but you don't need to be this explicit. If inst.get(...): would be sufficient

540 + flavor_id = inst.get("instance_type", None)

Get already by default returns None

For the *_id cases near the above, you probably want to leave them the way they are since 0 obviously equates to false.

review: Needs Fixing

[Brian Waldon (bcwaldon)]

I decided to not do any value testing at all, and simply use whatever value was there.

I should also point out that this branch has a prerequisite branch (~rackspace-titan/nova/openstack-api-versioned-controllers) that hasn't landed yet. I prematurely removed it from this merge prop. It's a hassle to deal with prereqs and merge props, so I'm not going to resubmit it another two times. We can just wait to merge it.

[Matt Dietz (cerberus)]

lgtm.

review: Approve

[Thierry Carrez (ttx)]

This is really close to getting merged and is reasonable, FFe granted for late merging before EOD Monday

review: Approve (ffe)

[Paul Voccio (pvo)]

lgtm.

review: Approve

[OpenStack Infra (hudson-openstack)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

Unmerged revisions

=== modified file 'nova/api/openstack/servers.py'
--- nova/api/openstack/servers.py	2011-03-25 12:51:35 +0000
+++ nova/api/openstack/servers.py	2011-03-25 15:12:57 +0000
@@ -48,11 +48,15 @@
     """ The Server API controller for the OpenStack API """
 
     _serialization_metadata = {
-        'application/xml': {
+        "application/xml": {
             "attributes": {
                 "server": ["id", "imageId", "name", "flavorId", "hostId",
                            "status", "progress", "adminPass", "flavorRef",
-                           "imageRef"]}}}
+                           "imageRef"],
+                "link": ["rel", "type", "href"],
+            },
+        },
+    }
 
     def __init__(self):
         self.compute_api = compute.API()
@@ -572,7 +576,7 @@
             base_url)
         addresses_builder = nova.api.openstack.views.addresses.ViewBuilderV11()
         return nova.api.openstack.views.servers.ViewBuilderV11(
-            addresses_builder, flavor_builder, image_builder)
+            addresses_builder, flavor_builder, image_builder, base_url)
 
     def _get_addresses_view_builder(self, req):
         return nova.api.openstack.views.addresses.ViewBuilderV11(req)

=== modified file 'nova/api/openstack/views/servers.py'
--- nova/api/openstack/views/servers.py	2011-03-24 05:08:17 +0000
+++ nova/api/openstack/views/servers.py	2011-03-25 15:12:57 +0000
@@ -16,6 +16,7 @@
 #    under the License.
 
 import hashlib
+import os
 
 from nova.compute import power_state
 import nova.compute
@@ -41,9 +42,13 @@
     def build(self, inst, is_detail):
         """Return a dict that represenst a server."""
         if is_detail:
-            return self._build_detail(inst)
+            server = self._build_detail(inst)
         else:
-            return self._build_simple(inst)
+            server = self._build_simple(inst)
+
+        self._build_extra(server, inst)
+
+        return server
 
     def _build_simple(self, inst):
         """Return a simple model of a server."""
@@ -97,29 +102,67 @@
         """Return the flavor sub-resource of a server."""
         raise NotImplementedError()
 
+    def _build_extra(self, response, inst):
+        pass
+
 
 class ViewBuilderV10(ViewBuilder):
     """Model an Openstack API V1.0 server response."""
 
     def _build_image(self, response, inst):
-        response['imageId'] = inst['image_id']
+        if 'image_id' in dict(inst):
+            response['imageId'] = inst['image_id']
 
     def _build_flavor(self, response, inst):
-        response['flavorId'] = inst['instance_type']
+        if 'instance_type' in dict(inst):
+            response['flavorId'] = inst['instance_type']
 
 
 class ViewBuilderV11(ViewBuilder):
     """Model an Openstack API V1.0 server response."""
-
-    def __init__(self, addresses_builder, flavor_builder, image_builder):
+    def __init__(self, addresses_builder, flavor_builder, image_builder,
+                 base_url):
         ViewBuilder.__init__(self, addresses_builder)
         self.flavor_builder = flavor_builder
         self.image_builder = image_builder
+        self.base_url = base_url
 
     def _build_image(self, response, inst):
-        image_id = inst["image_id"]
-        response["imageRef"] = self.image_builder.generate_href(image_id)
+        if "image_id" in dict(inst):
+            image_id = inst.get("image_id")
+            response["imageRef"] = self.image_builder.generate_href(image_id)
 
     def _build_flavor(self, response, inst):
-        flavor_id = inst["instance_type"]
-        response["flavorRef"] = self.flavor_builder.generate_href(flavor_id)
+        if "instance_type" in dict(inst):
+            flavor_id = inst["instance_type"]
+            flavor_ref = self.flavor_builder.generate_href(flavor_id)
+            response["flavorRef"] = flavor_ref
+
+    def _build_extra(self, response, inst):
+        self._build_links(response, inst)
+
+    def _build_links(self, response, inst):
+        href = self.generate_href(inst["id"])
+
+        links = [
+            {
+                "rel": "self",
+                "href": href,
+            },
+            {
+                "rel": "bookmark",
+                "type": "application/json",
+                "href": href,
+            },
+            {
+                "rel": "bookmark",
+                "type": "application/xml",
+                "href": href,
+            },
+        ]
+
+        response["server"]["links"] = links
+
+    def generate_href(self, server_id):
+        """Create an url that refers to a specific server id."""
+        return os.path.join(self.base_url, "servers", str(server_id))

=== modified file 'nova/tests/api/openstack/test_servers.py'
--- nova/tests/api/openstack/test_servers.py	2011-03-25 12:51:35 +0000
+++ nova/tests/api/openstack/test_servers.py	2011-03-25 15:12:57 +0000
@@ -164,6 +164,33 @@
         self.assertEqual(res_dict['server']['id'], 1)
         self.assertEqual(res_dict['server']['name'], 'server1')
 
+    def test_get_server_by_id_v11(self):
+        req = webob.Request.blank('/v1.1/servers/1')
+        res = req.get_response(fakes.wsgi_app())
+        res_dict = json.loads(res.body)
+        self.assertEqual(res_dict['server']['id'], 1)
+        self.assertEqual(res_dict['server']['name'], 'server1')
+
+        expected_links = [
+            {
+                "rel": "self",
+                "href": "http://localhost/v1.1/servers/1",
+            },
+            {
+                "rel": "bookmark",
+                "type": "application/json",
+                "href": "http://localhost/v1.1/servers/1",
+            },
+            {
+                "rel": "bookmark",
+                "type": "application/xml",
+                "href": "http://localhost/v1.1/servers/1",
+            },
+        ]
+
+        print res_dict['server']
+        self.assertEqual(res_dict['server']['links'], expected_links)
+
     def test_get_server_by_id_with_addresses(self):
         private = "192.168.0.3"
         public = ["1.2.3.4"]
@@ -186,7 +213,6 @@
         new_return_server = return_server_with_addresses(private, public)
         self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
         req = webob.Request.blank('/v1.1/servers/1')
-        req.environ['api.version'] = '1.1'
         res = req.get_response(fakes.wsgi_app())
         res_dict = json.loads(res.body)
         self.assertEqual(res_dict['server']['id'], 1)
@@ -211,6 +237,35 @@
             self.assertEqual(s.get('imageId', None), None)
             i += 1
 
+    def test_get_server_list_v11(self):
+        req = webob.Request.blank('/v1.1/servers')
+        res = req.get_response(fakes.wsgi_app())
+        res_dict = json.loads(res.body)
+
+        for i, s in enumerate(res_dict['servers']):
+            self.assertEqual(s['id'], i)
+            self.assertEqual(s['name'], 'server%d' % i)
+            self.assertEqual(s.get('imageId', None), None)
+
+            expected_links = [
+            {
+                "rel": "self",
+                "href": "http://localhost/v1.1/servers/%d" % (i,),
+            },
+            {
+                "rel": "bookmark",
+                "type": "application/json",
+                "href": "http://localhost/v1.1/servers/%d" % (i,),
+            },
+            {
+                "rel": "bookmark",
+                "type": "application/xml",
+                "href": "http://localhost/v1.1/servers/%d" % (i,),
+            },
+        ]
+
+        self.assertEqual(s['links'], expected_links)
+
     def test_get_servers_with_limit(self):
         req = webob.Request.blank('/v1.0/servers?limit=3')
         res = req.get_response(fakes.wsgi_app())
@@ -458,7 +513,6 @@
 
     def test_get_all_server_details_v1_1(self):
         req = webob.Request.blank('/v1.1/servers/detail')
-        req.environ['api.version'] = '1.1'
         res = req.get_response(fakes.wsgi_app())
         res_dict = json.loads(res.body)