bfca058af8
This patch proposes a default header to be injected when sending requests to a service. The header is added as the support to the micro-version specification from OpenStack API WorkingGroup [1]. We can use this 'api_version' property to track the micro-versions of service APIs we support in SDK. Users can optionally specify such an API version request as preferences in the 'Profile' object. [1] http://git.openstack.org/cgit/openstack/api-wg/tree/guidelines/microversion_specification.rst Change-Id: I421232a73de5dcc423a40acb79202a1f12bed430
121 lines
4.6 KiB
Python
121 lines
4.6 KiB
Python
# 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 keystoneauth1 import exceptions as _exceptions
|
|
|
|
from openstack import exceptions
|
|
from openstack.image import image_service
|
|
from openstack import profile
|
|
from openstack import session
|
|
|
|
|
|
class TestSession(testtools.TestCase):
|
|
|
|
def test_parse_url(self):
|
|
filt = image_service.ImageService()
|
|
self.assertEqual(
|
|
"http://127.0.0.1:9292/v1",
|
|
session.parse_url(filt, "http://127.0.0.1:9292"))
|
|
self.assertEqual(
|
|
"http://127.0.0.1:9292/foo/v1",
|
|
session.parse_url(filt, "http://127.0.0.1:9292/foo"))
|
|
self.assertEqual(
|
|
"http://127.0.0.1:9292/v2",
|
|
session.parse_url(filt, "http://127.0.0.1:9292/v2.0"))
|
|
filt.version = 'v1'
|
|
self.assertEqual(
|
|
"http://127.0.0.1:9292/v1/mytenant",
|
|
session.parse_url(filt, "http://127.0.0.1:9292/v2.0/mytenant/"))
|
|
self.assertEqual(
|
|
"http://127.0.0.1:9292/wot/v1/mytenant",
|
|
session.parse_url(filt, "http://127.0.0.1:9292/wot/v2.0/mytenant"))
|
|
|
|
def test_init_user_agent_none(self):
|
|
sot = session.Session(None)
|
|
self.assertTrue(sot.user_agent.startswith("openstacksdk"))
|
|
|
|
def test_init_user_agent_set(self):
|
|
sot = session.Session(None, user_agent="testing/123")
|
|
self.assertTrue(sot.user_agent.startswith("testing/123 openstacksdk"))
|
|
|
|
def test_init_with_single_api_request(self):
|
|
prof = profile.Profile()
|
|
prof.set_api_version('clustering', '1.2')
|
|
|
|
sot = session.Session(prof)
|
|
|
|
# The assertion acutally tests the property assigned in parent class
|
|
self.assertEqual({'openstack-api-version': 'clustering 1.2'},
|
|
sot.additional_headers)
|
|
|
|
def test_init_with_multi_api_requests(self):
|
|
prof = profile.Profile()
|
|
prof.set_api_version('clustering', '1.2')
|
|
prof.set_api_version('compute', '2.15')
|
|
|
|
sot = session.Session(prof)
|
|
|
|
versions = sot.additional_headers['openstack-api-version']
|
|
requests = [req.strip() for req in versions.split(',')]
|
|
self.assertIn('clustering 1.2', requests)
|
|
self.assertIn('compute 2.15', requests)
|
|
|
|
def test_init_with_no_api_requests(self):
|
|
prof = profile.Profile()
|
|
|
|
sot = session.Session(prof)
|
|
|
|
self.assertEqual({}, sot.additional_headers)
|
|
|
|
def test_map_exceptions_not_found_exception(self):
|
|
ksa_exc = _exceptions.HttpError(message="test", http_status=404)
|
|
func = mock.Mock(side_effect=ksa_exc)
|
|
|
|
os_exc = self.assertRaises(
|
|
exceptions.NotFoundException, session.map_exceptions(func))
|
|
self.assertIsInstance(os_exc, exceptions.NotFoundException)
|
|
self.assertEqual(ksa_exc.message, os_exc.message)
|
|
self.assertEqual(ksa_exc.http_status, os_exc.http_status)
|
|
self.assertEqual(ksa_exc, os_exc.cause)
|
|
|
|
def test_map_exceptions_http_exception(self):
|
|
ksa_exc = _exceptions.HttpError(message="test", http_status=400)
|
|
func = mock.Mock(side_effect=ksa_exc)
|
|
|
|
os_exc = self.assertRaises(
|
|
exceptions.HttpException, session.map_exceptions(func))
|
|
self.assertIsInstance(os_exc, exceptions.HttpException)
|
|
self.assertEqual(ksa_exc.message, os_exc.message)
|
|
self.assertEqual(ksa_exc.http_status, os_exc.http_status)
|
|
self.assertEqual(ksa_exc, os_exc.cause)
|
|
|
|
def test_map_exceptions_sdk_exception_1(self):
|
|
ksa_exc = _exceptions.ClientException()
|
|
func = mock.Mock(side_effect=ksa_exc)
|
|
|
|
os_exc = self.assertRaises(
|
|
exceptions.SDKException, session.map_exceptions(func))
|
|
self.assertIsInstance(os_exc, exceptions.SDKException)
|
|
self.assertEqual(ksa_exc, os_exc.cause)
|
|
|
|
def test_map_exceptions_sdk_exception_2(self):
|
|
ksa_exc = _exceptions.VersionNotAvailable()
|
|
func = mock.Mock(side_effect=ksa_exc)
|
|
|
|
os_exc = self.assertRaises(
|
|
exceptions.SDKException, session.map_exceptions(func))
|
|
self.assertIsInstance(os_exc, exceptions.SDKException)
|
|
self.assertEqual(ksa_exc, os_exc.cause)
|