identity version resource and version fixes

TerryHowe · TerryHowe · commit ef99720a8cd4 · 2014-11-23T07:34:41.000-07:00
Support for identity version and various version fixes:
* Added the notion of an unversioned service for a resource like the version
  resource.
* Changed all of the service filters so they could pass version through.
* Changed all the version resources to use unversioned services.

Change-Id: I92d6be9661560a8ced2648f1605fc3ffd8eeb91c
diff --git a/openstack/auth/service_catalog.py b/openstack/auth/service_catalog.py
@@ -95,8 +95,7 @@ def get_urls(self, filtration):
         urls = []
         for url, version in self._get_endpoints(filtration):
             if version:
-                if filtration.version:
-                    version = filtration.version
+                version = filtration.get_version(version)
                 url = url % {'version': version}
             urls.append(url)
         return urls
diff --git a/openstack/auth/service_filter.py b/openstack/auth/service_filter.py
@@ -67,6 +67,7 @@ def __init__(self, module, path=None):
 
 
 class ServiceFilter(object):
+    UNVERSIONED = ''
     ANY = 'any'
     PUBLIC = 'public'
     INTERNAL = 'internal'
@@ -112,11 +113,15 @@ def join(self, default):
         :param default: Default service identifier from the resource.
         :type default: :class:`~openstack.auth.service_filter.ServiceFilter`
         """
+        if default.version == self.UNVERSIONED:
+            version = default.version
+        else:
+            version = self.version
         return ServiceFilter(service_type=default.service_type,
                              visibility=self.visibility or default.visibility,
                              region=self.region,
                              service_name=self.service_name,
-                             version=self.version)
+                             version=version)
 
     def match_service_type(self, service_type):
         """Service types are equavilent."""
@@ -174,3 +179,12 @@ def get_service_module(self):
         is `object_store`.
         """
         return self.__class__.__module__.split('.')[1]
+
+    def get_version(self, version):
+        """Get the desired version.
+
+        If the service does not have a version, use the suggested version.
+        """
+        if self.version is None:
+            return version
+        return self.version
diff --git a/openstack/compute/compute_service.py b/openstack/compute/compute_service.py
@@ -18,6 +18,7 @@ class ComputeService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v2')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an compute service."""
-        super(ComputeService, self).__init__(service_type='compute')
+        super(ComputeService, self).__init__(service_type='compute',
+                                             version=version)
diff --git a/openstack/compute/version.py b/openstack/compute/version.py
@@ -18,7 +18,9 @@ class Version(resource.Resource):
     resource_key = 'version'
     resources_key = 'versions'
     base_path = '/'
-    service = compute_service.ComputeService()
+    service = compute_service.ComputeService(
+        version=compute_service.ComputeService.UNVERSIONED
+    )
 
     # capabilities
     allow_list = True
diff --git a/openstack/database/database_service.py b/openstack/database/database_service.py
@@ -18,6 +18,7 @@ class DatabaseService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v1')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an database service."""
-        super(DatabaseService, self).__init__(service_type='database')
+        super(DatabaseService, self).__init__(service_type='database',
+                                              version=version)
diff --git a/openstack/identity/version.py b/openstack/identity/version.py
@@ -0,0 +1,37 @@
+# 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.
+
+from openstack.identity import identity_service
+from openstack import resource
+
+
+class Version(resource.Resource):
+    resource_key = 'version'
+    resources_key = 'versions'
+    base_path = '/'
+    service = identity_service.IdentityService(
+        version=identity_service.IdentityService.UNVERSIONED
+    )
+
+    # capabilities
+    allow_list = True
+
+    # Properties
+    media_types = resource.prop('media-types')
+    status = resource.prop('status')
+    updated = resource.prop('updated')
+
+    @classmethod
+    def list(cls, session, **params):
+        resp = session.get(cls.base_path, service=cls.service, params=params)
+        for data in resp.body[cls.resources_key]['values']:
+            yield cls.existing(**data)
diff --git a/openstack/image/image_service.py b/openstack/image/image_service.py
@@ -21,6 +21,7 @@ class ImageService(service_filter.ServiceFilter):
         service_filter.ValidVersion('v2'),
     ]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an image service."""
-        super(ImageService, self).__init__(service_type='image')
+        super(ImageService, self).__init__(service_type='image',
+                                           version=version)
diff --git a/openstack/keystore/keystore_service.py b/openstack/keystore/keystore_service.py
@@ -18,6 +18,7 @@ class KeystoreService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v1')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an image service."""
-        super(KeystoreService, self).__init__(service_type='keystore')
+        super(KeystoreService, self).__init__(service_type='keystore',
+                                              version=version)
diff --git a/openstack/network/network_service.py b/openstack/network/network_service.py
@@ -18,6 +18,7 @@ class NetworkService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v2', 'v2.0')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an network service."""
-        super(NetworkService, self).__init__(service_type='network')
+        super(NetworkService, self).__init__(service_type='network',
+                                             version=version)
diff --git a/openstack/network/version.py b/openstack/network/version.py
@@ -18,7 +18,9 @@ class Version(resource.Resource):
     resource_key = 'version'
     resources_key = 'versions'
     base_path = '/'
-    service = network_service.NetworkService()
+    service = network_service.NetworkService(
+        version=network_service.NetworkService.UNVERSIONED
+    )
 
     # capabilities
     allow_list = True
