Merge lp:~gundlach/nova/controllers-in-api into lp:~hudson-openstack/nova/trunk

[Michael Gundlach]

Add Flavors controller supporting

GET /flavors

GET /flavors/detail

GET /flavors/<id>

Also add GET /images/detail

Turn the RackspaceAPIImageIdTranslator into a RackspaceAPIIdTranslator, so that it can be used to translate IDs for other rackspace API components as well (servers, backup schedules.) I thought I'd need it for flavors but it turns out flavors are so simple I could hard code their ids into compute.instance_types.INSTANCE_TYPES.

[Jay Pipes (jaypipes)]

Yep, looks great.

Wondering why you chose to make _id_translator.py prefixed with an underscore...is that file meant to be a private utility? Is there some reason you didn't want it to be part of the set of "public" Python classes?

review: Approve

[Michael Gundlach (gundlach)]

Yes, I didn't want api.rackspace.id_translator to exist along with "servers|images|flavors|sharedipgroups" which are all controllers.

I could have put that class into api.rackspace.__init__ I guess with a _ prepended, but, whatever :)

[lp:~gundlach/nova/controllers-in-api]

266. By Michael Gundlach on 2010-08-26

get to look like trunk

267. By Michael Gundlach on 2010-08-26

work endpoint/images.py into an S3ImageService. The translation isn't perfect, but it's a start.

=== modified file 'nova/api/rackspace/__init__.py'
--- nova/api/rackspace/__init__.py	2010-08-18 15:56:33 +0000
+++ nova/api/rackspace/__init__.py	2010-08-25 21:50:55 +0000
@@ -74,8 +74,10 @@
     def __init__(self):
         mapper = routes.Mapper()
         mapper.resource("server", "servers", controller=servers.Controller())
-        mapper.resource("image", "images", controller=images.Controller())
-        mapper.resource("flavor", "flavors", controller=flavors.Controller())
+        mapper.resource("image", "images", controller=images.Controller(),
+                        collection={'detail': 'GET'})
+        mapper.resource("flavor", "flavors", controller=flavors.Controller(),
+                        collection={'detail': 'GET'})
         mapper.resource("sharedipgroup", "sharedipgroups",
                         controller=sharedipgroups.Controller())
         super(APIRouter, self).__init__(mapper)

=== added file 'nova/api/rackspace/_id_translator.py'
--- nova/api/rackspace/_id_translator.py	1970-01-01 00:00:00 +0000
+++ nova/api/rackspace/_id_translator.py	2010-08-25 21:50:55 +0000
@@ -0,0 +1,42 @@
+from nova import datastore
+
+class RackspaceAPIIdTranslator(object):
+    """
+    Converts Rackspace API ids to and from the id format for a given
+    strategy.
+    """
+
+    def __init__(self, id_type, service_name):
+        """
+        Creates a translator for ids of the given type (e.g. 'flavor'), for the
+        given storage service backend class name (e.g. 'LocalFlavorService').
+        """
+
+        self._store = datastore.Redis.instance()
+        key_prefix = "rsapi.idtranslator.%s.%s" % (id_type, service_name)
+        # Forward (strategy format -> RS format) and reverse translation keys
+        self._fwd_key = "%s.fwd" % key_prefix
+        self._rev_key = "%s.rev" % key_prefix
+
+    def to_rs_id(self, opaque_id):
+        """Convert an id from a strategy-specific one to a Rackspace one."""
+        result = self._store.hget(self._fwd_key, str(opaque_id))
+        if result: # we have a mapping from opaque to RS for this strategy
+            return int(result)
+        else:
+            # Store the mapping.
+            nextid = self._store.incr("%s.lastid" % self._fwd_key)
+            if self._store.hsetnx(self._fwd_key, str(opaque_id), nextid):
+                # If someone else didn't beat us to it, store the reverse
+                # mapping as well.
+                self._store.hset(self._rev_key, nextid, str(opaque_id))
+                return nextid
+            else:
+                # Someone beat us to it; use their number instead, and
+                # discard nextid (which is OK -- we don't require that
+                # every int id be used.)
+                return int(self._store.hget(self._fwd_key, str(opaque_id)))
+
+    def from_rs_id(self, strategy_name, rs_id):
+        """Convert a Rackspace id to a strategy-specific one."""
+        return self._store.hget(self._rev_key, rs_id)

=== modified file 'nova/api/rackspace/flavors.py'
--- nova/api/rackspace/flavors.py	2010-08-18 15:56:33 +0000
+++ nova/api/rackspace/flavors.py	2010-08-25 21:50:55 +0000
@@ -15,4 +15,40 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-class Controller(object): pass
+from nova.api.rackspace import base
+from nova.compute import instance_types
+from webob import exc
+
+class Controller(base.Controller):
+    """Flavor controller for the Rackspace API."""
+
+    _serialization_metadata = {
+        'application/xml': {
+            "attributes": {
+                "flavor": [ "id", "name", "ram", "disk" ]
+            }
+        }
+    }
+
+    def index(self, req):
+        """Return all flavors in brief."""
+        return dict(flavors=[dict(id=flavor['id'], name=flavor['name'])
+                             for flavor in self.detail(req)['flavors']])
+
+    def detail(self, req):
+        """Return all flavors in detail."""
+        items = [self.show(req, id)['flavor'] for id in self._all_ids()]
+        return dict(flavors=items)
+
+    def show(self, req, id):
+        """Return data about the given flavor id."""
+        for name, val in instance_types.INSTANCE_TYPES.iteritems():
+            if val['flavorid'] == int(id):
+                item = dict(ram=val['memory_mb'], disk=val['local_gb'],
+                            id=val['flavorid'], name=name)
+                return dict(flavor=item)
+        raise exc.HTTPNotFound()
+
+    def _all_ids(self):
+        """Return the list of all flavorids."""
+        return [i['flavorid'] for i in instance_types.INSTANCE_TYPES.values()]

