8377fb9e18
Since the APIVersionManager stored the version numbers as ints and floats, it was not possible to distinguish between version 1.2 and 1.20, and also version 1.2 would be considered higher than version 1.13. With the introduction of microversioning in some services, the version numbers inflate quickly, making this a problem. This patch wraps the version numbers in a Version object, that stores the information as a semantic_version and correctly compares with other Version objects, as well as ints, floats and strings. It also removes the check for version being specified as a string, so that it's possible to specify versions such as 1.20 without having to explicitly create Version objects. Change-Id: I0b0d87582d617290f08359ad181216cb99edb768 Closes-Bug: #1649819
333 lines
12 KiB
Python
333 lines
12 KiB
Python
# Copyright 2012 United States Government as represented by the
|
|
# Administrator of the National Aeronautics and Space Administration.
|
|
# All Rights Reserved.
|
|
#
|
|
# Copyright 2012 Nebula, Inc.
|
|
#
|
|
# 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 __future__ import absolute_import
|
|
|
|
from django.conf import settings
|
|
|
|
from horizon import exceptions
|
|
|
|
from openstack_dashboard.api import base as api_base
|
|
from openstack_dashboard.api import cinder
|
|
from openstack_dashboard.api import glance
|
|
from openstack_dashboard.api import keystone
|
|
from openstack_dashboard.test import helpers as test
|
|
|
|
|
|
class APIResource(api_base.APIResourceWrapper):
|
|
"""Simple APIResource for testing."""
|
|
_attrs = ['foo', 'bar', 'baz']
|
|
|
|
@staticmethod
|
|
def get_instance(innerObject=None):
|
|
if innerObject is None:
|
|
|
|
class InnerAPIResource(object):
|
|
pass
|
|
|
|
innerObject = InnerAPIResource()
|
|
innerObject.foo = 'foo'
|
|
innerObject.bar = 'bar'
|
|
return APIResource(innerObject)
|
|
|
|
|
|
class APIDict(api_base.APIDictWrapper):
|
|
"""Simple APIDict for testing."""
|
|
_attrs = ['foo', 'bar', 'baz']
|
|
|
|
@staticmethod
|
|
def get_instance(innerDict=None):
|
|
if innerDict is None:
|
|
innerDict = {'foo': 'foo',
|
|
'bar': 'bar'}
|
|
return APIDict(innerDict)
|
|
|
|
|
|
class APIVersionTests(test.TestCase):
|
|
def test_equal(self):
|
|
version = api_base.Version('1.0')
|
|
self.assertEqual(1, version)
|
|
self.assertEqual(1.0, version)
|
|
self.assertEqual('1', version)
|
|
self.assertEqual('1.0', version)
|
|
version = api_base.Version(1)
|
|
self.assertEqual(1, version)
|
|
self.assertEqual(1.0, version)
|
|
self.assertEqual('1', version)
|
|
self.assertEqual('1.0', version)
|
|
version = api_base.Version(1.0)
|
|
self.assertEqual(1, version)
|
|
self.assertEqual(1.0, version)
|
|
self.assertEqual('1', version)
|
|
self.assertEqual('1.0', version)
|
|
version = api_base.Version('1.0')
|
|
self.assertEqual(api_base.Version(1), version)
|
|
self.assertEqual(api_base.Version(1.0), version)
|
|
self.assertEqual(api_base.Version('1'), version)
|
|
self.assertEqual(api_base.Version('1.0'), version)
|
|
|
|
def test_greater(self):
|
|
version1 = api_base.Version('1.0')
|
|
version12 = api_base.Version('1.2')
|
|
version120 = api_base.Version('1.20')
|
|
self.assertGreater(version12, version1)
|
|
self.assertGreater(version120, version12)
|
|
self.assertEqual(version12, 1) # sic!
|
|
self.assertGreater(1.2, version1)
|
|
self.assertGreater(version120, 1.2)
|
|
self.assertGreater('1.20', version12)
|
|
|
|
def test_dict(self):
|
|
version1 = api_base.Version('1.0')
|
|
version1b = api_base.Version('1.0')
|
|
self.assertIn(version1, {version1b: 1})
|
|
|
|
def test_text(self):
|
|
version1 = api_base.Version('1.0')
|
|
self.assertEqual("1.0", str(version1))
|
|
self.assertEqual("Version('1.0')", repr(version1))
|
|
|
|
|
|
# Wrapper classes that only define _attrs don't need extra testing.
|
|
class APIResourceWrapperTests(test.TestCase):
|
|
def test_get_attribute(self):
|
|
resource = APIResource.get_instance()
|
|
self.assertEqual('foo', resource.foo)
|
|
|
|
def test_get_invalid_attribute(self):
|
|
resource = APIResource.get_instance()
|
|
self.assertNotIn(
|
|
'missing', resource._attrs,
|
|
msg="Test assumption broken. Find new missing attribute")
|
|
with self.assertRaises(AttributeError):
|
|
resource.missing
|
|
|
|
def test_get_inner_missing_attribute(self):
|
|
resource = APIResource.get_instance()
|
|
with self.assertRaises(AttributeError):
|
|
resource.baz
|
|
|
|
def test_repr(self):
|
|
resource = APIResource.get_instance()
|
|
resource_str = resource.__repr__()
|
|
self.assertIn('foo', resource_str)
|
|
self.assertIn('bar', resource_str)
|
|
self.assertNotIn('baz', resource_str)
|
|
|
|
|
|
class APIDictWrapperTests(test.TestCase):
|
|
# APIDict allows for both attribute access and dictionary style [element]
|
|
# style access. Test both
|
|
def test_get_item(self):
|
|
resource = APIDict.get_instance()
|
|
self.assertEqual('foo', resource.foo)
|
|
self.assertEqual('foo', resource['foo'])
|
|
|
|
def test_get_invalid_item(self):
|
|
resource = APIDict.get_instance()
|
|
self.assertNotIn(
|
|
'missing', resource._attrs,
|
|
msg="Test assumption broken. Find new missing attribute")
|
|
with self.assertRaises(AttributeError):
|
|
resource.missing
|
|
with self.assertRaises(KeyError):
|
|
resource['missing']
|
|
|
|
def test_get_inner_missing_attribute(self):
|
|
resource = APIDict.get_instance()
|
|
with self.assertRaises(AttributeError):
|
|
resource.baz
|
|
with self.assertRaises(KeyError):
|
|
resource['baz']
|
|
|
|
def test_get_with_default(self):
|
|
resource = APIDict.get_instance()
|
|
|
|
self.assertEqual('foo', resource.get('foo'))
|
|
|
|
self.assertIsNone(resource.get('baz'))
|
|
|
|
self.assertEqual('retValue', resource.get('baz', 'retValue'))
|
|
|
|
def test_get_with_non_str(self):
|
|
resource = APIDict.get_instance()
|
|
self.assertNotIn(0, resource._attrs,
|
|
msg="Test assumption broken. "
|
|
"Find new missing attribute.")
|
|
self.assertIsNone(resource.get(0))
|
|
self.assertEqual('retValue', resource.get(0, 'retValue'))
|
|
|
|
def test_get_item_non_str(self):
|
|
resource = APIDict.get_instance()
|
|
self.assertNotIn(0, resource._attrs,
|
|
msg="Test assumption broken. "
|
|
"Find new missing attribute.")
|
|
with self.assertRaises(KeyError):
|
|
resource[0]
|
|
|
|
def test_in_not_there_str(self):
|
|
resource = APIDict.get_instance()
|
|
self.assertNotIn('missing', resource._attrs,
|
|
msg="Test assumption broken. "
|
|
"Find new missing attribute.")
|
|
# We're primarily interested in this test NOT raising a TypeError.
|
|
self.assertFalse('missing' in resource)
|
|
|
|
def test_in_not_there_non_str(self):
|
|
resource = APIDict.get_instance()
|
|
self.assertNotIn(0, resource._attrs,
|
|
msg="Test assumption broken. "
|
|
"Find new missing attribute.")
|
|
# We're primarily interested in this test NOT raising a TypeError.
|
|
self.assertFalse(0 in resource)
|
|
|
|
|
|
class ApiVersionTests(test.TestCase):
|
|
def setUp(self):
|
|
super(ApiVersionTests, self).setUp()
|
|
self.previous_settings = settings.OPENSTACK_API_VERSIONS
|
|
settings.OPENSTACK_API_VERSIONS = {
|
|
"data-processing": 1.1,
|
|
"identity": "2.0",
|
|
"volume": 1
|
|
}
|
|
# Make sure cached data from other tests doesn't interfere
|
|
cinder.VERSIONS.clear_active_cache()
|
|
keystone.VERSIONS.clear_active_cache()
|
|
glance.VERSIONS.clear_active_cache()
|
|
|
|
def tearDown(self):
|
|
super(ApiVersionTests, self).tearDown()
|
|
settings.OPENSTACK_API_VERSIONS = self.previous_settings
|
|
# Clear out our bogus data so it doesn't interfere
|
|
cinder.VERSIONS.clear_active_cache()
|
|
keystone.VERSIONS.clear_active_cache()
|
|
glance.VERSIONS.clear_active_cache()
|
|
|
|
def test_invalid_versions(self):
|
|
try:
|
|
getattr(keystone.VERSIONS, 'active')
|
|
except exceptions.ConfigurationError:
|
|
self.fail("ConfigurationError raised inappropriately.")
|
|
with self.assertRaises(exceptions.ConfigurationError):
|
|
getattr(cinder.VERSIONS, 'active')
|
|
try:
|
|
getattr(glance.VERSIONS, 'active')
|
|
except exceptions.ConfigurationError:
|
|
self.fail("ConfigurationError raised inappropriately.")
|
|
|
|
|
|
class ApiHelperTests(test.TestCase):
|
|
"""Tests for functions that don't use one of the api objects."""
|
|
|
|
def test_url_for(self):
|
|
url = api_base.url_for(self.request, 'image')
|
|
self.assertEqual('http://public.glance.example.com:9292', url)
|
|
|
|
url = api_base.url_for(self.request, 'image', endpoint_type='adminURL')
|
|
self.assertEqual('http://admin.glance.example.com:9292', url)
|
|
|
|
url = api_base.url_for(self.request, 'compute')
|
|
self.assertEqual('http://public.nova.example.com:8774/v2', url)
|
|
|
|
url = api_base.url_for(self.request, 'compute',
|
|
endpoint_type='adminURL')
|
|
self.assertEqual('http://admin.nova.example.com:8774/v2', url)
|
|
|
|
url = api_base.url_for(self.request, 'volumev2')
|
|
self.assertEqual('http://public.nova.example.com:8776/v2', url)
|
|
|
|
url = api_base.url_for(self.request, 'volumev2',
|
|
endpoint_type="internalURL")
|
|
self.assertEqual('http://int.nova.example.com:8776/v2', url)
|
|
|
|
url = api_base.url_for(self.request, 'volumev2',
|
|
endpoint_type='adminURL')
|
|
self.assertEqual('http://admin.nova.example.com:8776/v2', url)
|
|
|
|
self.assertNotIn('notAnApi', self.request.user.service_catalog,
|
|
'Select a new nonexistent service catalog key')
|
|
with self.assertRaises(exceptions.ServiceCatalogException):
|
|
url = api_base.url_for(self.request, 'notAnApi')
|
|
|
|
self.request.user.services_region = "RegionTwo"
|
|
url = api_base.url_for(self.request, 'compute')
|
|
self.assertEqual('http://public.nova2.example.com:8774/v2', url)
|
|
|
|
self.request.user.services_region = "RegionTwo"
|
|
url = api_base.url_for(self.request, 'compute',
|
|
endpoint_type='adminURL')
|
|
self.assertEqual('http://admin.nova2.example.com:8774/v2', url)
|
|
|
|
self.request.user.services_region = "RegionTwo"
|
|
with self.assertRaises(exceptions.ServiceCatalogException):
|
|
url = api_base.url_for(self.request, 'image')
|
|
|
|
self.request.user.services_region = "bogus_value"
|
|
url = api_base.url_for(self.request, 'identity',
|
|
endpoint_type='adminURL')
|
|
self.assertEqual('http://admin.keystone.example.com:35357/v2.0', url)
|
|
|
|
self.request.user.services_region = "bogus_value"
|
|
with self.assertRaises(exceptions.ServiceCatalogException):
|
|
url = api_base.url_for(self.request, 'image')
|
|
|
|
|
|
class QuotaSetTests(test.TestCase):
|
|
|
|
def test_quotaset_add_with_plus(self):
|
|
quota_dict = {'foo': 1, 'bar': 10}
|
|
other_quota_dict = {'my_test': 12}
|
|
quota_set = api_base.QuotaSet(quota_dict)
|
|
other_quota_set = api_base.QuotaSet(other_quota_dict)
|
|
|
|
quota_set += other_quota_set
|
|
self.assertEqual(3, len(quota_set))
|
|
|
|
quota_dict.update(other_quota_dict)
|
|
for q in quota_set:
|
|
self.assertEqual(quota_dict[q.name], q.limit)
|
|
|
|
def test_quotaset_add_doesnt_override_existing_quota(self):
|
|
quota_dict = {'foo': 1, 'bar': 10}
|
|
quota_set = api_base.QuotaSet(quota_dict)
|
|
other_quota_set = api_base.QuotaSet({'foo': 12})
|
|
|
|
quota_set += other_quota_set
|
|
self.assertEqual(2, len(quota_set))
|
|
|
|
for q in quota_set:
|
|
self.assertEqual(quota_dict[q.name], q.limit)
|
|
|
|
def test_quotaset_add_method(self):
|
|
quota_dict = {'foo': 1, 'bar': 10}
|
|
other_quota_dict = {'my_test': 12}
|
|
quota_set = api_base.QuotaSet(quota_dict)
|
|
other_quota_set = api_base.QuotaSet(other_quota_dict)
|
|
|
|
quota_set.add(other_quota_set)
|
|
self.assertEqual(3, len(quota_set))
|
|
|
|
quota_dict.update(other_quota_dict)
|
|
for q in quota_set:
|
|
self.assertEqual(quota_dict[q.name], q.limit)
|
|
|
|
def test_quotaset_add_with_wrong_type(self):
|
|
quota_set = api_base.QuotaSet({'foo': 1, 'bar': 10})
|
|
self.assertRaises(ValueError, quota_set.add, {'test': 7})
|