From 2189e5702b7ba91a87e1db21024799e1520d8ad0 Mon Sep 17 00:00:00 2001
From: Sean McGinnis <sean.mcginnis@gmail.com>
Date: Wed, 17 Apr 2019 13:42:44 -0500
Subject: [PATCH] Drop support for Cinder v1 API
This drops compatibility with Cinder services with the V1 API.
Change-Id: Ic7c6bd05a3991c3afce3dec80b29501932c5aac9
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
---
cinderclient/api_versions.py | 2 +-
cinderclient/client.py | 23 +-
.../tests/unit/fixture_data/client.py | 16 -
cinderclient/tests/unit/test_base.py | 2 +-
cinderclient/tests/unit/test_client.py | 8 -
cinderclient/tests/unit/v1/__init__.py | 0
.../tests/unit/v1/contrib/__init__.py | 0
.../unit/v1/contrib/test_list_extensions.py | 34 -
cinderclient/tests/unit/v1/fakes.py | 800 ---------
cinderclient/tests/unit/v1/test_auth.py | 339 ----
.../tests/unit/v1/test_availability_zone.py | 89 -
cinderclient/tests/unit/v1/test_limits.py | 164 --
cinderclient/tests/unit/v1/test_qos.py | 79 -
.../tests/unit/v1/test_quota_classes.py | 59 -
cinderclient/tests/unit/v1/test_quotas.py | 62 -
cinderclient/tests/unit/v1/test_services.py | 91 --
cinderclient/tests/unit/v1/test_shell.py | 495 ------
.../tests/unit/v1/test_snapshot_actions.py | 36 -
cinderclient/tests/unit/v1/test_types.py | 54 -
.../tests/unit/v1/test_volume_backups.py | 53 -
.../unit/v1/test_volume_encryption_types.py | 119 --
.../tests/unit/v1/test_volume_transfers.py | 51 -
cinderclient/tests/unit/v1/test_volumes.py | 118 --
cinderclient/tests/unit/v1/testfile.txt | 1 -
.../unit/v2/contrib/test_list_extensions.py | 2 +-
cinderclient/tests/unit/v3/fakes.py | 32 +-
cinderclient/v1/__init__.py | 17 -
cinderclient/v1/availability_zones.py | 42 -
cinderclient/v1/client.py | 123 --
cinderclient/v1/contrib/__init__.py | 0
cinderclient/v1/contrib/list_extensions.py | 46 -
cinderclient/v1/limits.py | 92 --
cinderclient/v1/qos_specs.py | 149 --
cinderclient/v1/quota_classes.py | 47 -
cinderclient/v1/quotas.py | 57 -
cinderclient/v1/services.py | 64 -
cinderclient/v1/shell.py | 1436 -----------------
cinderclient/v1/volume_backups.py | 78 -
cinderclient/v1/volume_backups_restore.py | 43 -
cinderclient/v1/volume_encryption_types.py | 98 --
cinderclient/v1/volume_snapshots.py | 183 ---
cinderclient/v1/volume_transfers.py | 88 -
cinderclient/v1/volume_types.py | 118 --
cinderclient/v1/volumes.py | 428 -----
.../cinderclient-5-de0508ce5a221d21.yaml | 5 +
45 files changed, 24 insertions(+), 5819 deletions(-)
delete mode 100644 cinderclient/tests/unit/v1/__init__.py
delete mode 100644 cinderclient/tests/unit/v1/contrib/__init__.py
delete mode 100644 cinderclient/tests/unit/v1/contrib/test_list_extensions.py
delete mode 100644 cinderclient/tests/unit/v1/fakes.py
delete mode 100644 cinderclient/tests/unit/v1/test_auth.py
delete mode 100644 cinderclient/tests/unit/v1/test_availability_zone.py
delete mode 100644 cinderclient/tests/unit/v1/test_limits.py
delete mode 100644 cinderclient/tests/unit/v1/test_qos.py
delete mode 100644 cinderclient/tests/unit/v1/test_quota_classes.py
delete mode 100644 cinderclient/tests/unit/v1/test_quotas.py
delete mode 100644 cinderclient/tests/unit/v1/test_services.py
delete mode 100644 cinderclient/tests/unit/v1/test_shell.py
delete mode 100644 cinderclient/tests/unit/v1/test_snapshot_actions.py
delete mode 100644 cinderclient/tests/unit/v1/test_types.py
delete mode 100644 cinderclient/tests/unit/v1/test_volume_backups.py
delete mode 100644 cinderclient/tests/unit/v1/test_volume_encryption_types.py
delete mode 100644 cinderclient/tests/unit/v1/test_volume_transfers.py
delete mode 100644 cinderclient/tests/unit/v1/test_volumes.py
delete mode 100644 cinderclient/tests/unit/v1/testfile.txt
delete mode 100644 cinderclient/v1/__init__.py
delete mode 100644 cinderclient/v1/availability_zones.py
delete mode 100644 cinderclient/v1/client.py
delete mode 100644 cinderclient/v1/contrib/__init__.py
delete mode 100644 cinderclient/v1/contrib/list_extensions.py
delete mode 100644 cinderclient/v1/limits.py
delete mode 100644 cinderclient/v1/qos_specs.py
delete mode 100644 cinderclient/v1/quota_classes.py
delete mode 100644 cinderclient/v1/quotas.py
delete mode 100644 cinderclient/v1/services.py
delete mode 100644 cinderclient/v1/shell.py
delete mode 100644 cinderclient/v1/volume_backups.py
delete mode 100644 cinderclient/v1/volume_backups_restore.py
delete mode 100644 cinderclient/v1/volume_encryption_types.py
delete mode 100644 cinderclient/v1/volume_snapshots.py
delete mode 100644 cinderclient/v1/volume_transfers.py
delete mode 100644 cinderclient/v1/volume_types.py
delete mode 100644 cinderclient/v1/volumes.py
diff --git a/cinderclient/api_versions.py b/cinderclient/api_versions.py
index 0fcb20839..f9e20f6fb 100644
--- a/cinderclient/api_versions.py
+++ b/cinderclient/api_versions.py
@@ -27,7 +27,7 @@ LOG = logging.getLogger(__name__)
# key is a deprecated version and value is an alternative version.
-DEPRECATED_VERSIONS = {"1": "2"}
+DEPRECATED_VERSIONS = {"2": "3"}
DEPRECATED_VERSION = "2.0"
MAX_VERSION = "3.52"
MIN_VERSION = "3.0"
diff --git a/cinderclient/client.py b/cinderclient/client.py
index 2ae122cc0..687533eb0 100644
--- a/cinderclient/client.py
+++ b/cinderclient/client.py
@@ -57,12 +57,10 @@ try:
except ImportError:
import simplejson as json
-_VALID_VERSIONS = ['v1', 'v2', 'v3']
+_VALID_VERSIONS = ['v2', 'v3']
V3_SERVICE_TYPE = 'volumev3'
V2_SERVICE_TYPE = 'volumev2'
-V1_SERVICE_TYPE = 'volume'
-SERVICE_TYPES = {'1': V1_SERVICE_TYPE,
- '2': V2_SERVICE_TYPE,
+SERVICE_TYPES = {'2': V2_SERVICE_TYPE,
'3': V3_SERVICE_TYPE}
REQ_ID_HEADER = 'X-OpenStack-Request-ID'
@@ -89,11 +87,11 @@ def get_server_version(url):
# NOTE(andreykurilin): endpoint URL has at least 2 formats:
# 1. The classic (legacy) endpoint:
- # http://{host}:{optional_port}/v{1 or 2 or 3}/{project-id}
- # http://{host}:{optional_port}/v{1 or 2 or 3}
+ # http://{host}:{optional_port}/v{2 or 3}/{project-id}
+ # http://{host}:{optional_port}/v{2 or 3}
# 3. Under wsgi:
- # http://{host}:{optional_port}/volume/v{1 or 2 or 3}
- for ver in ['v1', 'v2', 'v3']:
+ # http://{host}:{optional_port}/volume/v{2 or 3}
+ for ver in ['v2', 'v3']:
if u.path.endswith(ver) or "/{0}/".format(ver) in u.path:
path = u.path[:u.path.rfind(ver)]
version_url = '%s://%s%s' % (u.scheme, u.netloc, path)
@@ -114,6 +112,11 @@ def get_server_version(url):
min_version = version['min_version']
current_version = version['version']
break
+ else:
+ # Set the values, but don't break out the loop here in case v3
+ # comes later
+ min_version = '2.0'
+ current_version = '2.0'
except exceptions.ClientException as e:
logger.warning("Error in server version query:%s\n"
"Returning APIVersion 2.0", six.text_type(e.message))
@@ -740,7 +743,6 @@ def _get_client_class_and_version(version):
def get_client_class(version):
version_map = {
- '1': 'cinderclient.v1.client.Client',
'2': 'cinderclient.v2.client.Client',
'3': 'cinderclient.v3.client.Client',
}
@@ -808,8 +810,7 @@ def Client(version, *args, **kwargs):
Here ``VERSION`` can be a string or
``cinderclient.api_versions.APIVersion`` obj. If you prefer string value,
- you can use ``1`` (deprecated now), ``2``, or ``3.X``
- (where X is a microversion).
+ you can use ``2`` (deprecated now) or ``3.X`` (where X is a microversion).
Alternatively, you can create a client instance using the keystoneclient
diff --git a/cinderclient/tests/unit/fixture_data/client.py b/cinderclient/tests/unit/fixture_data/client.py
index 9fd35dc31..4a30f70b3 100644
--- a/cinderclient/tests/unit/fixture_data/client.py
+++ b/cinderclient/tests/unit/fixture_data/client.py
@@ -13,7 +13,6 @@
from keystoneauth1 import fixture
from cinderclient.tests.unit.fixture_data import base
-from cinderclient.v1 import client as v1client
from cinderclient.v2 import client as v2client
@@ -34,21 +33,6 @@ class Base(base.Fixture):
headers=self.json_headers)
-class V1(Base):
-
- def __init__(self, *args, **kwargs):
- super(V1, self).__init__(*args, **kwargs)
-
- svc = self.token.add_service('volume')
- svc.add_endpoint(self.volume_url)
-
- def new_client(self):
- return v1client.Client(username='xx',
- api_key='xx',
- project_id='xx',
- auth_url=self.identity_url)
-
-
class V2(Base):
def __init__(self, *args, **kwargs):
diff --git a/cinderclient/tests/unit/test_base.py b/cinderclient/tests/unit/test_base.py
index 99bb29ea5..63c569b7a 100644
--- a/cinderclient/tests/unit/test_base.py
+++ b/cinderclient/tests/unit/test_base.py
@@ -25,7 +25,7 @@ from cinderclient.v3 import volumes
from cinderclient.tests.unit import test_utils
from cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
+from cinderclient.tests.unit.v2 import fakes
cs = fakes.FakeClient()
diff --git a/cinderclient/tests/unit/test_client.py b/cinderclient/tests/unit/test_client.py
index 7fc6643c8..d83768f26 100644
--- a/cinderclient/tests/unit/test_client.py
+++ b/cinderclient/tests/unit/test_client.py
@@ -25,7 +25,6 @@ import six
from cinderclient import api_versions
import cinderclient.client
from cinderclient import exceptions
-import cinderclient.v1.client
import cinderclient.v2.client
from cinderclient.tests.unit import utils
@@ -35,10 +34,6 @@ from cinderclient.tests.unit.v3 import fakes
@ddt.ddt
class ClientTest(utils.TestCase):
- def test_get_client_class_v1(self):
- output = cinderclient.client.get_client_class('1')
- self.assertEqual(cinderclient.v1.client.Client, output)
-
def test_get_client_class_v2(self):
output = cinderclient.client.get_client_class('2')
self.assertEqual(cinderclient.v2.client.Client, output)
@@ -87,12 +82,9 @@ class ClientTest(utils.TestCase):
self.assertIn("fakeUser", output[1])
def test_versions(self):
- v1_url = 'http://fakeurl/v1/tenants'
v2_url = 'http://fakeurl/v2/tenants'
unknown_url = 'http://fakeurl/v9/tenants'
- self.assertEqual('1',
- cinderclient.client.get_volume_api_from_url(v1_url))
self.assertEqual('2',
cinderclient.client.get_volume_api_from_url(v2_url))
self.assertRaises(cinderclient.exceptions.UnsupportedVersion,
diff --git a/cinderclient/tests/unit/v1/__init__.py b/cinderclient/tests/unit/v1/__init__.py
deleted file mode 100644
index e69de29bb..000000000
diff --git a/cinderclient/tests/unit/v1/contrib/__init__.py b/cinderclient/tests/unit/v1/contrib/__init__.py
deleted file mode 100644
index e69de29bb..000000000
diff --git a/cinderclient/tests/unit/v1/contrib/test_list_extensions.py b/cinderclient/tests/unit/v1/contrib/test_list_extensions.py
deleted file mode 100644
index 25c90522d..000000000
--- a/cinderclient/tests/unit/v1/contrib/test_list_extensions.py
+++ /dev/null
@@ -1,34 +0,0 @@
-# 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 cinderclient import extension
-from cinderclient.v1.contrib import list_extensions
-
-from cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-extensions = [
- extension.Extension(list_extensions.__name__.split(".")[-1],
- list_extensions),
-]
-cs = fakes.FakeClient(extensions=extensions)
-
-
-class ListExtensionsTests(utils.TestCase):
- def test_list_extensions(self):
- all_exts = cs.list_extensions.show_all()
- cs.assert_called('GET', '/extensions')
- self.assertGreater(len(all_exts), 0)
- for r in all_exts:
- self.assertGreater(len(r.summary), 0)
diff --git a/cinderclient/tests/unit/v1/fakes.py b/cinderclient/tests/unit/v1/fakes.py
deleted file mode 100644
index 59be02184..000000000
--- a/cinderclient/tests/unit/v1/fakes.py
+++ /dev/null
@@ -1,800 +0,0 @@
-# Copyright (c) 2011 X.commerce, a business unit of eBay Inc.
-# Copyright (c) 2011 OpenStack Foundation
-#
-# 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 datetime import datetime
-
-import six.moves.urllib.parse as urlparse
-
-from cinderclient import client as base_client
-from cinderclient.tests.unit import fakes
-import cinderclient.tests.unit.utils as utils
-from cinderclient.v1 import client
-
-
-def _stub_volume(**kwargs):
- volume = {
- 'id': '00000000-0000-0000-0000-000000000000',
- 'display_name': None,
- 'display_description': None,
- "attachments": [],
- "bootable": "false",
- "availability_zone": "cinder",
- "created_at": "2012-08-27T00:00:00.000000",
- "metadata": {},
- "size": 1,
- "snapshot_id": None,
- "status": "available",
- "volume_type": "None",
- }
- volume.update(kwargs)
- return volume
-
-
-def _stub_snapshot(**kwargs):
- snapshot = {
- "created_at": "2012-08-28T16:30:31.000000",
- "display_description": None,
- "display_name": None,
- "id": '11111111-1111-1111-1111-111111111111',
- "size": 1,
- "status": "available",
- "volume_id": '00000000-0000-0000-0000-000000000000',
- }
- snapshot.update(kwargs)
- return snapshot
-
-
-def _self_href(base_uri, tenant_id, backup_id):
- return '%s/v1/%s/backups/%s' % (base_uri, tenant_id, backup_id)
-
-
-def _bookmark_href(base_uri, tenant_id, backup_id):
- return '%s/%s/backups/%s' % (base_uri, tenant_id, backup_id)
-
-
-def _stub_backup_full(id, base_uri, tenant_id):
- return {
- 'id': id,
- 'name': 'backup',
- 'description': 'nightly backup',
- 'volume_id': '712f4980-5ac1-41e5-9383-390aa7c9f58b',
- 'container': 'volumebackups',
- 'object_count': 220,
- 'size': 10,
- 'availability_zone': 'az1',
- 'created_at': '2013-04-12T08:16:37.000000',
- 'status': 'available',
- 'links': [
- {
- 'href': _self_href(base_uri, tenant_id, id),
- 'rel': 'self'
- },
- {
- 'href': _bookmark_href(base_uri, tenant_id, id),
- 'rel': 'bookmark'
- }
- ]
- }
-
-
-def _stub_backup(id, base_uri, tenant_id):
- return {
- 'id': id,
- 'name': 'backup',
- 'links': [
- {
- 'href': _self_href(base_uri, tenant_id, id),
- 'rel': 'self'
- },
- {
- 'href': _bookmark_href(base_uri, tenant_id, id),
- 'rel': 'bookmark'
- }
- ]
- }
-
-
-def _stub_restore():
- return {'volume_id': '712f4980-5ac1-41e5-9383-390aa7c9f58b'}
-
-
-def _stub_qos_full(id, base_uri, tenant_id, name=None, specs=None):
- if not name:
- name = 'fake-name'
- if not specs:
- specs = {}
-
- return {
- 'qos_specs': {
- 'id': id,
- 'name': name,
- 'consumer': 'back-end',
- 'specs': specs,
- },
- 'links': {
- 'href': _bookmark_href(base_uri, tenant_id, id),
- 'rel': 'bookmark'
- }
- }
-
-
-def _stub_qos_associates(id, name):
- return {
- 'assoications_type': 'volume_type',
- 'name': name,
- 'id': id,
- }
-
-
-def _stub_transfer_full(id, base_uri, tenant_id):
- return {
- 'id': id,
- 'name': 'transfer',
- 'volume_id': '8c05f861-6052-4df6-b3e0-0aebfbe686cc',
- 'created_at': '2013-04-12T08:16:37.000000',
- 'auth_key': '123456',
- 'links': [
- {
- 'href': _self_href(base_uri, tenant_id, id),
- 'rel': 'self'
- },
- {
- 'href': _bookmark_href(base_uri, tenant_id, id),
- 'rel': 'bookmark'
- }
- ]
- }
-
-
-def _stub_transfer(id, base_uri, tenant_id):
- return {
- 'id': id,
- 'name': 'transfer',
- 'volume_id': '8c05f861-6052-4df6-b3e0-0aebfbe686cc',
- 'links': [
- {
- 'href': _self_href(base_uri, tenant_id, id),
- 'rel': 'self'
- },
- {
- 'href': _bookmark_href(base_uri, tenant_id, id),
- 'rel': 'bookmark'
- }
- ]
- }
-
-
-def _stub_extend(id, new_size):
- return {'volume_id': '712f4980-5ac1-41e5-9383-390aa7c9f58b'}
-
-
-class FakeClient(fakes.FakeClient, client.Client):
-
- def __init__(self, api_version=None, *args, **kwargs):
- client.Client.__init__(self, 'username', 'password',
- 'project_id', 'auth_url',
- extensions=kwargs.get('extensions'))
- self.api_version = api_version
- self.client = FakeHTTPClient(**kwargs)
-
- def get_volume_api_version_from_endpoint(self):
- return self.client.get_volume_api_version_from_endpoint()
-
-
-class FakeHTTPClient(base_client.HTTPClient):
-
- def __init__(self, **kwargs):
- self.username = 'username'
- self.password = 'password'
- self.auth_url = 'auth_url'
- self.callstack = []
- self.management_url = 'http://10.0.2.15:8776/v1/fake'
-
- def _cs_request(self, url, method, **kwargs):
- # Check that certain things are called correctly
- if method in ['GET', 'DELETE']:
- assert 'body' not in kwargs
- elif method == 'PUT':
- assert 'body' in kwargs
-
- # Call the method
- args = urlparse.parse_qsl(urlparse.urlparse(url)[4])
- kwargs.update(args)
- munged_url = url.rsplit('?', 1)[0]
- munged_url = munged_url.strip('/').replace('/', '_').replace('.', '_')
- munged_url = munged_url.replace('-', '_')
-
- callback = "%s_%s" % (method.lower(), munged_url)
-
- if not hasattr(self, callback):
- raise AssertionError('Called unknown API method: %s %s, '
- 'expected fakes method name: %s' %
- (method, url, callback))
-
- # Note the call
- self.callstack.append((method, url, kwargs.get('body', None)))
- status, headers, body = getattr(self, callback)(**kwargs)
- r = utils.TestResponse({
- "status_code": status,
- "text": body,
- "headers": headers,
- })
- return r, body
-
- def get_volume_api_version_from_endpoint(self):
- magic_tuple = urlparse.urlsplit(self.management_url)
- scheme, netloc, path, query, frag = magic_tuple
- return path.lstrip('/').split('/')[0][1:]
-
- #
- # Snapshots
- #
-
- def get_snapshots_detail(self, **kw):
- return (200, {}, {'snapshots': [
- _stub_snapshot(),
- ]})
-
- def get_snapshots_1234(self, **kw):
- return (200, {}, {'snapshot': _stub_snapshot(id='1234')})
-
- def get_snapshots_5678(self, **kw):
- return (200, {}, {'snapshot': _stub_snapshot(id='5678')})
-
- def put_snapshots_1234(self, **kw):
- snapshot = _stub_snapshot(id='1234')
- snapshot.update(kw['body']['snapshot'])
- return (200, {}, {'snapshot': snapshot})
-
- def post_snapshots_1234_action(self, body, **kw):
- _body = None
- resp = 202
- assert len(list(body)) == 1
- action = list(body)[0]
- if action == 'os-reset_status':
- assert 'status' in body['os-reset_status']
- elif action == 'os-update_snapshot_status':
- assert 'status' in body['os-update_snapshot_status']
- else:
- raise AssertionError("Unexpected action: %s" % action)
- return (resp, {}, _body)
-
- def post_snapshots_5678_action(self, body, **kw):
- return self.post_snapshots_1234_action(body, **kw)
-
- def delete_snapshots_1234(self, **kw):
- return (202, {}, {})
-
- def delete_snapshots_5678(self, **kw):
- return (202, {}, {})
-
- #
- # Volumes
- #
-
- def put_volumes_1234(self, **kw):
- volume = _stub_volume(id='1234')
- volume.update(kw['body']['volume'])
- return (200, {}, {'volume': volume})
-
- def get_volumes(self, **kw):
- return (200, {}, {"volumes": [
- {'id': 1234, 'display_name': 'sample-volume'},
- {'id': 5678, 'display_name': 'sample-volume2'}
- ]})
-
- # TODO(jdg): This will need to change
- # at the very least it's not complete
- def get_volumes_detail(self, **kw):
- return (200, {}, {"volumes": [
- {'id': kw.get('id', 1234),
- 'display_name': 'sample-volume',
- 'attachments': [{'server_id': 1234}]},
- ]})
-
- def get_volumes_1234(self, **kw):
- r = {'volume': self.get_volumes_detail(id=1234)[2]['volumes'][0]}
- return (200, {}, r)
-
- def get_volumes_5678(self, **kw):
- r = {'volume': self.get_volumes_detail(id=5678)[2]['volumes'][0]}
- return (200, {}, r)
-
- def get_volumes_1234_encryption(self, **kw):
- r = {'encryption_key_id': 'id'}
- return (200, {}, r)
-
- def post_volumes_1234_action(self, body, **kw):
- _body = None
- resp = 202
- assert len(list(body)) == 1
- action = list(body)[0]
- if action == 'os-attach':
- keys = sorted(list(body[action]))
- assert (keys == ['instance_uuid', 'mode', 'mountpoint'] or
- keys == ['host_name', 'mode', 'mountpoint'])
- elif action == 'os-detach':
- assert body[action] is None
- elif action == 'os-reserve':
- assert body[action] is None
- elif action == 'os-unreserve':
- assert body[action] is None
- elif action == 'os-initialize_connection':
- assert list(body[action]) == ['connector']
- return (202, {}, {'connection_info': 'foos'})
- elif action == 'os-terminate_connection':
- assert list(body[action]) == ['connector']
- elif action == 'os-begin_detaching':
- assert body[action] is None
- elif action == 'os-roll_detaching':
- assert body[action] is None
- elif action == 'os-reset_status':
- assert 'status' in body[action]
- elif action == 'os-extend':
- assert list(body[action]) == ['new_size']
- elif action == 'os-migrate_volume':
- assert 'host' in body[action]
- assert 'force_host_copy' in body[action]
- elif action == 'os-update_readonly_flag':
- assert list(body[action]) == ['readonly']
- elif action == 'os-set_bootable':
- assert list(body[action]) == ['bootable']
- else:
- raise AssertionError("Unexpected action: %s" % action)
- return (resp, {}, _body)
-
- def post_volumes_5678_action(self, body, **kw):
- return self.post_volumes_1234_action(body, **kw)
-
- def post_volumes(self, **kw):
- return (202, {}, {'volume': {}})
-
- def delete_volumes_1234(self, **kw):
- return (202, {}, None)
-
- def delete_volumes_5678(self, **kw):
- return (202, {}, None)
-
- #
- # Quotas
- #
-
- def get_os_quota_sets_test(self, **kw):
- return (200, {}, {'quota_set': {
- 'tenant_id': 'test',
- 'metadata_items': [],
- 'volumes': 1,
- 'snapshots': 1,
- 'gigabytes': 1,
- 'backups': 1,
- 'backup_gigabytes': 1}})
-
- def get_os_quota_sets_test_defaults(self):
- return (200, {}, {'quota_set': {
- 'tenant_id': 'test',
- 'metadata_items': [],
- 'volumes': 1,
- 'snapshots': 1,
- 'gigabytes': 1,
- 'backups': 1,
- 'backup_gigabytes': 1}})
-
- def put_os_quota_sets_test(self, body, **kw):
- assert list(body) == ['quota_set']
- fakes.assert_has_keys(body['quota_set'],
- required=['tenant_id'])
- return (200, {}, {'quota_set': {
- 'tenant_id': 'test',
- 'metadata_items': [],
- 'volumes': 2,
- 'snapshots': 2,
- 'gigabytes': 1,
- 'backups': 1,
- 'backup_gigabytes': 1}})
-
- def delete_os_quota_sets_1234(self, **kw):
- return (200, {}, {})
-
- def delete_os_quota_sets_test(self, **kw):
- return (200, {}, {})
-
- #
- # Quota Classes
- #
-
- def get_os_quota_class_sets_test(self, **kw):
- return (200, {}, {'quota_class_set': {
- 'class_name': 'test',
- 'metadata_items': [],
- 'volumes': 1,
- 'snapshots': 1,
- 'gigabytes': 1,
- 'backups': 1,
- 'backup_gigabytes': 1}})
-
- def put_os_quota_class_sets_test(self, body, **kw):
- assert list(body) == ['quota_class_set']
- fakes.assert_has_keys(body['quota_class_set'],
- required=['class_name'])
- return (200, {}, {'quota_class_set': {
- 'class_name': 'test',
- 'metadata_items': [],
- 'volumes': 2,
- 'snapshots': 2,
- 'gigabytes': 1,
- 'backups': 1,
- 'backup_gigabytes': 1}})
-
- #
- # VolumeTypes
- #
- def get_types(self, **kw):
- return (200, {}, {
- 'volume_types': [{'id': 1,
- 'name': 'test-type-1',
- 'extra_specs': {}},
- {'id': 2,
- 'name': 'test-type-2',
- 'extra_specs': {}}]})
-
- def get_types_1(self, **kw):
- return (200, {}, {'volume_type': {'id': 1,
- 'name': 'test-type-1',
- 'extra_specs': {}}})
-
- def get_types_2(self, **kw):
- return (200, {}, {'volume_type': {'id': 2,
- 'name': 'test-type-2',
- 'extra_specs': {}}})
-
- def post_types(self, body, **kw):
- return (202, {}, {'volume_type': {'id': 3,
- 'name': 'test-type-3',
- 'extra_specs': {}}})
-
- def post_types_1_extra_specs(self, body, **kw):
- assert list(body) == ['extra_specs']
- return (200, {}, {'extra_specs': {'k': 'v'}})
-
- def delete_types_1_extra_specs_k(self, **kw):
- return(204, {}, None)
-
- def delete_types_1_extra_specs_m(self, **kw):
- return(204, {}, None)
-
- def delete_types_1(self, **kw):
- return (202, {}, None)
-
- #
- # VolumeEncryptionTypes
- #
- def get_types_1_encryption(self, **kw):
- return (200, {}, {'id': 1, 'volume_type_id': 1, 'provider': 'test',
- 'cipher': 'test', 'key_size': 1,
- 'control_location': 'front-end'})
-
- def get_types_2_encryption(self, **kw):
- return (200, {}, {})
-
- def post_types_2_encryption(self, body, **kw):
- return (200, {}, {'encryption': body})
-
- def put_types_1_encryption_1(self, body, **kw):
- return (200, {}, {})
-
- def delete_types_1_encryption_provider(self, **kw):
- return (202, {}, None)
-
- #
- # Set/Unset metadata
- #
- def delete_volumes_1234_metadata_test_key(self, **kw):
- return (204, {}, None)
-
- def delete_volumes_1234_metadata_key1(self, **kw):
- return (204, {}, None)
-
- def delete_volumes_1234_metadata_key2(self, **kw):
- return (204, {}, None)
-
- def post_volumes_1234_metadata(self, **kw):
- return (204, {}, {'metadata': {'test_key': 'test_value'}})
-
- #
- # List all extensions
- #
- def get_extensions(self, **kw):
- exts = [
- {
- "alias": "FAKE-1",
- "description": "Fake extension number 1",
- "links": [],
- "name": "Fake1",
- "namespace": ("http://docs.openstack.org/"
- "/ext/fake1/api/v1.1"),
- "updated": "2011-06-09T00:00:00+00:00"
- },
- {
- "alias": "FAKE-2",
- "description": "Fake extension number 2",
- "links": [],
- "name": "Fake2",
- "namespace": ("http://docs.openstack.org/"
- "/ext/fake1/api/v1.1"),
- "updated": "2011-06-09T00:00:00+00:00"
- },
- ]
- return (200, {}, {"extensions": exts, })
-
- #
- # VolumeBackups
- #
-
- def get_backups_76a17945_3c6f_435c_975b_b5685db10b62(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- backup1 = '76a17945-3c6f-435c-975b-b5685db10b62'
- return (200, {},
- {'backup': _stub_backup_full(backup1, base_uri, tenant_id)})
-
- def get_backups_detail(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- backup1 = '76a17945-3c6f-435c-975b-b5685db10b62'
- backup2 = 'd09534c6-08b8-4441-9e87-8976f3a8f699'
- return (200, {},
- {'backups': [
- _stub_backup_full(backup1, base_uri, tenant_id),
- _stub_backup_full(backup2, base_uri, tenant_id)]})
-
- def delete_backups_76a17945_3c6f_435c_975b_b5685db10b62(self, **kw):
- return (202, {}, None)
-
- def post_backups(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- backup1 = '76a17945-3c6f-435c-975b-b5685db10b62'
- return (202, {},
- {'backup': _stub_backup(backup1, base_uri, tenant_id)})
-
- def post_backups_76a17945_3c6f_435c_975b_b5685db10b62_restore(self, **kw):
- return (200, {},
- {'restore': _stub_restore()})
-
- def post_backups_1234_restore(self, **kw):
- return (200, {},
- {'restore': _stub_restore()})
-
- #
- # QoSSpecs
- #
-
- def get_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- qos_id1 = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- return (200, {},
- _stub_qos_full(qos_id1, base_uri, tenant_id))
-
- def get_qos_specs(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- qos_id1 = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- qos_id2 = '0FD8DD14-A396-4E55-9573-1FE59042E95B'
- return (200, {},
- {'qos_specs': [
- _stub_qos_full(qos_id1, base_uri, tenant_id, 'name-1'),
- _stub_qos_full(qos_id2, base_uri, tenant_id)]})
-
- def post_qos_specs(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- qos_name = 'qos-name'
- return (202, {},
- _stub_qos_full(qos_id, base_uri, tenant_id, qos_name))
-
- def put_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C(self, **kw):
- return (202, {}, None)
-
- def put_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C_delete_keys(
- self, **kw):
- return (202, {}, None)
-
- def delete_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C(self, **kw):
- return (202, {}, None)
-
- def get_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C_associations(
- self, **kw):
- type_id1 = '4230B13A-7A37-4E84-B777-EFBA6FCEE4FF'
- type_id2 = '4230B13A-AB37-4E84-B777-EFBA6FCEE4FF'
- type_name1 = 'type1'
- type_name2 = 'type2'
- return (202, {},
- {'qos_associations': [
- _stub_qos_associates(type_id1, type_name1),
- _stub_qos_associates(type_id2, type_name2)]})
-
- def get_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C_associate(
- self, **kw):
- return (202, {}, None)
-
- def get_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C_disassociate(
- self, **kw):
- return (202, {}, None)
-
- def get_qos_specs_1B6B6A04_A927_4AEB_810B_B7BAAD49F57C_disassociate_all(
- self, **kw):
- return (202, {}, None)
-
- #
- # VolumeTransfers
- #
-
- def get_os_volume_transfer_5678(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- transfer1 = '5678'
- return (200, {},
- {'transfer':
- _stub_transfer_full(transfer1, base_uri, tenant_id)})
-
- def get_os_volume_transfer_detail(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- transfer1 = '5678'
- transfer2 = 'f625ec3e-13dd-4498-a22a-50afd534cc41'
- return (200, {},
- {'transfers': [
- _stub_transfer_full(transfer1, base_uri, tenant_id),
- _stub_transfer_full(transfer2, base_uri, tenant_id)]})
-
- def delete_os_volume_transfer_5678(self, **kw):
- return (202, {}, None)
-
- def post_os_volume_transfer(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- transfer1 = '5678'
- return (202, {},
- {'transfer': _stub_transfer(transfer1, base_uri, tenant_id)})
-
- def post_os_volume_transfer_5678_accept(self, **kw):
- base_uri = 'http://localhost:8776'
- tenant_id = '0fa851f6668144cf9cd8c8419c1646c1'
- transfer1 = '5678'
- return (200, {},
- {'transfer': _stub_transfer(transfer1, base_uri, tenant_id)})
-
- #
- # Services
- #
- def get_os_services(self, **kw):
- host = kw.get('host', None)
- binary = kw.get('binary', None)
- services = [
- {
- 'binary': 'cinder-volume',
- 'host': 'host1',
- 'zone': 'cinder',
- 'status': 'enabled',
- 'state': 'up',
- 'updated_at': datetime(2012, 10, 29, 13, 42, 2)
- },
- {
- 'binary': 'cinder-volume',
- 'host': 'host2',
- 'zone': 'cinder',
- 'status': 'disabled',
- 'state': 'down',
- 'updated_at': datetime(2012, 9, 18, 8, 3, 38)
- },
- {
- 'binary': 'cinder-scheduler',
- 'host': 'host2',
- 'zone': 'cinder',
- 'status': 'disabled',
- 'state': 'down',
- 'updated_at': datetime(2012, 9, 18, 8, 3, 38)
- },
- ]
- if host:
- services = [i for i in services if i['host'] == host]
- if binary:
- services = [i for i in services if i['binary'] == binary]
- return (200, {}, {'services': services})
-
- def put_os_services_enable(self, body, **kw):
- return (200, {}, {'host': body['host'], 'binary': body['binary'],
- 'status': 'enabled'})
-
- def put_os_services_disable(self, body, **kw):
- return (200, {}, {'host': body['host'], 'binary': body['binary'],
- 'status': 'disabled'})
-
- def put_os_services_disable_log_reason(self, body, **kw):
- return (200, {}, {'host': body['host'], 'binary': body['binary'],
- 'status': 'disabled',
- 'disabled_reason': body['disabled_reason']})
-
- def get_os_availability_zone(self, **kw):
- return (200, {}, {
- "availabilityZoneInfo": [
- {
- "zoneName": "zone-1",
- "zoneState": {"available": True},
- "hosts": None,
- },
- {
- "zoneName": "zone-2",
- "zoneState": {"available": False},
- "hosts": None,
- },
- ]
- })
-
- def get_os_availability_zone_detail(self, **kw):
- return (200, {}, {
- "availabilityZoneInfo": [
- {
- "zoneName": "zone-1",
- "zoneState": {"available": True},
- "hosts": {
- "fake_host-1": {
- "cinder-volume": {
- "active": True,
- "available": True,
- "updated_at":
- datetime(2012, 12, 26, 14, 45, 25, 0)
- }
- }
- }
- },
- {
- "zoneName": "internal",
- "zoneState": {"available": True},
- "hosts": {
- "fake_host-1": {
- "cinder-sched": {
- "active": True,
- "available": True,
- "updated_at":
- datetime(2012, 12, 26, 14, 45, 24, 0)
- }
- }
- }
- },
- {
- "zoneName": "zone-2",
- "zoneState": {"available": False},
- "hosts": None,
- },
- ]
- })
-
- def post_snapshots_1234_metadata(self, **kw):
- return (200, {}, {"metadata": {"key1": "val1", "key2": "val2"}})
-
- def delete_snapshots_1234_metadata_key1(self, **kw):
- return (200, {}, None)
-
- def delete_snapshots_1234_metadata_key2(self, **kw):
- return (200, {}, None)
-
- def put_volumes_1234_metadata(self, **kw):
- return (200, {}, {"metadata": {"key1": "val1", "key2": "val2"}})
-
- def put_snapshots_1234_metadata(self, **kw):
- return (200, {}, {"metadata": {"key1": "val1", "key2": "val2"}})
diff --git a/cinderclient/tests/unit/v1/test_auth.py b/cinderclient/tests/unit/v1/test_auth.py
deleted file mode 100644
index 29f8cc390..000000000
--- a/cinderclient/tests/unit/v1/test_auth.py
+++ /dev/null
@@ -1,339 +0,0 @@
-# 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 json
-import mock
-
-import requests
-
-from cinderclient import exceptions
-from cinderclient.v1 import client
-
-from cinderclient.tests.unit import utils
-
-
-class AuthenticateAgainstKeystoneTests(utils.TestCase):
- def test_authenticate_success(self):
- cs = client.Client("username", "password", "project_id",
- "http://localhost:8776/v1", service_type='volume')
- resp = {
- "access": {
- "token": {
- "expires": "2014-11-01T03:32:15-05:00",
- "id": "FAKE_ID",
- },
- "serviceCatalog": [
- {
- "type": "volume",
- "endpoints": [
- {
- "region": "RegionOne",
- "adminURL": "http://localhost:8776/v1",
- "internalURL": "http://localhost:8776/v1",
- "publicURL": "http://localhost:8776/v1",
- },
- ],
- },
- ],
- },
- }
- auth_response = utils.TestResponse({
- "status_code": 200,
- "text": json.dumps(resp),
- })
-
- mock_request = mock.Mock(return_value=(auth_response))
-
- @mock.patch.object(requests, "request", mock_request)
- def test_auth_call():
- cs.client.authenticate()
- headers = {
- 'User-Agent': cs.client.USER_AGENT,
- 'Content-Type': 'application/json',
- 'Accept': 'application/json',
- }
- body = {
- 'auth': {
- 'passwordCredentials': {
- 'username': cs.client.user,
- 'password': cs.client.password,
- },
- 'tenantName': cs.client.projectid,
- },
- }
-
- token_url = cs.client.auth_url + "/tokens"
- mock_request.assert_called_with(
- "POST",
- token_url,
- headers=headers,
- data=json.dumps(body),
- allow_redirects=True,
- **self.TEST_REQUEST_BASE)
-
- endpoints = resp["access"]["serviceCatalog"][0]['endpoints']
- public_url = endpoints[0]["publicURL"].rstrip('/')
- self.assertEqual(public_url, cs.client.management_url)
- token_id = resp["access"]["token"]["id"]
- self.assertEqual(token_id, cs.client.auth_token)
-
- test_auth_call()
-
- def test_authenticate_tenant_id(self):
- cs = client.Client("username", "password",
- auth_url="http://localhost:8776/v1",
- tenant_id='tenant_id', service_type='volume')
- resp = {
- "access": {
- "token": {
- "expires": "2014-11-01T03:32:15-05:00",
- "id": "FAKE_ID",
- "tenant": {
- "description": None,
- "enabled": True,
- "id": "tenant_id",
- "name": "demo"
- } # tenant associated with token
- },
- "serviceCatalog": [
- {
- "type": "volume",
- "endpoints": [
- {
- "region": "RegionOne",
- "adminURL": "http://localhost:8776/v1",
- "internalURL": "http://localhost:8776/v1",
- "publicURL": "http://localhost:8776/v1",
- },
- ],
- },
- ],
- },
- }
- auth_response = utils.TestResponse({
- "status_code": 200,
- "text": json.dumps(resp),
- })
-
- mock_request = mock.Mock(return_value=(auth_response))
-
- @mock.patch.object(requests, "request", mock_request)
- def test_auth_call():
- cs.client.authenticate()
- headers = {
- 'User-Agent': cs.client.USER_AGENT,
- 'Content-Type': 'application/json',
- 'Accept': 'application/json',
- }
- body = {
- 'auth': {
- 'passwordCredentials': {
- 'username': cs.client.user,
- 'password': cs.client.password,
- },
- 'tenantId': cs.client.tenant_id,
- },
- }
-
- token_url = cs.client.auth_url + "/tokens"
- mock_request.assert_called_with(
- "POST",
- token_url,
- headers=headers,
- data=json.dumps(body),
- allow_redirects=True,
- **self.TEST_REQUEST_BASE)
-
- endpoints = resp["access"]["serviceCatalog"][0]['endpoints']
- public_url = endpoints[0]["publicURL"].rstrip('/')
- self.assertEqual(public_url, cs.client.management_url)
- token_id = resp["access"]["token"]["id"]
- self.assertEqual(token_id, cs.client.auth_token)
- tenant_id = resp["access"]["token"]["tenant"]["id"]
- self.assertEqual(tenant_id, cs.client.tenant_id)
-
- test_auth_call()
-
- def test_authenticate_failure(self):
- cs = client.Client("username", "password", "project_id",
- "http://localhost:8776/v1")
- resp = {"unauthorized": {"message": "Unauthorized", "code": "401"}}
- auth_response = utils.TestResponse({
- "status_code": 401,
- "text": json.dumps(resp),
- })
-
- mock_request = mock.Mock(return_value=(auth_response))
-
- @mock.patch.object(requests, "request", mock_request)
- def test_auth_call():
- self.assertRaises(exceptions.Unauthorized, cs.client.authenticate)
-
- test_auth_call()
-
- def test_auth_redirect(self):
- cs = client.Client("username", "password", "project_id",
- "http://localhost:8776/v1", service_type='volume')
- dict_correct_response = {
- "access": {
- "token": {
- "expires": "2014-11-01T03:32:15-05:00",
- "id": "FAKE_ID",
- },
- "serviceCatalog": [
- {
- "type": "volume",
- "endpoints": [
- {
- "adminURL": "http://localhost:8776/v1",
- "region": "RegionOne",
- "internalURL": "http://localhost:8776/v1",
- "publicURL": "http://localhost:8776/v1/",
- },
- ],
- },
- ],
- },
- }
- correct_response = json.dumps(dict_correct_response)
- dict_responses = [
- {"headers": {'location': 'http://127.0.0.1:5001'},
- "status_code": 305,
- "text": "Use proxy"},
- # Configured on admin port, cinder redirects to v2.0 port.
- # When trying to connect on it, keystone auth succeed by v1.0
- # protocol (through headers) but tokens are being returned in
- # body (looks like keystone bug). Leaved for compatibility.
- {"headers": {},
- "status_code": 200,
- "text": correct_response},
- {"headers": {},
- "status_code": 200,
- "text": correct_response}
- ]
-
- responses = [(utils.TestResponse(resp)) for resp in dict_responses]
-
- def side_effect(*args, **kwargs):
- return responses.pop(0)
-
- mock_request = mock.Mock(side_effect=side_effect)
-
- @mock.patch.object(requests, "request", mock_request)
- def test_auth_call():
- cs.client.authenticate()
- headers = {
- 'User-Agent': cs.client.USER_AGENT,
- 'Content-Type': 'application/json',
- 'Accept': 'application/json',
- }
- body = {
- 'auth': {
- 'passwordCredentials': {
- 'username': cs.client.user,
- 'password': cs.client.password,
- },
- 'tenantName': cs.client.projectid,
- },
- }
-
- token_url = cs.client.auth_url + "/tokens"
- mock_request.assert_called_with(
- "POST",
- token_url,
- headers=headers,
- data=json.dumps(body),
- allow_redirects=True,
- **self.TEST_REQUEST_BASE)
-
- resp = dict_correct_response
- endpoints = resp["access"]["serviceCatalog"][0]['endpoints']
- public_url = endpoints[0]["publicURL"].rstrip('/')
- self.assertEqual(public_url, cs.client.management_url)
- token_id = resp["access"]["token"]["id"]
- self.assertEqual(token_id, cs.client.auth_token)
-
- test_auth_call()
-
-
-class AuthenticationTests(utils.TestCase):
- def test_authenticate_success(self):
- cs = client.Client("username", "password", "project_id", "auth_url")
- management_url = 'https://localhost/v1.1/443470'
- auth_response = utils.TestResponse({
- 'status_code': 204,
- 'headers': {
- 'x-server-management-url': management_url,
- 'x-auth-token': '1b751d74-de0c-46ae-84f0-915744b582d1',
- },
- })
- mock_request = mock.Mock(return_value=(auth_response))
-
- @mock.patch.object(requests, "request", mock_request)
- def test_auth_call():
- cs.client.authenticate()
- headers = {
- 'Accept': 'application/json',
- 'X-Auth-User': 'username',
- 'X-Auth-Key': 'password',
- 'X-Auth-Project-Id': 'project_id',
- 'User-Agent': cs.client.USER_AGENT
- }
- mock_request.assert_called_with(
- "GET",
- cs.client.auth_url,
- headers=headers,
- **self.TEST_REQUEST_BASE)
-
- self.assertEqual(auth_response.headers['x-server-management-url'],
- cs.client.management_url)
- self.assertEqual(auth_response.headers['x-auth-token'],
- cs.client.auth_token)
-
- test_auth_call()
-
- def test_authenticate_failure(self):
- cs = client.Client("username", "password", "project_id", "auth_url")
- auth_response = utils.TestResponse({"status_code": 401})
- mock_request = mock.Mock(return_value=(auth_response))
-
- @mock.patch.object(requests, "request", mock_request)
- def test_auth_call():
- self.assertRaises(exceptions.Unauthorized, cs.client.authenticate)
-
- test_auth_call()
-
- def test_auth_automatic(self):
- cs = client.Client("username", "password", "project_id", "auth_url")
- http_client = cs.client
- http_client.management_url = ''
- mock_request = mock.Mock(return_value=(None, None))
-
- @mock.patch.object(http_client, 'request', mock_request)
- @mock.patch.object(http_client, 'authenticate')
- def test_auth_call(m):
- http_client.get('/')
- self.assertTrue(m.called)
- self.assertTrue(mock_request.called)
-
- test_auth_call()
-
- def test_auth_manual(self):
- cs = client.Client("username", "password", "project_id", "auth_url")
-
- @mock.patch.object(cs.client, 'authenticate')
- def test_auth_call(m):
- cs.authenticate()
- self.assertTrue(m.called)
-
- test_auth_call()
diff --git a/cinderclient/tests/unit/v1/test_availability_zone.py b/cinderclient/tests/unit/v1/test_availability_zone.py
deleted file mode 100644
index 7e4c439ce..000000000
--- a/cinderclient/tests/unit/v1/test_availability_zone.py
+++ /dev/null
@@ -1,89 +0,0 @@
-# Copyright 2011-2013 OpenStack Foundation
-# Copyright 2013 IBM Corp.
-# All Rights Reserved.
-#
-# 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 six
-
-from cinderclient.v1 import availability_zones
-from cinderclient.v1 import shell
-
-from cinderclient.tests.unit.fixture_data import availability_zones as azfixture # noqa
-from cinderclient.tests.unit.fixture_data import client
-from cinderclient.tests.unit import utils
-
-
-class AvailabilityZoneTest(utils.FixturedTestCase):
-
- client_fixture_class = client.V1
- data_fixture_class = azfixture.Fixture
-
- def _assertZone(self, zone, name, status):
- self.assertEqual(name, zone.zoneName)
- self.assertEqual(status, zone.zoneState)
-
- def test_list_availability_zone(self):
- zones = self.cs.availability_zones.list(detailed=False)
- self.assert_called('GET', '/os-availability-zone')
-
- for zone in zones:
- self.assertIsInstance(zone,
- availability_zones.AvailabilityZone)
-
- self.assertEqual(2, len(zones))
-
- l0 = [six.u('zone-1'), six.u('available')]
- l1 = [six.u('zone-2'), six.u('not available')]
-
- z0 = shell._treeizeAvailabilityZone(zones[0])
- z1 = shell._treeizeAvailabilityZone(zones[1])
-
- self.assertEqual((1, 1), (len(z0), len(z1)))
-
- self._assertZone(z0[0], l0[0], l0[1])
- self._assertZone(z1[0], l1[0], l1[1])
-
- def test_detail_availability_zone(self):
- zones = self.cs.availability_zones.list(detailed=True)
- self.assert_called('GET', '/os-availability-zone/detail')
-
- for zone in zones:
- self.assertIsInstance(zone,
- availability_zones.AvailabilityZone)
-
- self.assertEqual(3, len(zones))
-
- l0 = [six.u('zone-1'), six.u('available')]
- l1 = [six.u('|- fake_host-1'), six.u('')]
- l2 = [six.u('| |- cinder-volume'),
- six.u('enabled :-) 2012-12-26 14:45:25')]
- l3 = [six.u('internal'), six.u('available')]
- l4 = [six.u('|- fake_host-1'), six.u('')]
- l5 = [six.u('| |- cinder-sched'),
- six.u('enabled :-) 2012-12-26 14:45:24')]
- l6 = [six.u('zone-2'), six.u('not available')]
-
- z0 = shell._treeizeAvailabilityZone(zones[0])
- z1 = shell._treeizeAvailabilityZone(zones[1])
- z2 = shell._treeizeAvailabilityZone(zones[2])
-
- self.assertEqual((3, 3, 1), (len(z0), len(z1), len(z2)))
-
- self._assertZone(z0[0], l0[0], l0[1])
- self._assertZone(z0[1], l1[0], l1[1])
- self._assertZone(z0[2], l2[0], l2[1])
- self._assertZone(z1[0], l3[0], l3[1])
- self._assertZone(z1[1], l4[0], l4[1])
- self._assertZone(z1[2], l5[0], l5[1])
- self._assertZone(z2[0], l6[0], l6[1])
diff --git a/cinderclient/tests/unit/v1/test_limits.py b/cinderclient/tests/unit/v1/test_limits.py
deleted file mode 100644
index 72808dff9..000000000
--- a/cinderclient/tests/unit/v1/test_limits.py
+++ /dev/null
@@ -1,164 +0,0 @@
-# Copyright 2014 OpenStack Foundation
-#
-# 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
-
-from cinderclient.tests.unit import utils
-from cinderclient.v1 import limits
-
-
-def _get_default_RateLimit(verb="verb1", uri="uri1", regex="regex1",
- value="value1",
- remain="remain1", unit="unit1",
- next_available="next1"):
- return limits.RateLimit(verb, uri, regex, value, remain, unit,
- next_available)
-
-
-class TestLimits(utils.TestCase):
- def test_repr(self):
- l = limits.Limits(None, {"foo": "bar"})
- self.assertEqual("<Limits>", repr(l))
-
- def test_absolute(self):
- l = limits.Limits(None,
- {"absolute": {"name1": "value1", "name2": "value2"}})
- l1 = limits.AbsoluteLimit("name1", "value1")
- l2 = limits.AbsoluteLimit("name2", "value2")
- for item in l.absolute:
- self.assertIn(item, [l1, l2])
-
- def test_rate(self):
- l = limits.Limits(None,
- {
- "rate": [
- {
- "uri": "uri1",
- "regex": "regex1",
- "limit": [
- {
- "verb": "verb1",
- "value": "value1",
- "remaining": "remain1",
- "unit": "unit1",
- "next-available": "next1",
- },
- ],
- },
- {
- "uri": "uri2",
- "regex": "regex2",
- "limit": [
- {
- "verb": "verb2",
- "value": "value2",
- "remaining": "remain2",
- "unit": "unit2",
- "next-available": "next2",
- },
- ],
- },
- ],
- })
- l1 = limits.RateLimit("verb1", "uri1", "regex1", "value1", "remain1",
- "unit1", "next1")
- l2 = limits.RateLimit("verb2", "uri2", "regex2", "value2", "remain2",
- "unit2", "next2")
- for item in l.rate:
- self.assertIn(item, [l1, l2])
-
-
-class TestRateLimit(utils.TestCase):
- def test_equal(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit()
- self.assertEqual(l1, l2)
-
- def test_not_equal_verbs(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(verb="verb2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_uris(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(uri="uri2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_regexps(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(regex="regex2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_values(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(value="value2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_remains(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(remain="remain2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_units(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(unit="unit2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_next_available(self):
- l1 = _get_default_RateLimit()
- l2 = _get_default_RateLimit(next_available="next2")
- self.assertNotEqual(l1, l2)
-
- def test_repr(self):
- l1 = _get_default_RateLimit()
- self.assertEqual("<RateLimit: method=verb1 uri=uri1>", repr(l1))
-
-
-class TestAbsoluteLimit(utils.TestCase):
- def test_equal(self):
- l1 = limits.AbsoluteLimit("name1", "value1")
- l2 = limits.AbsoluteLimit("name1", "value1")
- self.assertEqual(l1, l2)
-
- def test_not_equal_values(self):
- l1 = limits.AbsoluteLimit("name1", "value1")
- l2 = limits.AbsoluteLimit("name1", "value2")
- self.assertNotEqual(l1, l2)
-
- def test_not_equal_names(self):
- l1 = limits.AbsoluteLimit("name1", "value1")
- l2 = limits.AbsoluteLimit("name2", "value1")
- self.assertNotEqual(l1, l2)
-
- def test_repr(self):
- l1 = limits.AbsoluteLimit("name1", "value1")
- self.assertEqual("<AbsoluteLimit: name=name1>", repr(l1))
-
-
-class TestLimitsManager(utils.TestCase):
- def test_get(self):
- api = mock.Mock()
- api.client.get.return_value = (
- None,
- {"limits": {"absolute": {"name1": "value1", }},
- "no-limits": {"absolute": {"name2": "value2", }}})
- l1 = limits.AbsoluteLimit("name1", "value1")
- limitsManager = limits.LimitsManager(api)
-
- lim = limitsManager.get()
-
- self.assertIsInstance(lim, limits.Limits)
- for l in lim.absolute:
- self.assertEqual(l1, l)
diff --git a/cinderclient/tests/unit/v1/test_qos.py b/cinderclient/tests/unit/v1/test_qos.py
deleted file mode 100644
index cfecbe8d0..000000000
--- a/cinderclient/tests/unit/v1/test_qos.py
+++ /dev/null
@@ -1,79 +0,0 @@
-# Copyright (C) 2013 eBay Inc.
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-cs = fakes.FakeClient()
-
-
-class QoSSpecsTest(utils.TestCase):
-
- def test_create(self):
- specs = dict(k1='v1', k2='v2')
- cs.qos_specs.create('qos-name', specs)
- cs.assert_called('POST', '/qos-specs')
-
- def test_get(self):
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- cs.qos_specs.get(qos_id)
- cs.assert_called('GET', '/qos-specs/%s' % qos_id)
-
- def test_list(self):
- cs.qos_specs.list()
- cs.assert_called('GET', '/qos-specs')
-
- def test_delete(self):
- cs.qos_specs.delete('1B6B6A04-A927-4AEB-810B-B7BAAD49F57C')
- cs.assert_called('DELETE',
- '/qos-specs/1B6B6A04-A927-4AEB-810B-B7BAAD49F57C?'
- 'force=False')
-
- def test_set_keys(self):
- body = {'qos_specs': dict(k1='v1')}
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- cs.qos_specs.set_keys(qos_id, body)
- cs.assert_called('PUT', '/qos-specs/%s' % qos_id)
-
- def test_unset_keys(self):
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- body = {'keys': ['k1']}
- cs.qos_specs.unset_keys(qos_id, body)
- cs.assert_called('PUT', '/qos-specs/%s/delete_keys' % qos_id)
-
- def test_get_associations(self):
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- cs.qos_specs.get_associations(qos_id)
- cs.assert_called('GET', '/qos-specs/%s/associations' % qos_id)
-
- def test_associate(self):
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- type_id = '4230B13A-7A37-4E84-B777-EFBA6FCEE4FF'
- cs.qos_specs.associate(qos_id, type_id)
- cs.assert_called('GET', '/qos-specs/%s/associate?vol_type_id=%s'
- % (qos_id, type_id))
-
- def test_disassociate(self):
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- type_id = '4230B13A-7A37-4E84-B777-EFBA6FCEE4FF'
- cs.qos_specs.disassociate(qos_id, type_id)
- cs.assert_called('GET', '/qos-specs/%s/disassociate?vol_type_id=%s'
- % (qos_id, type_id))
-
- def test_disassociate_all(self):
- qos_id = '1B6B6A04-A927-4AEB-810B-B7BAAD49F57C'
- cs.qos_specs.disassociate_all(qos_id)
- cs.assert_called('GET', '/qos-specs/%s/disassociate_all' % qos_id)
diff --git a/cinderclient/tests/unit/v1/test_quota_classes.py b/cinderclient/tests/unit/v1/test_quota_classes.py
deleted file mode 100644
index 8ed91b7c3..000000000
--- a/cinderclient/tests/unit/v1/test_quota_classes.py
+++ /dev/null
@@ -1,59 +0,0 @@
-# Copyright (c) 2011 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-cs = fakes.FakeClient()
-
-
-class QuotaClassSetsTest(utils.TestCase):
-
- def test_class_quotas_get(self):
- class_name = 'test'
- cs.quota_classes.get(class_name)
- cs.assert_called('GET', '/os-quota-class-sets/%s' % class_name)
-
- def test_update_quota(self):
- q = cs.quota_classes.get('test')
- q.update(volumes=2, snapshots=2, gigabytes=2000,
- backups=2, backup_gigabytes=2000)
- cs.assert_called('PUT', '/os-quota-class-sets/test')
-
- def test_refresh_quota(self):
- q = cs.quota_classes.get('test')
- q2 = cs.quota_classes.get('test')
- self.assertEqual(q.volumes, q2.volumes)
- self.assertEqual(q.snapshots, q2.snapshots)
- self.assertEqual(q.gigabytes, q2.gigabytes)
- self.assertEqual(q.backups, q2.backups)
- self.assertEqual(q.backup_gigabytes, q2.backup_gigabytes)
- q2.volumes = 0
- self.assertNotEqual(q.volumes, q2.volumes)
- q2.snapshots = 0
- self.assertNotEqual(q.snapshots, q2.snapshots)
- q2.gigabytes = 0
- self.assertNotEqual(q.gigabytes, q2.gigabytes)
- q2.backups = 0
- self.assertNotEqual(q.backups, q2.backups)
- q2.backup_gigabytes = 0
- self.assertNotEqual(q.backup_gigabytes, q2.backup_gigabytes)
- q2.get()
- self.assertEqual(q.volumes, q2.volumes)
- self.assertEqual(q.snapshots, q2.snapshots)
- self.assertEqual(q.gigabytes, q2.gigabytes)
- self.assertEqual(q.backups, q2.backups)
- self.assertEqual(q.backup_gigabytes, q2.backup_gigabytes)
diff --git a/cinderclient/tests/unit/v1/test_quotas.py b/cinderclient/tests/unit/v1/test_quotas.py
deleted file mode 100644
index aebff63f0..000000000
--- a/cinderclient/tests/unit/v1/test_quotas.py
+++ /dev/null
@@ -1,62 +0,0 @@
-# Copyright (c) 2011 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-cs = fakes.FakeClient()
-
-
-class QuotaSetsTest(utils.TestCase):
-
- def test_tenant_quotas_get(self):
- tenant_id = 'test'
- cs.quotas.get(tenant_id)
- cs.assert_called('GET', '/os-quota-sets/%s?usage=False' % tenant_id)
-
- def test_tenant_quotas_defaults(self):
- tenant_id = 'test'
- cs.quotas.defaults(tenant_id)
- cs.assert_called('GET', '/os-quota-sets/%s/defaults' % tenant_id)
-
- def test_update_quota(self):
- q = cs.quotas.get('test')
- q.update(volumes=2)
- q.update(snapshots=2)
- q.update(backups=2)
- cs.assert_called('PUT', '/os-quota-sets/test')
-
- def test_refresh_quota(self):
- q = cs.quotas.get('test')
- q2 = cs.quotas.get('test')
- self.assertEqual(q.volumes, q2.volumes)
- self.assertEqual(q.snapshots, q2.snapshots)
- self.assertEqual(q.backups, q2.backups)
- q2.volumes = 0
- self.assertNotEqual(q.volumes, q2.volumes)
- q2.snapshots = 0
- self.assertNotEqual(q.snapshots, q2.snapshots)
- q2.backups = 0
- self.assertNotEqual(q.backups, q2.backups)
- q2.get()
- self.assertEqual(q.volumes, q2.volumes)
- self.assertEqual(q.snapshots, q2.snapshots)
- self.assertEqual(q.backups, q2.backups)
-
- def test_delete_quota(self):
- tenant_id = 'test'
- cs.quotas.delete(tenant_id)
- cs.assert_called('DELETE', '/os-quota-sets/test')
diff --git a/cinderclient/tests/unit/v1/test_services.py b/cinderclient/tests/unit/v1/test_services.py
deleted file mode 100644
index bf3e26c1d..000000000
--- a/cinderclient/tests/unit/v1/test_services.py
+++ /dev/null
@@ -1,91 +0,0 @@
-# Copyright (c) 2013 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-from cinderclient.v1 import services
-
-
-cs = fakes.FakeClient()
-
-FAKE_SERVICE = {"host": "host1",
- 'binary': 'cinder-volume',
- "status": "enable",
- "availability_zone": "nova"}
-
-
-class ServicesTest(utils.TestCase):
-
- def test_list_services(self):
- svs = cs.services.list()
- cs.assert_called('GET', '/os-services')
- self.assertEqual(3, len(svs))
- [self.assertIsInstance(s, services.Service) for s in svs]
-
- def test_list_services_with_hostname(self):
- svs = cs.services.list(host='host2')
- cs.assert_called('GET', '/os-services?host=host2')
- self.assertEqual(2, len(svs))
- [self.assertIsInstance(s, services.Service) for s in svs]
- [self.assertEqual('host2', s.host) for s in svs]
-
- def test_list_services_with_binary(self):
- svs = cs.services.list(binary='cinder-volume')
- cs.assert_called('GET', '/os-services?binary=cinder-volume')
- self.assertEqual(2, len(svs))
- [self.assertIsInstance(s, services.Service) for s in svs]
- [self.assertEqual('cinder-volume', s.binary) for s in svs]
-
- def test_list_services_with_host_binary(self):
- svs = cs.services.list('host2', 'cinder-volume')
- cs.assert_called('GET', '/os-services?host=host2&binary=cinder-volume')
- self.assertEqual(1, len(svs))
- [self.assertIsInstance(s, services.Service) for s in svs]
- [self.assertEqual('host2', s.host) for s in svs]
- [self.assertEqual('cinder-volume', s.binary) for s in svs]
-
- def test_services_enable(self):
- s = cs.services.enable('host1', 'cinder-volume')
- values = {"host": "host1", 'binary': 'cinder-volume'}
- cs.assert_called('PUT', '/os-services/enable', values)
- self.assertIsInstance(s, services.Service)
- self.assertEqual('enabled', s.status)
-
- def test_services_disable(self):
- s = cs.services.disable('host1', 'cinder-volume')
- values = {"host": "host1", 'binary': 'cinder-volume'}
- cs.assert_called('PUT', '/os-services/disable', values)
- self.assertIsInstance(s, services.Service)
- self.assertEqual('disabled', s.status)
-
- def test_services_disable_log_reason(self):
- s = cs.services.disable_log_reason(
- 'host1', 'cinder-volume', 'disable bad host')
- values = {"host": "host1", 'binary': 'cinder-volume',
- "disabled_reason": "disable bad host"}
- cs.assert_called('PUT', '/os-services/disable-log-reason', values)
- self.assertIsInstance(s, services.Service)
- self.assertEqual('disabled', s.status)
-
- def test___repr__(self):
- """
- Unit test for Service.__repr__
-
- Verify that one Service object can be printed.
- """
- svs = services.Service(None, FAKE_SERVICE)
- self.assertEqual(
- "<Service: binary=%s host=%s>" % (FAKE_SERVICE['binary'],
- FAKE_SERVICE['host']), repr(svs))
diff --git a/cinderclient/tests/unit/v1/test_shell.py b/cinderclient/tests/unit/v1/test_shell.py
deleted file mode 100644
index ef5948d5f..000000000
--- a/cinderclient/tests/unit/v1/test_shell.py
+++ /dev/null
@@ -1,495 +0,0 @@
-# Copyright 2010 Jacob Kaplan-Moss
-
-# Copyright (c) 2011 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 fixtures
-import mock
-from requests_mock.contrib import fixture as requests_mock_fixture
-
-from cinderclient import client
-from cinderclient import exceptions
-from cinderclient import shell
-from cinderclient.v1 import shell as shell_v1
-
-from cinderclient.tests.unit.fixture_data import keystone_client
-from cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-@mock.patch.object(client, 'Client', fakes.FakeClient)
-class ShellTest(utils.TestCase):
-
- FAKE_ENV = {
- 'CINDER_USERNAME': 'username',
- 'CINDER_PASSWORD': 'password',
- 'CINDER_PROJECT_ID': 'project_id',
- 'OS_VOLUME_API_VERSION': '1',
- 'CINDER_URL': keystone_client.BASE_URL,
- }
-
- # Patch os.environ to avoid required auth info.
- def setUp(self):
- """Run before each test."""
- super(ShellTest, self).setUp()
- for var in self.FAKE_ENV:
- self.useFixture(fixtures.EnvironmentVariable(var,
- self.FAKE_ENV[var]))
-
- self.mock_completion()
-
- self.shell = shell.OpenStackCinderShell()
-
- # HACK(bcwaldon): replace this when we start using stubs
- self.old_client_class = client.Client
- client.Client = fakes.FakeClient
-
- self.requests = self.useFixture(requests_mock_fixture.Fixture())
- self.requests.register_uri(
- 'GET', keystone_client.BASE_URL,
- text=keystone_client.keystone_request_callback)
-
- def run_command(self, cmd):
- self.shell.main(cmd.split())
-
- def assert_called(self, method, url, body=None, **kwargs):
- return self.shell.cs.assert_called(method, url, body, **kwargs)
-
- def assert_called_anytime(self, method, url, body=None):
- return self.shell.cs.assert_called_anytime(method, url, body)
-
- def test_extract_metadata(self):
- # mimic the result of argparse's parse_args() method
- class Arguments(object):
-
- def __init__(self, metadata=None):
- self.metadata = metadata or []
-
- inputs = [
- ([], {}),
- (["key=value"], {"key": "value"}),
- (["key"], {"key": None}),
- (["k1=v1", "k2=v2"], {"k1": "v1", "k2": "v2"}),
- (["k1=v1", "k2"], {"k1": "v1", "k2": None}),
- (["k1", "k2=v2"], {"k1": None, "k2": "v2"})
- ]
-
- for input in inputs:
- args = Arguments(metadata=input[0])
- self.assertEqual(input[1], shell_v1._extract_metadata(args))
-
- def test_translate_volume_keys(self):
- cs = fakes.FakeClient()
- v = cs.volumes.list()[0]
- setattr(v, 'os-vol-tenant-attr:tenant_id', 'fake_tenant')
- setattr(v, '_info', {'attachments': [{'server_id': 1234}],
- 'id': 1234, 'display_name': 'sample-volume',
- 'os-vol-tenant-attr:tenant_id': 'fake_tenant'})
- shell_v1._translate_volume_keys([v])
- self.assertEqual('fake_tenant', v.tenant_id)
-
- def test_list(self):
- self.run_command('list')
- # NOTE(jdg): we default to detail currently
- self.assert_called('GET', '/volumes/detail?all_tenants=0')
-
- def test_list_filter_tenant_with_all_tenants(self):
- self.run_command('list --tenant=123 --all-tenants 1')
- self.assert_called('GET',
- '/volumes/detail?all_tenants=1&project_id=123')
-
- def test_list_filter_tenant_without_all_tenants(self):
- self.run_command('list --tenant=123')
- self.assert_called('GET',
- '/volumes/detail?all_tenants=1&project_id=123')
-
- def test_metadata_args_with_limiter(self):
- self.run_command('create --metadata key1="--test1" 1')
- expected = {'volume': {'snapshot_id': None,
- 'display_description': None,
- 'source_volid': None,
- 'status': 'creating',
- 'size': 1,
- 'volume_type': None,
- 'imageRef': None,
- 'availability_zone': None,
- 'attach_status': 'detached',
- 'user_id': None,
- 'project_id': None,
- 'metadata': {'key1': '"--test1"'},
- 'display_name': None}}
- self.assert_called_anytime('POST', '/volumes', expected)
-
- def test_metadata_args_limiter_display_name(self):
- self.run_command('create --metadata key1="--t1" --display-name="t" 1')
- expected = {'volume': {'snapshot_id': None,
- 'display_description': None,
- 'source_volid': None,
- 'status': 'creating',
- 'size': 1,
- 'volume_type': None,
- 'imageRef': None,
- 'availability_zone': None,
- 'attach_status': 'detached',
- 'user_id': None,
- 'project_id': None,
- 'metadata': {'key1': '"--t1"'},
- 'display_name': '"t"'}}
- self.assert_called_anytime('POST', '/volumes', expected)
-
- def test_delimit_metadata_args(self):
- self.run_command('create --metadata key1="test1" key2="test2" 1')
- expected = {'volume': {'snapshot_id': None,
- 'display_description': None,
- 'source_volid': None,
- 'status': 'creating',
- 'size': 1,
- 'volume_type': None,
- 'imageRef': None,
- 'availability_zone': None,
- 'attach_status': 'detached',
- 'user_id': None,
- 'project_id': None,
- 'metadata': {'key1': '"test1"',
- 'key2': '"test2"'},
- 'display_name': None}}
- self.assert_called_anytime('POST', '/volumes', expected)
-
- def test_delimit_metadata_args_display_name(self):
- self.run_command('create --metadata key1="t1" --display-name="t" 1')
- expected = {'volume': {'snapshot_id': None,
- 'display_description': None,
- 'source_volid': None,
- 'status': 'creating',
- 'size': 1,
- 'volume_type': None,
- 'imageRef': None,
- 'availability_zone': None,
- 'attach_status': 'detached',
- 'user_id': None,
- 'project_id': None,
- 'metadata': {'key1': '"t1"'},
- 'display_name': '"t"'}}
- self.assert_called_anytime('POST', '/volumes', expected)
-
- def test_list_filter_status(self):
- self.run_command('list --status=available')
- self.assert_called('GET',
- '/volumes/detail?all_tenants=0&status=available')
-
- def test_list_filter_display_name(self):
- self.run_command('list --display-name=1234')
- self.assert_called('GET',
- '/volumes/detail?all_tenants=0&display_name=1234')
-
- def test_list_all_tenants(self):
- self.run_command('list --all-tenants=1')
- self.assert_called('GET', '/volumes/detail?all_tenants=1')
-
- def test_list_availability_zone(self):
- self.run_command('availability-zone-list')
- self.assert_called('GET', '/os-availability-zone')
-
- def test_list_limit(self):
- self.run_command('list --limit=10')
- self.assert_called('GET', '/volumes/detail?all_tenants=0&limit=10')
-
- def test_show(self):
- self.run_command('show 1234')
- self.assert_called('GET', '/volumes/1234')
-
- def test_delete(self):
- self.run_command('delete 1234')
- self.assert_called('DELETE', '/volumes/1234')
-
- def test_delete_by_name(self):
- self.run_command('delete sample-volume')
- self.assert_called_anytime('GET', '/volumes/detail?all_tenants=1&'
- 'display_name=sample-volume')
- self.assert_called('DELETE', '/volumes/1234')
-
- def test_delete_multiple(self):
- self.run_command('delete 1234 5678')
- self.assert_called_anytime('DELETE', '/volumes/1234')
- self.assert_called('DELETE', '/volumes/5678')
-
- def test_backup(self):
- self.run_command('backup-create 1234')
- self.assert_called('POST', '/backups')
-
- def test_restore(self):
- self.run_command('backup-restore 1234')
- self.assert_called('POST', '/backups/1234/restore')
-
- def test_snapshot_list_filter_volume_id(self):
- self.run_command('snapshot-list --volume-id=1234')
- self.assert_called('GET',
- '/snapshots/detail?all_tenants=0&volume_id=1234')
-
- def test_snapshot_list_filter_status_and_volume_id(self):
- self.run_command('snapshot-list --status=available --volume-id=1234')
- self.assert_called('GET', '/snapshots/detail?'
- 'all_tenants=0&status=available&volume_id=1234')
-
- def test_rename(self):
- # basic rename with positional arguments
- self.run_command('rename 1234 new-name')
- expected = {'volume': {'display_name': 'new-name'}}
- self.assert_called('PUT', '/volumes/1234', body=expected)
- # change description only
- self.run_command('rename 1234 --display-description=new-description')
- expected = {'volume': {'display_description': 'new-description'}}
- self.assert_called('PUT', '/volumes/1234', body=expected)
- # rename and change description
- self.run_command('rename 1234 new-name '
- '--display-description=new-description')
- expected = {'volume': {
- 'display_name': 'new-name',
- 'display_description': 'new-description',
- }}
- self.assert_called('PUT', '/volumes/1234', body=expected)
-
- # Call rename with no arguments
- self.assertRaises(SystemExit, self.run_command, 'rename')
-
- def test_rename_snapshot(self):
- # basic rename with positional arguments
- self.run_command('snapshot-rename 1234 new-name')
- expected = {'snapshot': {'display_name': 'new-name'}}
- self.assert_called('PUT', '/snapshots/1234', body=expected)
- # change description only
- self.run_command('snapshot-rename 1234 '
- '--display-description=new-description')
- expected = {'snapshot': {'display_description': 'new-description'}}
- self.assert_called('PUT', '/snapshots/1234', body=expected)
- # snapshot-rename and change description
- self.run_command('snapshot-rename 1234 new-name '
- '--display-description=new-description')
- expected = {'snapshot': {
- 'display_name': 'new-name',
- 'display_description': 'new-description',
- }}
- self.assert_called('PUT', '/snapshots/1234', body=expected)
-
- # Call snapshot-rename with no arguments
- self.assertRaises(SystemExit, self.run_command, 'snapshot-rename')
-
- def test_set_metadata_set(self):
- self.run_command('metadata 1234 set key1=val1 key2=val2')
- self.assert_called('POST', '/volumes/1234/metadata',
- {'metadata': {'key1': 'val1', 'key2': 'val2'}})
-
- def test_set_metadata_delete_dict(self):
- self.run_command('metadata 1234 unset key1=val1 key2=val2')
- self.assert_called('DELETE', '/volumes/1234/metadata/key1')
- self.assert_called('DELETE', '/volumes/1234/metadata/key2', pos=-2)
-
- def test_set_metadata_delete_keys(self):
- self.run_command('metadata 1234 unset key1 key2')
- self.assert_called('DELETE', '/volumes/1234/metadata/key1')
- self.assert_called('DELETE', '/volumes/1234/metadata/key2', pos=-2)
-
- def test_reset_state(self):
- self.run_command('reset-state 1234')
- expected = {'os-reset_status': {'status': 'available'}}
- self.assert_called('POST', '/volumes/1234/action', body=expected)
-
- def test_reset_state_attach(self):
- self.run_command('reset-state --state in-use 1234')
- expected = {'os-reset_status': {'status': 'in-use'}}
- self.assert_called('POST', '/volumes/1234/action', body=expected)
-
- def test_reset_state_with_flag(self):
- self.run_command('reset-state --state error 1234')
- expected = {'os-reset_status': {'status': 'error'}}
- self.assert_called('POST', '/volumes/1234/action', body=expected)
-
- def test_reset_state_multiple(self):
- self.run_command('reset-state 1234 5678 --state error')
- expected = {'os-reset_status': {'status': 'error'}}
- self.assert_called_anytime('POST', '/volumes/1234/action',
- body=expected)
- self.assert_called_anytime('POST', '/volumes/5678/action',
- body=expected)
-
- def test_reset_state_two_with_one_nonexistent(self):
- cmd = 'reset-state 1234 123456789'
- self.assertRaises(exceptions.CommandError, self.run_command, cmd)
- expected = {'os-reset_status': {'status': 'available'}}
- self.assert_called_anytime('POST', '/volumes/1234/action',
- body=expected)
-
- def test_reset_state_one_with_one_nonexistent(self):
- cmd = 'reset-state 123456789'
- self.assertRaises(exceptions.CommandError, self.run_command, cmd)
-
- def test_snapshot_reset_state(self):
- self.run_command('snapshot-reset-state 1234')
- expected = {'os-reset_status': {'status': 'available'}}
- self.assert_called('POST', '/snapshots/1234/action', body=expected)
-
- def test_snapshot_reset_state_with_flag(self):
- self.run_command('snapshot-reset-state --state error 1234')
- expected = {'os-reset_status': {'status': 'error'}}
- self.assert_called('POST', '/snapshots/1234/action', body=expected)
-
- def test_snapshot_reset_state_multiple(self):
- self.run_command('snapshot-reset-state 1234 5678')
- expected = {'os-reset_status': {'status': 'available'}}
- self.assert_called_anytime('POST', '/snapshots/1234/action',
- body=expected)
- self.assert_called_anytime('POST', '/snapshots/5678/action',
- body=expected)
-
- def test_encryption_type_list(self):
- """
- Test encryption-type-list shell command.
-
- Verify a series of GET requests are made:
- - one to get the volume type list information
- - one per volume type to retrieve the encryption type information
- """
- self.run_command('encryption-type-list')
- self.assert_called_anytime('GET', '/types')
- self.assert_called_anytime('GET', '/types/1/encryption')
- self.assert_called_anytime('GET', '/types/2/encryption')
-
- def test_encryption_type_show(self):
- """
- Test encryption-type-show shell command.
-
- Verify two GET requests are made per command invocation:
- - one to get the volume type information
- - one to get the encryption type information
- """
- self.run_command('encryption-type-show 1')
- self.assert_called('GET', '/types/1/encryption')
- self.assert_called_anytime('GET', '/types/1')
-
- def test_encryption_type_create(self):
- """
- Test encryption-type-create shell command.
-
- Verify GET and POST requests are made per command invocation:
- - one GET request to retrieve the relevant volume type information
- - one POST request to create the new encryption type
- """
- expected = {'encryption': {'cipher': None, 'key_size': None,
- 'provider': 'TestProvider',
- 'control_location': 'front-end'}}
- self.run_command('encryption-type-create 2 TestProvider')
- self.assert_called('POST', '/types/2/encryption', body=expected)
- self.assert_called_anytime('GET', '/types/2')
-
- def test_encryption_type_update(self):
- """
- Test encryption-type-update shell command.
-
- Verify two GETs/one PUT requests are made per command invocation:
- - one GET request to retrieve the relevant volume type information
- - one GET request to retrieve the relevant encryption type information
- - one PUT request to update the encryption type information
- """
- self.skipTest("Not implemented")
-
- def test_encryption_type_delete(self):
- """
- Test encryption-type-delete shell command.
-
- Verify one GET/one DELETE requests are made per command invocation:
- - one GET request to retrieve the relevant volume type information
- - one DELETE request to delete the encryption type information
- """
- self.run_command('encryption-type-delete 1')
- self.assert_called('DELETE', '/types/1/encryption/provider')
- self.assert_called_anytime('GET', '/types/1')
-
- def test_migrate_volume(self):
- self.run_command('migrate 1234 fakehost --force-host-copy=True')
- expected = {'os-migrate_volume': {'force_host_copy': 'True',
- 'host': 'fakehost'}}
- self.assert_called('POST', '/volumes/1234/action', body=expected)
-
- def test_snapshot_metadata_set(self):
- self.run_command('snapshot-metadata 1234 set key1=val1 key2=val2')
- self.assert_called('POST', '/snapshots/1234/metadata',
- {'metadata': {'key1': 'val1', 'key2': 'val2'}})
-
- def test_snapshot_metadata_unset_dict(self):
- self.run_command('snapshot-metadata 1234 unset key1=val1 key2=val2')
- self.assert_called_anytime('DELETE', '/snapshots/1234/metadata/key1')
- self.assert_called_anytime('DELETE', '/snapshots/1234/metadata/key2')
-
- def test_snapshot_metadata_unset_keys(self):
- self.run_command('snapshot-metadata 1234 unset key1 key2')
- self.assert_called_anytime('DELETE', '/snapshots/1234/metadata/key1')
- self.assert_called_anytime('DELETE', '/snapshots/1234/metadata/key2')
-
- def test_volume_metadata_update_all(self):
- self.run_command('metadata-update-all 1234 key1=val1 key2=val2')
- self.assert_called('PUT', '/volumes/1234/metadata',
- {'metadata': {'key1': 'val1', 'key2': 'val2'}})
-
- def test_snapshot_metadata_update_all(self):
- self.run_command('snapshot-metadata-update-all\
- 1234 key1=val1 key2=val2')
- self.assert_called('PUT', '/snapshots/1234/metadata',
- {'metadata': {'key1': 'val1', 'key2': 'val2'}})
-
- def test_readonly_mode_update(self):
- self.run_command('readonly-mode-update 1234 True')
- expected = {'os-update_readonly_flag': {'readonly': True}}
- self.assert_called('POST', '/volumes/1234/action', body=expected)
-
- self.run_command('readonly-mode-update 1234 False')
- expected = {'os-update_readonly_flag': {'readonly': False}}
- self.assert_called('POST', '/volumes/1234/action', body=expected)
-
- def test_service_disable(self):
- self.run_command('service-disable host cinder-volume')
- self.assert_called('PUT', '/os-services/disable',
- {"binary": "cinder-volume", "host": "host"})
-
- def test_services_disable_with_reason(self):
- cmd = 'service-disable host cinder-volume --reason no_reason'
- self.run_command(cmd)
- body = {'host': 'host', 'binary': 'cinder-volume',
- 'disabled_reason': 'no_reason'}
- self.assert_called('PUT', '/os-services/disable-log-reason', body)
-
- def test_service_enable(self):
- self.run_command('service-enable host cinder-volume')
- self.assert_called('PUT', '/os-services/enable',
- {"binary": "cinder-volume", "host": "host"})
-
- def test_snapshot_delete(self):
- self.run_command('snapshot-delete 1234')
- self.assert_called('DELETE', '/snapshots/1234')
-
- def test_quota_delete(self):
- self.run_command('quota-delete 1234')
- self.assert_called('DELETE', '/os-quota-sets/1234')
-
- def test_snapshot_delete_multiple(self):
- self.run_command('snapshot-delete 1234 5678')
- self.assert_called('DELETE', '/snapshots/5678')
-
- def test_list_transfer(self):
- self.run_command('transfer-list')
- self.assert_called('GET', '/os-volume-transfer/detail?all_tenants=0')
-
- def test_list_transfer_all_tenants(self):
- self.run_command('transfer-list --all-tenants=1')
- self.assert_called('GET', '/os-volume-transfer/detail?all_tenants=1')
diff --git a/cinderclient/tests/unit/v1/test_snapshot_actions.py b/cinderclient/tests/unit/v1/test_snapshot_actions.py
deleted file mode 100644
index 2b0402883..000000000
--- a/cinderclient/tests/unit/v1/test_snapshot_actions.py
+++ /dev/null
@@ -1,36 +0,0 @@
-# Copyright 2013 Red Hat, Inc.
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit.fixture_data import client
-from cinderclient.tests.unit.fixture_data import snapshots
-from cinderclient.tests.unit import utils
-
-
-class SnapshotActionsTest(utils.FixturedTestCase):
-
- client_fixture_class = client.V1
- data_fixture_class = snapshots.Fixture
-
- def test_update_snapshot_status(self):
- s = self.cs.volume_snapshots.get('1234')
- stat = {'status': 'available'}
- self.cs.volume_snapshots.update_snapshot_status(s, stat)
- self.assert_called('POST', '/snapshots/1234/action')
-
- def test_update_snapshot_status_with_progress(self):
- s = self.cs.volume_snapshots.get('1234')
- stat = {'status': 'available', 'progress': '73%'}
- self.cs.volume_snapshots.update_snapshot_status(s, stat)
- self.assert_called('POST', '/snapshots/1234/action')
diff --git a/cinderclient/tests/unit/v1/test_types.py b/cinderclient/tests/unit/v1/test_types.py
deleted file mode 100644
index 6f1b0c29e..000000000
--- a/cinderclient/tests/unit/v1/test_types.py
+++ /dev/null
@@ -1,54 +0,0 @@
-# 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 cinderclient.v1 import volume_types
-
-from cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-cs = fakes.FakeClient()
-
-
-class TypesTest(utils.TestCase):
- def test_list_types(self):
- tl = cs.volume_types.list()
- cs.assert_called('GET', '/types')
- for t in tl:
- self.assertIsInstance(t, volume_types.VolumeType)
-
- def test_create(self):
- t = cs.volume_types.create('test-type-3')
- cs.assert_called('POST', '/types')
- self.assertIsInstance(t, volume_types.VolumeType)
-
- def test_set_key(self):
- t = cs.volume_types.get(1)
- t.set_keys({'k': 'v'})
- cs.assert_called('POST',
- '/types/1/extra_specs',
- {'extra_specs': {'k': 'v'}})
-
- def test_unset_keys(self):
- t = cs.volume_types.get(1)
- t.unset_keys(['k'])
- cs.assert_called('DELETE', '/types/1/extra_specs/k')
-
- def test_unset_multiple_keys(self):
- t = cs.volume_types.get(1)
- t.unset_keys(['k', 'm'])
- cs.assert_called_anytime('DELETE', '/types/1/extra_specs/k')
- cs.assert_called_anytime('DELETE', '/types/1/extra_specs/m')
-
- def test_delete(self):
- cs.volume_types.delete(1)
- cs.assert_called('DELETE', '/types/1')
diff --git a/cinderclient/tests/unit/v1/test_volume_backups.py b/cinderclient/tests/unit/v1/test_volume_backups.py
deleted file mode 100644
index 94020fa39..000000000
--- a/cinderclient/tests/unit/v1/test_volume_backups.py
+++ /dev/null
@@ -1,53 +0,0 @@
-# Copyright (C) 2013 Hewlett-Packard Development Company, L.P.
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-cs = fakes.FakeClient()
-
-
-class VolumeBackupsTest(utils.TestCase):
-
- def test_create(self):
- cs.backups.create('2b695faf-b963-40c8-8464-274008fbcef4')
- cs.assert_called('POST', '/backups')
-
- def test_get(self):
- backup_id = '76a17945-3c6f-435c-975b-b5685db10b62'
- cs.backups.get(backup_id)
- cs.assert_called('GET', '/backups/%s' % backup_id)
-
- def test_list(self):
- cs.backups.list()
- cs.assert_called('GET', '/backups/detail')
-
- def test_delete(self):
- b = cs.backups.list()[0]
- b.delete()
- cs.assert_called('DELETE',
- '/backups/76a17945-3c6f-435c-975b-b5685db10b62')
- cs.backups.delete('76a17945-3c6f-435c-975b-b5685db10b62')
- cs.assert_called('DELETE',
- '/backups/76a17945-3c6f-435c-975b-b5685db10b62')
- cs.backups.delete(b)
- cs.assert_called('DELETE',
- '/backups/76a17945-3c6f-435c-975b-b5685db10b62')
-
- def test_restore(self):
- backup_id = '76a17945-3c6f-435c-975b-b5685db10b62'
- cs.restores.restore(backup_id)
- cs.assert_called('POST', '/backups/%s/restore' % backup_id)
diff --git a/cinderclient/tests/unit/v1/test_volume_encryption_types.py b/cinderclient/tests/unit/v1/test_volume_encryption_types.py
deleted file mode 100644
index 48554b07f..000000000
--- a/cinderclient/tests/unit/v1/test_volume_encryption_types.py
+++ /dev/null
@@ -1,119 +0,0 @@
-# Copyright (c) 2013 The Johns Hopkins University/Applied Physics Laboratory
-# All Rights Reserved.
-#
-# 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 cinderclient.v1.volume_encryption_types import VolumeEncryptionType
-
-from cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-cs = fakes.FakeClient()
-
-FAKE_ENCRY_TYPE = {'provider': 'Test',
- 'key_size': None,
- 'cipher': None,
- 'control_location': None,
- 'volume_type_id': '65922555-7bc0-47e9-8d88-c7fdbcac4781',
- 'encryption_id': '62daf814-cf9b-401c-8fc8-f84d7850fb7c'}
-
-
-class VolumeEncryptionTypesTest(utils.TestCase):
- """
- Test suite for the Volume Encryption Types Resource and Manager.
- """
-
- def test_list(self):
- """
- Unit test for VolumeEncryptionTypesManager.list
-
- Verify that a series of GET requests are made:
- - one GET request for the list of volume types
- - one GET request per volume type for encryption type information
-
- Verify that all returned information is :class: VolumeEncryptionType
- """
- encryption_types = cs.volume_encryption_types.list()
- cs.assert_called_anytime('GET', '/types')
- cs.assert_called_anytime('GET', '/types/2/encryption')
- cs.assert_called_anytime('GET', '/types/1/encryption')
- for encryption_type in encryption_types:
- self.assertIsInstance(encryption_type, VolumeEncryptionType)
-
- def test_get(self):
- """
- Unit test for VolumeEncryptionTypesManager.get
-
- Verify that one GET request is made for the volume type encryption
- type information. Verify that returned information is :class:
- VolumeEncryptionType
- """
- encryption_type = cs.volume_encryption_types.get(1)
- cs.assert_called('GET', '/types/1/encryption')
- self.assertIsInstance(encryption_type, VolumeEncryptionType)
-
- def test_get_no_encryption(self):
- """
- Unit test for VolumeEncryptionTypesManager.get
-
- Verify that a request on a volume type with no associated encryption
- type information returns a VolumeEncryptionType with no attributes.
- """
- encryption_type = cs.volume_encryption_types.get(2)
- self.assertIsInstance(encryption_type, VolumeEncryptionType)
- self.assertFalse(hasattr(encryption_type, 'id'),
- 'encryption type has an id')
-
- def test_create(self):
- """
- Unit test for VolumeEncryptionTypesManager.create
-
- Verify that one POST request is made for the encryption type creation.
- Verify that encryption type creation returns a VolumeEncryptionType.
- """
- result = cs.volume_encryption_types.create(2, {'provider': 'Test',
- 'key_size': None,
- 'cipher': None,
- 'control_location':
- None})
- cs.assert_called('POST', '/types/2/encryption')
- self.assertIsInstance(result, VolumeEncryptionType)
-
- def test_update(self):
- """
- Unit test for VolumeEncryptionTypesManager.update
- """
- self.skipTest("Not implemented")
-
- def test_delete(self):
- """
- Unit test for VolumeEncryptionTypesManager.delete
-
- Verify that one DELETE request is made for encryption type deletion
- Verify that encryption type deletion returns None
- """
- result = cs.volume_encryption_types.delete(1)
- cs.assert_called('DELETE', '/types/1/encryption/provider')
- self.assertIsInstance(result, tuple)
- self.assertEqual(202, result[0].status_code)
-
- def test___repr__(self):
- """
- Unit test for VolumeEncryptionTypes.__repr__
-
- Verify that one encryption type can be printed
- """
- encry_type = VolumeEncryptionType(None, FAKE_ENCRY_TYPE)
- self.assertEqual(
- "<VolumeEncryptionType: %s>" % FAKE_ENCRY_TYPE['encryption_id'],
- repr(encry_type))
diff --git a/cinderclient/tests/unit/v1/test_volume_transfers.py b/cinderclient/tests/unit/v1/test_volume_transfers.py
deleted file mode 100644
index 4b27cb3f1..000000000
--- a/cinderclient/tests/unit/v1/test_volume_transfers.py
+++ /dev/null
@@ -1,51 +0,0 @@
-# Copyright (C) 2013 Hewlett-Packard Development Company, L.P.
-# All Rights Reserved.
-#
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-cs = fakes.FakeClient()
-
-
-class VolumeTransfersTest(utils.TestCase):
-
- def test_create(self):
- cs.transfers.create('1234')
- cs.assert_called('POST', '/os-volume-transfer')
-
- def test_get(self):
- transfer_id = '5678'
- cs.transfers.get(transfer_id)
- cs.assert_called('GET', '/os-volume-transfer/%s' % transfer_id)
-
- def test_list(self):
- cs.transfers.list()
- cs.assert_called('GET', '/os-volume-transfer/detail')
-
- def test_delete(self):
- b = cs.transfers.list()[0]
- b.delete()
- cs.assert_called('DELETE', '/os-volume-transfer/5678')
- cs.transfers.delete('5678')
- cs.assert_called('DELETE', '/os-volume-transfer/5678')
- cs.transfers.delete(b)
- cs.assert_called('DELETE', '/os-volume-transfer/5678')
-
- def test_accept(self):
- transfer_id = '5678'
- auth_key = '12345'
- cs.transfers.accept(transfer_id, auth_key)
- cs.assert_called('POST', '/os-volume-transfer/%s/accept' % transfer_id)
diff --git a/cinderclient/tests/unit/v1/test_volumes.py b/cinderclient/tests/unit/v1/test_volumes.py
deleted file mode 100644
index 8906a4eba..000000000
--- a/cinderclient/tests/unit/v1/test_volumes.py
+++ /dev/null
@@ -1,118 +0,0 @@
-# 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 cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
-
-
-cs = fakes.FakeClient()
-
-
-class VolumesTest(utils.TestCase):
-
- def test_delete_volume(self):
- v = cs.volumes.list()[0]
- v.delete()
- cs.assert_called('DELETE', '/volumes/1234')
- cs.volumes.delete('1234')
- cs.assert_called('DELETE', '/volumes/1234')
- cs.volumes.delete(v)
- cs.assert_called('DELETE', '/volumes/1234')
-
- def test_create_volume(self):
- cs.volumes.create(1)
- cs.assert_called('POST', '/volumes')
-
- def test_attach(self):
- v = cs.volumes.get('1234')
- cs.volumes.attach(v, 1, '/dev/vdc', mode='rw')
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_attach_to_host(self):
- v = cs.volumes.get('1234')
- cs.volumes.attach(v, None, None, host_name='test', mode='rw')
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_detach(self):
- v = cs.volumes.get('1234')
- cs.volumes.detach(v)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_reserve(self):
- v = cs.volumes.get('1234')
- cs.volumes.reserve(v)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_unreserve(self):
- v = cs.volumes.get('1234')
- cs.volumes.unreserve(v)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_begin_detaching(self):
- v = cs.volumes.get('1234')
- cs.volumes.begin_detaching(v)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_roll_detaching(self):
- v = cs.volumes.get('1234')
- cs.volumes.roll_detaching(v)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_initialize_connection(self):
- v = cs.volumes.get('1234')
- cs.volumes.initialize_connection(v, {})
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_terminate_connection(self):
- v = cs.volumes.get('1234')
- cs.volumes.terminate_connection(v, {})
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_set_metadata(self):
- cs.volumes.set_metadata(1234, {'k1': 'v1'})
- cs.assert_called('POST', '/volumes/1234/metadata',
- {'metadata': {'k1': 'v1'}})
-
- def test_delete_metadata(self):
- keys = ['key1']
- cs.volumes.delete_metadata(1234, keys)
- cs.assert_called('DELETE', '/volumes/1234/metadata/key1')
-
- def test_extend(self):
- v = cs.volumes.get('1234')
- cs.volumes.extend(v, 2)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_get_encryption_metadata(self):
- cs.volumes.get_encryption_metadata('1234')
- cs.assert_called('GET', '/volumes/1234/encryption')
-
- def test_migrate(self):
- v = cs.volumes.get('1234')
- cs.volumes.migrate_volume(v, 'dest', False)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_metadata_update_all(self):
- cs.volumes.update_all_metadata(1234, {'k1': 'v1'})
- cs.assert_called('PUT', '/volumes/1234/metadata',
- {'metadata': {'k1': 'v1'}})
-
- def test_readonly_mode_update(self):
- v = cs.volumes.get('1234')
- cs.volumes.update_readonly_flag(v, True)
- cs.assert_called('POST', '/volumes/1234/action')
-
- def test_set_bootable(self):
- v = cs.volumes.get('1234')
- cs.volumes.set_bootable(v, True)
- cs.assert_called('POST', '/volumes/1234/action')
diff --git a/cinderclient/tests/unit/v1/testfile.txt b/cinderclient/tests/unit/v1/testfile.txt
deleted file mode 100644
index e4e860f38..000000000
--- a/cinderclient/tests/unit/v1/testfile.txt
+++ /dev/null
@@ -1 +0,0 @@
-BLAH
diff --git a/cinderclient/tests/unit/v2/contrib/test_list_extensions.py b/cinderclient/tests/unit/v2/contrib/test_list_extensions.py
index 4603bca5f..313b6ef58 100644
--- a/cinderclient/tests/unit/v2/contrib/test_list_extensions.py
+++ b/cinderclient/tests/unit/v2/contrib/test_list_extensions.py
@@ -18,7 +18,7 @@ from cinderclient import extension
from cinderclient.v2.contrib import list_extensions
from cinderclient.tests.unit import utils
-from cinderclient.tests.unit.v1 import fakes
+from cinderclient.tests.unit.v2 import fakes
extensions = [
diff --git a/cinderclient/tests/unit/v3/fakes.py b/cinderclient/tests/unit/v3/fakes.py
index b552f5ec7..928adb1e5 100644
--- a/cinderclient/tests/unit/v3/fakes.py
+++ b/cinderclient/tests/unit/v3/fakes.py
@@ -671,19 +671,7 @@ class FakeHTTPClient(fake_v2.FakeHTTPClient):
def fake_request_get():
- versions = {'versions': [{'id': 'v1.0',
- 'links': [{'href': 'http://docs.openstack.org/',
- 'rel': 'describedby',
- 'type': 'text/html'},
- {'href': 'http://192.168.122.197/v1/',
- 'rel': 'self'}],
- 'media-types': [{'base': 'application/json',
- 'type': 'application/'}],
- 'min_version': '',
- 'status': 'DEPRECATED',
- 'updated': '2016-05-02T20:25:19Z',
- 'version': ''},
- {'id': 'v2.0',
+ versions = {'versions': [{'id': 'v2.0',
'links': [{'href': 'http://docs.openstack.org/',
'rel': 'describedby',
'type': 'text/html'},
@@ -692,7 +680,7 @@ def fake_request_get():
'media-types': [{'base': 'application/json',
'type': 'application/'}],
'min_version': '',
- 'status': 'SUPPORTED',
+ 'status': 'DEPRECATED',
'updated': '2014-06-28T12:20:21Z',
'version': ''},
{'id': 'v3.0',
@@ -711,19 +699,7 @@ def fake_request_get():
def fake_request_get_no_v3():
- versions = {'versions': [{'id': 'v1.0',
- 'links': [{'href': 'http://docs.openstack.org/',
- 'rel': 'describedby',
- 'type': 'text/html'},
- {'href': 'http://192.168.122.197/v1/',
- 'rel': 'self'}],
- 'media-types': [{'base': 'application/json',
- 'type': 'application/'}],
- 'min_version': '',
- 'status': 'DEPRECATED',
- 'updated': '2016-05-02T20:25:19Z',
- 'version': ''},
- {'id': 'v2.0',
+ versions = {'versions': [{'id': 'v2.0',
'links': [{'href': 'http://docs.openstack.org/',
'rel': 'describedby',
'type': 'text/html'},
@@ -732,7 +708,7 @@ def fake_request_get_no_v3():
'media-types': [{'base': 'application/json',
'type': 'application/'}],
'min_version': '',
- 'status': 'SUPPORTED',
+ 'status': 'DEPRECATED',
'updated': '2014-06-28T12:20:21Z',
'version': ''}]}
return versions
diff --git a/cinderclient/v1/__init__.py b/cinderclient/v1/__init__.py
deleted file mode 100644
index 3637ffdda..000000000
--- a/cinderclient/v1/__init__.py
+++ /dev/null
@@ -1,17 +0,0 @@
-# Copyright (c) 2012 OpenStack Foundation
-#
-# All Rights Reserved.
-#
-# 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 cinderclient.v1.client import Client # noqa
diff --git a/cinderclient/v1/availability_zones.py b/cinderclient/v1/availability_zones.py
deleted file mode 100644
index b85d6dd3c..000000000
--- a/cinderclient/v1/availability_zones.py
+++ /dev/null
@@ -1,42 +0,0 @@
-# Copyright 2011-2013 OpenStack Foundation
-# Copyright 2013 IBM Corp.
-# All Rights Reserved.
-#
-# 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.
-
-"""Availability Zone interface (v1 extension)"""
-
-from cinderclient import base
-
-
-class AvailabilityZone(base.Resource):
- NAME_ATTR = 'display_name'
-
- def __repr__(self):
- return "<AvailabilityZone: %s>" % self.zoneName
-
-
-class AvailabilityZoneManager(base.ManagerWithFind):
- """Manage :class:`AvailabilityZone` resources."""
- resource_class = AvailabilityZone
-
- def list(self, detailed=False):
- """Lists all availability zones.
-
- :rtype: list of :class:`AvailabilityZone`
- """
- if detailed is True:
- return self._list("/os-availability-zone/detail",
- "availabilityZoneInfo")
- else:
- return self._list("/os-availability-zone", "availabilityZoneInfo")
diff --git a/cinderclient/v1/client.py b/cinderclient/v1/client.py
deleted file mode 100644
index ca534cf45..000000000
--- a/cinderclient/v1/client.py
+++ /dev/null
@@ -1,123 +0,0 @@
-# Copyright (c) 2013 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient import client
-from cinderclient.v1 import availability_zones
-from cinderclient.v1 import limits
-from cinderclient.v1 import qos_specs
-from cinderclient.v1 import quota_classes
-from cinderclient.v1 import quotas
-from cinderclient.v1 import services
-from cinderclient.v1 import volume_backups
-from cinderclient.v1 import volume_backups_restore
-from cinderclient.v1 import volume_encryption_types
-from cinderclient.v1 import volume_snapshots
-from cinderclient.v1 import volume_transfers
-from cinderclient.v1 import volume_types
-from cinderclient.v1 import volumes
-
-
-class Client(object):
- """
- Top-level object to access the OpenStack Volume API.
-
- Create an instance with your creds::
-
- >>> client = Client(USERNAME, PASSWORD, PROJECT_ID, AUTH_URL)
-
- Then call methods on its managers::
-
- >>> client.volumes.list()
- ...
-
- """
-
- version = '1'
-
- def __init__(self, username=None, api_key=None, project_id=None,
- auth_url='', insecure=False, timeout=None, tenant_id=None,
- proxy_tenant_id=None, proxy_token=None, region_name=None,
- endpoint_type='publicURL', extensions=None,
- service_type='volume', service_name=None,
- volume_service_name=None, bypass_url=None,
- retries=0, http_log_debug=False,
- cacert=None, auth_system='keystone', auth_plugin=None,
- session=None, **kwargs):
- # FIXME(comstud): Rename the api_key argument above when we
- # know it's not being used as keyword argument
- password = api_key
- self.limits = limits.LimitsManager(self)
-
- # extensions
- self.volumes = volumes.VolumeManager(self)
- self.volume_snapshots = volume_snapshots.SnapshotManager(self)
- self.volume_types = volume_types.VolumeTypeManager(self)
- self.volume_encryption_types = \
- volume_encryption_types.VolumeEncryptionTypeManager(self)
- self.qos_specs = qos_specs.QoSSpecsManager(self)
- self.quota_classes = quota_classes.QuotaClassSetManager(self)
- self.quotas = quotas.QuotaSetManager(self)
- self.backups = volume_backups.VolumeBackupManager(self)
- self.restores = volume_backups_restore.VolumeBackupRestoreManager(self)
- self.transfers = volume_transfers.VolumeTransferManager(self)
- self.services = services.ServiceManager(self)
- self.availability_zones = \
- availability_zones.AvailabilityZoneManager(self)
-
- # Add in any extensions...
- if extensions:
- for extension in extensions:
- if extension.manager_class:
- setattr(self, extension.name,
- extension.manager_class(self))
-
- self.client = client._construct_http_client(
- username=username,
- password=password,
- project_id=project_id,
- auth_url=auth_url,
- insecure=insecure,
- timeout=timeout,
- tenant_id=tenant_id,
- proxy_tenant_id=tenant_id,
- proxy_token=proxy_token,
- region_name=region_name,
- endpoint_type=endpoint_type,
- service_type=service_type,
- service_name=service_name,
- volume_service_name=volume_service_name,
- bypass_url=bypass_url,
- retries=retries,
- http_log_debug=http_log_debug,
- cacert=cacert,
- auth_system=auth_system,
- auth_plugin=auth_plugin,
- session=session,
- **kwargs)
-
- def authenticate(self):
- """
- Authenticate against the server.
-
- Normally this is called automatically when you first access the API,
- but you can call this method to force authentication right now.
-
- Returns on success; raises :exc:`exceptions.Unauthorized` if the
- credentials are wrong.
- """
- self.client.authenticate()
-
- def get_volume_api_version_from_endpoint(self):
- return self.client.get_volume_api_version_from_endpoint()
diff --git a/cinderclient/v1/contrib/__init__.py b/cinderclient/v1/contrib/__init__.py
deleted file mode 100644
index e69de29bb..000000000
diff --git a/cinderclient/v1/contrib/list_extensions.py b/cinderclient/v1/contrib/list_extensions.py
deleted file mode 100644
index f63ba5f22..000000000
--- a/cinderclient/v1/contrib/list_extensions.py
+++ /dev/null
@@ -1,46 +0,0 @@
-# Copyright (c) 2011 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient import base
-from cinderclient import utils
-
-
-class ListExtResource(base.Resource):
- @property
- def summary(self):
- descr = self.description.strip()
- if not descr:
- return '??'
- lines = descr.split("\n")
- if len(lines) == 1:
- return lines[0]
- else:
- return lines[0] + "..."
-
-
-class ListExtManager(base.Manager):
- resource_class = ListExtResource
-
- def show_all(self):
- return self._list("/extensions", 'extensions')
-
-
-def do_list_extensions(client, _args):
- """
- Lists all available os-api extensions.
- """
- extensions = client.list_extensions.show_all()
- fields = ["Name", "Summary", "Alias", "Updated"]
- utils.print_list(extensions, fields)
diff --git a/cinderclient/v1/limits.py b/cinderclient/v1/limits.py
deleted file mode 100644
index 1ae281524..000000000
--- a/cinderclient/v1/limits.py
+++ /dev/null
@@ -1,92 +0,0 @@
-# Copyright 2011 OpenStack Foundation
-#
-# 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 cinderclient import base
-
-
-class Limits(base.Resource):
- """A collection of RateLimit and AbsoluteLimit objects."""
-
- def __repr__(self):
- return "<Limits>"
-
- @property
- def absolute(self):
- for (name, value) in list(self._info['absolute'].items()):
- yield AbsoluteLimit(name, value)
-
- @property
- def rate(self):
- for group in self._info['rate']:
- uri = group['uri']
- regex = group['regex']
- for rate in group['limit']:
- yield RateLimit(rate['verb'], uri, regex, rate['value'],
- rate['remaining'], rate['unit'],
- rate['next-available'])
-
-
-class RateLimit(object):
- """Data model that represents a flattened view of a single rate limit."""
-
- def __init__(self, verb, uri, regex, value, remain,
- unit, next_available):
- self.verb = verb
- self.uri = uri
- self.regex = regex
- self.value = value
- self.remain = remain
- self.unit = unit
- self.next_available = next_available
-
- def __eq__(self, other):
- return self.uri == other.uri \
- and self.regex == other.regex \
- and self.value == other.value \
- and self.verb == other.verb \
- and self.remain == other.remain \
- and self.unit == other.unit \
- and self.next_available == other.next_available
-
- def __repr__(self):
- return "<RateLimit: method=%s uri=%s>" % (self.verb, self.uri)
-
-
-class AbsoluteLimit(object):
- """Data model that represents a single absolute limit."""
-
- def __init__(self, name, value):
- self.name = name
- self.value = value
-
- def __eq__(self, other):
- return self.value == other.value and self.name == other.name
-
- def __repr__(self):
- return "<AbsoluteLimit: name=%s>" % (self.name)
-
-
-class LimitsManager(base.Manager):
- """Manager object used to interact with limits resource."""
-
- resource_class = Limits
-
- def get(self):
- """
- Get a specific extension.
-
- :rtype: :class:`Limits`
- """
- return self._get("/limits", "limits")
diff --git a/cinderclient/v1/qos_specs.py b/cinderclient/v1/qos_specs.py
deleted file mode 100644
index f54d2f6b1..000000000
--- a/cinderclient/v1/qos_specs.py
+++ /dev/null
@@ -1,149 +0,0 @@
-# Copyright (c) 2013 eBay Inc.
-# Copyright (c) OpenStack Foundation
-#
-# 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.
-
-
-"""
-QoS Specs interface.
-"""
-
-from cinderclient import base
-
-
-class QoSSpecs(base.Resource):
- """QoS specs entity represents quality-of-service parameters/requirements.
-
- A QoS specs is a set of parameters or requirements for quality-of-service
- purpose, which can be associated with volume types (for now). In future,
- QoS specs may be extended to be associated other entities, such as single
- volume.
- """
- def __repr__(self):
- return "<QoSSpecs: %s>" % self.name
-
- def delete(self):
- return self.manager.delete(self)
-
-
-class QoSSpecsManager(base.ManagerWithFind):
- """
- Manage :class:`QoSSpecs` resources.
- """
- resource_class = QoSSpecs
-
- def list(self, search_opts=None):
- """Get a list of all qos specs.
-
- :rtype: list of :class:`QoSSpecs`.
- """
- return self._list("/qos-specs", "qos_specs")
-
- def get(self, qos_specs):
- """Get a specific qos specs.
-
- :param qos_specs: The ID of the :class:`QoSSpecs` to get.
- :rtype: :class:`QoSSpecs`
- """
- return self._get("/qos-specs/%s" % base.getid(qos_specs), "qos_specs")
-
- def delete(self, qos_specs, force=False):
- """Delete a specific qos specs.
-
- :param qos_specs: The ID of the :class:`QoSSpecs` to be removed.
- :param force: Flag that indicates whether to delete target qos specs
- if it was in-use.
- """
- self._delete("/qos-specs/%s?force=%s" %
- (base.getid(qos_specs), force))
-
- def create(self, name, specs):
- """Create a qos specs.
-
- :param name: Descriptive name of the qos specs, must be unique
- :param specs: A dict of key/value pairs to be set
- :rtype: :class:`QoSSpecs`
- """
-
- body = {
- "qos_specs": {
- "name": name,
- }
- }
-
- body["qos_specs"].update(specs)
- return self._create("/qos-specs", body, "qos_specs")
-
- def set_keys(self, qos_specs, specs):
- """Add/Update keys in a qos_specs.
-
- :param qos_specs: The ID of qos specs
- :param specs: A dict of key/value pairs to be set
- :rtype: :class:`QoSSpecs`
- """
-
- body = {
- "qos_specs": {}
- }
-
- body["qos_specs"].update(specs)
- return self._update("/qos-specs/%s" % qos_specs, body)
-
- def unset_keys(self, qos_specs, specs):
- """Remove keys from a qos specs.
-
- :param qos_specs: The ID of qos specs
- :param specs: A list of key to be unset
- :rtype: :class:`QoSSpecs`
- """
-
- body = {'keys': specs}
-
- return self._update("/qos-specs/%s/delete_keys" % qos_specs,
- body)
-
- def get_associations(self, qos_specs):
- """Get associated entities of a qos specs.
-
- :param qos_specs: The id of the :class: `QoSSpecs`
- :return: a list of entities that associated with specific qos specs.
- """
- return self._list("/qos-specs/%s/associations" % base.getid(qos_specs),
- "qos_associations")
-
- def associate(self, qos_specs, vol_type_id):
- """Associate a volume type with specific qos specs.
-
- :param qos_specs: The qos specs to be associated with
- :param vol_type_id: The volume type id to be associated with
- """
- self.api.client.get("/qos-specs/%s/associate?vol_type_id=%s" %
- (base.getid(qos_specs), vol_type_id))
-
- def disassociate(self, qos_specs, vol_type_id):
- """Disassociate qos specs from volume type.
-
- :param qos_specs: The qos specs to be associated with
- :param vol_type_id: The volume type id to be associated with
- """
- self.api.client.get("/qos-specs/%s/disassociate?vol_type_id=%s" %
- (base.getid(qos_specs), vol_type_id))
-
- def disassociate_all(self, qos_specs):
- """Disassociate all entities from specific qos specs.
-
- :param qos_specs: The qos specs to be associated with
- """
- self.api.client.get("/qos-specs/%s/disassociate_all" %
- base.getid(qos_specs))
diff --git a/cinderclient/v1/quota_classes.py b/cinderclient/v1/quota_classes.py
deleted file mode 100644
index 37441b32c..000000000
--- a/cinderclient/v1/quota_classes.py
+++ /dev/null
@@ -1,47 +0,0 @@
-# Copyright (c) 2012 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient import base
-
-
-class QuotaClassSet(base.Resource):
-
- @property
- def id(self):
- """QuotaClassSet does not have a 'id' attribute but base.Resource
- needs it to self-refresh and QuotaSet is indexed by class_name.
- """
- return self.class_name
-
- def update(self, *args, **kwargs):
- return self.manager.update(self.class_name, *args, **kwargs)
-
-
-class QuotaClassSetManager(base.Manager):
- resource_class = QuotaClassSet
-
- def get(self, class_name):
- return self._get("/os-quota-class-sets/%s" % (class_name),
- "quota_class_set")
-
- def update(self, class_name, **updates):
- body = {'quota_class_set': {'class_name': class_name}}
-
- for update in updates:
- body['quota_class_set'][update] = updates[update]
-
- result = self._update('/os-quota-class-sets/%s' % (class_name), body)
- return self.resource_class(self,
- result['quota_class_set'], loaded=True)
diff --git a/cinderclient/v1/quotas.py b/cinderclient/v1/quotas.py
deleted file mode 100644
index 7453cb7fe..000000000
--- a/cinderclient/v1/quotas.py
+++ /dev/null
@@ -1,57 +0,0 @@
-# Copyright (c) 2011 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 cinderclient import base
-
-
-class QuotaSet(base.Resource):
-
- @property
- def id(self):
- """QuotaSet does not have a 'id' attribute but base. Resource needs it
- to self-refresh and QuotaSet is indexed by tenant_id.
- """
- return self.tenant_id
-
- def update(self, *args, **kwargs):
- return self.manager.update(self.tenant_id, *args, **kwargs)
-
-
-class QuotaSetManager(base.Manager):
- resource_class = QuotaSet
-
- def get(self, tenant_id, usage=False):
- if hasattr(tenant_id, 'tenant_id'):
- tenant_id = tenant_id.tenant_id
- return self._get("/os-quota-sets/%s?usage=%s" % (tenant_id, usage),
- "quota_set")
-
- def update(self, tenant_id, **updates):
- body = {'quota_set': {'tenant_id': tenant_id}}
-
- for update in updates:
- body['quota_set'][update] = updates[update]
-
- result = self._update('/os-quota-sets/%s' % (tenant_id), body)
- return self.resource_class(self, result['quota_set'], loaded=True)
-
- def defaults(self, tenant_id):
- return self._get('/os-quota-sets/%s/defaults' % tenant_id,
- 'quota_set')
-
- def delete(self, tenant_id):
- if hasattr(tenant_id, 'tenant_id'):
- tenant_id = tenant_id.tenant_id
- return self._delete("/os-quota-sets/%s" % tenant_id)
diff --git a/cinderclient/v1/services.py b/cinderclient/v1/services.py
deleted file mode 100644
index b6faf0399..000000000
--- a/cinderclient/v1/services.py
+++ /dev/null
@@ -1,64 +0,0 @@
-# Copyright (c) 2013 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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.
-
-"""
-service interface
-"""
-from cinderclient import base
-
-
-class Service(base.Resource):
-
- def __repr__(self):
- return "<Service: binary=%s host=%s>" % (self.binary, self.host)
-
-
-class ServiceManager(base.ManagerWithFind):
- resource_class = Service
-
- def list(self, host=None, binary=None):
- """
- Describes service list for host.
-
- :param host: destination host name.
- :param binary: service binary.
- """
- url = "/os-services"
- filters = []
- if host:
- filters.append("host=%s" % host)
- if binary:
- filters.append("binary=%s" % binary)
- if filters:
- url = "%s?%s" % (url, "&".join(filters))
- return self._list(url, "services")
-
- def enable(self, host, binary):
- """Enable the service specified by hostname and binary."""
- body = {"host": host, "binary": binary}
- result = self._update("/os-services/enable", body)
- return self.resource_class(self, result)
-
- def disable(self, host, binary):
- """Disable the service specified by hostname and binary."""
- body = {"host": host, "binary": binary}
- result = self._update("/os-services/disable", body)
- return self.resource_class(self, result)
-
- def disable_log_reason(self, host, binary, reason):
- """Disable the service with reason."""
- body = {"host": host, "binary": binary, "disabled_reason": reason}
- result = self._update("/os-services/disable-log-reason", body)
- return self.resource_class(self, result)
diff --git a/cinderclient/v1/shell.py b/cinderclient/v1/shell.py
deleted file mode 100644
index 59535ab97..000000000
--- a/cinderclient/v1/shell.py
+++ /dev/null
@@ -1,1436 +0,0 @@
-# Copyright 2010 Jacob Kaplan-Moss
-#
-# Copyright (c) 2011-2014 OpenStack Foundation
-# All Rights Reserved.
-#
-# 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 print_function
-
-import argparse
-import copy
-import os
-import sys
-import time
-import warnings
-
-from cinderclient import exceptions
-from cinderclient import utils
-from cinderclient.v1 import availability_zones
-from oslo_utils import strutils
-
-
-def _poll_for_status(poll_fn, obj_id, action, final_ok_states,
- poll_period=5, show_progress=True):
- """Blocks while an action occurs. Periodically shows progress."""
- def print_progress(progress):
- if show_progress:
- msg = ('\rInstance %(action)s... %(progress)s%% complete'
- % dict(action=action, progress=progress))
- else:
- msg = '\rInstance %(action)s...' % dict(action=action)
-
- sys.stdout.write(msg)
- sys.stdout.flush()
-
- print()
- while True:
- obj = poll_fn(obj_id)
- status = obj.status.lower()
- progress = getattr(obj, 'progress', None) or 0
- if status in final_ok_states:
- print_progress(100)
- print("\nFinished")
- break
- elif status == "error":
- print("\nError %(action)s instance" % {'action': action})
- break
- else:
- print_progress(progress)
- time.sleep(poll_period)
-
-
-def _find_volume_snapshot(cs, snapshot):
- """Gets a volume snapshot by name or ID."""
- return utils.find_resource(cs.volume_snapshots, snapshot)
-
-
-def _find_backup(cs, backup):
- """Gets a backup by name or ID."""
- return utils.find_resource(cs.backups, backup)
-
-
-def _find_transfer(cs, transfer):
- """Gets a transfer by name or ID."""
- return utils.find_resource(cs.transfers, transfer)
-
-
-def _find_qos_specs(cs, qos_specs):
- """Gets a qos specs by ID."""
- return utils.find_resource(cs.qos_specs, qos_specs)
-
-
-def _print_volume(volume):
- utils.print_dict(volume._info)
-
-
-def _print_volume_snapshot(snapshot):
- utils.print_dict(snapshot._info)
-
-
-def _print_volume_image(image):
- utils.print_dict(image[1]['os-volume_upload_image'])
-
-
-def _translate_keys(collection, convert):
- for item in collection:
- keys = item.__dict__
- for from_key, to_key in convert:
- if from_key in keys and to_key not in keys:
- setattr(item, to_key, item._info[from_key])
-
-
-def _translate_volume_keys(collection):
- convert = [('displayName', 'display_name'), ('volumeType', 'volume_type'),
- ('os-vol-tenant-attr:tenant_id', 'tenant_id')]
- _translate_keys(collection, convert)
-
-
-def _translate_volume_snapshot_keys(collection):
- convert = [('displayName', 'display_name'), ('volumeId', 'volume_id')]
- _translate_keys(collection, convert)
-
-
-def _translate_availability_zone_keys(collection):
- convert = [('zoneName', 'name'), ('zoneState', 'status')]
- _translate_keys(collection, convert)
-
-
-def _extract_metadata(args):
- metadata = {}
- for metadatum in args.metadata:
- # unset doesn't require a val, so we have the if/else
- if '=' in metadatum:
- (key, value) = metadatum.split('=', 1)
- else:
- key = metadatum
- value = None
-
- metadata[key] = value
- return metadata
-
-
-@utils.arg(
- '--all-tenants',
- dest='all_tenants',
- metavar='<0|1>',
- nargs='?',
- type=int,
- const=1,
- default=0,
- help='Shows details for all tenants. Admin only.')
-@utils.arg(
- '--all_tenants',
- nargs='?',
- type=int,
- const=1,
- help=argparse.SUPPRESS)
-@utils.arg(
- '--display-name',
- metavar='<display-name>',
- default=None,
- help='Filters list by a volume display name. Default=None.')
-@utils.arg(
- '--status',
- metavar='<status>',
- default=None,
- help='Filters list by a status. Default=None.')
-@utils.arg(
- '--metadata',
- type=str,
- nargs='*',
- metavar='<key=value>',
- default=None,
- help='Filters list by metadata key and value pair. '
- 'Default=None.')
-@utils.arg(
- '--tenant',
- type=str,
- dest='tenant',
- nargs='?',
- metavar='<tenant>',
- help='Display information from single tenant (Admin only).')
-@utils.arg(
- '--limit',
- metavar='<limit>',
- default=None,
- help='Maximum number of volumes to return. OPTIONAL: Default=None.')
-def do_list(cs, args):
- """Lists all volumes."""
- all_tenants = 1 if args.tenant else \
- int(os.environ.get("ALL_TENANTS", args.all_tenants))
- search_opts = {
- 'all_tenants': all_tenants,
- 'project_id': args.tenant,
- 'display_name': args.display_name,
- 'status': args.status,
- 'metadata': _extract_metadata(args) if args.metadata else None,
- }
- volumes = cs.volumes.list(search_opts=search_opts, limit=args.limit)
- _translate_volume_keys(volumes)
-
- # Create a list of servers to which the volume is attached
- for vol in volumes:
- servers = [s.get('server_id') for s in vol.attachments]
- setattr(vol, 'attached_to', ','.join(map(str, servers)))
- if all_tenants:
- key_list = ['ID', 'Tenant ID', 'Status', 'Display Name',
- 'Size', 'Volume Type', 'Bootable', 'Attached to']
- else:
- key_list = ['ID', 'Status', 'Display Name',
- 'Size', 'Volume Type', 'Bootable', 'Attached to']
- utils.print_list(volumes, key_list)
-
-
-@utils.arg('volume', metavar='<volume>', help='Volume name or ID.')
-def do_show(cs, args):
- """Shows volume details."""
- volume = utils.find_volume(cs, args.volume)
- _print_volume(volume)
-
-
-@utils.arg('size',
- metavar='<size>',
- type=int,
- help='Volume size, in GiBs.')
-@utils.arg(
- '--snapshot-id',
- metavar='<snapshot-id>',
- default=None,
- help='Creates volume from snapshot ID. '
- 'Default=None.')
-@utils.arg(
- '--snapshot_id',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--source-volid',
- metavar='<source-volid>',
- default=None,
- help='Creates volume from volume ID. '
- 'Default=None.')
-@utils.arg(
- '--source_volid',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--image-id',
- metavar='<image-id>',
- default=None,
- help='Creates volume from image ID. '
- 'Default=None.')
-@utils.arg(
- '--image_id',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--display-name',
- metavar='<display-name>',
- default=None,
- help='Volume name. '
- 'Default=None.')
-@utils.arg(
- '--display_name',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--display-description',
- metavar='<display-description>',
- default=None,
- help='Volume description. '
- 'Default=None.')
-@utils.arg(
- '--display_description',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--volume-type',
- metavar='<volume-type>',
- default=None,
- help='Volume type. '
- 'Default=None.')
-@utils.arg(
- '--volume_type',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--availability-zone',
- metavar='<availability-zone>',
- default=None,
- help='Availability zone for volume. '
- 'Default=None.')
-@utils.arg(
- '--availability_zone',
- help=argparse.SUPPRESS)
-@utils.arg('--metadata',
- type=str,
- nargs='*',
- metavar='<key=value>',
- default=None,
- help='Metadata key and value pairs. '
- 'Default=None.')
-def do_create(cs, args):
- """Creates a volume."""
-
- volume_metadata = None
- if args.metadata is not None:
- volume_metadata = _extract_metadata(args)
-
- volume = cs.volumes.create(args.size,
- args.snapshot_id,
- args.source_volid,
- args.display_name,
- args.display_description,
- args.volume_type,
- availability_zone=args.availability_zone,
- imageRef=args.image_id,
- metadata=volume_metadata)
- _print_volume(volume)
-
-
-@utils.arg('volume', metavar='<volume>', nargs='+',
- help='Name or ID of volume to delete. '
- 'Separate multiple volumes with a space.')
-def do_delete(cs, args):
- """Removes one or more volumes."""
- failure_count = 0
- for volume in args.volume:
- try:
- utils.find_volume(cs, volume).delete()
- print("Request to delete volume %s has been accepted." % (volume))
- except Exception as e:
- failure_count += 1
- print("Delete for volume %s failed: %s" % (volume, e))
- if failure_count == len(args.volume):
- raise exceptions.CommandError("Unable to delete any of the specified "
- "volumes.")
-
-
-@utils.arg('volume', metavar='<volume>', nargs='+',
- help='Name or ID of volume to delete. '
- 'Separate multiple volumes with a space.')
-def do_force_delete(cs, args):
- """Attempts force-delete of volume, regardless of state."""
- failure_count = 0
- for volume in args.volume:
- try:
- utils.find_volume(cs, volume).force_delete()
- except Exception as e:
- failure_count += 1
- print("Delete for volume %s failed: %s" % (volume, e))
- if failure_count == len(args.volume):
- raise exceptions.CommandError("Unable to force delete any of the "
- "specified volumes.")
-
-
-@utils.arg('volume', metavar='<volume>', nargs='+',
- help='Name or ID of volume to modify. '
- 'Separate multiple volumes with a space.')
-@utils.arg('--state', metavar='<state>', default='available',
- help=('The state to assign to the volume. Valid values are '
- '"available", "error", "creating", "deleting", "in-use", '
- '"attaching", "detaching" and "error_deleting". '
- 'NOTE: This command simply changes the state of the '
- 'Volume in the DataBase with no regard to actual status, '
- 'exercise caution when using. Default=available.'))
-def do_reset_state(cs, args):
- """Explicitly updates the volume state."""
- failure_flag = False
-
- for volume in args.volume:
- try:
- utils.find_volume(cs, volume).reset_state(args.state)
- except Exception as e:
- failure_flag = True
- msg = "Reset state for volume %s failed: %s" % (volume, e)
- print(msg)
-
- if failure_flag:
- msg = "Unable to reset the state for the specified volume(s)."
- raise exceptions.CommandError(msg)
-
-
-@utils.arg('volume', metavar='<volume>',
- help='Name or ID of volume to rename.')
-@utils.arg('display_name', nargs='?', metavar='<display-name>',
- help='New display name for volume.')
-@utils.arg('--display-description', metavar='<display-description>',
- default=None, help='Volume description. Default=None.')
-def do_rename(cs, args):
- """Renames a volume."""
- kwargs = {}
- if args.display_name is not None:
- kwargs['display_name'] = args.display_name
- if args.display_description is not None:
- kwargs['display_description'] = args.display_description
-
- if not any(kwargs):
- msg = 'Must supply either display-name or display-description.'
- raise exceptions.ClientException(code=1, message=msg)
-
- utils.find_volume(cs, args.volume).update(**kwargs)
-
-
-@utils.arg('volume',
- metavar='<volume>',
- help='Name or ID of volume for which to update metadata.')
-@utils.arg('action',
- metavar='<action>',
- choices=['set', 'unset'],
- help='The action. Valid values are "set" or "unset."')
-@utils.arg('metadata',
- metavar='<key=value>',
- nargs='+',
- default=[],
- help='The metadata key and pair to set or unset. '
- 'For unset, specify only the key. '
- 'Default=[].')
-def do_metadata(cs, args):
- """Sets or deletes volume metadata."""
- volume = utils.find_volume(cs, args.volume)
- metadata = _extract_metadata(args)
-
- if args.action == 'set':
- cs.volumes.set_metadata(volume, metadata)
- elif args.action == 'unset':
- # NOTE(zul): Make sure py2/py3 sorting is the same
- cs.volumes.delete_metadata(volume, sorted(metadata.keys(),
- reverse=True))
-
-
-@utils.arg(
- '--all-tenants',
- dest='all_tenants',
- metavar='<0|1>',
- nargs='?',
- type=int,
- const=1,
- default=0,
- help='Shows details for all tenants. Admin only.')
-@utils.arg(
- '--all_tenants',
- nargs='?',
- type=int,
- const=1,
- help=argparse.SUPPRESS)
-@utils.arg(
- '--display-name',
- metavar='<display-name>',
- default=None,
- help='Filters list by a display name. Default=None.')
-@utils.arg(
- '--status',
- metavar='<status>',
- default=None,
- help='Filters list by a status. Default=None.')
-@utils.arg(
- '--volume-id',
- metavar='<volume-id>',
- default=None,
- help='Filters list by a volume ID. Default=None.')
-def do_snapshot_list(cs, args):
- """Lists all snapshots."""
- all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants))
- search_opts = {
- 'all_tenants': all_tenants,
- 'display_name': args.display_name,
- 'status': args.status,
- 'volume_id': args.volume_id,
- }
-
- snapshots = cs.volume_snapshots.list(search_opts=search_opts)
- _translate_volume_snapshot_keys(snapshots)
- utils.print_list(snapshots,
- ['ID', 'Volume ID', 'Status', 'Display Name', 'Size'])
-
-
-@utils.arg('snapshot', metavar='<snapshot>',
- help='Name or ID of snapshot.')
-def do_snapshot_show(cs, args):
- """Shows snapshot details."""
- snapshot = _find_volume_snapshot(cs, args.snapshot)
- _print_volume_snapshot(snapshot)
-
-
-@utils.arg('volume',
- metavar='<volume>',
- help='Name or ID of volume to snapshot.')
-@utils.arg('--force',
- metavar='<True|False>',
- default=False,
- help='Allows or disallows snapshot of '
- 'a volume when the volume is attached to an instance. '
- 'If set to True, ignores the current status of the '
- 'volume when attempting to snapshot it rather '
- 'than forcing it to be available. '
- 'Default=False.')
-@utils.arg(
- '--display-name',
- metavar='<display-name>',
- default=None,
- help='The snapshot name. Default=None.')
-@utils.arg(
- '--display_name',
- help=argparse.SUPPRESS)
-@utils.arg(
- '--display-description',
- metavar='<display-description>',
- default=None,
- help='The snapshot description. Default=None.')
-@utils.arg(
- '--display_description',
- help=argparse.SUPPRESS)
-def do_snapshot_create(cs, args):
- """Creates a snapshot."""
- volume = utils.find_volume(cs, args.volume)
- snapshot = cs.volume_snapshots.create(volume.id,
- args.force,
- args.display_name,
- args.display_description)
- _print_volume_snapshot(snapshot)
-
-
-@utils.arg('snapshot',
- metavar='<snapshot>', nargs='+',
- help='Name or ID of the snapshot(s) to delete.')
-def do_snapshot_delete(cs, args):
- """Remove one or more snapshots."""
- failure_count = 0
- for snapshot in args.snapshot:
- try:
- _find_volume_snapshot(cs, snapshot).delete()
- except Exception as e:
- failure_count += 1
- print("Delete for snapshot %s failed: %s" % (snapshot, e))
- if failure_count == len(args.snapshot):
- raise exceptions.CommandError("Unable to delete any of the specified "
- "snapshots.")
-
-
-@utils.arg('snapshot', metavar='<snapshot>',
- help='Name or ID of snapshot.')
-@utils.arg('display_name', nargs='?', metavar='<display-name>',
- help='New display name for snapshot.')
-@utils.arg('--display-description', metavar='<display-description>',
- default=None, help='Snapshot description. Default=None.')
-def do_snapshot_rename(cs, args):
- """Renames a snapshot."""
- kwargs = {}
- if args.display_name is not None:
- kwargs['display_name'] = args.display_name
- if args.display_description is not None:
- kwargs['display_description'] = args.display_description
-
- if not any(kwargs):
- msg = 'Must supply either display-name or display-description.'
- raise exceptions.ClientException(code=1, message=msg)
-
- _find_volume_snapshot(cs, args.snapshot).update(**kwargs)
-
-
-@utils.arg('snapshot', metavar='<snapshot>', nargs='+',
- help='Name or ID of snapshot to modify.')
-@utils.arg('--state', metavar='<state>', default='available',
- help=('The state to assign to the snapshot. Valid values are '
- '"available", "error", "creating", "deleting", and '
- '"error_deleting". NOTE: This command simply changes '
- 'the state of the Snapshot in the DataBase with no regard '
- 'to actual status, exercise caution when using. '
- 'Default=available.'))
-def do_snapshot_reset_state(cs, args):
- """Explicitly updates the snapshot state."""
- failure_count = 0
-
- single = (len(args.snapshot) == 1)
-
- for snapshot in args.snapshot:
- try:
- _find_volume_snapshot(cs, snapshot).reset_state(args.state)
- except Exception as e:
- failure_count += 1
- msg = "Reset state for snapshot %s failed: %s" % (snapshot, e)
- if not single:
- print(msg)
-
- if failure_count == len(args.snapshot):
- if not single:
- msg = ("Unable to reset the state for any of the specified "
- "snapshots.")
- raise exceptions.CommandError(msg)
-
-
-def _print_volume_type_list(vtypes):
- utils.print_list(vtypes, ['ID', 'Name'])
-
-
-def do_type_list(cs, args):
- """Lists available 'volume types'."""
- vtypes = cs.volume_types.list()
- _print_volume_type_list(vtypes)
-
-
-def do_extra_specs_list(cs, args):
- """Lists current volume types and extra specs."""
- vtypes = cs.volume_types.list()
- utils.print_list(vtypes, ['ID', 'Name', 'extra_specs'])
-
-
-@utils.arg('name',
- metavar='<name>',
- help='Name for the volume type.')
-def do_type_create(cs, args):
- """Creates a volume type."""
- vtype = cs.volume_types.create(args.name)
- _print_volume_type_list([vtype])
-
-
-@utils.arg('id',
- metavar='<id>',
- help='ID of volume type to delete.')
-def do_type_delete(cs, args):
- """Deletes a specified volume type."""
- volume_type = _find_volume_type(cs, args.id)
- cs.volume_types.delete(volume_type)
-
-
-@utils.arg('vtype',
- metavar='<vtype>',
- help='Name or ID of volume type.')
-@utils.arg('action',
- metavar='<action>',
- choices=['set', 'unset'],
- help='The action. Valid values are "set" or "unset."')
-@utils.arg('metadata',
- metavar='<key=value>',
- nargs='*',
- default=None,
- help='The extra specs key and value pair to set or unset. '
- 'For unset, specify only the key. Default=None.')
-def do_type_key(cs, args):
- """Sets or unsets extra_spec for a volume type."""
- vtype = _find_volume_type(cs, args.vtype)
-
- if args.metadata is not None:
- keypair = _extract_metadata(args)
-
- if args.action == 'set':
- vtype.set_keys(keypair)
- elif args.action == 'unset':
- vtype.unset_keys(list(keypair))
-
-
-def do_endpoints(cs, args):
- """Discovers endpoints registered by authentication service."""
- warnings.warn(
- "``cinder endpoints`` is deprecated, use ``openstack catalog list`` "
- "instead. The ``cinder endpoints`` command may be removed in the P "
- "release or next major release of cinderclient (v2.0.0 or greater).")
- catalog = cs.client.service_catalog.catalog
- for e in catalog:
- utils.print_dict(e['endpoints'][0], e['name'])
-
-
-def do_credentials(cs, args):
- """Shows user credentials returned from auth."""
- catalog = cs.client.service_catalog.catalog
- utils.print_dict(catalog['user'], "User Credentials")
- utils.print_dict(catalog['token'], "Token")
-
-
-_quota_resources = ['volumes', 'snapshots', 'gigabytes',
- 'backups', 'backup_gigabytes']
-_quota_infos = ['Type', 'In_use', 'Reserved', 'Limit']
-
-
-def _quota_show(quotas):
- quota_dict = {}
- for resource in quotas._info:
- good_name = False
- for name in _quota_resources:
- if resource.startswith(name):
- good_name = True
- if not good_name:
- continue
- quota_dict[resource] = getattr(quotas, resource, None)
- utils.print_dict(quota_dict)
-
-
-def _quota_usage_show(quotas):
- quota_list = []
- for resource in quotas._info.keys():
- good_name = False
- for name in _quota_resources:
- if resource.startswith(name):
- good_name = True
- if not good_name:
- continue
- quota_info = getattr(quotas, resource, None)
- quota_info['Type'] = resource
- quota_info = dict((k.capitalize(), v) for k, v in quota_info.items())
- quota_list.append(quota_info)
- utils.print_list(quota_list, _quota_infos)
-
-
-def _quota_update(manager, identifier, args):
- updates = {}
- for resource in _quota_resources:
- val = getattr(args, resource, None)
- if val is not None:
- if args.volume_type:
- resource = resource + '_%s' % args.volume_type
- updates[resource] = val
-
- if updates:
- _quota_show(manager.update(identifier, **updates))
-
-
-@utils.arg('tenant', metavar='<tenant_id>',
- help='ID of the tenant for which to list quotas.')
-def do_quota_show(cs, args):
- """Lists quotas for a tenant."""
-
- _quota_show(cs.quotas.get(args.tenant))
-
-
-@utils.arg('tenant', metavar='<tenant_id>',
- help='ID of the tenant for which to list quota usage.')
-def do_quota_usage(cs, args):
- """Lists quota usage for a tenant."""
-
- _quota_usage_show(cs.quotas.get(args.tenant, usage=True))
-
-
-@utils.arg('tenant', metavar='<tenant_id>',
- help='ID of the tenant for which to list default quotas.')
-def do_quota_defaults(cs, args):
- """Lists default quotas for a tenant."""
-
- _quota_show(cs.quotas.defaults(args.tenant))
-
-
-@utils.arg('tenant', metavar='<tenant_id>',
- help='ID of the tenant for which to set quotas.')
-@utils.arg('--volumes',
- metavar='<volumes>',
- type=int, default=None,
- help='The new "volumes" quota value. Default=None.')
-@utils.arg('--snapshots',
- metavar='<snapshots>',
- type=int, default=None,
- help='The new "snapshots" quota value. Default=None.')
-@utils.arg('--gigabytes',
- metavar='<gigabytes>',
- type=int, default=None,
- help='The new "gigabytes" quota value. Default=None.')
-@utils.arg('--backups',
- metavar='<backups>',
- type=int, default=None,
- help='The new "backups" quota value. Default=None.')
-@utils.arg('--backup-gigabytes',
- metavar='<backup_gigabytes>',
- type=int, default=None,
- help='The new "backup_gigabytes" quota value. Default=None.')
-@utils.arg('--volume-type',
- metavar='<volume_type_name>',
- default=None,
- help='Volume type. Default=None.')
-def do_quota_update(cs, args):
- """Updates quotas for a tenant."""
-
- _quota_update(cs.quotas, args.tenant, args)
-
-
-@utils.arg('tenant', metavar='<tenant_id>',
- help='UUID of tenant to delete the quotas for.')
-def do_quota_delete(cs, args):
- """Delete the quotas for a tenant."""
-
- cs.quotas.delete(args.tenant)
-
-
-@utils.arg('class_name', metavar='<class>',
- help='Name of quota class for which to list quotas.')
-def do_quota_class_show(cs, args):
- """Lists quotas for a quota class."""
-
- _quota_show(cs.quota_classes.get(args.class_name))
-
-
-@utils.arg('class_name', metavar='<class>',
- help='Name of quota class for which to set quotas.')
-@utils.arg('--volumes',
- metavar='<volumes>',
- type=int, default=None,
- help='The new "volumes" quota value. Default=None.')
-@utils.arg('--snapshots',
- metavar='<snapshots>',
- type=int, default=None,
- help='The new "snapshots" quota value. Default=None.')
-@utils.arg('--gigabytes',
- metavar='<gigabytes>',
- type=int, default=None,
- help='The new "gigabytes" quota value. Default=None.')
-@utils.arg('--volume-type',
- metavar='<volume_type_name>',
- default=None,
- help='Volume type. Default=None.')
-def do_quota_class_update(cs, args):
- """Updates quotas for a quota class."""
-
- _quota_update(cs.quota_classes, args.class_name, args)
-
-
-def do_absolute_limits(cs, args):
- """Lists absolute limits for a user."""
- limits = cs.limits.get().absolute
- columns = ['Name', 'Value']
- utils.print_list(limits, columns)
-
-
-def do_rate_limits(cs, args):
- """Lists rate limits for a user."""
- limits = cs.limits.get().rate
- columns = ['Verb', 'URI', 'Value', 'Remain', 'Unit', 'Next_Available']
- utils.print_list(limits, columns)
-
-
-def _find_volume_type(cs, vtype):
- """Gets a volume type by name or ID."""
- return utils.find_resource(cs.volume_types, vtype)
-
-
-@utils.arg('volume',
- metavar='<volume>',
- help='Name or ID of volume to upload to an image.')
-@utils.arg('--force',
- metavar='<True|False>',
- default=False,
- help='Enables or disables upload of '
- 'a volume that is attached to an instance. '
- 'Default=False.')
-@utils.arg('--container-format',
- metavar='<container-format>',
- default='bare',
- help='Container format type. '
- 'Default is bare.')
-@utils.arg('--disk-format',
- metavar='<disk-format>',
- default='raw',
- help='Disk format type. '
- 'Default is raw.')
-@utils.arg('image_name',
- metavar='<image-name>',
- help='The new image name.')
-def do_upload_to_image(cs, args):
- """Uploads volume to Image Service as an image."""
- volume = utils.find_volume(cs, args.volume)
- _print_volume_image(volume.upload_to_image(args.force,
- args.image_name,
- args.container_format,
- args.disk_format))
-
-
-@utils.arg('volume', metavar='<volume>',
- help='Name or ID of volume to back up.')
-@utils.arg('--container', metavar='<container>',
- default=None,
- help='Backup container name. Default=None.')
-@utils.arg('--display-name', metavar='<display-name>',
- default=None,
- help='Backup name. Default=None.')
-@utils.arg('--display-description', metavar='<display-description>',
- default=None,
- help='Backup description. Default=None.')
-def do_backup_create(cs, args):
- """Creates a volume backup."""
- volume = utils.find_volume(cs, args.volume)
- backup = cs.backups.create(volume.id,
- args.container,
- args.display_name,
- args.display_description)
-
- info = {"volume_id": volume.id}
- info.update(backup._info)
-
- if 'links' in info:
- info.pop('links')
-
- utils.print_dict(info)
-
-
-@utils.arg('backup', metavar='<backup>', help='Name or ID of backup.')
-def do_backup_show(cs, args):
- """Show backup details."""
- backup = _find_backup(cs, args.backup)
- info = dict()
- info.update(backup._info)
-
- if 'links' in info:
- info.pop('links')
-
- utils.print_dict(info)
-
-
-def do_backup_list(cs, args):
- """Lists all backups."""
- backups = cs.backups.list()
- columns = ['ID', 'Volume ID', 'Status', 'Name', 'Size', 'Object Count',
- 'Container']
- utils.print_list(backups, columns)
-
-
-@utils.arg('backup', metavar='<backup>',
- help='Name or ID of backup to delete.')
-def do_backup_delete(cs, args):
- """Removes a backup."""
- backup = _find_backup(cs, args.backup)
- backup.delete()
-
-
-@utils.arg('backup', metavar='<backup>',
- help='ID of backup to restore.')
-@utils.arg('--volume-id', metavar='<volume>',
- default=None,
- help='ID or name of backup volume to '
- 'which to restore. Default=None.')
-def do_backup_restore(cs, args):
- """Restores a backup."""
- if args.volume_id:
- volume_id = utils.find_volume(cs, args.volume_id).id
- else:
- volume_id = None
- cs.restores.restore(args.backup, volume_id)
-
-
-@utils.arg('volume', metavar='<volume>',
- help='Name or ID of volume to transfer.')
-@utils.arg('--display-name', metavar='<display-name>',
- default=None,
- help='Transfer name. Default=None.')
-def do_transfer_create(cs, args):
- """Creates a volume transfer."""
- volume = utils.find_volume(cs, args.volume)
- transfer = cs.transfers.create(volume.id,
- args.display_name)
- info = dict()
- info.update(transfer._info)
-
- if 'links' in info:
- info.pop('links')
-
- utils.print_dict(info)
-
-
-@utils.arg('transfer', metavar='<transfer>',
- help='Name or ID of transfer to delete.')
-def do_transfer_delete(cs, args):
- """Undoes a transfer."""
- transfer = _find_transfer(cs, args.transfer)
- transfer.delete()
-
-
-@utils.arg('transfer', metavar='<transfer>',
- help='ID of transfer to accept.')
-@utils.arg('auth_key', metavar='<auth_key>',
- help='Authentication key of transfer to accept.')
-def do_transfer_accept(cs, args):
- """Accepts a volume transfer."""
- transfer = cs.transfers.accept(args.transfer, args.auth_key)
- info = dict()
- info.update(transfer._info)
-
- if 'links' in info:
- info.pop('links')
-
- utils.print_dict(info)
-
-
-@utils.arg(
- '--all-tenants',
- dest='all_tenants',
- metavar='<0|1>',
- nargs='?',
- type=int,
- const=1,
- default=0,
- help='Shows details for all tenants. Admin only.')
-@utils.arg(
- '--all_tenants',
- nargs='?',
- type=int,
- const=1,
- help=argparse.SUPPRESS)
-def do_transfer_list(cs, args):
- """Lists all transfers."""
- all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants))
- search_opts = {
- 'all_tenants': all_tenants,
- }
- transfers = cs.transfers.list(search_opts=search_opts)
- columns = ['ID', 'Volume ID', 'Name']
- utils.print_list(transfers, columns)
-
-
-@utils.arg('transfer', metavar='<transfer>',
- help='Name or ID of transfer to accept.')
-def do_transfer_show(cs, args):
- """Show transfer details."""
- transfer = _find_transfer(cs, args.transfer)
- info = dict()
- info.update(transfer._info)
-
- if 'links' in info:
- info.pop('links')
-
- utils.print_dict(info)
-
-
-@utils.arg('volume', metavar='<volume>',
- help='Name or ID of volume to extend.')
-@utils.arg('new_size',
- metavar='<new-size>',
- type=int,
- help='Size of volume, in GiBs.')
-def do_extend(cs, args):
- """Attempts to extend size of an existing volume."""
- volume = utils.find_volume(cs, args.volume)
- cs.volumes.extend(volume, args.new_size)
-
-
-@utils.arg('--host', metavar='<hostname>', default=None,
- help='Host name. Default=None.')
-@utils.arg('--binary', metavar='<binary>', default=None,
- help='Service binary. Default=None.')
-def do_service_list(cs, args):
- """Lists all services. Filter by host and service binary."""
- result = cs.services.list(host=args.host, binary=args.binary)
- columns = ["Binary", "Host", "Zone", "Status", "State", "Updated_at"]
- # NOTE(jay-lau-513): we check if the response has disabled_reason
- # so as not to add the column when the extended ext is not enabled.
- if result and hasattr(result[0], 'disabled_reason'):
- columns.append("Disabled Reason")
- utils.print_list(result, columns)
-
-
-@utils.arg('host', metavar='<hostname>', help='Host name.')
-@utils.arg('binary', metavar='<binary>', help='Service binary.')
-def do_service_enable(cs, args):
- """Enables the service."""
- result = cs.services.enable(args.host, args.binary)
- columns = ["Host", "Binary", "Status"]
- utils.print_list([result], columns)
-
-
-@utils.arg('host', metavar='<hostname>', help='Host name.')
-@utils.arg('binary', metavar='<binary>', help='Service binary.')
-@utils.arg('--reason', metavar='<reason>',
- help='Reason for disabling service.')
-def do_service_disable(cs, args):
- """Disables the service."""
- columns = ["Host", "Binary", "Status"]
- if args.reason:
- columns.append('Disabled Reason')
- result = cs.services.disable_log_reason(args.host, args.binary,
- args.reason)
- else:
- result = cs.services.disable(args.host, args.binary)
- utils.print_list([result], columns)
-
-
-def _treeizeAvailabilityZone(zone):
- """Builds a tree view for availability zones."""
- AvailabilityZone = availability_zones.AvailabilityZone
-
- az = AvailabilityZone(zone.manager,
- copy.deepcopy(zone._info), zone._loaded)
- result = []
-
- # Zone tree view item
- az.zoneName = zone.zoneName
- az.zoneState = ('available'
- if zone.zoneState['available'] else 'not available')
- az._info['zoneName'] = az.zoneName
- az._info['zoneState'] = az.zoneState
- result.append(az)
-
- if getattr(zone, "hosts", None) and zone.hosts is not None:
- for (host, services) in zone.hosts.items():
- # Host tree view item
- az = AvailabilityZone(zone.manager,
- copy.deepcopy(zone._info), zone._loaded)
- az.zoneName = '|- %s' % host
- az.zoneState = ''
- az._info['zoneName'] = az.zoneName
- az._info['zoneState'] = az.zoneState
- result.append(az)
-
- for (svc, state) in services.items():
- # Service tree view item
- az = AvailabilityZone(zone.manager,
- copy.deepcopy(zone._info), zone._loaded)
- az.zoneName = '| |- %s' % svc
- az.zoneState = '%s %s %s' % (
- 'enabled' if state['active'] else 'disabled',
- ':-)' if state['available'] else 'XXX',
- state['updated_at'])
- az._info['zoneName'] = az.zoneName
- az._info['zoneState'] = az.zoneState
- result.append(az)
- return result
-
-
-def do_availability_zone_list(cs, _args):
- """Lists all availability zones."""
- try:
- availability_zones = cs.availability_zones.list()
- except exceptions.Forbidden: # policy doesn't allow probably
- try:
- availability_zones = cs.availability_zones.list(detailed=False)
- except Exception:
- raise
-
- result = []
- for zone in availability_zones:
- result += _treeizeAvailabilityZone(zone)
- _translate_availability_zone_keys(result)
- utils.print_list(result, ['Name', 'Status'])
-
-
-def _print_volume_encryption_type_list(encryption_types):
- """
- Lists volume encryption types.
-
- :param encryption_types: a list of :class: VolumeEncryptionType instances
- """
- utils.print_list(encryption_types, ['Volume Type ID', 'Provider',
- 'Cipher', 'Key Size',
- 'Control Location'])
-
-
-def do_encryption_type_list(cs, args):
- """Shows encryption type details for volume types. Admin only."""
- result = cs.volume_encryption_types.list()
- utils.print_list(result, ['Volume Type ID', 'Provider', 'Cipher',
- 'Key Size', 'Control Location'])
-
-
-@utils.arg('volume_type',
- metavar='<volume_type>',
- type=str,
- help='Name or ID of volume type.')
-def do_encryption_type_show(cs, args):
- """Shows encryption type details for volume type. Admin only."""
- volume_type = _find_volume_type(cs, args.volume_type)
-
- result = cs.volume_encryption_types.get(volume_type)
-
- # Display result or an empty table if no result
- if hasattr(result, 'volume_type_id'):
- _print_volume_encryption_type_list([result])
- else:
- _print_volume_encryption_type_list([])
-
-
-@utils.arg('volume_type',
- metavar='<volume_type>',
- type=str,
- help='Name or ID of volume type.')
-@utils.arg('provider',
- metavar='<provider>',
- type=str,
- help='The class that provides encryption support. '
- 'For example, a volume driver class path.')
-@utils.arg('--cipher',
- metavar='<cipher>',
- type=str,
- required=False,
- default=None,
- help='The encryption algorithm and mode. '
- 'For example, aes-xts-plain64. Default=None.')
-@utils.arg('--key_size',
- metavar='<key_size>',
- type=int,
- required=False,
- default=None,
- help='Size of encryption key, in bits. '
- 'For example, 128 or 256. Default=None.')
-@utils.arg('--control_location',
- metavar='<control_location>',
- choices=['front-end', 'back-end'],
- type=str,
- required=False,
- default='front-end',
- help='Notional service where encryption is performed. '
- 'Valid values are "front-end" or "back-end." '
- 'For example, front-end=Nova. '
- 'Default is "front-end."')
-def do_encryption_type_create(cs, args):
- """Creates encryption type for a volume type. Admin only."""
- volume_type = _find_volume_type(cs, args.volume_type)
-
- body = {
- 'provider': args.provider,
- 'cipher': args.cipher,
- 'key_size': args.key_size,
- 'control_location': args.control_location
- }
-
- result = cs.volume_encryption_types.create(volume_type, body)
- _print_volume_encryption_type_list([result])
-
-
-@utils.arg('volume_type',
- metavar='<volume_type>',
- type=str,
- help='Name or ID of volume type.')
-def do_encryption_type_delete(cs, args):
- """Deletes encryption type for a volume type. Admin only."""
- volume_type = _find_volume_type(cs, args.volume_type)
- cs.volume_encryption_types.delete(volume_type)
-
-
-@utils.arg('volume', metavar='<volume>', help='ID of volume to migrate.')
-@utils.arg('host', metavar='<host>', help='Destination host.')
-@utils.arg('--force-host-copy', metavar='<True|False>',
- choices=['True', 'False'], required=False,
- default=False,
- help='Enables or disables generic host-based '
- 'force-migration, which bypasses driver '
- 'optimizations. Default=False.')
-def do_migrate(cs, args):
- """Migrates volume to a new host."""
- volume = utils.find_volume(cs, args.volume)
-
- volume.migrate_volume(args.host, args.force_host_copy)
-
-
-def _print_qos_specs(qos_specs):
- utils.print_dict(qos_specs._info)
-
-
-def _print_qos_specs_list(q_specs):
- utils.print_list(q_specs, ['ID', 'Name', 'Consumer', 'specs'])
-
-
-def _print_qos_specs_and_associations_list(q_specs):
- utils.print_list(q_specs, ['ID', 'Name', 'Consumer', 'specs'])
-
-
-def _print_associations_list(associations):
- utils.print_list(associations, ['Association_Type', 'Name', 'ID'])
-
-
-@utils.arg('name',
- metavar='<name>',
- help='Name of new QoS specifications.')
-@utils.arg('metadata',
- metavar='<key=value>',
- nargs='+',
- default=[],
- help='Specifications for QoS.')
-def do_qos_create(cs, args):
- """Creates a qos specs."""
- keypair = None
- if args.metadata is not None:
- keypair = _extract_metadata(args)
- qos_specs = cs.qos_specs.create(args.name, keypair)
- _print_qos_specs(qos_specs)
-
-
-def do_qos_list(cs, args):
- """Lists qos specs."""
- qos_specs = cs.qos_specs.list()
- _print_qos_specs_list(qos_specs)
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-def do_qos_show(cs, args):
- """Shows a specified qos specs."""
- qos_specs = _find_qos_specs(cs, args.qos_specs)
- _print_qos_specs(qos_specs)
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-@utils.arg('--force',
- metavar='<True|False>',
- default=False,
- help='Enables or disables deletion of in-use '
- 'QoS specifications. Default=False.')
-def do_qos_delete(cs, args):
- """Deletes a specified qos specs."""
- force = strutils.bool_from_string(args.force, strict=True)
- qos_specs = _find_qos_specs(cs, args.qos_specs)
- cs.qos_specs.delete(qos_specs, force)
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-@utils.arg('vol_type_id', metavar='<volume_type_id>',
- help='ID of volume type.')
-def do_qos_associate(cs, args):
- """Associates qos specs with specified volume type."""
- cs.qos_specs.associate(args.qos_specs, args.vol_type_id)
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-@utils.arg('vol_type_id', metavar='<volume_type_id>',
- help='ID of volume type.')
-def do_qos_disassociate(cs, args):
- """Disassociates qos specs from specified volume type."""
- cs.qos_specs.disassociate(args.qos_specs, args.vol_type_id)
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-def do_qos_disassociate_all(cs, args):
- """Disassociates qos specs from all associations."""
- cs.qos_specs.disassociate_all(args.qos_specs)
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-@utils.arg('action',
- metavar='<action>',
- choices=['set', 'unset'],
- help='The action. Valid values are "set" or "unset."')
-@utils.arg('metadata', metavar='key=value',
- nargs='+',
- default=[],
- help='Metadata key and value pair to set or unset. '
- 'For unset, specify only the key.')
-def do_qos_key(cs, args):
- """Sets or unsets specifications for a qos spec."""
- keypair = _extract_metadata(args)
-
- if args.action == 'set':
- cs.qos_specs.set_keys(args.qos_specs, keypair)
- elif args.action == 'unset':
- cs.qos_specs.unset_keys(args.qos_specs, list(keypair))
-
-
-@utils.arg('qos_specs', metavar='<qos_specs>',
- help='ID of QoS specifications.')
-def do_qos_get_association(cs, args):
- """Gets all associations for specified qos specs."""
- associations = cs.qos_specs.get_associations(args.qos_specs)
- _print_associations_list(associations)
-
-
-@utils.arg('snapshot',
- metavar='<snapshot>',
- help='ID of snapshot for which to update metadata.')
-@utils.arg('action',
- metavar='<action>',
- choices=['set', 'unset'],
- help='The action. Valid values are "set" or "unset."')
-@utils.arg('metadata',
- metavar='<key=value>',
- nargs='+',
- default=[],
- help='The metadata key and value pair to set or unset. '
- 'For unset, specify only the key.')
-def do_snapshot_metadata(cs, args):
- """Sets or deletes snapshot metadata."""
- snapshot = _find_volume_snapshot(cs, args.snapshot)
- metadata = _extract_metadata(args)
-
- if args.action == 'set':
- metadata = snapshot.set_metadata(metadata)
- utils.print_dict(metadata._info)
- elif args.action == 'unset':
- snapshot.delete_metadata(list(metadata.keys()))
-
-
-@utils.arg('snapshot', metavar='<snapshot>',
- help='ID of snapshot.')
-def do_snapshot_metadata_show(cs, args):
- """Shows snapshot metadata."""
- snapshot = _find_volume_snapshot(cs, args.snapshot)
- utils.print_dict(snapshot._info['metadata'], 'Metadata-property')
-
-
-@utils.arg('volume', metavar='<volume>',
- help='ID of volume.')
-def do_metadata_show(cs, args):
- """Shows volume metadata."""
- volume = utils.find_volume(cs, args.volume)
- utils.print_dict(volume._info['metadata'], 'Metadata-property')
-
-
-@utils.arg('volume',
- metavar='<volume>',
- help='ID of volume for which to update metadata.')
-@utils.arg('metadata',
- metavar='<key=value>',
- nargs='+',
- default=[],
- help='Metadata key and value pair or pairs to update. '
- 'Default=[].')
-def do_metadata_update_all(cs, args):
- """Updates volume metadata."""
- volume = utils.find_volume(cs, args.volume)
- metadata = _extract_metadata(args)
- metadata = volume.update_all_metadata(metadata)
- utils.print_dict(metadata['metadata'], 'Metadata-property')
-
-
-@utils.arg('snapshot',
- metavar='<snapshot>',
- help='ID of snapshot for which to update metadata.')
-@utils.arg('metadata',
- metavar='<key=value>',
- nargs='+',
- default=[],
- help='Metadata key and value pair or pairs to update. '
- 'Default=[].')
-def do_snapshot_metadata_update_all(cs, args):
- """Updates snapshot metadata."""
- snapshot = _find_volume_snapshot(cs, args.snapshot)
- metadata = _extract_metadata(args)
- metadata = snapshot.update_all_metadata(metadata)
- utils.print_dict(metadata)
-
-
-@utils.arg('volume', metavar='<volume>', help='ID of volume to update.')
-@utils.arg('read_only',
- metavar='<True|true|False|false>',
- choices=['True', 'true', 'False', 'false'],
- help='Enables or disables update of volume to '
- 'read-only access mode.')
-def do_readonly_mode_update(cs, args):
- """Updates volume read-only access-mode flag."""
- volume = utils.find_volume(cs, args.volume)
- cs.volumes.update_readonly_flag(volume,
- strutils.bool_from_string(args.read_only,
- strict=True))
-
-
-@utils.arg('volume', metavar='<volume>', help='ID of the volume to update.')
-@utils.arg('bootable',
- metavar='<True|true|False|false>',
- choices=['True', 'true', 'False', 'false'],
- help='Flag to indicate whether volume is bootable.')
-def do_set_bootable(cs, args):
- """Update bootable status of a volume."""
- volume = utils.find_volume(cs, args.volume)
- cs.volumes.set_bootable(volume,
- strutils.bool_from_string(args.bootable,
- strict=True))
diff --git a/cinderclient/v1/volume_backups.py b/cinderclient/v1/volume_backups.py
deleted file mode 100644
index 4040d5d5f..000000000
--- a/cinderclient/v1/volume_backups.py
+++ /dev/null
@@ -1,78 +0,0 @@
-# Copyright (C) 2013 Hewlett-Packard Development Company, L.P.
-# All Rights Reserved.
-#
-# 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.
-
-"""
-Volume Backups interface (1.1 extension).
-"""
-
-from cinderclient import base
-
-
-class VolumeBackup(base.Resource):
- """A volume backup is a block level backup of a volume."""
- NAME_ATTR = "display_name"
-
- def __repr__(self):
- return "<VolumeBackup: %s>" % self.id
-
- def delete(self):
- """Delete this volume backup."""
- return self.manager.delete(self)
-
-
-class VolumeBackupManager(base.ManagerWithFind):
- """Manage :class:`VolumeBackup` resources."""
- resource_class = VolumeBackup
-
- def create(self, volume_id, container=None,
- name=None, description=None):
- """Creates a volume backup.
-
- :param volume_id: The ID of the volume to backup.
- :param container: The name of the backup service container.
- :param name: The name of the backup.
- :param description: The description of the backup.
- :rtype: :class:`VolumeBackup`
- """
- body = {'backup': {'volume_id': volume_id,
- 'container': container,
- 'name': name,
- 'description': description}}
- return self._create('/backups', body, 'backup')
-
- def get(self, backup_id):
- """Show details of a volume backup.
-
- :param backup_id: The ID of the backup to display.
- :rtype: :class:`VolumeBackup`
- """
- return self._get("/backups/%s" % backup_id, "backup")
-
- def list(self, detailed=True, search_opts=None):
- """Get a list of all volume backups.
-
- :rtype: list of :class:`VolumeBackup`
- """
- if detailed is True:
- return self._list("/backups/detail", "backups")
- else:
- return self._list("/backups", "backups")
-
- def delete(self, backup):
- """Delete a volume backup.
-
- :param backup: The :class:`VolumeBackup` to delete.
- """
- self._delete("/backups/%s" % base.getid(backup))
diff --git a/cinderclient/v1/volume_backups_restore.py b/cinderclient/v1/volume_backups_restore.py
deleted file mode 100644
index 0eafa8220..000000000
--- a/cinderclient/v1/volume_backups_restore.py
+++ /dev/null
@@ -1,43 +0,0 @@
-# Copyright (C) 2013 Hewlett-Packard Development Company, L.P.
-# All Rights Reserved.
-#
-# 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.
-
-"""Volume Backups Restore interface (1.1 extension).
-
-This is part of the Volume Backups interface.
-"""
-
-from cinderclient import base
-
-
-class VolumeBackupsRestore(base.Resource):
- """A Volume Backups Restore represents a restore operation."""
- def __repr__(self):
- return "<VolumeBackupsRestore: %s>" % self.volume_id
-
-
-class VolumeBackupRestoreManager(base.Manager):
- """Manage :class:`VolumeBackupsRestore` resources."""
- resource_class = VolumeBackupsRestore
-
- def restore(self, backup_id, volume_id=None):
- """Restore a backup to a volume.
-
- :param backup_id: The ID of the backup to restore.
- :param volume_id: The ID of the volume to restore the backup to.
- :rtype: :class:`Restore`
- """
- body = {'restore': {'volume_id': volume_id}}
- return self._create("/backups/%s/restore" % backup_id,
- body, "restore")
diff --git a/cinderclient/v1/volume_encryption_types.py b/cinderclient/v1/volume_encryption_types.py
deleted file mode 100644
index 654445b06..000000000
--- a/cinderclient/v1/volume_encryption_types.py
+++ /dev/null
@@ -1,98 +0,0 @@
-# Copyright (c) 2013 The Johns Hopkins University/Applied Physics Laboratory
-# All Rights Reserved.
-#
-# 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.
-
-
-"""
-Volume Encryption Type interface
-"""
-
-from cinderclient import base
-
-
-class VolumeEncryptionType(base.Resource):
- """
- A Volume Encryption Type is a collection of settings used to conduct
- encryption for a specific volume type.
- """
- def __repr__(self):
- return "<VolumeEncryptionType: %s>" % self.encryption_id
-
-
-class VolumeEncryptionTypeManager(base.ManagerWithFind):
- """
- Manage :class: `VolumeEncryptionType` resources.
- """
- resource_class = VolumeEncryptionType
-
- def list(self, search_opts=None):
- """
- List all volume encryption types.
-
- :param search_opts: Search options to filter out volume
- encryption types
- :return: a list of :class: VolumeEncryptionType instances
- """
- # Since the encryption type is a volume type extension, we cannot get
- # all encryption types without going through all volume types.
- volume_types = self.api.volume_types.list()
- encryption_types = []
- for volume_type in volume_types:
- encryption_type = self._get("/types/%s/encryption"
- % base.getid(volume_type))
- if hasattr(encryption_type, 'volume_type_id'):
- encryption_types.append(encryption_type)
- return encryption_types
-
- def get(self, volume_type):
- """
- Get the volume encryption type for the specified volume type.
-
- :param volume_type: the volume type to query
- :return: an instance of :class: VolumeEncryptionType
- """
- return self._get("/types/%s/encryption" % base.getid(volume_type))
-
- def create(self, volume_type, specs):
- """
- Creates encryption type for a volume type. Default: admin only.
-
- :param volume_type: the volume type on which to add an encryption type
- :param specs: the encryption type specifications to add
- :return: an instance of :class: VolumeEncryptionType
- """
- body = {'encryption': specs}
- return self._create("/types/%s/encryption" % base.getid(volume_type),
- body, "encryption")
-
- def update(self, volume_type, specs):
- """
- Update the encryption type information for the specified volume type.
-
- :param volume_type: the volume type whose encryption type information
- must be updated
- :param specs: the encryption type specifications to update
- :return: an instance of :class: VolumeEncryptionType
- """
- raise NotImplementedError()
-
- def delete(self, volume_type):
- """
- Delete the encryption type information for the specified volume type.
-
- :param volume_type: the volume type whose encryption type information
- must be deleted
- """
- return self._delete("/types/%s/encryption/provider" %
- base.getid(volume_type))
diff --git a/cinderclient/v1/volume_snapshots.py b/cinderclient/v1/volume_snapshots.py
deleted file mode 100644
index 922071a71..000000000
--- a/cinderclient/v1/volume_snapshots.py
+++ /dev/null
@@ -1,183 +0,0 @@
-# Copyright 2011 Denali Systems, Inc.
-# All Rights Reserved.
-#
-# 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.
-
-"""
-Volume snapshot interface (1.1 extension).
-"""
-
-from cinderclient import base
-from cinderclient import utils
-
-
-class Snapshot(base.Resource):
- """
- A Snapshot is a point-in-time snapshot of an openstack volume.
- """
- NAME_ATTR = "display_name"
-
- def __repr__(self):
- return "<Snapshot: %s>" % self.id
-
- def delete(self):
- """
- Delete this snapshot.
- """
- self.manager.delete(self)
-
- def update(self, **kwargs):
- """
- Update the display_name or display_description for this snapshot.
- """
- self.manager.update(self, **kwargs)
-
- @property
- def progress(self):
- return self._info.get('os-extended-snapshot-attributes:progress')
-
- @property
- def project_id(self):
- return self._info.get('os-extended-snapshot-attributes:project_id')
-
- def reset_state(self, state):
- """Update the snapshot with the provided state."""
- self.manager.reset_state(self, state)
-
- def set_metadata(self, metadata):
- """Set metadata of this snapshot."""
- return self.manager.set_metadata(self, metadata)
-
- def delete_metadata(self, keys):
- """Delete metadata of this snapshot."""
- return self.manager.delete_metadata(self, keys)
-
- def update_all_metadata(self, metadata):
- """Update_all metadata of this snapshot."""
- return self.manager.update_all_metadata(self, metadata)
-
-
-class SnapshotManager(base.ManagerWithFind):
- """
- Manage :class:`Snapshot` resources.
- """
- resource_class = Snapshot
-
- def create(self, volume_id, force=False,
- display_name=None, display_description=None):
-
- """
- Create a snapshot of the given volume.
-
- :param volume_id: The ID of the volume to snapshot.
- :param force: If force is True, create a snapshot even if the volume is
- attached to an instance. Default is False.
- :param display_name: Name of the snapshot
- :param display_description: Description of the snapshot
- :rtype: :class:`Snapshot`
- """
- body = {'snapshot': {'volume_id': volume_id,
- 'force': force,
- 'display_name': display_name,
- 'display_description': display_description}}
- return self._create('/snapshots', body, 'snapshot')
-
- def get(self, snapshot_id):
- """
- Get a snapshot.
-
- :param snapshot_id: The ID of the snapshot to get.
- :rtype: :class:`Snapshot`
- """
- return self._get("/snapshots/%s" % snapshot_id, "snapshot")
-
- def list(self, detailed=True, search_opts=None):
- """
- Get a list of all snapshots.
-
- :rtype: list of :class:`Snapshot`
- """
- query_string = utils.build_query_param(search_opts, sort=True)
-
- detail = ""
- if detailed:
- detail = "/detail"
-
- return self._list("/snapshots%s%s" % (detail, query_string),
- "snapshots")
-
- def delete(self, snapshot):
- """
- Delete a snapshot.
-
- :param snapshot: The :class:`Snapshot` to delete.
- """
- self._delete("/snapshots/%s" % base.getid(snapshot))
-
- def update(self, snapshot, **kwargs):
- """
- Update the display_name or display_description for a snapshot.
-
- :param snapshot: The :class:`Snapshot` to update.
- """
- if not kwargs:
- return
-
- body = {"snapshot": kwargs}
-
- self._update("/snapshots/%s" % base.getid(snapshot), body)
-
- def reset_state(self, snapshot, state):
- """Update the specified volume with the provided state."""
- return self._action('os-reset_status', snapshot, {'status': state})
-
- def _action(self, action, snapshot, info=None, **kwargs):
- """Perform a snapshot action."""
- body = {action: info}
- self.run_hooks('modify_body_for_action', body, **kwargs)
- url = '/snapshots/%s/action' % base.getid(snapshot)
- return self.api.client.post(url, body=body)
-
- def update_snapshot_status(self, snapshot, update_dict):
- return self._action('os-update_snapshot_status',
- base.getid(snapshot), update_dict)
-
- def set_metadata(self, snapshot, metadata):
- """Update/Set a snapshots metadata.
-
- :param snapshot: The :class:`Snapshot`.
- :param metadata: A list of keys to be set.
- """
- body = {'metadata': metadata}
- return self._create("/snapshots/%s/metadata" % base.getid(snapshot),
- body, "metadata")
-
- def delete_metadata(self, snapshot, keys):
- """Delete specified keys from snapshot metadata.
-
- :param snapshot: The :class:`Snapshot`.
- :param keys: A list of keys to be removed.
- """
- snapshot_id = base.getid(snapshot)
- for k in keys:
- self._delete("/snapshots/%s/metadata/%s" % (snapshot_id, k))
-
- def update_all_metadata(self, snapshot, metadata):
- """Update_all snapshot metadata.
-
- :param snapshot: The :class:`Snapshot`.
- :param metadata: A list of keys to be updated.
- """
- body = {'metadata': metadata}
- return self._update("/snapshots/%s/metadata" % base.getid(snapshot),
- body)
diff --git a/cinderclient/v1/volume_transfers.py b/cinderclient/v1/volume_transfers.py
deleted file mode 100644
index 9f292a446..000000000
--- a/cinderclient/v1/volume_transfers.py
+++ /dev/null
@@ -1,88 +0,0 @@
-# Copyright (C) 2013 Hewlett-Packard Development Company, L.P.
-# All Rights Reserved.
-#
-# 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.
-
-"""
-Volume transfer interface (1.1 extension).
-"""
-
-from cinderclient import base
-from cinderclient import utils
-
-
-class VolumeTransfer(base.Resource):
- """Transfer a volume from one tenant to another"""
-
- def __repr__(self):
- return "<VolumeTransfer: %s>" % self.id
-
- def delete(self):
- """Delete this volume transfer."""
- return self.manager.delete(self)
-
-
-class VolumeTransferManager(base.ManagerWithFind):
- """Manage :class:`VolumeTransfer` resources."""
- resource_class = VolumeTransfer
-
- def create(self, volume_id, name=None):
- """Creates a volume transfer.
-
- :param volume_id: The ID of the volume to transfer.
- :param name: The name of the transfer.
- :rtype: :class:`VolumeTransfer`
- """
- body = {'transfer': {'volume_id': volume_id,
- 'name': name}}
- return self._create('/os-volume-transfer', body, 'transfer')
-
- def accept(self, transfer_id, auth_key):
- """Accept a volume transfer.
-
- :param transfer_id: The ID of the transfer to accept.
- :param auth_key: The auth_key of the transfer.
- :rtype: :class:`VolumeTransfer`
- """
- body = {'accept': {'auth_key': auth_key}}
- return self._create('/os-volume-transfer/%s/accept' % transfer_id,
- body, 'transfer')
-
- def get(self, transfer_id):
- """Show details of a volume transfer.
-
- :param transfer_id: The ID of the volume transfer to display.
- :rtype: :class:`VolumeTransfer`
- """
- return self._get("/os-volume-transfer/%s" % transfer_id, "transfer")
-
- def list(self, detailed=True, search_opts=None):
- """Get a list of all volume transfer.
-
- :rtype: list of :class:`VolumeTransfer`
- """
- query_string = utils.build_query_param(search_opts)
-
- detail = ""
- if detailed:
- detail = "/detail"
-
- return self._list("/os-volume-transfer%s%s" % (detail, query_string),
- "transfers")
-
- def delete(self, transfer_id):
- """Delete a volume transfer.
-
- :param transfer_id: The :class:`VolumeTransfer` to delete.
- """
- self._delete("/os-volume-transfer/%s" % base.getid(transfer_id))
diff --git a/cinderclient/v1/volume_types.py b/cinderclient/v1/volume_types.py
deleted file mode 100644
index 6e5b0af1f..000000000
--- a/cinderclient/v1/volume_types.py
+++ /dev/null
@@ -1,118 +0,0 @@
-# Copyright (c) 2011 Rackspace US, 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.
-
-
-"""
-Volume Type interface.
-"""
-
-from cinderclient import base
-
-
-class VolumeType(base.Resource):
- """
- A Volume Type is the type of volume to be created
- """
- def __repr__(self):
- return "<VolumeType: %s>" % self.name
-
- def get_keys(self):
- """
- Get extra specs from a volume type.
-
- :param vol_type: The :class:`VolumeType` to get extra specs from
- """
- _resp, body = self.manager.api.client.get(
- "/types/%s/extra_specs" %
- base.getid(self))
- return body["extra_specs"]
-
- def set_keys(self, metadata):
- """
- Set extra specs on a volume type.
-
- :param type : The :class:`VolumeType` to set extra spec on
- :param metadata: A dict of key/value pairs to be set
- """
- body = {'extra_specs': metadata}
- return self.manager._create(
- "/types/%s/extra_specs" % base.getid(self),
- body,
- "extra_specs",
- return_raw=True)
-
- def unset_keys(self, keys):
- """
- Unset extra specs on a volume type.
-
- :param type_id: The :class:`VolumeType` to unset extra spec on
- :param keys: A list of keys to be unset
- """
-
- # NOTE(jdg): This wasn't actually doing all of the keys before
- # the return in the loop resulted in only ONE key being unset,
- # since on success the return was None, we'll only interrupt
- # the loop and if an exception is raised.
- for k in keys:
- self.manager._delete("/types/%s/extra_specs/%s" %
- (base.getid(self), k))
-
-
-class VolumeTypeManager(base.ManagerWithFind):
- """
- Manage :class:`VolumeType` resources.
- """
- resource_class = VolumeType
-
- def list(self, search_opts=None):
- """
- Get a list of all volume types.
-
- :rtype: list of :class:`VolumeType`.
- """
- return self._list("/types", "volume_types")
-
- def get(self, volume_type):
- """
- Get a specific volume type.
-
- :param volume_type: The ID of the :class:`VolumeType` to get.
- :rtype: :class:`VolumeType`
- """
- return self._get("/types/%s" % base.getid(volume_type), "volume_type")
-
- def delete(self, volume_type):
- """
- Delete a specific volume_type.
-
- :param volume_type: The name or ID of the :class:`VolumeType` to get.
- """
- self._delete("/types/%s" % base.getid(volume_type))
-
- def create(self, name):
- """
- Creates a volume type.
-
- :param name: Descriptive name of the volume type
- :rtype: :class:`VolumeType`
- """
-
- body = {
- "volume_type": {
- "name": name,
- }
- }
-
- return self._create("/types", body, "volume_type")
diff --git a/cinderclient/v1/volumes.py b/cinderclient/v1/volumes.py
deleted file mode 100644
index 8e25f40b1..000000000
--- a/cinderclient/v1/volumes.py
+++ /dev/null
@@ -1,428 +0,0 @@
-# Copyright 2011 Denali Systems, Inc.
-# All Rights Reserved.
-#
-# 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.
-
-"""
-Volume interface (1.1 extension).
-"""
-
-from cinderclient import base
-from cinderclient import utils
-
-
-class Volume(base.Resource):
- """A volume is an extra block level storage to the OpenStack instances."""
- NAME_ATTR = "display_name"
-
- def __repr__(self):
- return "<Volume: %s>" % self.id
-
- def delete(self):
- """Delete this volume."""
- self.manager.delete(self)
-
- def update(self, **kwargs):
- """Update the display_name or display_description for this volume."""
- self.manager.update(self, **kwargs)
-
- def attach(self, instance_uuid, mountpoint, mode='rw',
- host_name=None):
- """Set attachment metadata.
-
- :param instance_uuid: uuid of the attaching instance.
- :param mountpoint: mountpoint on the attaching instance or host.
- :param mode: the access mode
- :param host_name: name of the attaching host.
- """
- return self.manager.attach(self, instance_uuid, mountpoint, mode,
- host_name)
-
- def detach(self):
- """Clear attachment metadata."""
- return self.manager.detach(self)
-
- def reserve(self, volume):
- """Reserve this volume."""
- return self.manager.reserve(self)
-
- def unreserve(self, volume):
- """Unreserve this volume."""
- return self.manager.unreserve(self)
-
- def begin_detaching(self, volume):
- """Begin detaching volume."""
- return self.manager.begin_detaching(self)
-
- def roll_detaching(self, volume):
- """Roll detaching volume."""
- return self.manager.roll_detaching(self)
-
- def initialize_connection(self, volume, connector):
- """Initialize a volume connection.
-
- :param connector: connector dict from nova.
- """
- return self.manager.initialize_connection(self, connector)
-
- def terminate_connection(self, volume, connector):
- """Terminate a volume connection.
-
- :param connector: connector dict from nova.
- """
- return self.manager.terminate_connection(self, connector)
-
- def set_metadata(self, volume, metadata):
- """Set or Append metadata to a volume.
-
- :param volume : The :class: `Volume` to set metadata on
- :param metadata: A dict of key/value pairs to set
- """
- return self.manager.set_metadata(self, metadata)
-
- def upload_to_image(self, force, image_name, container_format,
- disk_format):
- """Upload a volume to image service as an image."""
- return self.manager.upload_to_image(self, force, image_name,
- container_format, disk_format)
-
- def force_delete(self):
- """Delete the specified volume ignoring its current state.
-
- :param volume: The UUID of the volume to force-delete.
- """
- self.manager.force_delete(self)
-
- def reset_state(self, state):
- """Update the volume with the provided state."""
- self.manager.reset_state(self, state)
-
- def extend(self, volume, new_size):
- """Extend the size of the specified volume.
-
- :param volume: The UUID of the volume to extend.
- :param new_size: The desired size to extend volume to.
- """
- self.manager.extend(self, new_size)
-
- def migrate_volume(self, host, force_host_copy):
- """Migrate the volume to a new host."""
- self.manager.migrate_volume(self, host, force_host_copy)
-
- def update_all_metadata(self, metadata):
- """Update all metadata of this volume."""
- return self.manager.update_all_metadata(self, metadata)
-
- def update_readonly_flag(self, volume, read_only):
- """Update the read-only access mode flag of the specified volume.
-
- :param volume: The UUID of the volume to update.
- :param read_only: The value to indicate whether to update volume to
- read-only access mode.
- """
- self.manager.update_readonly_flag(self, read_only)
-
-
-class VolumeManager(base.ManagerWithFind):
- """
- Manage :class:`Volume` resources.
- """
- resource_class = Volume
-
- def create(self, size, snapshot_id=None, source_volid=None,
- display_name=None, display_description=None,
- volume_type=None, user_id=None,
- project_id=None, availability_zone=None,
- metadata=None, imageRef=None):
- """
- Creates a volume.
-
- :param size: Size of volume in GB
- :param snapshot_id: ID of the snapshot
- :param display_name: Name of the volume
- :param display_description: Description of the volume
- :param volume_type: Type of volume
- :param user_id: User id derived from context
- :param project_id: Project id derived from context
- :param availability_zone: Availability Zone to use
- :param metadata: Optional metadata to set on volume creation
- :param imageRef: reference to an image stored in glance
- :param source_volid: ID of source volume to clone from
- :rtype: :class:`Volume`
- """
-
- if metadata is None:
- volume_metadata = {}
- else:
- volume_metadata = metadata
-
- body = {'volume': {'size': size,
- 'snapshot_id': snapshot_id,
- 'display_name': display_name,
- 'display_description': display_description,
- 'volume_type': volume_type,
- 'user_id': user_id,
- 'project_id': project_id,
- 'availability_zone': availability_zone,
- 'status': "creating",
- 'attach_status': "detached",
- 'metadata': volume_metadata,
- 'imageRef': imageRef,
- 'source_volid': source_volid,
- }}
- return self._create('/volumes', body, 'volume')
-
- def get(self, volume_id):
- """
- Get a volume.
-
- :param volume_id: The ID of the volume to get.
- :rtype: :class:`Volume`
- """
- return self._get("/volumes/%s" % volume_id, "volume")
-
- def list(self, detailed=True, search_opts=None, limit=None):
- """
- Get a list of all volumes.
-
- :rtype: list of :class:`Volume`
- """
- if search_opts is None:
- search_opts = {}
-
- if limit:
- search_opts['limit'] = limit
-
- query_string = utils.build_query_param(search_opts, sort=True)
-
- detail = ""
- if detailed:
- detail = "/detail"
-
- return self._list("/volumes%s%s" % (detail, query_string),
- "volumes")
-
- def delete(self, volume):
- """
- Delete a volume.
-
- :param volume: The :class:`Volume` to delete.
- """
- self._delete("/volumes/%s" % base.getid(volume))
-
- def update(self, volume, **kwargs):
- """
- Update the display_name or display_description for a volume.
-
- :param volume: The :class:`Volume` to update.
- """
- if not kwargs:
- return
-
- body = {"volume": kwargs}
-
- self._update("/volumes/%s" % base.getid(volume), body)
-
- def _action(self, action, volume, info=None, **kwargs):
- """
- Perform a volume "action."
- """
- body = {action: info}
- self.run_hooks('modify_body_for_action', body, **kwargs)
- url = '/volumes/%s/action' % base.getid(volume)
- return self.api.client.post(url, body=body)
-
- def attach(self, volume, instance_uuid, mountpoint, mode='rw',
- host_name=None):
- """
- Set attachment metadata.
-
- :param volume: The :class:`Volume` (or its ID)
- you would like to attach.
- :param instance_uuid: uuid of the attaching instance or host.
- :param mountpoint: mountpoint on the attaching instance.
- :param mode: the access mode.
- :param host_name: name of the attaching host.
- """
- body = {'mountpoint': mountpoint, 'mode': mode}
- if instance_uuid is not None:
- body.update({'instance_uuid': instance_uuid})
- if host_name is not None:
- body.update({'host_name': host_name})
- return self._action('os-attach', volume, body)
-
- def detach(self, volume):
- """
- Clear attachment metadata.
-
- :param volume: The :class:`Volume` (or its ID)
- you would like to detach.
- """
- return self._action('os-detach', volume)
-
- def reserve(self, volume):
- """
- Reserve this volume.
-
- :param volume: The :class:`Volume` (or its ID)
- you would like to reserve.
- """
- return self._action('os-reserve', volume)
-
- def unreserve(self, volume):
- """
- Unreserve this volume.
-
- :param volume: The :class:`Volume` (or its ID)
- you would like to unreserve.
- """
- return self._action('os-unreserve', volume)
-
- def begin_detaching(self, volume):
- """
- Begin detaching this volume.
-
- :param volume: The :class:`Volume` (or its ID)
- you would like to detach.
- """
- return self._action('os-begin_detaching', volume)
-
- def roll_detaching(self, volume):
- """
- Roll detaching this volume.
-
- :param volume: The :class:`Volume` (or its ID)
- you would like to roll detaching.
- """
- return self._action('os-roll_detaching', volume)
-
- def initialize_connection(self, volume, connector):
- """
- Initialize a volume connection.
-
- :param volume: The :class:`Volume` (or its ID).
- :param connector: connector dict from nova.
- """
- return self._action('os-initialize_connection', volume,
- {'connector': connector})[1]['connection_info']
-
- def terminate_connection(self, volume, connector):
- """
- Terminate a volume connection.
-
- :param volume: The :class:`Volume` (or its ID).
- :param connector: connector dict from nova.
- """
- self._action('os-terminate_connection', volume,
- {'connector': connector})
-
- def set_metadata(self, volume, metadata):
- """
- Update/Set a volumes metadata.
-
- :param volume: The :class:`Volume`.
- :param metadata: A list of keys to be set.
- """
- body = {'metadata': metadata}
- return self._create("/volumes/%s/metadata" % base.getid(volume),
- body, "metadata")
-
- def delete_metadata(self, volume, keys):
- """
- Delete specified keys from volumes metadata.
-
- :param volume: The :class:`Volume`.
- :param keys: A list of keys to be removed.
- """
- for k in keys:
- self._delete("/volumes/%s/metadata/%s" % (base.getid(volume), k))
-
- def upload_to_image(self, volume, force, image_name, container_format,
- disk_format):
- """
- Upload volume to image service as image.
-
- :param volume: The :class:`Volume` to upload.
- """
- return self._action('os-volume_upload_image',
- volume,
- {'force': force,
- 'image_name': image_name,
- 'container_format': container_format,
- 'disk_format': disk_format})
-
- def force_delete(self, volume):
- return self._action('os-force_delete', base.getid(volume))
-
- def reset_state(self, volume, state):
- """Update the provided volume with the provided state."""
- return self._action('os-reset_status', volume, {'status': state})
-
- def extend(self, volume, new_size):
- return self._action('os-extend',
- base.getid(volume),
- {'new_size': new_size})
-
- def get_encryption_metadata(self, volume_id):
- """
- Retrieve the encryption metadata from the desired volume.
-
- :param volume_id: the id of the volume to query
- :return: a dictionary of volume encryption metadata
- """
- return self._get("/volumes/%s/encryption" % volume_id)._info
-
- def migrate_volume(self, volume, host, force_host_copy):
- """Migrate volume to new host.
-
- :param volume: The :class:`Volume` to migrate
- :param host: The destination host
- :param force_host_copy: Skip driver optimizations
- """
-
- return self._action('os-migrate_volume',
- volume,
- {'host': host, 'force_host_copy': force_host_copy})
-
- def migrate_volume_completion(self, old_volume, new_volume, error):
- """Complete the migration from the old volume to the temp new one.
-
- :param old_volume: The original :class:`Volume` in the migration
- :param new_volume: The new temporary :class:`Volume` in the migration
- :param error: Inform of an error to cause migration cleanup
- """
-
- new_volume_id = base.getid(new_volume)
- return self._action('os-migrate_volume_completion',
- old_volume,
- {'new_volume': new_volume_id, 'error': error})[1]
-
- def update_all_metadata(self, volume, metadata):
- """Update all metadata of a volume.
-
- :param volume: The :class:`Volume`.
- :param metadata: A list of keys to be updated.
- """
- body = {'metadata': metadata}
- return self._update("/volumes/%s/metadata" % base.getid(volume),
- body)
-
- def update_readonly_flag(self, volume, flag):
- return self._action('os-update_readonly_flag',
- base.getid(volume),
- {'readonly': flag})
-
- def set_bootable(self, volume, flag):
- return self._action('os-set_bootable',
- base.getid(volume),
- {'bootable': flag})
diff --git a/releasenotes/notes/cinderclient-5-de0508ce5a221d21.yaml b/releasenotes/notes/cinderclient-5-de0508ce5a221d21.yaml
index 24c26dd7c..3cf32c695 100644
--- a/releasenotes/notes/cinderclient-5-de0508ce5a221d21.yaml
+++ b/releasenotes/notes/cinderclient-5-de0508ce5a221d21.yaml
@@ -5,3 +5,8 @@ prelude: >
support for the Cinder v1 API has been removed. Prior to upgrading to this
release, ensure all Cinder services that need to be managed are 13.0.0
(Rocky) or later.
+upgrade:
+ - |
+ This version of the python-cinderclient no longer supports the Cinder v1
+ API. Ensure all mananaged services have at least the v2 API available prior
+ to upgrading this client.