=== modified file 'nova/api/rackspace/images.py'
--- nova/api/rackspace/images.py	2010-08-24 20:24:24 +0000
+++ nova/api/rackspace/images.py	2010-08-25 21:50:55 +0000
@@ -15,9 +15,9 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-from nova import datastore
-from nova import image
+import nova.image.service
 from nova.api.rackspace import base
+from nova.api.rackspace import _id_translator
 from webob import exc
 
 class Controller(base.Controller):
@@ -32,35 +32,25 @@
     }
 
     def __init__(self):
-        self._service = image.service.ImageService.load()
-        self._id_translator = RackspaceAPIImageIdTranslator()
-
-    def _to_rs_id(self, image_id):
-        """
-        Convert an image id from the format of our ImageService strategy
-        to the Rackspace API format (an int).
-        """
-        strategy = self._service.__class__.__name__
-        return self._id_translator.to_rs_id(strategy, image_id)
-
-    def _from_rs_id(self, rs_image_id):
-        """
-        Convert an image id from the Rackspace API format (an int) to the
-        format of our ImageService strategy.
-        """
-        strategy = self._service.__class__.__name__
-        return self._id_translator.from_rs_id(strategy, rs_image_id)
+        self._service = nova.image.service.ImageService.load()
+        self._id_translator = _id_translator.RackspaceAPIIdTranslator(
+                "image", self._service.__class__.__name__)
 
     def index(self, req):
-        """Return all public images."""
+        """Return all public images in brief."""
+        return dict(images=[dict(id=img['id'], name=img['name'])
+                            for img in self.detail(req)['images']])
+
+    def detail(self, req):
+        """Return all public images in detail."""
         data = self._service.index()
         for img in data:
-            img['id'] = self._to_rs_id(img['id'])
+            img['id'] = self._id_translator.to_rs_id(img['id'])
         return dict(images=data)
 
     def show(self, req, id):
         """Return data about the given image id."""
-        opaque_id = self._from_rs_id(id)
+        opaque_id = self._id_translator.from_rs_id(id)
         img = self._service.show(opaque_id)
         img['id'] = id
         return dict(image=img)
@@ -78,40 +68,3 @@
         # Users may not modify public images, and that's all that 
         # we support for now.
         raise exc.HTTPNotFound()
-
-
-class RackspaceAPIImageIdTranslator(object):
-    """
-    Converts Rackspace API image ids to and from the id format for a given
-    strategy.
-    """
-
-    def __init__(self):
-        self._store = datastore.Redis.instance()
-        self._key_template = "rsapi.idstrategies.image.%s.%s"
-
-    def to_rs_id(self, strategy_name, opaque_id):
-        """Convert an id from a strategy-specific one to a Rackspace one."""
-        key = self._key_template % (strategy_name, "fwd")
-        result = self._store.hget(key, str(opaque_id))
-        if result: # we have a mapping from opaque to RS for this strategy
-            return int(result)
-        else:
-            # Store the mapping.
-            nextid = self._store.incr("%s.lastid" % key)
-            if self._store.hsetnx(key, str(opaque_id), nextid):
-                # If someone else didn't beat us to it, store the reverse
-                # mapping as well.
-                key = self._key_template % (strategy_name, "rev")
-                self._store.hset(key, nextid, str(opaque_id))
-                return nextid
-            else:
-                # Someone beat us to it; use their number instead, and
-                # discard nextid (which is OK -- we don't require that
-                # every int id be used.)
-                return int(self._store.hget(key, str(opaque_id)))
-
-    def from_rs_id(self, strategy_name, rs_id):
-        """Convert a Rackspace id to a strategy-specific one."""
-        key = self._key_template % (strategy_name, "rev")
-        return self._store.hget(key, rs_id)

=== modified file 'nova/compute/instance_types.py'
--- nova/compute/instance_types.py	2010-07-18 17:15:12 +0000
+++ nova/compute/instance_types.py	2010-08-25 21:50:55 +0000
@@ -21,10 +21,10 @@
 The built-in instance properties.
 """
 
-INSTANCE_TYPES = {}
-INSTANCE_TYPES['m1.tiny'] = {'memory_mb': 512, 'vcpus': 1, 'local_gb': 0}
-INSTANCE_TYPES['m1.small'] = {'memory_mb': 1024, 'vcpus': 1, 'local_gb': 10}
-INSTANCE_TYPES['m1.medium'] = {'memory_mb': 2048, 'vcpus': 2, 'local_gb': 10}
-INSTANCE_TYPES['m1.large'] = {'memory_mb': 4096, 'vcpus': 4, 'local_gb': 10}
-INSTANCE_TYPES['m1.xlarge'] = {'memory_mb': 8192, 'vcpus': 4, 'local_gb': 10}
-INSTANCE_TYPES['c1.medium'] = {'memory_mb': 2048, 'vcpus': 4, 'local_gb': 10}
+INSTANCE_TYPES = {
+    'm1.tiny': dict(memory_mb=512, vcpus=1, local_gb=0, flavorid=1),
+    'm1.small': dict(memory_mb=1024, vcpus=1, local_gb=10, flavorid=2),
+    'm1.medium': dict(memory_mb=2048, vcpus=2, local_gb=10, flavorid=3),
+    'm1.large': dict(memory_mb=4096, vcpus=4, local_gb=10, flavorid=4),
+    'm1.xlarge': dict(memory_mb=8192, vcpus=4, local_gb=10, flavorid=5),
+    'c1.medium': dict(memory_mb=2048, vcpus=4, local_gb=10, flavorid=6)}

=== added file 'nova/image/__init__.py'