diff --git a/openstack/object_store/object_store_service.py b/openstack/object_store/object_store_service.py
@@ -18,6 +18,7 @@ class ObjectStoreService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v1')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an object store service."""
-        super(ObjectStoreService, self).__init__(service_type='object-store')
+        super(ObjectStoreService, self).__init__(service_type='object-store',
+                                                 version=version)
diff --git a/openstack/orchestration/orchestration_service.py b/openstack/orchestration/orchestration_service.py
@@ -18,8 +18,9 @@ class OrchestrationService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v1')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create an orchestration service."""
         super(OrchestrationService, self).__init__(
-            service_type='orchestration'
+            service_type='orchestration',
+            version=version
         )
diff --git a/openstack/orchestration/version.py b/openstack/orchestration/version.py
@@ -18,7 +18,9 @@ class Version(resource.Resource):
     resource_key = 'version'
     resources_key = 'versions'
     base_path = '/'
-    service = orchestration_service.OrchestrationService()
+    service = orchestration_service.OrchestrationService(
+        version=orchestration_service.OrchestrationService.UNVERSIONED
+    )
 
     # capabilities
     allow_list = True
diff --git a/openstack/telemetry/telemetry_service.py b/openstack/telemetry/telemetry_service.py
@@ -18,6 +18,7 @@ class TelemetryService(service_filter.ServiceFilter):
 
     valid_versions = [service_filter.ValidVersion('v2')]
 
-    def __init__(self):
+    def __init__(self, version=None):
         """Create a telemetry service."""
-        super(TelemetryService, self).__init__(service_type='metering')
+        super(TelemetryService, self).__init__(service_type='metering',
+                                               version=version)
diff --git a/openstack/tests/auth/test_service_filter.py b/openstack/tests/auth/test_service_filter.py
@@ -117,6 +117,15 @@ def test_join_visibility(self):
         result = user_preference.join(service_default)
         self.assertEqual("admin", result.visibility)
 
+    def test_join_version(self):
+        user_preference = filt.ServiceFilter(version='v2')
+        service_default = filt.ServiceFilter()
+        self.assertEqual('v2', user_preference.join(service_default).version)
+        service_default = filt.ServiceFilter(
+            version=filt.ServiceFilter.UNVERSIONED
+        )
+        self.assertEqual('', user_preference.join(service_default).version)
+
     def test_set_visibility(self):
         sot = filt.ServiceFilter()
         sot.set_visibility("PUBLICURL")
@@ -131,6 +140,16 @@ def test_get_module(self):
         self.assertEqual('openstack.identity.v3', sot.get_module())
         self.assertEqual('identity', sot.get_service_module())
 
+    def test_get_version(self):
+        sot = identity_service.IdentityService()
+        self.assertEqual('v3', sot.get_version('v3'))
+        sot = identity_service.IdentityService(
+            version=identity_service.IdentityService.UNVERSIONED
+        )
+        self.assertEqual('', sot.get_version('v3'))
+        sot = identity_service.IdentityService(version='v2')
+        self.assertEqual('v2', sot.get_version('v3'))
+
 
 class TestValidVersion(testtools.TestCase):
     def test_constructor(self):
diff --git a/openstack/tests/identity/test_version.py b/openstack/tests/identity/test_version.py
@@ -0,0 +1,65 @@
+# 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 mock
+import testtools
+
+from openstack.identity import version
+
+IDENTIFIER = 'IDENTIFIER'
+EXAMPLE = {
+    'id': IDENTIFIER,
+    'media-types': '2',
+    'status': '3',
+    'updated': '4',
+}
+
+
+class TestVersion(testtools.TestCase):
+
+    def test_basic(self):
+        sot = version.Version()
+        self.assertEqual('version', sot.resource_key)
+        self.assertEqual('versions', sot.resources_key)
+        self.assertEqual('/', sot.base_path)
+        self.assertEqual('identity', sot.service.service_type)
+        self.assertFalse(sot.allow_create)
+        self.assertFalse(sot.allow_retrieve)
+        self.assertFalse(sot.allow_update)
+        self.assertFalse(sot.allow_delete)
+        self.assertTrue(sot.allow_list)
+
+    def test_make_it(self):
+        sot = version.Version(EXAMPLE)
+        self.assertEqual(EXAMPLE['id'], sot.id)
+        self.assertEqual(EXAMPLE['media-types'], sot.media_types)
+        self.assertEqual(EXAMPLE['status'], sot.status)
+        self.assertEqual(EXAMPLE['updated'], sot.updated)
+
+    def test_list(self):
+        resp = mock.MagicMock()
+        resp.body = {
+            "versions": {
+                "values": [
+                    {"status": "stable", "updated": "a", "id": "v1.0"},
+                    {"status": "stable", "updated": "b", "id": "v1.1"},
+                ]
+            }
+        }
+        session = mock.MagicMock()
+        session.get = mock.MagicMock()
+        session.get.return_value = resp
+        sot = version.Version(EXAMPLE)
+        result = sot.list(session)
+        self.assertEqual(next(result)['id'], 'v1.0')
+        self.assertEqual(next(result)['id'], 'v1.1')
+        self.assertRaises(StopIteration, next, result)

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ class ImageService(service_filter.ServiceFilter):`
`21`	`21`	`service_filter.ValidVersion('v2'),`
`22`	`22`	`]`
`23`	`23`
`24`		`- def __init__(self):`
	`24`	`+ def __init__(self, version=None):`
`25`	`25`	`"""Create an image service."""`
`26`		`- super(ImageService, self).__init__(service_type='image')`
	`26`	`+ super(ImageService, self).__init__(service_type='image',`
	`27`	`+ version=version)`