From 3502a5591a654ae57741c6738994ffa9d8457696 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Mon, 17 May 2021 18:34:11 -0400 Subject: Remove v2 support from the shell Also removes the v2 support from the generic client and restores a skipped test. Additionally, the cinderclient.tests.v2.test_availablity_zone module depends on the v2.shell class, so move that module to v3, update the v3 AvailablityZone class, and make appropriate adjustments to the tests and test fixtures. Change-Id: I7a3cca15f5944141d510a75af6684221c297963b --- cinderclient/api_versions.py | 48 +- cinderclient/client.py | 44 +- cinderclient/shell.py | 41 +- cinderclient/tests/unit/fixture_data/client.py | 16 + .../tests/unit/fixture_data/keystone_client.py | 4 +- cinderclient/tests/unit/test_api_versions.py | 39 +- cinderclient/tests/unit/test_client.py | 33 +- cinderclient/tests/unit/test_shell.py | 24 +- .../tests/unit/v2/test_availability_zone.py | 89 - cinderclient/tests/unit/v2/test_shell.py | 1358 ----------- .../tests/unit/v3/test_availability_zone.py | 89 + cinderclient/v2/shell.py | 2475 -------------------- cinderclient/v3/availability_zones.py | 25 +- cinderclient/v3/shell.py | 4 +- cinderclient/v3/shell_base.py | 2475 ++++++++++++++++++++ 15 files changed, 2749 insertions(+), 4015 deletions(-) delete mode 100644 cinderclient/tests/unit/v2/test_availability_zone.py delete mode 100644 cinderclient/tests/unit/v2/test_shell.py create mode 100644 cinderclient/tests/unit/v3/test_availability_zone.py delete mode 100644 cinderclient/v2/shell.py create mode 100644 cinderclient/v3/shell_base.py diff --git a/cinderclient/api_versions.py b/cinderclient/api_versions.py index d7a470d..47a923a 100644 --- a/cinderclient/api_versions.py +++ b/cinderclient/api_versions.py @@ -13,8 +13,6 @@ import functools import logging -import os -import pkgutil import re from oslo_utils import strutils @@ -26,9 +24,8 @@ from cinderclient import utils LOG = logging.getLogger(__name__) -# key is a deprecated version and value is an alternative version. -DEPRECATED_VERSIONS = {"2": "3"} -DEPRECATED_VERSION = "2.0" +# key is unsupported version, value is appropriate supported alternative +REPLACEMENT_VERSIONS = {"1": "3", "2": "3"} MAX_VERSION = "3.64" MIN_VERSION = "3.0" @@ -190,14 +187,12 @@ class VersionedMethod(object): def get_available_major_versions(): - # NOTE(andreykurilin): available clients version should not be - # hardcoded, so let's discover them. - matcher = re.compile(r"v[0-9]*$") - submodules = pkgutil.iter_modules([os.path.dirname(__file__)]) - available_versions = [name[1:] for loader, name, ispkg in submodules - if matcher.search(name)] - - return available_versions + # NOTE: the discovery code previously here assumed that if a v2 + # module exists, it must contain a client. This will be False + # during the transition period when the v2 client is removed but + # we are still using other classes in that module. Right now there's + # only one client version available, so we simply hard-code it. + return ['3'] def check_major_version(api_version): @@ -224,11 +219,11 @@ def check_major_version(api_version): def get_api_version(version_string): """Returns checked APIVersion object""" version_string = str(version_string) - if version_string in DEPRECATED_VERSIONS: - LOG.warning("Version %(deprecated_version)s is deprecated, use " - "alternative version %(alternative)s instead.", - {"deprecated_version": version_string, - "alternative": DEPRECATED_VERSIONS[version_string]}) + if version_string in REPLACEMENT_VERSIONS: + LOG.warning("Version %(old)s is not supported, use " + "supported version %(now)s instead.", + {"old": version_string, + "now": REPLACEMENT_VERSIONS[version_string]}) if strutils.is_int_like(version_string): version_string = "%s.0" % version_string @@ -248,11 +243,20 @@ def _get_server_version_range(client): client.version) if not versions: - return APIVersion(), APIVersion() + msg = _("Server does not support microversions. You cannot use this " + "version of the cinderclient with the requested server. " + "Try using a cinderclient version less than 8.0.0.") + raise exceptions.UnsupportedVersion(msg) + for version in versions: if '3.' in version.version: return APIVersion(version.min_version), APIVersion(version.version) + # if we're still here, there's nothing we understand in the versions + msg = _("You cannot use this version of the cinderclient with the " + "requested server.") + raise exceptions.UnsupportedVersion(msg) + def get_highest_version(client): """Queries the server version info and returns highest supported @@ -278,12 +282,6 @@ def discover_version(client, requested_version): server_start_version, server_end_version = _get_server_version_range( client) - if not server_start_version and not server_end_version: - msg = ("Server does not support microversions. Changing server " - "version to %(min_version)s.") - LOG.debug(msg, {"min_version": DEPRECATED_VERSION}) - return APIVersion(DEPRECATED_VERSION) - _validate_server_version(server_start_version, server_end_version) # get the highest version the server can handle relative to the diff --git a/cinderclient/client.py b/cinderclient/client.py index c473343..559e6aa 100644 --- a/cinderclient/client.py +++ b/cinderclient/client.py @@ -57,16 +57,14 @@ except Exception: pass -_VALID_VERSIONS = ['v2', 'v3'] +_VALID_VERSIONS = ['v3'] V3_SERVICE_TYPE = 'volumev3' -V2_SERVICE_TYPE = 'volumev2' -SERVICE_TYPES = {'2': V2_SERVICE_TYPE, - '3': V3_SERVICE_TYPE} +SERVICE_TYPES = {'3': V3_SERVICE_TYPE} REQ_ID_HEADER = 'X-OpenStack-Request-ID' # tell keystoneclient that we can ignore the /v1|v2/{project_id} component of # the service catalog when doing discovery lookups -for svc in ('volume', 'volumev2', 'volumev3'): +for svc in ('volume', 'volumev3'): discover.add_catalog_discover_hack(svc, re.compile(r'/v[12]/\w+/?$'), '/') @@ -85,6 +83,8 @@ def get_server_version(url, insecure=False, cacert=None, cert=None): :returns: APIVersion object for min and max version supported by the server """ + # NOTE: we (the client) don't support v2 anymore, but this function + # is checking the server version min_version = "2.0" current_version = "2.0" @@ -128,22 +128,37 @@ def get_server_version(url, insecure=False, cacert=None, cert=None): 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' + # keep looking in case this cloud is running v2 and + # we haven't seen v3 yet + continue except exceptions.ClientException as e: + # NOTE: logging the warning but returning the lowest server API version + # supported in this OpenStack release is the legacy behavior, so that's + # what we do here + min_version = '3.0' + current_version = '3.0' logger.warning("Error in server version query:%s\n" - "Returning APIVersion 2.0", str(e.message)) + "Returning APIVersion 3.0", str(e.message)) return (api_versions.APIVersion(min_version), api_versions.APIVersion(current_version)) def get_highest_client_server_version(url, insecure=False, cacert=None, cert=None): - """Returns highest supported version by client and server as a string.""" + """Returns highest supported version by client and server as a string. + + :raises: UnsupportedVersion if the maximum supported by the server + is less than the minimum supported by the client + """ min_server, max_server = get_server_version(url, insecure, cacert, cert) max_client = api_versions.APIVersion(api_versions.MAX_VERSION) + min_client = api_versions.APIVersion(api_versions.MIN_VERSION) + if max_server < min_client: + msg = _("The maximum version supported by the server (%(srv)s) does " + "not meet the minimum version supported by this client " + "(%(cli)s)") % {"srv": str(max_server), + "cli": api_versions.MIN_VERSION} + raise exceptions.UnsupportedVersion(msg) return min(max_server, max_client).get_string() @@ -769,7 +784,6 @@ def _get_client_class_and_version(version): def get_client_class(version): version_map = { - '2': 'cinderclient.v2.client.Client', '3': 'cinderclient.v3.client.Client', } try: @@ -797,10 +811,6 @@ def discover_extensions(version): def _discover_via_python_path(): for (module_loader, name, ispkg) in pkgutil.iter_modules(): if name.endswith('cinderclient_ext'): - if not hasattr(module_loader, 'load_module'): - # Python 2.6 compat: actually get an ImpImporter obj - module_loader = module_loader.find_module(name) - module = module_loader.load_module(name) yield name, module @@ -845,7 +855,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 ``2`` (deprecated now) or ``3.X`` (where X is a microversion). + you can use ``3`` or ``3.X`` (where X is a microversion). Alternatively, you can create a client instance using the keystoneclient diff --git a/cinderclient/shell.py b/cinderclient/shell.py index 0c3fa45..dc9190a 100644 --- a/cinderclient/shell.py +++ b/cinderclient/shell.py @@ -48,7 +48,6 @@ except Exception: DEFAULT_MAJOR_OS_VOLUME_API_VERSION = "3" DEFAULT_CINDER_ENDPOINT_TYPE = 'publicURL' -V2_SHELL = 'cinderclient.v2.shell' V3_SHELL = 'cinderclient.v3.shell' HINT_HELP_MSG = (" [hint: use '--os-volume-api-version' flag to show help " "message for proper version]") @@ -202,7 +201,8 @@ class OpenStackCinderShell(object): default=None), help=_('Block Storage API version. ' 'Accepts X, X.Y (where X is major and Y is minor ' - 'part).' + 'part). NOTE: this client accepts only \'3\' for ' + 'the major version. ' 'Default=env[OS_VOLUME_API_VERSION].')) parser.add_argument('--os_volume_api_version', help=argparse.SUPPRESS) @@ -356,10 +356,7 @@ class OpenStackCinderShell(object): self.subcommands = {} subparsers = parser.add_subparsers(metavar='') - if version.ver_major == 3: - actions_module = importutils.import_module(V3_SHELL) - else: - actions_module = importutils.import_module(V2_SHELL) + actions_module = importutils.import_module(V3_SHELL) self._find_actions(subparsers, actions_module, version, do_help, input_args) @@ -740,6 +737,10 @@ class OpenStackCinderShell(object): except exc.AuthorizationFailure: raise exc.CommandError("Unable to authorize user.") + # FIXME: this section figuring out the api version could use + # analysis and refactoring. See + # https://review.opendev.org/c/openstack/python-cinderclient/+/766882/ + # for some ideas. endpoint_api_version = None # Try to get the API version from the endpoint URL. If that fails fall # back to trying to use what the user specified via @@ -750,18 +751,26 @@ class OpenStackCinderShell(object): self.cs.get_volume_api_version_from_endpoint() except exc.UnsupportedVersion: endpoint_api_version = options.os_volume_api_version - if api_version_input: + # FIXME: api_version_input is initialized as True at the beginning + # of this function and never modified + if api_version_input and endpoint_api_version: logger.warning("Cannot determine the API version from " "the endpoint URL. Falling back to the " "user-specified version: %s", endpoint_api_version) - else: + elif endpoint_api_version: logger.warning("Cannot determine the API version from the " "endpoint URL or user input. Falling back " "to the default API version: %s", endpoint_api_version) + else: + msg = _("Cannot determine API version. Please specify by " + "using --os-volume-api-version option.") + raise exc.UnsupportedVersion(msg) API_MAX_VERSION = api_versions.APIVersion(api_versions.MAX_VERSION) + # FIXME: the endpoint_api_version[0] can ONLY be '3' now, so the + # above line should probably be ripped out and this condition removed if endpoint_api_version[0] == '3': disc_client = client.Client(API_MAX_VERSION, os_username, @@ -807,14 +816,9 @@ class OpenStackCinderShell(object): os_auth_url, client_args): - if (os_api_version.get_major_version() in - api_versions.DEPRECATED_VERSIONS): - discovered_version = api_versions.DEPRECATED_VERSION - os_service_type = 'volume' - else: - discovered_version = api_versions.discover_version( - current_client, - os_api_version) + discovered_version = api_versions.discover_version( + current_client, + os_api_version) if not os_endpoint_type: os_endpoint_type = DEFAULT_CINDER_ENDPOINT_TYPE @@ -841,6 +845,11 @@ class OpenStackCinderShell(object): return current_client, discovered_version def _discover_service_type(self, discovered_version): + # FIXME: this function is either no longer needed or could use a + # refactoring. The official service type is 'block-storage', + # which isn't even present here. (Devstack creates 2 service + # types which it maps to v3: 'block-storage' and 'volumev3'. + # The default 'catalog_type' in tempest is 'volumev3'.) SERVICE_TYPES = {'1': 'volume', '2': 'volumev2', '3': 'volumev3'} major_version = discovered_version.get_major_version() service_type = SERVICE_TYPES[major_version] diff --git a/cinderclient/tests/unit/fixture_data/client.py b/cinderclient/tests/unit/fixture_data/client.py index 4a30f70..2beeb90 100644 --- a/cinderclient/tests/unit/fixture_data/client.py +++ b/cinderclient/tests/unit/fixture_data/client.py @@ -14,6 +14,7 @@ from keystoneauth1 import fixture from cinderclient.tests.unit.fixture_data import base from cinderclient.v2 import client as v2client +from cinderclient.v3 import client as v3client class Base(base.Fixture): @@ -46,3 +47,18 @@ class V2(Base): api_key='xx', project_id='xx', auth_url=self.identity_url) + + +class V3(Base): + + def __init__(self, *args, **kwargs): + super(V3, self).__init__(*args, **kwargs) + + svc = self.token.add_service('volumev3') + svc.add_endpoint(self.volume_url) + + def new_client(self): + return v3client.Client(username='xx', + api_key='xx', + project_id='xx', + auth_url=self.identity_url) diff --git a/cinderclient/tests/unit/fixture_data/keystone_client.py b/cinderclient/tests/unit/fixture_data/keystone_client.py index 061235b..81767c5 100644 --- a/cinderclient/tests/unit/fixture_data/keystone_client.py +++ b/cinderclient/tests/unit/fixture_data/keystone_client.py @@ -153,7 +153,7 @@ def generate_v2_project_scoped_token(**kwargs): ], 'endpoints_links': [], 'name': None, - 'type': 'volumev2' + 'type': 'volumev3' } # Add multiple Cinder endpoints @@ -163,7 +163,7 @@ def generate_v2_project_scoped_token(**kwargs): name = "cinder%i" % count # Assign the service name and a unique endpoint endpoint_copy['endpoints'][0]['publicURL'] = \ - 'http://%s.api.com/v2' % name + 'http://%s.api.com/v3' % name endpoint_copy['name'] = name o['access']['serviceCatalog'].append(endpoint_copy) diff --git a/cinderclient/tests/unit/test_api_versions.py b/cinderclient/tests/unit/test_api_versions.py index d8aad76..f56336c 100644 --- a/cinderclient/tests/unit/test_api_versions.py +++ b/cinderclient/tests/unit/test_api_versions.py @@ -18,7 +18,6 @@ from unittest import mock import ddt from cinderclient import api_versions -from cinderclient import client as base_client from cinderclient import exceptions from cinderclient.tests.unit import test_utils from cinderclient.tests.unit import utils @@ -212,6 +211,14 @@ class DiscoverVersionTestCase(utils.TestCase): self.fake_client.services.server_api_version.return_value = val @ddt.data( + # what the data mean: + # items 1, 2: client min, max + # items 3, 4: server min, max + # item 5: user's requested API version + # item 6: should this raise an exception? + # item 7: version that should be returned when no exception + # item 8: what client.services.server_api_version should return + # when called by _get_server_version_range in discover_version ("3.1", "3.3", "3.4", "3.7", "3.3", True), # Server too new ("3.9", "3.10", "3.0", "3.3", "3.10", True), # Server too old ("3.3", "3.9", "3.7", "3.17", "3.9", False), # Requested < server @@ -222,9 +229,8 @@ class DiscoverVersionTestCase(utils.TestCase): # downgraded because of both: ("3.5", "3.7", "3.0", "3.8", "3.9", False, "3.7"), ("3.5", "3.5", "3.0", "3.5", "3.5", False), # Server & client same - ("3.5", "3.5", "3.0", "3.5", "3.5", False, "2.0", []), # Pre-micro + ("3.5", "3.5", None, None, "3.5", True, None, []), # Pre-micro ("3.1", "3.11", "3.4", "3.7", "3.7", False), # Requested in range - ("3.1", "3.11", None, None, "3.7", False), # Server w/o support ("3.5", "3.5", "3.0", "3.5", "1.0", True) # Requested too old ) @ddt.unpack @@ -240,21 +246,23 @@ class DiscoverVersionTestCase(utils.TestCase): api_versions.MIN_VERSION = client_min if exp_range: - self.assertRaisesRegex(exceptions.UnsupportedVersion, - ".*range is '%s' to '%s'.*" % - (server_min, server_max), - api_versions.discover_version, - self.fake_client, - api_versions.APIVersion(requested_version)) + exc = self.assertRaises(exceptions.UnsupportedVersion, + api_versions.discover_version, + self.fake_client, + api_versions.APIVersion(requested_version)) + if ret_val is not None: + self.assertIn("Server does not support microversions", + str(exc)) + else: + self.assertIn("range is '%s' to '%s'" % + (server_min, server_max), str(exc)) else: discovered_version = api_versions.discover_version( self.fake_client, api_versions.APIVersion(requested_version)) version = requested_version - if server_min is None and server_max is None: - version = api_versions.DEPRECATED_VERSION - elif end_version is not None: + if end_version is not None: version = end_version self.assertEqual(version, discovered_version.get_string()) @@ -266,10 +274,3 @@ class DiscoverVersionTestCase(utils.TestCase): highest_version = api_versions.get_highest_version(self.fake_client) self.assertEqual("3.14", highest_version.get_string()) self.assertTrue(self.fake_client.services.server_api_version.called) - - def test_get_highest_version_bad_client(self): - """Tests that we gracefully handle the wrong version of client.""" - v2_client = base_client.Client('2.0') - ex = self.assertRaises(exceptions.UnsupportedVersion, - api_versions.get_highest_version, v2_client) - self.assertIn('Invalid client version 2.0 to get', str(ex)) diff --git a/cinderclient/tests/unit/test_client.py b/cinderclient/tests/unit/test_client.py index fa19492..1501d6f 100644 --- a/cinderclient/tests/unit/test_client.py +++ b/cinderclient/tests/unit/test_client.py @@ -33,8 +33,9 @@ import cinderclient.v2.client class ClientTest(utils.TestCase): def test_get_client_class_v2(self): - output = cinderclient.client.get_client_class('2') - self.assertEqual(cinderclient.v2.client.Client, output) + self.assertRaises(cinderclient.exceptions.UnsupportedVersion, + cinderclient.client.get_client_class, + '2') def test_get_client_class_unknown(self): self.assertRaises(cinderclient.exceptions.UnsupportedVersion, @@ -81,10 +82,14 @@ class ClientTest(utils.TestCase): def test_versions(self): v2_url = 'http://fakeurl/v2/tenants' + v3_url = 'http://fakeurl/v3/tenants' unknown_url = 'http://fakeurl/v9/tenants' - self.assertEqual('2', - cinderclient.client.get_volume_api_from_url(v2_url)) + self.assertRaises(cinderclient.exceptions.UnsupportedVersion, + cinderclient.client.get_volume_api_from_url, + v2_url) + self.assertEqual('3', + cinderclient.client.get_volume_api_from_url(v3_url)) self.assertRaises(cinderclient.exceptions.UnsupportedVersion, cinderclient.client.get_volume_api_from_url, unknown_url) @@ -318,6 +323,7 @@ class GetAPIVersionTestCase(utils.TestCase): @mock.patch('cinderclient.client.requests.get') def test_get_server_version_v2(self, mock_request): + # Why are we testing this? Because we can! mock_response = utils.TestResponse({ "status_code": 200, @@ -329,6 +335,7 @@ class GetAPIVersionTestCase(utils.TestCase): url = "http://192.168.122.127:8776/v2/e5526285ebd741b1819393f772f11fc3" min_version, max_version = cinderclient.client.get_server_version(url) + self.assertEqual(api_versions.APIVersion('2.0'), min_version) self.assertEqual(api_versions.APIVersion('2.0'), max_version) @@ -427,3 +434,21 @@ class GetAPIVersionTestCase(utils.TestCase): cinderclient.client.get_highest_client_server_version(url)) expected = version if version == '3.12' else '3.16' self.assertEqual(expected, highest) + + @mock.patch('cinderclient.client.requests.get') + def test_get_highest_client_server_version_negative(self, + mock_request): + + mock_response = utils.TestResponse({ + "status_code": 200, + "text": json.dumps(fakes.fake_request_get_no_v3()) + }) + + mock_request.return_value = mock_response + + url = "http://192.168.122.127:8776/v3/e5526285ebd741b1819393f772f11fc3" + + self.assertRaises(exceptions.UnsupportedVersion, + cinderclient.client. + get_highest_client_server_version, + url) diff --git a/cinderclient/tests/unit/test_shell.py b/cinderclient/tests/unit/test_shell.py index 8c5df11..682d509 100644 --- a/cinderclient/tests/unit/test_shell.py +++ b/cinderclient/tests/unit/test_shell.py @@ -13,9 +13,9 @@ import argparse import io +import json import re import sys -import unittest from unittest import mock import ddt @@ -35,6 +35,7 @@ from cinderclient import shell from cinderclient.tests.unit import fake_actions_module from cinderclient.tests.unit.fixture_data import keystone_client from cinderclient.tests.unit import utils +from cinderclient.tests.unit.v3 import fakes @ddt.ddt @@ -205,8 +206,13 @@ class ShellTest(utils.TestCase): os_auth_url = "http://multiple.service.names/v2.0" mocker.register_uri('POST', os_auth_url + "/tokens", text=keystone_client.keystone_request_callback) + # microversion support requires us to make a versions request + # to the endpoint to see exactly what is supported by the server mocker.register_uri('GET', - "http://cinder%i.api.com/v2/volumes/detail" + "http://cinder%i.api.com/" + % count, text=json.dumps(fakes.fake_request_get())) + mocker.register_uri('GET', + "http://cinder%i.api.com/v3/volumes/detail" % count, text='{"volumes": []}') self.make_env(include={'OS_AUTH_URL': os_auth_url, 'CINDER_SERVICE_NAME': 'cinder%i' % count}) @@ -219,7 +225,6 @@ class ShellTest(utils.TestCase): _shell.main, ['list', '--name', 'abc', '--filters', 'name=xyz']) - @unittest.skip("Skip cuz I broke it") def test_cinder_service_name(self): # Failing with 'No mock address' means we are not # choosing the correct endpoint @@ -248,14 +253,19 @@ class ShellTest(utils.TestCase): tenant_name=self.FAKE_ENV['OS_PROJECT_NAME'], username=self.FAKE_ENV['OS_USERNAME']) + @mock.patch('cinderclient.api_versions.discover_version', + return_value=api_versions.APIVersion("3.0")) @requests_mock.Mocker() - def test_noauth_plugin(self, mocker): - os_auth_url = "http://example.com/v2" + def test_noauth_plugin(self, mock_disco, mocker): + # just to prove i'm not crazy about the mock parameter ordering + self.assertTrue(requests_mock.mocker.Mocker, type(mocker)) + + os_volume_url = "http://example.com/volumes/v3" mocker.register_uri('GET', "%s/volumes/detail" - % os_auth_url, text='{"volumes": []}') + % os_volume_url, text='{"volumes": []}') _shell = shell.OpenStackCinderShell() - args = ['--os-endpoint', os_auth_url, + args = ['--os-endpoint', os_volume_url, '--os-auth-type', 'noauth', '--os-user-id', 'admin', '--os-project-id', 'admin', 'list'] _shell.main(args) diff --git a/cinderclient/tests/unit/v2/test_availability_zone.py b/cinderclient/tests/unit/v2/test_availability_zone.py deleted file mode 100644 index e9b5d02..0000000 --- a/cinderclient/tests/unit/v2/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. - -from cinderclient.v2 import availability_zones -from cinderclient.v2 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.V2 - 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') - self._assert_request_id(zones) - - for zone in zones: - self.assertIsInstance(zone, - availability_zones.AvailabilityZone) - - self.assertEqual(2, len(zones)) - - l0 = ['zone-1', 'available'] - l1 = ['zone-2', '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') - self._assert_request_id(zones) - - for zone in zones: - self.assertIsInstance(zone, - availability_zones.AvailabilityZone) - - self.assertEqual(3, len(zones)) - - l0 = ['zone-1', 'available'] - l1 = ['|- fake_host-1', ''] - l2 = ['| |- cinder-volume', - 'enabled :-) 2012-12-26 14:45:25'] - l3 = ['internal', 'available'] - l4 = ['|- fake_host-1', ''] - l5 = ['| |- cinder-sched', - 'enabled :-) 2012-12-26 14:45:24'] - l6 = ['zone-2', '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/v2/test_shell.py b/cinderclient/tests/unit/v2/test_shell.py deleted file mode 100644 index 78ecf74..0000000 --- a/cinderclient/tests/unit/v2/test_shell.py +++ /dev/null @@ -1,1358 +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 unittest import mock -from urllib import parse - -import ddt -import fixtures -from requests_mock.contrib import fixture as requests_mock_fixture - -from cinderclient import client -from cinderclient import exceptions -from cinderclient import shell -from cinderclient.tests.unit.fixture_data import keystone_client -from cinderclient.tests.unit import utils -from cinderclient.tests.unit.v2 import fakes -from cinderclient.v2 import shell as test_shell -from cinderclient.v2 import volume_backups -from cinderclient.v2 import volumes - - -@ddt.ddt -@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': '2', - '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() - - self.requests = self.useFixture(requests_mock_fixture.Fixture()) - self.requests.register_uri( - 'GET', keystone_client.BASE_URL, - text=keystone_client.keystone_request_callback) - - self.cs = mock.Mock() - - def _make_args(self, args): - class Args(object): - def __init__(self, entries): - self.__dict__.update(entries) - - return Args(args) - - def run_command(self, cmd): - self.shell.main(cmd.split()) - - def assert_called(self, method, url, body=None, - partial_body=None, **kwargs): - return self.shell.cs.assert_called(method, url, body, - partial_body, **kwargs) - - def test_list(self): - self.run_command('list') - # NOTE(jdg): we default to detail currently - self.assert_called('GET', '/volumes/detail') - - def test_list_filter_tenant_with_all_tenants(self): - self.run_command('list --all-tenants=1 --tenant 123') - 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') - self.assert_called('GET', '/volumes/1234') - expected = {'volume': {'imageRef': None, - 'size': 1, - 'availability_zone': None, - 'source_volid': None, - 'consistencygroup_id': None, - 'name': None, - 'snapshot_id': None, - 'metadata': {'key1': '"--test1"'}, - 'volume_type': None, - 'description': None, - }} - self.assert_called_anytime('POST', '/volumes', expected) - - def test_metadata_args_limiter_display_name(self): - self.run_command('create --metadata key1="--t1" --name="t" 1') - self.assert_called('GET', '/volumes/1234') - expected = {'volume': {'imageRef': None, - 'size': 1, - 'availability_zone': None, - 'source_volid': None, - 'consistencygroup_id': None, - 'name': '"t"', - 'snapshot_id': None, - 'metadata': {'key1': '"--t1"'}, - 'volume_type': None, - 'description': None, - }} - 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': {'imageRef': None, - 'size': 1, - 'availability_zone': None, - 'source_volid': None, - 'consistencygroup_id': None, - 'name': None, - 'snapshot_id': None, - 'metadata': {'key1': '"test1"', - 'key2': '"test2"'}, - 'volume_type': None, - 'description': None, - }} - self.assert_called_anytime('POST', '/volumes', expected) - - def test_delimit_metadata_args_display_name(self): - self.run_command('create --metadata key1="t1" --name="t" 1') - self.assert_called('GET', '/volumes/1234') - expected = {'volume': {'imageRef': None, - 'size': 1, - 'availability_zone': None, - 'source_volid': None, - 'consistencygroup_id': None, - 'name': '"t"', - 'snapshot_id': None, - 'metadata': {'key1': '"t1"'}, - 'volume_type': None, - 'description': None, - }} - 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?status=available') - - def test_list_filter_bootable_true(self): - self.run_command('list --bootable=true') - self.assert_called('GET', '/volumes/detail?bootable=true') - - def test_list_filter_bootable_false(self): - self.run_command('list --bootable=false') - self.assert_called('GET', '/volumes/detail?bootable=false') - - def test_list_filter_name(self): - self.run_command('list --name=1234') - self.assert_called('GET', '/volumes/detail?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_marker(self): - self.run_command('list --marker=1234') - self.assert_called('GET', '/volumes/detail?marker=1234') - - def test_list_limit(self): - self.run_command('list --limit=10') - self.assert_called('GET', '/volumes/detail?limit=10') - - @mock.patch("cinderclient.utils.print_list") - def test_list_field(self, mock_print): - self.run_command('list --field Status,Name,Size,Bootable') - self.assert_called('GET', '/volumes/detail') - key_list = ['ID', 'Status', 'Name', 'Size', 'Bootable'] - mock_print.assert_called_once_with(mock.ANY, key_list, - exclude_unavailable=True, sortby_index=0) - - @mock.patch("cinderclient.utils.print_list") - def test_list_field_with_all_tenants(self, mock_print): - self.run_command('list --field Status,Name,Size,Bootable ' - '--all-tenants 1') - self.assert_called('GET', '/volumes/detail?all_tenants=1') - key_list = ['ID', 'Status', 'Name', 'Size', 'Bootable'] - mock_print.assert_called_once_with(mock.ANY, key_list, - exclude_unavailable=True, sortby_index=0) - - @mock.patch("cinderclient.utils.print_list") - def test_list_duplicate_fields(self, mock_print): - self.run_command('list --field Status,id,Size,status') - self.assert_called('GET', '/volumes/detail') - key_list = ['ID', 'Status', 'Size'] - mock_print.assert_called_once_with(mock.ANY, key_list, - exclude_unavailable=True, sortby_index=0) - - @mock.patch("cinderclient.utils.print_list") - def test_list_field_with_tenant(self, mock_print): - self.run_command('list --field Status,Name,Size,Bootable ' - '--tenant 123') - self.assert_called('GET', - '/volumes/detail?all_tenants=1&project_id=123') - key_list = ['ID', 'Status', 'Name', 'Size', 'Bootable'] - mock_print.assert_called_once_with(mock.ANY, key_list, - exclude_unavailable=True, sortby_index=0) - - def test_list_sort_name(self): - # Client 'name' key is mapped to 'display_name' - self.run_command('list --sort=name') - self.assert_called('GET', '/volumes/detail?sort=display_name') - - def test_list_sort_single_key_only(self): - self.run_command('list --sort=id') - self.assert_called('GET', '/volumes/detail?sort=id') - - def test_list_sort_single_key_trailing_colon(self): - self.run_command('list --sort=id:') - self.assert_called('GET', '/volumes/detail?sort=id') - - def test_list_sort_single_key_and_dir(self): - self.run_command('list --sort=id:asc') - url = '/volumes/detail?%s' % parse.urlencode([('sort', 'id:asc')]) - self.assert_called('GET', url) - - def test_list_sort_multiple_keys_only(self): - self.run_command('list --sort=id,status,size') - url = ('/volumes/detail?%s' % - parse.urlencode([('sort', 'id,status,size')])) - self.assert_called('GET', url) - - def test_list_sort_multiple_keys_and_dirs(self): - self.run_command('list --sort=id:asc,status,size:desc') - url = ('/volumes/detail?%s' % - parse.urlencode([('sort', 'id:asc,status,size:desc')])) - self.assert_called('GET', url) - - def test_list_reorder_with_sort(self): - # sortby_index is None if there is sort information - for cmd in ['list --sort=name', - 'list --sort=name:asc']: - with mock.patch('cinderclient.utils.print_list') as mock_print: - self.run_command(cmd) - mock_print.assert_called_once_with( - mock.ANY, mock.ANY, exclude_unavailable=True, - sortby_index=None) - - def test_list_reorder_without_sort(self): - # sortby_index is 0 without sort information - for cmd in ['list', 'list --all-tenants']: - with mock.patch('cinderclient.utils.print_list') as mock_print: - self.run_command(cmd) - mock_print.assert_called_once_with( - mock.ANY, mock.ANY, exclude_unavailable=True, - sortby_index=0) - - def test_list_availability_zone(self): - self.run_command('availability-zone-list') - self.assert_called('GET', '/os-availability-zone') - - def test_create_volume_from_snapshot(self): - expected = {'volume': {'size': None}} - - expected['volume']['snapshot_id'] = '1234' - self.run_command('create --snapshot-id=1234') - self.assert_called_anytime('POST', '/volumes', partial_body=expected) - self.assert_called('GET', '/volumes/1234') - - expected['volume']['size'] = 2 - self.run_command('create --snapshot-id=1234 2') - self.assert_called_anytime('POST', '/volumes', partial_body=expected) - self.assert_called('GET', '/volumes/1234') - - def test_create_volume_from_volume(self): - expected = {'volume': {'size': None}} - - expected['volume']['source_volid'] = '1234' - self.run_command('create --source-volid=1234') - self.assert_called_anytime('POST', '/volumes', partial_body=expected) - self.assert_called('GET', '/volumes/1234') - - expected['volume']['size'] = 2 - self.run_command('create --source-volid=1234 2') - self.assert_called_anytime('POST', '/volumes', partial_body=expected) - self.assert_called('GET', '/volumes/1234') - - def test_create_volume_from_image(self): - expected = {'volume': {'size': 1, - 'imageRef': '1234'}} - self.run_command('create --image=1234 1') - self.assert_called_anytime('POST', '/volumes', partial_body=expected) - self.assert_called('GET', '/volumes/1234') - - def test_upload_to_image(self): - expected = {'os-volume_upload_image': {'force': False, - 'container_format': 'bare', - 'disk_format': 'raw', - 'image_name': 'test-image'}} - self.run_command('upload-to-image 1234 test-image') - self.assert_called_anytime('GET', '/volumes/1234') - self.assert_called_anytime('POST', '/volumes/1234/action', - body=expected) - - def test_upload_to_image_force(self): - expected = {'os-volume_upload_image': {'force': 'True', - 'container_format': 'bare', - 'disk_format': 'raw', - 'image_name': 'test-image'}} - self.run_command('upload-to-image --force=True 1234 test-image') - self.assert_called_anytime('GET', '/volumes/1234') - self.assert_called_anytime('POST', '/volumes/1234/action', - body=expected) - - def test_create_size_required_if_not_snapshot_or_clone(self): - self.assertRaises(SystemExit, self.run_command, 'create') - - def test_create_size_zero_if_not_snapshot_or_clone(self): - expected = {'volume': {'size': 0}} - self.run_command('create 0') - self.assert_called_anytime('POST', '/volumes', partial_body=expected) - self.assert_called('GET', '/volumes/1234') - - 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&' - '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_delete_with_cascade_true(self): - self.run_command('delete 1234 --cascade') - self.assert_called('DELETE', '/volumes/1234?cascade=True') - self.run_command('delete --cascade 1234') - self.assert_called('DELETE', '/volumes/1234?cascade=True') - - def test_delete_with_cascade_with_invalid_value(self): - self.assertRaises(SystemExit, self.run_command, - 'delete 1234 --cascade 1234') - - def test_backup(self): - self.run_command('backup-create 1234') - self.assert_called('POST', '/backups') - - def test_backup_incremental(self): - self.run_command('backup-create 1234 --incremental') - self.assert_called('POST', '/backups') - - def test_backup_force(self): - self.run_command('backup-create 1234 --force') - self.assert_called('POST', '/backups') - - def test_backup_snapshot(self): - self.run_command('backup-create 1234 --snapshot-id 4321') - self.assert_called('POST', '/backups') - - def test_multiple_backup_delete(self): - self.run_command('backup-delete 1234 5678') - self.assert_called_anytime('DELETE', '/backups/1234') - self.assert_called('DELETE', '/backups/5678') - - def test_restore(self): - self.run_command('backup-restore 1234') - self.assert_called('POST', '/backups/1234/restore') - - def test_restore_with_name(self): - self.run_command('backup-restore 1234 --name restore_vol') - expected = {'restore': {'volume_id': None, 'name': 'restore_vol'}} - self.assert_called('POST', '/backups/1234/restore', - body=expected) - - def test_restore_with_name_error(self): - self.assertRaises(exceptions.CommandError, self.run_command, - 'backup-restore 1234 --volume fake_vol --name ' - 'restore_vol') - - @ddt.data('backup_name', '1234') - @mock.patch('cinderclient.shell_utils.find_backup') - @mock.patch('cinderclient.utils.print_dict') - @mock.patch('cinderclient.utils.find_volume') - def test_do_backup_restore_with_name(self, - value, - mock_find_volume, - mock_print_dict, - mock_find_backup): - backup_id = '1234' - volume_id = '5678' - name = None - input = { - 'backup': value, - 'volume': volume_id, - 'name': None - } - - args = self._make_args(input) - with mock.patch.object(self.cs.restores, - 'restore') as mocked_restore: - mock_find_volume.return_value = volumes.Volume(self, - {'id': volume_id}, - loaded=True) - mock_find_backup.return_value = volume_backups.VolumeBackup( - self, - {'id': backup_id}, - loaded=True) - test_shell.do_backup_restore(self.cs, args) - mock_find_backup.assert_called_once_with( - self.cs, - value) - mocked_restore.assert_called_once_with( - backup_id, - volume_id, - name) - self.assertTrue(mock_print_dict.called) - - def test_record_export(self): - self.run_command('backup-export 1234') - self.assert_called('GET', '/backups/1234/export_record') - - def test_record_import(self): - self.run_command('backup-import fake.driver URL_STRING') - expected = {'backup-record': {'backup_service': 'fake.driver', - 'backup_url': 'URL_STRING'}} - self.assert_called('POST', '/backups/import_record', expected) - - def test_snapshot_list_filter_volume_id(self): - self.run_command('snapshot-list --volume-id=1234') - self.assert_called('GET', '/snapshots/detail?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?' - 'status=available&volume_id=1234') - - def test_snapshot_list_filter_name(self): - self.run_command('snapshot-list --name abc') - self.assert_called('GET', '/snapshots/detail?name=abc') - - @mock.patch("cinderclient.utils.print_list") - def test_snapshot_list_sort(self, mock_print_list): - self.run_command('snapshot-list --sort id') - self.assert_called('GET', '/snapshots/detail?sort=id') - columns = ['ID', 'Volume ID', 'Status', 'Name', 'Size'] - mock_print_list.assert_called_once_with(mock.ANY, columns, - sortby_index=None) - - def test_snapshot_list_filter_tenant_with_all_tenants(self): - self.run_command('snapshot-list --all-tenants=1 --tenant 123') - self.assert_called('GET', - '/snapshots/detail?all_tenants=1&project_id=123') - - def test_snapshot_list_filter_tenant_without_all_tenants(self): - self.run_command('snapshot-list --tenant 123') - self.assert_called('GET', - '/snapshots/detail?all_tenants=1&project_id=123') - - def test_rename(self): - # basic rename with positional arguments - self.run_command('rename 1234 new-name') - expected = {'volume': {'name': 'new-name'}} - self.assert_called('PUT', '/volumes/1234', body=expected) - # change description only - self.run_command('rename 1234 --description=new-description') - expected = {'volume': {'description': 'new-description'}} - self.assert_called('PUT', '/volumes/1234', body=expected) - # rename and change description - self.run_command('rename 1234 new-name ' - '--description=new-description') - expected = {'volume': { - 'name': 'new-name', - '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_invalid_args(self): - """Ensure that error generated does not reference an HTTP code.""" - - self.assertRaisesRegex(exceptions.ClientException, - '(?!HTTP)', - self.run_command, - 'rename volume-1234-abcd') - - def test_rename_snapshot(self): - # basic rename with positional arguments - self.run_command('snapshot-rename 1234 new-name') - expected = {'snapshot': {'name': 'new-name'}} - self.assert_called('PUT', '/snapshots/1234', body=expected) - # change description only - self.run_command('snapshot-rename 1234 ' - '--description=new-description') - expected = {'snapshot': {'description': 'new-description'}} - self.assert_called('PUT', '/snapshots/1234', body=expected) - # snapshot-rename and change description - self.run_command('snapshot-rename 1234 new-name ' - '--description=new-description') - expected = {'snapshot': { - 'name': 'new-name', - '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_rename_snapshot_invalid_args(self): - self.assertRaises(exceptions.ClientException, - self.run_command, - 'snapshot-rename snapshot-1234') - - 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_with_attach_status(self): - self.run_command('reset-state --attach-status detached 1234') - expected = {'os-reset_status': {'attach_status': 'detached'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_reset_state_with_attach_status_with_flag(self): - self.run_command('reset-state --state in-use ' - '--attach-status attached 1234') - expected = {'os-reset_status': {'status': 'in-use', - 'attach_status': 'attached'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_reset_state_with_reset_migration_status(self): - self.run_command('reset-state --reset-migration-status 1234') - expected = {'os-reset_status': {'migration_status': 'none'}} - 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_backup_reset_state(self): - self.run_command('backup-reset-state 1234') - expected = {'os-reset_status': {'status': 'available'}} - self.assert_called('POST', '/backups/1234/action', body=expected) - - def test_backup_reset_state_with_flag(self): - self.run_command('backup-reset-state --state error 1234') - expected = {'os-reset_status': {'status': 'error'}} - self.assert_called('POST', '/backups/1234/action', body=expected) - - def test_backup_reset_state_multiple(self): - self.run_command('backup-reset-state 1234 5678') - expected = {'os-reset_status': {'status': 'available'}} - self.assert_called_anytime('POST', '/backups/1234/action', - body=expected) - self.assert_called_anytime('POST', '/backups/5678/action', - body=expected) - - def test_type_list(self): - self.run_command('type-list') - self.assert_called_anytime('GET', '/types?is_public=None') - - def test_type_show(self): - self.run_command('type-show 1') - self.assert_called('GET', '/types/1') - - def test_type_create(self): - self.run_command('type-create test-type-1') - self.assert_called('POST', '/types') - - def test_type_create_public(self): - expected = {'volume_type': {'name': 'test-type-1', - 'description': 'test_type-1-desc', - 'os-volume-type-access:is_public': True}} - self.run_command('type-create test-type-1 ' - '--description=test_type-1-desc ' - '--is-public=True') - self.assert_called('POST', '/types', body=expected) - - def test_type_create_private(self): - expected = {'volume_type': {'name': 'test-type-3', - 'description': 'test_type-3-desc', - 'os-volume-type-access:is_public': False}} - self.run_command('type-create test-type-3 ' - '--description=test_type-3-desc ' - '--is-public=False') - self.assert_called('POST', '/types', body=expected) - - def test_type_create_with_invalid_bool(self): - self.assertRaises(ValueError, - self.run_command, - ('type-create test-type-3 ' - '--description=test_type-3-desc ' - '--is-public=invalid_bool')) - - def test_type_update(self): - expected = {'volume_type': {'name': 'test-type-1', - 'description': 'test_type-1-desc', - 'is_public': False}} - self.run_command('type-update --name test-type-1 ' - '--description=test_type-1-desc ' - '--is-public=False 1') - self.assert_called('PUT', '/types/1', body=expected) - - def test_type_update_with_invalid_bool(self): - self.assertRaises(ValueError, - self.run_command, - 'type-update --name test-type-1 ' - '--description=test_type-1-desc ' - '--is-public=invalid_bool 1') - - def test_type_update_without_args(self): - self.assertRaises(exceptions.CommandError, self.run_command, - 'type-update 1') - - def test_type_access_list(self): - self.run_command('type-access-list --volume-type 3') - self.assert_called('GET', '/types/3/os-volume-type-access') - - def test_type_access_add_project(self): - expected = {'addProjectAccess': {'project': '101'}} - self.run_command('type-access-add --volume-type 3 --project-id 101') - self.assert_called_anytime('GET', '/types/3') - self.assert_called('POST', '/types/3/action', - body=expected) - - def test_type_access_add_project_by_name(self): - expected = {'addProjectAccess': {'project': '101'}} - with mock.patch('cinderclient.utils.find_resource') as mock_find: - mock_find.return_value = '3' - self.run_command('type-access-add --volume-type type_name \ - --project-id 101') - mock_find.assert_called_once_with(mock.ANY, 'type_name') - self.assert_called('POST', '/types/3/action', - body=expected) - - def test_type_access_remove_project(self): - expected = {'removeProjectAccess': {'project': '101'}} - self.run_command('type-access-remove ' - '--volume-type 3 --project-id 101') - self.assert_called_anytime('GET', '/types/3') - self.assert_called('POST', '/types/3/action', - body=expected) - - def test_type_delete(self): - self.run_command('type-delete 1') - self.assert_called('DELETE', '/types/1') - - def test_type_delete_multiple(self): - self.run_command('type-delete 1 3') - self.assert_called_anytime('DELETE', '/types/1') - self.assert_called('DELETE', '/types/3') - - def test_type_delete_by_name(self): - self.run_command('type-delete test-type-1') - self.assert_called_anytime('GET', '/types?is_public=None') - self.assert_called('DELETE', '/types/1') - - 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?is_public=None') - 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') - - @ddt.data('--key-size 512 --control-location front-end', - '--key_size 512 --control_location front-end') # old style - def test_encryption_type_create_with_args(self, arg): - expected = {'encryption': {'cipher': None, - 'key_size': 512, - 'provider': 'TestProvider', - 'control_location': 'front-end'}} - self.run_command('encryption-type-create 2 TestProvider ' + arg) - 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 - Verify that the PUT request correctly parses encryption-type-update - parameters from sys.argv - """ - parameters = {'--provider': 'EncryptionProvider', '--cipher': 'des', - '--key-size': 1024, '--control-location': 'back-end'} - - # Construct the argument string for the update call and the - # expected encryption-type body that should be produced by it - args = ' '.join(['%s %s' % (k, v) for k, v in parameters.items()]) - expected = {'encryption': {'provider': 'EncryptionProvider', - 'cipher': 'des', - 'key_size': 1024, - 'control_location': 'back-end'}} - - self.run_command('encryption-type-update 1 %s' % args) - self.assert_called('GET', '/types/1/encryption') - self.assert_called_anytime('GET', '/types/1') - self.assert_called_anytime('PUT', '/types/1/encryption/provider', - body=expected) - - def test_encryption_type_update_no_attributes(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 - """ - expected = {'encryption': {}} - self.run_command('encryption-type-update 1') - self.assert_called('GET', '/types/1/encryption') - self.assert_called_anytime('GET', '/types/1') - self.assert_called_anytime('PUT', '/types/1/encryption/provider', - body=expected) - - def test_encryption_type_update_default_attributes(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 - Verify that the encryption-type body produced contains default None - values for all specified parameters. - """ - parameters = ['--cipher', '--key-size'] - - # Construct the argument string for the update call and the - # expected encryption-type body that should be produced by it - args = ' '.join(['%s' % (p) for p in parameters]) - expected_pairs = [(k.strip('-').replace('-', '_'), None) for k in - parameters] - expected = {'encryption': dict(expected_pairs)} - - self.run_command('encryption-type-update 1 %s' % args) - self.assert_called('GET', '/types/1/encryption') - self.assert_called_anytime('GET', '/types/1') - self.assert_called_anytime('PUT', '/types/1/encryption/provider', - body=expected) - - 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 ' - '--lock-volume=True') - expected = {'os-migrate_volume': {'force_host_copy': 'True', - 'lock_volume': 'True', - 'host': 'fakehost'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_migrate_volume_bool_force(self): - self.run_command('migrate 1234 fakehost --force-host-copy ' - '--lock-volume') - expected = {'os-migrate_volume': {'force_host_copy': True, - 'lock_volume': True, - 'host': 'fakehost'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_migrate_volume_bool_force_false(self): - # Set both --force-host-copy and --lock-volume to False. - self.run_command('migrate 1234 fakehost --force-host-copy=False ' - '--lock-volume=False') - expected = {'os-migrate_volume': {'force_host_copy': 'False', - 'lock_volume': 'False', - 'host': 'fakehost'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - # Do not set the values to --force-host-copy and --lock-volume. - self.run_command('migrate 1234 fakehost') - expected = {'os-migrate_volume': {'force_host_copy': False, - 'lock_volume': False, - '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_retype_with_policy(self): - self.run_command('retype 1234 foo --migration-policy=on-demand') - expected = {'os-retype': {'new_type': 'foo', - 'migration_policy': 'on-demand'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_retype_default_policy(self): - self.run_command('retype 1234 foo') - expected = {'os-retype': {'new_type': 'foo', - 'migration_policy': 'never'}} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_snapshot_delete(self): - """Tests delete snapshot without force parameter""" - self.run_command('snapshot-delete 1234') - self.assert_called('DELETE', '/snapshots/1234') - - def test_snapshot_delete_multiple(self): - """Tests delete multiple snapshots without force parameter""" - self.run_command('snapshot-delete 5678 1234') - self.assert_called_anytime('DELETE', '/snapshots/5678') - self.assert_called('DELETE', '/snapshots/1234') - - def test_force_snapshot_delete(self): - """Tests delete snapshot with default force parameter value(True)""" - self.run_command('snapshot-delete 1234 --force') - expected_body = {'os-force_delete': None} - self.assert_called('POST', - '/snapshots/1234/action', - expected_body) - - def test_force_snapshot_delete_multiple(self): - """ - Tests delete multiple snapshots with force parameter - - Snapshot delete with force parameter allows deleting snapshot of a - volume when its status is other than "available" or "error". - """ - self.run_command('snapshot-delete 5678 1234 --force') - expected_body = {'os-force_delete': None} - self.assert_called_anytime('POST', - '/snapshots/5678/action', - expected_body) - self.assert_called_anytime('POST', - '/snapshots/1234/action', - expected_body) - - def test_quota_delete(self): - self.run_command('quota-delete 1234') - self.assert_called('DELETE', '/os-quota-sets/1234') - - def test_volume_manage(self): - self.run_command('manage host1 some_fake_name ' - '--name foo --description bar ' - '--volume-type baz --availability-zone az ' - '--metadata k1=v1 k2=v2') - expected = {'volume': {'host': 'host1', - 'ref': {'source-name': 'some_fake_name'}, - 'name': 'foo', - 'description': 'bar', - 'volume_type': 'baz', - 'availability_zone': 'az', - 'metadata': {'k1': 'v1', 'k2': 'v2'}, - 'bootable': False}} - self.assert_called_anytime('POST', '/os-volume-manage', body=expected) - - def test_volume_manage_bootable(self): - """ - Tests the --bootable option - - If this flag is specified, then the resulting POST should contain - bootable: True. - """ - self.run_command('manage host1 some_fake_name ' - '--name foo --description bar --bootable ' - '--volume-type baz --availability-zone az ' - '--metadata k1=v1 k2=v2') - expected = {'volume': {'host': 'host1', - 'ref': {'source-name': 'some_fake_name'}, - 'name': 'foo', - 'description': 'bar', - 'volume_type': 'baz', - 'availability_zone': 'az', - 'metadata': {'k1': 'v1', 'k2': 'v2'}, - 'bootable': True}} - self.assert_called_anytime('POST', '/os-volume-manage', body=expected) - - def test_volume_manage_source_name(self): - """ - Tests the --source-name option. - - Checks that the --source-name option correctly updates the - ref structure that is passed in the HTTP POST - """ - self.run_command('manage host1 VolName ' - '--name foo --description bar ' - '--volume-type baz --availability-zone az ' - '--metadata k1=v1 k2=v2') - expected = {'volume': {'host': 'host1', - 'ref': {'source-name': 'VolName'}, - 'name': 'foo', - 'description': 'bar', - 'volume_type': 'baz', - 'availability_zone': 'az', - 'metadata': {'k1': 'v1', 'k2': 'v2'}, - 'bootable': False}} - self.assert_called_anytime('POST', '/os-volume-manage', body=expected) - - def test_volume_manage_source_id(self): - """ - Tests the --source-id option. - - Checks that the --source-id option correctly updates the - ref structure that is passed in the HTTP POST - """ - self.run_command('manage host1 1234 ' - '--id-type source-id ' - '--name foo --description bar ' - '--volume-type baz --availability-zone az ' - '--metadata k1=v1 k2=v2') - expected = {'volume': {'host': 'host1', - 'ref': {'source-id': '1234'}, - 'name': 'foo', - 'description': 'bar', - 'volume_type': 'baz', - 'availability_zone': 'az', - 'metadata': {'k1': 'v1', 'k2': 'v2'}, - 'bootable': False}} - self.assert_called_anytime('POST', '/os-volume-manage', body=expected) - - def test_volume_manageable_list(self): - self.run_command('manageable-list fakehost') - self.assert_called('GET', '/os-volume-manage/detail?host=fakehost') - - def test_volume_manageable_list_details(self): - self.run_command('manageable-list fakehost --detailed True') - self.assert_called('GET', '/os-volume-manage/detail?host=fakehost') - - def test_volume_manageable_list_no_details(self): - self.run_command('manageable-list fakehost --detailed False') - self.assert_called('GET', '/os-volume-manage?host=fakehost') - - def test_volume_unmanage(self): - self.run_command('unmanage 1234') - self.assert_called('POST', '/volumes/1234/action', - body={'os-unmanage': None}) - - def test_create_snapshot_from_volume_with_metadata(self): - """ - Tests create snapshot with --metadata parameter. - - Checks metadata params are set during create snapshot - when metadata is passed - """ - expected = {'snapshot': {'volume_id': 1234, - 'metadata': {'k1': 'v1', - 'k2': 'v2'}}} - self.run_command('snapshot-create 1234 --metadata k1=v1 k2=v2 ' - '--force=True') - self.assert_called_anytime('POST', '/snapshots', partial_body=expected) - - def test_create_snapshot_from_volume_with_metadata_bool_force(self): - """ - Tests create snapshot with --metadata parameter. - - Checks metadata params are set during create snapshot - when metadata is passed - """ - expected = {'snapshot': {'volume_id': 1234, - 'metadata': {'k1': 'v1', - 'k2': 'v2'}}} - self.run_command('snapshot-create 1234 --metadata k1=v1 k2=v2 --force') - self.assert_called_anytime('POST', '/snapshots', partial_body=expected) - - def test_get_pools(self): - self.run_command('get-pools') - self.assert_called('GET', '/scheduler-stats/get_pools') - - def test_get_pools_detail(self): - self.run_command('get-pools --detail') - self.assert_called('GET', '/scheduler-stats/get_pools?detail=True') - - 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') - - def test_consistencygroup_update(self): - self.run_command('consisgroup-update ' - '--name cg2 --description desc2 ' - '--add-volumes uuid1,uuid2 ' - '--remove-volumes uuid3,uuid4 ' - '1234') - expected = {'consistencygroup': {'name': 'cg2', - 'description': 'desc2', - 'add_volumes': 'uuid1,uuid2', - 'remove_volumes': 'uuid3,uuid4'}} - self.assert_called('PUT', '/consistencygroups/1234', - body=expected) - - def test_consistencygroup_update_invalid_args(self): - self.assertRaises(exceptions.ClientException, - self.run_command, - 'consisgroup-update 1234') - - def test_consistencygroup_create_from_src_snap(self): - self.run_command('consisgroup-create-from-src ' - '--name cg ' - '--cgsnapshot 1234') - expected = { - 'consistencygroup-from-src': { - 'name': 'cg', - 'cgsnapshot_id': '1234', - 'description': None, - 'user_id': None, - 'project_id': None, - 'status': 'creating', - 'source_cgid': None - } - } - self.assert_called('POST', '/consistencygroups/create_from_src', - expected) - - def test_consistencygroup_create_from_src_cg(self): - self.run_command('consisgroup-create-from-src ' - '--name cg ' - '--source-cg 1234') - expected = { - 'consistencygroup-from-src': { - 'name': 'cg', - 'cgsnapshot_id': None, - 'description': None, - 'user_id': None, - 'project_id': None, - 'status': 'creating', - 'source_cgid': '1234' - } - } - self.assert_called('POST', '/consistencygroups/create_from_src', - expected) - - def test_consistencygroup_create_from_src_fail_no_snap_cg(self): - self.assertRaises(exceptions.ClientException, - self.run_command, - 'consisgroup-create-from-src ' - '--name cg') - - def test_consistencygroup_create_from_src_fail_both_snap_cg(self): - self.assertRaises(exceptions.ClientException, - self.run_command, - 'consisgroup-create-from-src ' - '--name cg ' - '--cgsnapshot 1234 ' - '--source-cg 5678') - - def test_set_image_metadata(self): - self.run_command('image-metadata 1234 set key1=val1') - expected = {"os-set_image_metadata": {"metadata": {"key1": "val1"}}} - self.assert_called('POST', '/volumes/1234/action', - body=expected) - - def test_unset_image_metadata(self): - self.run_command('image-metadata 1234 unset key1') - expected = {"os-unset_image_metadata": {"key": "key1"}} - self.assert_called('POST', '/volumes/1234/action', - body=expected) - - def _get_params_from_stack(self, pos=-1): - method, url = self.shell.cs.client.callstack[pos][0:2] - path, query = parse.splitquery(url) - params = parse.parse_qs(query) - return path, params - - def test_backup_list_all_tenants(self): - self.run_command('backup-list --all-tenants=1 --name=bc ' - '--status=available --volume-id=1234') - expected = { - 'all_tenants': ['1'], - 'name': ['bc'], - 'status': ['available'], - 'volume_id': ['1234'], - } - - path, params = self._get_params_from_stack() - - self.assertEqual('/backups/detail', path) - self.assertEqual(4, len(params)) - - for k in params.keys(): - self.assertEqual(expected[k], params[k]) - - def test_backup_list_volume_id(self): - self.run_command('backup-list --volume-id=1234') - self.assert_called('GET', '/backups/detail?volume_id=1234') - - def test_backup_list(self): - self.run_command('backup-list') - self.assert_called('GET', '/backups/detail') - - @mock.patch("cinderclient.utils.print_list") - def test_backup_list_sort(self, mock_print_list): - self.run_command('backup-list --sort id') - self.assert_called('GET', '/backups/detail?sort=id') - columns = ['ID', 'Volume ID', 'Status', 'Name', 'Size', 'Object Count', - 'Container'] - mock_print_list.assert_called_once_with(mock.ANY, columns, - sortby_index=None) - - def test_backup_list_data_timestamp(self): - self.run_command('backup-list --sort data_timestamp') - self.assert_called('GET', '/backups/detail?sort=data_timestamp') - - def test_get_capabilities(self): - self.run_command('get-capabilities host') - self.assert_called('GET', '/capabilities/host') - - def test_image_metadata_show(self): - # since the request is not actually sent to cinder API but is - # calling the method in :class:`v2.fakes.FakeHTTPClient` instead. - # Thus, ignore any exception which is false negative compare - # with real API call. - try: - self.run_command('image-metadata-show 1234') - except Exception: - pass - expected = {"os-show_image_metadata": None} - self.assert_called('POST', '/volumes/1234/action', body=expected) - - def test_snapshot_manage(self): - self.run_command('snapshot-manage 1234 some_fake_name ' - '--name foo --description bar ' - '--metadata k1=v1 k2=v2') - expected = {'snapshot': {'volume_id': 1234, - 'ref': {'source-name': 'some_fake_name'}, - 'name': 'foo', - 'description': 'bar', - 'metadata': {'k1': 'v1', 'k2': 'v2'} - }} - self.assert_called_anytime('POST', '/os-snapshot-manage', - body=expected) - - def test_snapshot_manageable_list(self): - self.run_command('snapshot-manageable-list fakehost') - self.assert_called('GET', '/os-snapshot-manage/detail?host=fakehost') - - def test_snapshot_manageable_list_details(self): - self.run_command('snapshot-manageable-list fakehost --detailed True') - self.assert_called('GET', '/os-snapshot-manage/detail?host=fakehost') - - def test_snapshot_manageable_list_no_details(self): - self.run_command('snapshot-manageable-list fakehost --detailed False') - self.assert_called('GET', '/os-snapshot-manage?host=fakehost') - - def test_snapshot_unmanage(self): - self.run_command('snapshot-unmanage 1234') - self.assert_called('POST', '/snapshots/1234/action', - body={'os-unmanage': None}) - - def test_extra_specs_list(self): - self.run_command('extra-specs-list') - self.assert_called('GET', '/types?is_public=None') - - def test_quota_class_show(self): - self.run_command('quota-class-show test') - self.assert_called('GET', '/os-quota-class-sets/test') - - def test_quota_class_update(self): - expected = {'quota_class_set': {'volumes': 2, - 'snapshots': 2, - 'gigabytes': 1, - 'backups': 1, - 'backup_gigabytes': 1, - 'per_volume_gigabytes': 1}} - self.run_command('quota-class-update test ' - '--volumes 2 ' - '--snapshots 2 ' - '--gigabytes 1 ' - '--backups 1 ' - '--backup-gigabytes 1 ' - '--per-volume-gigabytes 1') - self.assert_called('PUT', '/os-quota-class-sets/test', body=expected) - - def test_translate_attachments(self): - attachment_id = 'aaaa' - server_id = 'bbbb' - obj_id = 'cccc' - info = { - 'attachments': [{ - 'attachment_id': attachment_id, - 'id': obj_id, - 'server_id': server_id}] - } - - new_info = test_shell._translate_attachments(info) - - self.assertEqual(attachment_id, new_info['attachment_ids'][0]) - self.assertEqual(server_id, new_info['attached_servers'][0]) - self.assertNotIn('id', new_info) diff --git a/cinderclient/tests/unit/v3/test_availability_zone.py b/cinderclient/tests/unit/v3/test_availability_zone.py new file mode 100644 index 0000000..ebacf83 --- /dev/null +++ b/cinderclient/tests/unit/v3/test_availability_zone.py @@ -0,0 +1,89 @@ +# 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. + +from cinderclient.v3 import availability_zones +from cinderclient.v3 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.V3 + 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') + self._assert_request_id(zones) + + for zone in zones: + self.assertIsInstance(zone, + availability_zones.AvailabilityZone) + + self.assertEqual(2, len(zones)) + + l0 = ['zone-1', 'available'] + l1 = ['zone-2', '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') + self._assert_request_id(zones) + + for zone in zones: + self.assertIsInstance(zone, + availability_zones.AvailabilityZone) + + self.assertEqual(3, len(zones)) + + l0 = ['zone-1', 'available'] + l1 = ['|- fake_host-1', ''] + l2 = ['| |- cinder-volume', + 'enabled :-) 2012-12-26 14:45:25'] + l3 = ['internal', 'available'] + l4 = ['|- fake_host-1', ''] + l5 = ['| |- cinder-sched', + 'enabled :-) 2012-12-26 14:45:24'] + l6 = ['zone-2', '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/v2/shell.py b/cinderclient/v2/shell.py deleted file mode 100644 index e3f8682..0000000 --- a/cinderclient/v2/shell.py +++ /dev/null @@ -1,2475 +0,0 @@ -# Copyright (c) 2013-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. - -import argparse -import collections -import copy -import os - -from oslo_utils import strutils - -from cinderclient import base -from cinderclient import exceptions -from cinderclient import shell_utils -from cinderclient import utils -from cinderclient.v2 import availability_zones - - -def _translate_attachments(info): - attachments = [] - attached_servers = [] - for attachment in info['attachments']: - attachments.append(attachment['attachment_id']) - attached_servers.append(attachment['server_id']) - info.pop('attachments', None) - info['attachment_ids'] = attachments - info['attached_servers'] = attached_servers - return 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) -@utils.arg('--name', - metavar='', - default=None, - help='Filters results by a name. Default=None.') -@utils.arg('--display-name', - help=argparse.SUPPRESS) -@utils.arg('--status', - metavar='', - default=None, - help='Filters results by a status. Default=None.') -@utils.arg('--bootable', - metavar='', - const=True, - nargs='?', - choices=['True', 'true', 'False', 'false'], - help='Filters results by bootable status. Default=None.') -@utils.arg('--migration_status', - metavar='', - default=None, - help='Filters results by a migration status. Default=None. ' - 'Admin only.') -@utils.arg('--metadata', - nargs='*', - metavar='', - default=None, - help='Filters results by a image metadata key and value pair. ' - 'Default=None.') -@utils.arg('--marker', - metavar='', - default=None, - help='Begin returning volumes that appear later in the volume ' - 'list than that represented by this volume id. ' - 'Default=None.') -@utils.arg('--limit', - metavar='', - default=None, - help='Maximum number of volumes to return. Default=None.') -@utils.arg('--fields', - default=None, - metavar='', - help='Comma-separated list of fields to display. ' - 'Use the show command to see which fields are available. ' - 'Unavailable/non-existent fields will be ignored. ' - 'Default=None.') -@utils.arg('--sort', - metavar='[:]', - default=None, - help=(('Comma-separated list of sort keys and directions in the ' - 'form of [:]. ' - 'Valid keys: %s. ' - 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) -@utils.arg('--tenant', - type=str, - dest='tenant', - nargs='?', - metavar='', - help='Display information from single tenant (Admin only).') -def do_list(cs, args): - """Lists all volumes.""" - # NOTE(thingee): Backwards-compatibility with v1 args - if args.display_name is not None: - args.name = args.display_name - - 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, - 'name': args.name, - 'status': args.status, - 'bootable': args.bootable, - 'migration_status': args.migration_status, - 'metadata': (shell_utils.extract_metadata(args) if args.metadata - else None), - } - - # If unavailable/non-existent fields are specified, these fields will - # be removed from key_list at the print_list() during key validation. - field_titles = [] - if args.fields: - for field_title in args.fields.split(','): - field_titles.append(field_title) - - volumes = cs.volumes.list(search_opts=search_opts, marker=args.marker, - limit=args.limit, sort=args.sort) - shell_utils.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 field_titles: - # Remove duplicate fields - key_list = ['ID'] - unique_titles = [k for k in collections.OrderedDict.fromkeys( - [x.title().strip() for x in field_titles]) if k != 'Id'] - key_list.extend(unique_titles) - else: - key_list = ['ID', 'Status', 'Name', 'Size', 'Volume Type', - 'Bootable', 'Attached to'] - # If all_tenants is specified, print - # Tenant ID as well. - if search_opts['all_tenants']: - key_list.insert(1, 'Tenant ID') - - if args.sort: - sortby_index = None - else: - sortby_index = 0 - utils.print_list(volumes, key_list, exclude_unavailable=True, - sortby_index=sortby_index) - - -@utils.arg('volume', - metavar='', - help='Name or ID of volume.') -def do_show(cs, args): - """Shows volume details.""" - info = dict() - volume = utils.find_volume(cs, args.volume) - info.update(volume._info) - - if 'readonly' in info['metadata']: - info['readonly'] = info['metadata']['readonly'] - - info.pop('links', None) - info = _translate_attachments(info) - utils.print_dict(info, - formatters=['metadata', 'volume_image_metadata', - 'attachment_ids', 'attached_servers']) - - -class CheckSizeArgForCreate(argparse.Action): - def __call__(self, parser, args, values, option_string=None): - if ((args.snapshot_id or args.source_volid) - is None and values is None): - if not hasattr(args, 'backup_id') or args.backup_id is None: - parser.error('Size is a required parameter if snapshot ' - 'or source volume or backup is not specified.') - setattr(args, self.dest, values) - - -@utils.arg('size', - metavar='', - nargs='?', - type=int, - action=CheckSizeArgForCreate, - help='Size of volume, in GiBs. (Required unless ' - 'snapshot-id/source-volid is specified).') -@utils.arg('--consisgroup-id', - metavar='', - default=None, - help='ID of a consistency group where the new volume belongs to. ' - 'Default=None.') -@utils.arg('--snapshot-id', - metavar='', - default=None, - help='Creates volume from snapshot ID. Default=None.') -@utils.arg('--snapshot_id', - help=argparse.SUPPRESS) -@utils.arg('--source-volid', - metavar='', - default=None, - help='Creates volume from volume ID. Default=None.') -@utils.arg('--source_volid', - help=argparse.SUPPRESS) -@utils.arg('--image-id', - metavar='', - default=None, - help='Creates volume from image ID. Default=None.') -@utils.arg('--image_id', - help=argparse.SUPPRESS) -@utils.arg('--image', - metavar='', - default=None, - help='Creates a volume from image (ID or name). Default=None.') -@utils.arg('--image_ref', - help=argparse.SUPPRESS) -@utils.arg('--name', - metavar='', - default=None, - help='Volume name. Default=None.') -@utils.arg('--display-name', - help=argparse.SUPPRESS) -@utils.arg('--display_name', - help=argparse.SUPPRESS) -@utils.arg('--description', - metavar='', - default=None, - help='Volume description. Default=None.') -@utils.arg('--display-description', - help=argparse.SUPPRESS) -@utils.arg('--display_description', - help=argparse.SUPPRESS) -@utils.arg('--volume-type', - metavar='', - default=None, - help='Volume type. Default=None.') -@utils.arg('--volume_type', - help=argparse.SUPPRESS) -@utils.arg('--availability-zone', - metavar='', - default=None, - help='Availability zone for volume. Default=None.') -@utils.arg('--availability_zone', - help=argparse.SUPPRESS) -@utils.arg('--metadata', - nargs='*', - metavar='', - default=None, - help='Metadata key and value pairs. Default=None.') -@utils.arg('--hint', - metavar='', - dest='scheduler_hints', - action='append', - default=[], - help='Scheduler hint, similar to nova. Repeat option to set ' - 'multiple hints. Values with the same key will be stored ' - 'as a list.') -def do_create(cs, args): - """Creates a volume.""" - # NOTE(thingee): Backwards-compatibility with v1 args - if args.display_name is not None: - args.name = args.display_name - - if args.display_description is not None: - args.description = args.display_description - - volume_metadata = None - if args.metadata is not None: - volume_metadata = shell_utils.extract_metadata(args) - - # NOTE(N.S.): take this piece from novaclient - hints = {} - if args.scheduler_hints: - for hint in args.scheduler_hints: - key, _sep, value = hint.partition('=') - # NOTE(vish): multiple copies of same hint will - # result in a list of values - if key in hints: - if isinstance(hints[key], str): - hints[key] = [hints[key]] - hints[key] += [value] - else: - hints[key] = value - # NOTE(N.S.): end of taken piece - - # Keep backward compatibility with image_id, favoring explicit ID - image_ref = args.image_id or args.image or args.image_ref - - volume = cs.volumes.create(args.size, - args.consisgroup_id, - args.snapshot_id, - args.source_volid, - args.name, - args.description, - args.volume_type, - availability_zone=args.availability_zone, - imageRef=image_ref, - metadata=volume_metadata, - scheduler_hints=hints) - - info = dict() - volume = cs.volumes.get(volume.id) - info.update(volume._info) - - if 'readonly' in info['metadata']: - info['readonly'] = info['metadata']['readonly'] - - info.pop('links', None) - info = _translate_attachments(info) - utils.print_dict(info) - - -@utils.arg('--cascade', - action='store_true', - default=False, - help='Remove any snapshots along with volume. Default=False.') -@utils.arg('volume', - metavar='', nargs='+', - help='Name or ID of volume or volumes to delete.') -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(cascade=args.cascade) - 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='', nargs='+', - help='Name or ID of volume or volumes to delete.') -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='', nargs='+', - help='Name or ID of volume to modify.') -@utils.arg('--state', metavar='', default=None, - help=('The state to assign to the volume. Valid values are ' - '"available", "error", "creating", "deleting", "in-use", ' - '"attaching", "detaching", "error_deleting" and ' - '"maintenance". ' - 'NOTE: This command simply changes the state of the ' - 'Volume in the DataBase with no regard to actual status, ' - 'exercise caution when using. Default=None, that means the ' - 'state is unchanged.')) -@utils.arg('--attach-status', metavar='', default=None, - help=('The attach status to assign to the volume in the DataBase, ' - 'with no regard to the actual status. Valid values are ' - '"attached" and "detached". Default=None, that means the ' - 'status is unchanged.')) -@utils.arg('--reset-migration-status', - action='store_true', - help=('Clears the migration status of the volume in the DataBase ' - 'that indicates the volume is source or destination of ' - 'volume migration, with no regard to the actual status.')) -def do_reset_state(cs, args): - """Explicitly updates the volume state in the Cinder database. - - Note that this does not affect whether the volume is actually attached to - the Nova compute host or instance and can result in an unusable volume. - Being a database change only, this has no impact on the true state of the - volume and may not match the actual state. This can render a volume - unusable in the case of change to the 'available' state. - """ - failure_flag = False - migration_status = 'none' if args.reset_migration_status else None - if not (args.state or args.attach_status or migration_status): - # Nothing specified, default to resetting state - args.state = 'available' - - for volume in args.volume: - try: - utils.find_volume(cs, volume).reset_state(args.state, - args.attach_status, - migration_status) - 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='', - help='Name or ID of volume to rename.') -@utils.arg('name', - nargs='?', - metavar='', - help='New name for volume.') -@utils.arg('--description', metavar='', - help='Volume description. Default=None.', - default=None) -@utils.arg('--display-description', - help=argparse.SUPPRESS) -@utils.arg('--display_description', - help=argparse.SUPPRESS) -def do_rename(cs, args): - """Renames a volume.""" - kwargs = {} - - if args.name is not None: - kwargs['name'] = args.name - if args.display_description is not None: - kwargs['description'] = args.display_description - elif args.description is not None: - kwargs['description'] = args.description - - if not any(kwargs): - msg = 'Must supply either name or description.' - raise exceptions.ClientException(code=1, message=msg) - - utils.find_volume(cs, args.volume).update(**kwargs) - - -@utils.arg('volume', - metavar='', - help='Name or ID of volume for which to update metadata.') -@utils.arg('action', - metavar='', - choices=['set', 'unset'], - help='The action. Valid values are "set" or "unset."') -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='Metadata key and value pair to set or unset. ' - 'For unset, specify only the key.') -def do_metadata(cs, args): - """Sets or deletes volume metadata.""" - volume = utils.find_volume(cs, args.volume) - metadata = shell_utils.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('volume', - metavar='', - help='Name or ID of volume for which to update metadata.') -@utils.arg('action', - metavar='', - choices=['set', 'unset'], - help="The action. Valid values are 'set' or 'unset.'") -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='Metadata key and value pair to set or unset. ' - 'For unset, specify only the key.') -def do_image_metadata(cs, args): - """Sets or deletes volume image metadata.""" - volume = utils.find_volume(cs, args.volume) - metadata = shell_utils.extract_metadata(args) - - if args.action == 'set': - cs.volumes.set_image_metadata(volume, metadata) - elif args.action == 'unset': - cs.volumes.delete_image_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('--name', - metavar='', - default=None, - help='Filters results by a name. Default=None.') -@utils.arg('--display-name', - help=argparse.SUPPRESS) -@utils.arg('--display_name', - help=argparse.SUPPRESS) -@utils.arg('--status', - metavar='', - default=None, - help='Filters results by a status. Default=None.') -@utils.arg('--volume-id', - metavar='', - default=None, - help='Filters results by a volume ID. Default=None.') -@utils.arg('--volume_id', - help=argparse.SUPPRESS) -@utils.arg('--marker', - metavar='', - default=None, - help='Begin returning snapshots that appear later in the snapshot ' - 'list than that represented by this id. ' - 'Default=None.') -@utils.arg('--limit', - metavar='', - default=None, - help='Maximum number of snapshots to return. Default=None.') -@utils.arg('--sort', - metavar='[:]', - default=None, - help=(('Comma-separated list of sort keys and directions in the ' - 'form of [:]. ' - 'Valid keys: %s. ' - 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) -@utils.arg('--tenant', - type=str, - dest='tenant', - nargs='?', - metavar='', - help='Display information from single tenant (Admin only).') -def do_snapshot_list(cs, args): - """Lists all snapshots.""" - all_tenants = (1 if args.tenant else - int(os.environ.get("ALL_TENANTS", args.all_tenants))) - - if args.display_name is not None: - args.name = args.display_name - - search_opts = { - 'all_tenants': all_tenants, - 'name': args.name, - 'status': args.status, - 'volume_id': args.volume_id, - 'project_id': args.tenant, - } - - snapshots = cs.volume_snapshots.list(search_opts=search_opts, - marker=args.marker, - limit=args.limit, - sort=args.sort) - shell_utils.translate_volume_snapshot_keys(snapshots) - if args.sort: - sortby_index = None - else: - sortby_index = 0 - - utils.print_list(snapshots, - ['ID', 'Volume ID', 'Status', 'Name', 'Size'], - sortby_index=sortby_index) - - -@utils.arg('snapshot', - metavar='', - help='Name or ID of snapshot.') -def do_snapshot_show(cs, args): - """Shows snapshot details.""" - snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) - shell_utils.print_volume_snapshot(snapshot) - - -@utils.arg('volume', - metavar='', - help='Name or ID of volume to snapshot.') -@utils.arg('--force', - metavar='', - const=True, - nargs='?', - 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('--name', - metavar='', - default=None, - help='Snapshot name. Default=None.') -@utils.arg('--display-name', - help=argparse.SUPPRESS) -@utils.arg('--display_name', - help=argparse.SUPPRESS) -@utils.arg('--description', - metavar='', - default=None, - help='Snapshot description. Default=None.') -@utils.arg('--display-description', - help=argparse.SUPPRESS) -@utils.arg('--display_description', - help=argparse.SUPPRESS) -@utils.arg('--metadata', - nargs='*', - metavar='', - default=None, - help='Snapshot metadata key and value pairs. Default=None.') -def do_snapshot_create(cs, args): - """Creates a snapshot.""" - if args.display_name is not None: - args.name = args.display_name - - if args.display_description is not None: - args.description = args.display_description - - snapshot_metadata = None - if args.metadata is not None: - snapshot_metadata = shell_utils.extract_metadata(args) - - volume = utils.find_volume(cs, args.volume) - snapshot = cs.volume_snapshots.create(volume.id, - args.force, - args.name, - args.description, - metadata=snapshot_metadata) - shell_utils.print_volume_snapshot(snapshot) - - -@utils.arg('snapshot', - metavar='', nargs='+', - help='Name or ID of the snapshot(s) to delete.') -@utils.arg('--force', - action="store_true", - help='Allows deleting snapshot of a volume ' - 'when its status is other than "available" or "error". ' - 'Default=False.') -def do_snapshot_delete(cs, args): - """Removes one or more snapshots.""" - failure_count = 0 - - for snapshot in args.snapshot: - try: - shell_utils.find_volume_snapshot(cs, snapshot).delete(args.force) - 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='', - help='Name or ID of snapshot.') -@utils.arg('name', nargs='?', metavar='', - help='New name for snapshot.') -@utils.arg('--description', metavar='', - default=None, - help='Snapshot description. Default=None.') -@utils.arg('--display-description', - help=argparse.SUPPRESS) -@utils.arg('--display_description', - help=argparse.SUPPRESS) -def do_snapshot_rename(cs, args): - """Renames a snapshot.""" - kwargs = {} - - if args.name is not None: - kwargs['name'] = args.name - - if args.description is not None: - kwargs['description'] = args.description - elif args.display_description is not None: - kwargs['description'] = args.display_description - - if not any(kwargs): - msg = 'Must supply either name or description.' - raise exceptions.ClientException(code=1, message=msg) - - shell_utils.find_volume_snapshot(cs, args.snapshot).update(**kwargs) - print("Request to rename snapshot '%s' has been accepted." % ( - args.snapshot)) - - -@utils.arg('snapshot', metavar='', nargs='+', - help='Name or ID of snapshot to modify.') -@utils.arg('--state', metavar='', - 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: - shell_utils.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 do_type_list(cs, args): - """Lists available 'volume types'. - - (Only admin and tenant users will see private types) - """ - vtypes = cs.volume_types.list() - shell_utils.print_volume_type_list(vtypes) - - -def do_type_default(cs, args): - """List the default volume type.""" - vtype = cs.volume_types.default() - shell_utils.print_volume_type_list([vtype]) - - -@utils.arg('volume_type', - metavar='', - help='Name or ID of the volume type.') -def do_type_show(cs, args): - """Show volume type details.""" - vtype = shell_utils.find_vtype(cs, args.volume_type) - info = dict() - info.update(vtype._info) - - info.pop('links', None) - utils.print_dict(info, formatters=['extra_specs']) - - -@utils.arg('id', - metavar='', - help='ID of the volume type.') -@utils.arg('--name', - metavar='', - help='Name of the volume type.') -@utils.arg('--description', - metavar='', - help='Description of the volume type.') -@utils.arg('--is-public', - metavar='', - help='Make type accessible to the public or not.') -def do_type_update(cs, args): - """Updates volume type name, description, and/or is_public.""" - is_public = args.is_public - if args.name is None and args.description is None and is_public is None: - raise exceptions.CommandError('Specify a new type name, description, ' - 'is_public or a combination thereof.') - - if is_public is not None: - is_public = strutils.bool_from_string(args.is_public, strict=True) - vtype = cs.volume_types.update(args.id, args.name, args.description, - is_public) - shell_utils.print_volume_type_list([vtype]) - - -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='', - help='Name of new volume type.') -@utils.arg('--description', - metavar='', - help='Description of new volume type.') -@utils.arg('--is-public', - metavar='', - default=True, - help='Make type accessible to the public (default true).') -def do_type_create(cs, args): - """Creates a volume type.""" - is_public = strutils.bool_from_string(args.is_public, strict=True) - vtype = cs.volume_types.create(args.name, args.description, is_public) - shell_utils.print_volume_type_list([vtype]) - - -@utils.arg('vol_type', - metavar='', nargs='+', - help='Name or ID of volume type or types to delete.') -def do_type_delete(cs, args): - """Deletes volume type or types.""" - failure_count = 0 - for vol_type in args.vol_type: - try: - vtype = shell_utils.find_volume_type(cs, vol_type) - cs.volume_types.delete(vtype) - print("Request to delete volume type %s has been accepted." - % (vol_type)) - except Exception as e: - failure_count += 1 - print("Delete for volume type %s failed: %s" % (vol_type, e)) - if failure_count == len(args.vol_type): - raise exceptions.CommandError("Unable to delete any of the " - "specified types.") - - -@utils.arg('vtype', - metavar='', - help='Name or ID of volume type.') -@utils.arg('action', - metavar='', - choices=['set', 'unset'], - help='The action. Valid values are "set" or "unset."') -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='The extra specs key and value pair to set or unset. ' - 'For unset, specify only the key.') -def do_type_key(cs, args): - """Sets or unsets extra_spec for a volume type.""" - vtype = shell_utils.find_volume_type(cs, args.vtype) - keypair = shell_utils.extract_metadata(args) - - if args.action == 'set': - vtype.set_keys(keypair) - elif args.action == 'unset': - vtype.unset_keys(list(keypair)) - - -@utils.arg('--volume-type', metavar='', required=True, - help='Filter results by volume type name or ID.') -def do_type_access_list(cs, args): - """Print access information about the given volume type.""" - volume_type = shell_utils.find_volume_type(cs, args.volume_type) - if volume_type.is_public: - raise exceptions.CommandError("Failed to get access list " - "for public volume type.") - access_list = cs.volume_type_access.list(volume_type) - - columns = ['Volume_type_ID', 'Project_ID'] - utils.print_list(access_list, columns) - - -@utils.arg('--volume-type', metavar='', required=True, - help='Volume type name or ID to add access for the given project.') -@utils.arg('--project-id', metavar='', required=True, - help='Project ID to add volume type access for.') -def do_type_access_add(cs, args): - """Adds volume type access for the given project.""" - vtype = shell_utils.find_volume_type(cs, args.volume_type) - cs.volume_type_access.add_project_access(vtype, args.project_id) - - -@utils.arg('--volume-type', metavar='', required=True, - help=('Volume type name or ID to remove access ' - 'for the given project.')) -@utils.arg('--project-id', metavar='', required=True, - help='Project ID to remove volume type access for.') -def do_type_access_remove(cs, args): - """Removes volume type access for the given project.""" - vtype = shell_utils.find_volume_type(cs, args.volume_type) - cs.volume_type_access.remove_project_access( - vtype, args.project_id) - - -@utils.arg('tenant', - metavar='', - help='ID of tenant for which to list quotas.') -def do_quota_show(cs, args): - """Lists quotas for a tenant.""" - - shell_utils.quota_show(cs.quotas.get(args.tenant)) - - -@utils.arg('tenant', metavar='', - help='ID of tenant for which to list quota usage.') -def do_quota_usage(cs, args): - """Lists quota usage for a tenant.""" - - shell_utils.quota_usage_show(cs.quotas.get(args.tenant, usage=True)) - - -@utils.arg('tenant', - metavar='', - help='ID of tenant for which to list quota defaults.') -def do_quota_defaults(cs, args): - """Lists default quotas for a tenant.""" - - shell_utils.quota_show(cs.quotas.defaults(args.tenant)) - - -@utils.arg('tenant', - metavar='', - help='ID of tenant for which to set quotas.') -@utils.arg('--volumes', - metavar='', - type=int, default=None, - help='The new "volumes" quota value. Default=None.') -@utils.arg('--snapshots', - metavar='', - type=int, default=None, - help='The new "snapshots" quota value. Default=None.') -@utils.arg('--gigabytes', - metavar='', - type=int, default=None, - help='The new "gigabytes" quota value. Default=None.') -@utils.arg('--backups', - metavar='', - type=int, default=None, - help='The new "backups" quota value. Default=None.') -@utils.arg('--backup-gigabytes', - metavar='', - type=int, default=None, - help='The new "backup_gigabytes" quota value. Default=None.') -@utils.arg('--volume-type', - metavar='', - default=None, - help='Volume type. Default=None.') -@utils.arg('--per-volume-gigabytes', - metavar='', - type=int, default=None, - help='Set max volume size limit. Default=None.') -def do_quota_update(cs, args): - """Updates quotas for a tenant.""" - - shell_utils.quota_update(cs.quotas, args.tenant, args) - - -@utils.arg('tenant', metavar='', - 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='', - help='Name of quota class for which to list quotas.') -def do_quota_class_show(cs, args): - """Lists quotas for a quota class.""" - - shell_utils.quota_show(cs.quota_classes.get(args.class_name)) - - -@utils.arg('class_name', - metavar='', - help='Name of quota class for which to set quotas.') -@utils.arg('--volumes', - metavar='', - type=int, default=None, - help='The new "volumes" quota value. Default=None.') -@utils.arg('--snapshots', - metavar='', - type=int, default=None, - help='The new "snapshots" quota value. Default=None.') -@utils.arg('--gigabytes', - metavar='', - type=int, default=None, - help='The new "gigabytes" quota value. Default=None.') -@utils.arg('--backups', - metavar='', - type=int, default=None, - help='The new "backups" quota value. Default=None.') -@utils.arg('--backup-gigabytes', - metavar='', - type=int, default=None, - help='The new "backup_gigabytes" quota value. Default=None.') -@utils.arg('--volume-type', - metavar='', - default=None, - help='Volume type. Default=None.') -@utils.arg('--per-volume-gigabytes', - metavar='', - type=int, default=None, - help='Set max volume size limit. Default=None.') -def do_quota_class_update(cs, args): - """Updates quotas for a quota class.""" - - shell_utils.quota_update(cs.quota_classes, args.class_name, args) - - -@utils.arg('tenant', - metavar='', - nargs='?', - default=None, - help='Display information for a single tenant (Admin only).') -def do_absolute_limits(cs, args): - """Lists absolute limits for a user.""" - limits = cs.limits.get(args.tenant).absolute - columns = ['Name', 'Value'] - utils.print_list(limits, columns) - - -@utils.arg('tenant', - metavar='', - nargs='?', - default=None, - help='Display information for a single tenant (Admin only).') -def do_rate_limits(cs, args): - """Lists rate limits for a user.""" - limits = cs.limits.get(args.tenant).rate - columns = ['Verb', 'URI', 'Value', 'Remain', 'Unit', 'Next_Available'] - utils.print_list(limits, columns) - - -@utils.arg('volume', - metavar='', - help='Name or ID of volume to snapshot.') -@utils.arg('--force', - metavar='', - const=True, - nargs='?', - default=False, - help='Enables or disables upload of ' - 'a volume that is attached to an instance. ' - 'Default=False. ' - 'This option may not be supported by your cloud.') -@utils.arg('--container-format', - metavar='', - default='bare', - help='Container format type. ' - 'Default is bare.') -@utils.arg('--container_format', - help=argparse.SUPPRESS) -@utils.arg('--disk-format', - metavar='', - default='raw', - help='Disk format type. ' - 'Default is raw.') -@utils.arg('--disk_format', - help=argparse.SUPPRESS) -@utils.arg('image_name', - metavar='', - help='The new image name.') -@utils.arg('--image_name', - help=argparse.SUPPRESS) -def do_upload_to_image(cs, args): - """Uploads volume to Image Service as an image.""" - volume = utils.find_volume(cs, args.volume) - shell_utils.print_volume_image( - volume.upload_to_image(args.force, - args.image_name, - args.container_format, - args.disk_format)) - - -@utils.arg('volume', metavar='', help='ID of volume to migrate.') -@utils.arg('host', metavar='', help='Destination host. Takes the form: ' - 'host@backend-name#pool') -@utils.arg('--force-host-copy', metavar='', - choices=['True', 'False'], - required=False, - const=True, - nargs='?', - default=False, - help='Enables or disables generic host-based ' - 'force-migration, which bypasses driver ' - 'optimizations. Default=False.') -@utils.arg('--lock-volume', metavar='', - choices=['True', 'False'], - required=False, - const=True, - nargs='?', - default=False, - help='Enables or disables the termination of volume migration ' - 'caused by other commands. This option applies to the ' - 'available volume. True means it locks the volume ' - 'state and does not allow the migration to be aborted. The ' - 'volume status will be in maintenance during the ' - 'migration. False means it allows the volume migration ' - 'to be aborted. The volume status is still in the original ' - 'status. Default=False.') -def do_migrate(cs, args): - """Migrates volume to a new host.""" - volume = utils.find_volume(cs, args.volume) - try: - volume.migrate_volume(args.host, args.force_host_copy, - args.lock_volume) - print("Request to migrate volume %s has been accepted." % (volume.id)) - except Exception as e: - print("Migration for volume %s failed: %s." % (volume.id, e)) - - -@utils.arg('volume', metavar='', - help='Name or ID of volume for which to modify type.') -@utils.arg('new_type', metavar='', help='New volume type.') -@utils.arg('--migration-policy', metavar='', required=False, - choices=['never', 'on-demand'], default='never', - help='Migration policy during retype of volume.') -def do_retype(cs, args): - """Changes the volume type for a volume.""" - volume = utils.find_volume(cs, args.volume) - volume.retype(args.new_type, args.migration_policy) - - -@utils.arg('volume', metavar='', - help='Name or ID of volume to backup.') -@utils.arg('--container', metavar='', - default=None, - help='Backup container name. Default=None.') -@utils.arg('--display-name', - help=argparse.SUPPRESS) -@utils.arg('--name', metavar='', - default=None, - help='Backup name. Default=None.') -@utils.arg('--display-description', - help=argparse.SUPPRESS) -@utils.arg('--description', - metavar='', - default=None, - help='Backup description. Default=None.') -@utils.arg('--incremental', - action='store_true', - help='Incremental backup. Default=False.', - default=False) -@utils.arg('--force', - action='store_true', - help='Allows or disallows backup of a volume ' - 'when the volume is attached to an instance. ' - 'If set to True, backs up the volume whether ' - 'its status is "available" or "in-use". The backup ' - 'of an "in-use" volume means your data is crash ' - 'consistent. Default=False.', - default=False) -@utils.arg('--snapshot-id', - metavar='', - default=None, - help='ID of snapshot to backup. Default=None.') -def do_backup_create(cs, args): - """Creates a volume backup.""" - if args.display_name is not None: - args.name = args.display_name - - if args.display_description is not None: - args.description = args.display_description - - volume = utils.find_volume(cs, args.volume) - backup = cs.backups.create(volume.id, - args.container, - args.name, - args.description, - args.incremental, - args.force, - args.snapshot_id) - - info = {"volume_id": volume.id} - info.update(backup._info) - - if 'links' in info: - info.pop('links') - - utils.print_dict(info) - - -@utils.arg('backup', metavar='', help='Name or ID of backup.') -def do_backup_show(cs, args): - """Shows backup details.""" - backup = shell_utils.find_backup(cs, args.backup) - info = dict() - info.update(backup._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('--all-tenants', - metavar='', - 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('--name', - metavar='', - default=None, - help='Filters results by a name. Default=None.') -@utils.arg('--status', - metavar='', - default=None, - help='Filters results by a status. Default=None.') -@utils.arg('--volume-id', - metavar='', - default=None, - help='Filters results by a volume ID. Default=None.') -@utils.arg('--volume_id', - help=argparse.SUPPRESS) -@utils.arg('--marker', - metavar='', - default=None, - help='Begin returning backups that appear later in the backup ' - 'list than that represented by this id. ' - 'Default=None.') -@utils.arg('--limit', - metavar='', - default=None, - help='Maximum number of backups to return. Default=None.') -@utils.arg('--sort', - metavar='[:]', - default=None, - help=(('Comma-separated list of sort keys and directions in the ' - 'form of [:]. ' - 'Valid keys: %s. ' - 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) -def do_backup_list(cs, args): - """Lists all backups.""" - - search_opts = { - 'all_tenants': args.all_tenants, - 'name': args.name, - 'status': args.status, - 'volume_id': args.volume_id, - } - - backups = cs.backups.list(search_opts=search_opts, - marker=args.marker, - limit=args.limit, - sort=args.sort) - shell_utils.translate_volume_snapshot_keys(backups) - columns = ['ID', 'Volume ID', 'Status', 'Name', 'Size', 'Object Count', - 'Container'] - if args.sort: - sortby_index = None - else: - sortby_index = 0 - utils.print_list(backups, columns, sortby_index=sortby_index) - - -@utils.arg('--force', - action="store_true", - help='Allows deleting backup of a volume ' - 'when its status is other than "available" or "error". ' - 'Default=False.') -@utils.arg('backup', metavar='', nargs='+', - help='Name or ID of backup(s) to delete.') -def do_backup_delete(cs, args): - """Removes one or more backups.""" - failure_count = 0 - for backup in args.backup: - try: - shell_utils.find_backup(cs, backup).delete(args.force) - print("Request to delete backup %s has been accepted." % (backup)) - except Exception as e: - failure_count += 1 - print("Delete for backup %s failed: %s" % (backup, e)) - if failure_count == len(args.backup): - raise exceptions.CommandError("Unable to delete any of the specified " - "backups.") - - -@utils.arg('backup', metavar='', - help='Name or ID of backup to restore.') -@utils.arg('--volume-id', metavar='', - default=None, - help=argparse.SUPPRESS) -@utils.arg('--volume', metavar='', - default=None, - help='Name or ID of existing volume to which to restore. ' - 'This is mutually exclusive with --name and takes priority. ' - 'Default=None.') -@utils.arg('--name', metavar='', - default=None, - help='Use the name for new volume creation to restore. ' - 'This is mutually exclusive with --volume (or the deprecated ' - '--volume-id) and --volume (or --volume-id) takes priority. ' - 'Default=None.') -def do_backup_restore(cs, args): - """Restores a backup.""" - vol = args.volume or args.volume_id - if vol: - volume_id = utils.find_volume(cs, vol).id - if args.name: - args.name = None - print('Mutually exclusive options are specified simultaneously: ' - '"--volume (or the deprecated --volume-id) and --name". ' - 'The --volume (or --volume-id) option takes priority.') - else: - volume_id = None - - backup = shell_utils.find_backup(cs, args.backup) - restore = cs.restores.restore(backup.id, volume_id, args.name) - - info = {"backup_id": backup.id} - info.update(restore._info) - - info.pop('links', None) - - utils.print_dict(info) - - -@utils.arg('backup', metavar='', - help='ID of the backup to export.') -def do_backup_export(cs, args): - """Export backup metadata record.""" - info = cs.backups.export_record(args.backup) - utils.print_dict(info) - - -@utils.arg('backup_service', metavar='', - help='Backup service to use for importing the backup.') -@utils.arg('backup_url', metavar='', - help='Backup URL for importing the backup metadata.') -def do_backup_import(cs, args): - """Import backup metadata record.""" - info = cs.backups.import_record(args.backup_service, args.backup_url) - info.pop('links', None) - - utils.print_dict(info) - - -@utils.arg('backup', metavar='', nargs='+', - help='Name or ID of the backup to modify.') -@utils.arg('--state', metavar='', - default='available', - help='The state to assign to the backup. Valid values are ' - '"available", "error". Default=available.') -def do_backup_reset_state(cs, args): - """Explicitly updates the backup state.""" - failure_count = 0 - - single = (len(args.backup) == 1) - - for backup in args.backup: - try: - shell_utils.find_backup(cs, backup).reset_state(args.state) - print("Request to update backup '%s' has been accepted." % backup) - except Exception as e: - failure_count += 1 - msg = "Reset state for backup %s failed: %s" % (backup, e) - if not single: - print(msg) - - if failure_count == len(args.backup): - if not single: - msg = ("Unable to reset the state for any of the specified " - "backups.") - raise exceptions.CommandError(msg) - - -@utils.arg('volume', metavar='', - help='Name or ID of volume to transfer.') -@utils.arg('--name', - metavar='', - default=None, - help='Transfer name. Default=None.') -@utils.arg('--display-name', - help=argparse.SUPPRESS) -def do_transfer_create(cs, args): - """Creates a volume transfer.""" - if args.display_name is not None: - args.name = args.display_name - - volume = utils.find_volume(cs, args.volume) - transfer = cs.transfers.create(volume.id, - args.name) - info = dict() - info.update(transfer._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('transfer', metavar='', - help='Name or ID of transfer to delete.') -def do_transfer_delete(cs, args): - """Undoes a transfer.""" - transfer = shell_utils.find_transfer(cs, args.transfer) - transfer.delete() - - -@utils.arg('transfer', metavar='', - help='ID of transfer to accept.') -@utils.arg('auth_key', metavar='', - 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) - - info.pop('links', None) - 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='', - help='Name or ID of transfer to accept.') -def do_transfer_show(cs, args): - """Shows transfer details.""" - transfer = shell_utils.find_transfer(cs, args.transfer) - info = dict() - info.update(transfer._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('volume', metavar='', - help='Name or ID of volume to extend.') -@utils.arg('new_size', - metavar='', - type=int, - help='New 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='', default=None, - help='Host name. Default=None.') -@utils.arg('--binary', metavar='', default=None, - help='Service binary. Default=None.') -@utils.arg('--withreplication', - metavar='', - const=True, - nargs='?', - default=False, - help='Enables or disables display of ' - 'Replication info for c-vol services. Default=False.') -def do_service_list(cs, args): - """Lists all services. Filter by host and service binary.""" - replication = strutils.bool_from_string(args.withreplication, - strict=True) - result = cs.services.list(host=args.host, binary=args.binary) - columns = ["Binary", "Host", "Zone", "Status", "State", "Updated_at"] - if replication: - columns.extend(["Replication Status", "Active Backend ID", "Frozen"]) - # 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='', help='Host name.') -@utils.arg('binary', metavar='', 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='', help='Host name.') -@utils.arg('binary', metavar='', help='Service binary.') -@utils.arg('--reason', metavar='', - 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) - shell_utils.translate_availability_zone_keys(result) - utils.print_list(result, ['Name', 'Status']) - - -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='', - type=str, - help='Name or ID of volume type.') -def do_encryption_type_show(cs, args): - """Shows encryption type details for a volume type. Admin only.""" - volume_type = shell_utils.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'): - shell_utils.print_volume_encryption_type_list([result]) - else: - shell_utils.print_volume_encryption_type_list([]) - - -@utils.arg('volume_type', - metavar='', - type=str, - help='Name or ID of volume type.') -@utils.arg('provider', - metavar='', - type=str, - help='The encryption provider format. ' - 'For example, "luks" or "plain".') -@utils.arg('--cipher', - metavar='', - type=str, - required=False, - default=None, - help='The encryption algorithm or mode. ' - 'For example, aes-xts-plain64. Default=None.') -@utils.arg('--key-size', - metavar='', - type=int, - required=False, - default=None, - help='Size of encryption key, in bits. ' - 'For example, 128 or 256. Default=None.') -@utils.arg('--key_size', - type=int, - required=False, - default=None, - help=argparse.SUPPRESS) -@utils.arg('--control-location', - metavar='', - 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".') -@utils.arg('--control_location', - type=str, - required=False, - default='front-end', - help=argparse.SUPPRESS) -def do_encryption_type_create(cs, args): - """Creates encryption type for a volume type. Admin only.""" - volume_type = shell_utils.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) - shell_utils.print_volume_encryption_type_list([result]) - - -@utils.arg('volume_type', - metavar='', - type=str, - help="Name or ID of the volume type") -@utils.arg('--provider', - metavar='', - type=str, - required=False, - default=argparse.SUPPRESS, - help="Encryption provider format (e.g. 'luks' or 'plain').") -@utils.arg('--cipher', - metavar='', - type=str, - nargs='?', - required=False, - default=argparse.SUPPRESS, - const=None, - help="Encryption algorithm/mode to use (e.g., aes-xts-plain64). " - "Provide parameter without value to set to provider default.") -@utils.arg('--key-size', - dest='key_size', - metavar='', - type=int, - nargs='?', - required=False, - default=argparse.SUPPRESS, - const=None, - help="Size of the encryption key, in bits (e.g., 128, 256). " - "Provide parameter without value to set to provider default. ") -@utils.arg('--control-location', - dest='control_location', - metavar='', - choices=['front-end', 'back-end'], - type=str, - required=False, - default=argparse.SUPPRESS, - help="Notional service where encryption is performed (e.g., " - "front-end=Nova). Values: 'front-end', 'back-end'") -def do_encryption_type_update(cs, args): - """Update encryption type information for a volume type (Admin Only).""" - volume_type = shell_utils.find_volume_type(cs, args.volume_type) - - # An argument should only be pulled if the user specified the parameter. - body = {} - for attr in ['provider', 'cipher', 'key_size', 'control_location']: - if hasattr(args, attr): - body[attr] = getattr(args, attr) - - cs.volume_encryption_types.update(volume_type, body) - result = cs.volume_encryption_types.get(volume_type) - shell_utils.print_volume_encryption_type_list([result]) - - -@utils.arg('volume_type', - metavar='', - 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 = shell_utils.find_volume_type(cs, args.volume_type) - cs.volume_encryption_types.delete(volume_type) - - -@utils.arg('name', - metavar='', - help='Name of new QoS specifications.') -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='QoS specifications.') -def do_qos_create(cs, args): - """Creates a qos specs.""" - keypair = None - if args.metadata is not None: - keypair = shell_utils.extract_metadata(args) - qos_specs = cs.qos_specs.create(args.name, keypair) - shell_utils.print_qos_specs(qos_specs) - - -def do_qos_list(cs, args): - """Lists qos specs.""" - qos_specs = cs.qos_specs.list() - shell_utils.print_qos_specs_list(qos_specs) - - -@utils.arg('qos_specs', metavar='', - help='ID of QoS specifications to show.') -def do_qos_show(cs, args): - """Shows qos specs details.""" - qos_specs = shell_utils.find_qos_specs(cs, args.qos_specs) - shell_utils.print_qos_specs(qos_specs) - - -@utils.arg('qos_specs', metavar='', - help='ID of QoS specifications to delete.') -@utils.arg('--force', - metavar='', - const=True, - nargs='?', - 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 = shell_utils.find_qos_specs(cs, args.qos_specs) - cs.qos_specs.delete(qos_specs, force) - - -@utils.arg('qos_specs', metavar='', - help='ID of QoS specifications.') -@utils.arg('vol_type_id', metavar='', - help='ID of volume type with which to associate ' - 'QoS specifications.') -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='', - help='ID of QoS specifications.') -@utils.arg('vol_type_id', metavar='', - help='ID of volume type with which to associate ' - 'QoS specifications.') -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='', - help='ID of QoS specifications on which to operate.') -def do_qos_disassociate_all(cs, args): - """Disassociates qos specs from all its associations.""" - cs.qos_specs.disassociate_all(args.qos_specs) - - -@utils.arg('qos_specs', metavar='', - help='ID of QoS specifications.') -@utils.arg('action', - metavar='', - 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 = shell_utils.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='', - help='ID of QoS specifications.') -def do_qos_get_association(cs, args): - """Lists all associations for specified qos specs.""" - associations = cs.qos_specs.get_associations(args.qos_specs) - shell_utils.print_associations_list(associations) - - -@utils.arg('snapshot', - metavar='', - help='ID of snapshot for which to update metadata.') -@utils.arg('action', - metavar='', - choices=['set', 'unset'], - help='The action. Valid values are "set" or "unset."') -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='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 = shell_utils.find_volume_snapshot(cs, args.snapshot) - metadata = shell_utils.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='', - help='ID of snapshot.') -def do_snapshot_metadata_show(cs, args): - """Shows snapshot metadata.""" - snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) - utils.print_dict(snapshot._info['metadata'], 'Metadata-property') - - -@utils.arg('volume', metavar='', - 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='', - help='ID of volume.') -def do_image_metadata_show(cs, args): - """Shows volume image metadata.""" - volume = utils.find_volume(cs, args.volume) - resp, body = volume.show_image_metadata(volume) - utils.print_dict(body['metadata'], 'Metadata-property') - - -@utils.arg('volume', - metavar='', - help='ID of volume for which to update metadata.') -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='Metadata key and value pair or pairs to update.') -def do_metadata_update_all(cs, args): - """Updates volume metadata.""" - volume = utils.find_volume(cs, args.volume) - metadata = shell_utils.extract_metadata(args) - metadata = volume.update_all_metadata(metadata) - utils.print_dict(metadata['metadata'], 'Metadata-property') - - -@utils.arg('snapshot', - metavar='', - help='ID of snapshot for which to update metadata.') -@utils.arg('metadata', - metavar='', - nargs='+', - default=[], - help='Metadata key and value pair to update.') -def do_snapshot_metadata_update_all(cs, args): - """Updates snapshot metadata.""" - snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) - metadata = shell_utils.extract_metadata(args) - metadata = snapshot.update_all_metadata(metadata) - utils.print_dict(metadata) - - -@utils.arg('volume', metavar='', help='ID of volume to update.') -@utils.arg('read_only', - metavar='', - 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='', help='ID of the volume to update.') -@utils.arg('bootable', - metavar='', - 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)) - - -@utils.arg('host', - metavar='', - help='Cinder host on which the existing volume resides; ' - 'takes the form: host@backend-name#pool') -@utils.arg('identifier', - metavar='', - help='Name or other Identifier for existing volume') -@utils.arg('--id-type', - metavar='', - default='source-name', - help='Type of backend device identifier provided, ' - 'typically source-name or source-id (Default=source-name)') -@utils.arg('--name', - metavar='', - help='Volume name (Default=None)') -@utils.arg('--description', - metavar='', - help='Volume description (Default=None)') -@utils.arg('--volume-type', - metavar='', - help='Volume type (Default=None)') -@utils.arg('--availability-zone', - metavar='', - help='Availability zone for volume (Default=None)') -@utils.arg('--metadata', - nargs='*', - metavar='', - help='Metadata key=value pairs (Default=None)') -@utils.arg('--bootable', - action='store_true', - help='Specifies that the newly created volume should be' - ' marked as bootable') -def do_manage(cs, args): - """Manage an existing volume.""" - volume_metadata = None - if args.metadata is not None: - volume_metadata = shell_utils.extract_metadata(args) - - # Build a dictionary of key/value pairs to pass to the API. - ref_dict = {args.id_type: args.identifier} - - # The recommended way to specify an existing volume is by ID or name, and - # have the Cinder driver look for 'source-name' or 'source-id' elements in - # the ref structure. To make things easier for the user, we have special - # --source-name and --source-id CLI options that add the appropriate - # element to the ref structure. - # - # Note how argparse converts hyphens to underscores. We use hyphens in the - # dictionary so that it is consistent with what the user specified on the - # CLI. - - if hasattr(args, 'source_name') and args.source_name is not None: - ref_dict['source-name'] = args.source_name - if hasattr(args, 'source_id') and args.source_id is not None: - ref_dict['source-id'] = args.source_id - - volume = cs.volumes.manage(host=args.host, - ref=ref_dict, - name=args.name, - description=args.description, - volume_type=args.volume_type, - availability_zone=args.availability_zone, - metadata=volume_metadata, - bootable=args.bootable) - - info = {} - volume = cs.volumes.get(volume.id) - info.update(volume._info) - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('volume', metavar='', - help='Name or ID of the volume to unmanage.') -def do_unmanage(cs, args): - """Stop managing a volume.""" - volume = utils.find_volume(cs, args.volume) - cs.volumes.unmanage(volume.id) - - -@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.') -def do_consisgroup_list(cs, args): - """Lists all consistency groups.""" - consistencygroups = cs.consistencygroups.list() - - columns = ['ID', 'Status', 'Name'] - utils.print_list(consistencygroups, columns) - - -@utils.arg('consistencygroup', - metavar='', - help='Name or ID of a consistency group.') -def do_consisgroup_show(cs, args): - """Shows details of a consistency group.""" - info = dict() - consistencygroup = shell_utils.find_consistencygroup(cs, - args.consistencygroup) - info.update(consistencygroup._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('volumetypes', - metavar='', - help='Volume types.') -@utils.arg('--name', - metavar='', - help='Name of a consistency group.') -@utils.arg('--description', - metavar='', - default=None, - help='Description of a consistency group. Default=None.') -@utils.arg('--availability-zone', - metavar='', - default=None, - help='Availability zone for volume. Default=None.') -def do_consisgroup_create(cs, args): - """Creates a consistency group.""" - - consistencygroup = cs.consistencygroups.create( - args.volumetypes, - args.name, - args.description, - availability_zone=args.availability_zone) - - info = dict() - consistencygroup = cs.consistencygroups.get(consistencygroup.id) - info.update(consistencygroup._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('--cgsnapshot', - metavar='', - help='Name or ID of a cgsnapshot. Default=None.') -@utils.arg('--source-cg', - metavar='', - help='Name or ID of a source CG. Default=None.') -@utils.arg('--name', - metavar='', - help='Name of a consistency group. Default=None.') -@utils.arg('--description', - metavar='', - help='Description of a consistency group. Default=None.') -def do_consisgroup_create_from_src(cs, args): - """Creates a consistency group from a cgsnapshot or a source CG.""" - if not args.cgsnapshot and not args.source_cg: - msg = ('Cannot create consistency group because neither ' - 'cgsnapshot nor source CG is provided.') - raise exceptions.ClientException(code=1, message=msg) - if args.cgsnapshot and args.source_cg: - msg = ('Cannot create consistency group because both ' - 'cgsnapshot and source CG are provided.') - raise exceptions.ClientException(code=1, message=msg) - cgsnapshot = None - if args.cgsnapshot: - cgsnapshot = shell_utils.find_cgsnapshot(cs, args.cgsnapshot) - source_cg = None - if args.source_cg: - source_cg = shell_utils.find_consistencygroup(cs, args.source_cg) - info = cs.consistencygroups.create_from_src( - cgsnapshot.id if cgsnapshot else None, - source_cg.id if source_cg else None, - args.name, - args.description) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('consistencygroup', - metavar='', nargs='+', - help='Name or ID of one or more consistency groups ' - 'to be deleted.') -@utils.arg('--force', - action='store_true', - default=False, - help='Allows or disallows consistency groups ' - 'to be deleted. If the consistency group is empty, ' - 'it can be deleted without the force flag. ' - 'If the consistency group is not empty, the force ' - 'flag is required for it to be deleted.') -def do_consisgroup_delete(cs, args): - """Removes one or more consistency groups.""" - failure_count = 0 - for consistencygroup in args.consistencygroup: - try: - shell_utils.find_consistencygroup( - cs, consistencygroup).delete(args.force) - except Exception as e: - failure_count += 1 - print("Delete for consistency group %s failed: %s" % - (consistencygroup, e)) - if failure_count == len(args.consistencygroup): - raise exceptions.CommandError("Unable to delete any of the specified " - "consistency groups.") - - -@utils.arg('consistencygroup', - metavar='', - help='Name or ID of a consistency group.') -@utils.arg('--name', metavar='', - help='New name for consistency group. Default=None.') -@utils.arg('--description', metavar='', - help='New description for consistency group. Default=None.') -@utils.arg('--add-volumes', - metavar='', - help='UUID of one or more volumes ' - 'to be added to the consistency group, ' - 'separated by commas. Default=None.') -@utils.arg('--remove-volumes', - metavar='', - help='UUID of one or more volumes ' - 'to be removed from the consistency group, ' - 'separated by commas. Default=None.') -def do_consisgroup_update(cs, args): - """Updates a consistency group.""" - kwargs = {} - - if args.name is not None: - kwargs['name'] = args.name - - if args.description is not None: - kwargs['description'] = args.description - - if args.add_volumes is not None: - kwargs['add_volumes'] = args.add_volumes - - if args.remove_volumes is not None: - kwargs['remove_volumes'] = args.remove_volumes - - if not kwargs: - msg = ('At least one of the following args must be supplied: ' - 'name, description, add-volumes, remove-volumes.') - raise exceptions.ClientException(code=1, message=msg) - - shell_utils.find_consistencygroup( - cs, args.consistencygroup).update(**kwargs) - print("Request to update consistency group '%s' has been accepted." % ( - args.consistencygroup)) - - -@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('--status', - metavar='', - default=None, - help='Filters results by a status. Default=None.') -@utils.arg('--consistencygroup-id', - metavar='', - default=None, - help='Filters results by a consistency group ID. Default=None.') -def do_cgsnapshot_list(cs, args): - """Lists all cgsnapshots.""" - - all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants)) - - search_opts = { - 'all_tenants': all_tenants, - 'status': args.status, - 'consistencygroup_id': args.consistencygroup_id, - } - - cgsnapshots = cs.cgsnapshots.list(search_opts=search_opts) - - columns = ['ID', 'Status', 'Name'] - utils.print_list(cgsnapshots, columns) - - -@utils.arg('cgsnapshot', - metavar='', - help='Name or ID of cgsnapshot.') -def do_cgsnapshot_show(cs, args): - """Shows cgsnapshot details.""" - info = dict() - cgsnapshot = shell_utils.find_cgsnapshot(cs, args.cgsnapshot) - info.update(cgsnapshot._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('consistencygroup', - metavar='', - help='Name or ID of a consistency group.') -@utils.arg('--name', - metavar='', - default=None, - help='Cgsnapshot name. Default=None.') -@utils.arg('--description', - metavar='', - default=None, - help='Cgsnapshot description. Default=None.') -def do_cgsnapshot_create(cs, args): - """Creates a cgsnapshot.""" - consistencygroup = shell_utils.find_consistencygroup(cs, - args.consistencygroup) - cgsnapshot = cs.cgsnapshots.create( - consistencygroup.id, - args.name, - args.description) - - info = dict() - cgsnapshot = cs.cgsnapshots.get(cgsnapshot.id) - info.update(cgsnapshot._info) - - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('cgsnapshot', - metavar='', nargs='+', - help='Name or ID of one or more cgsnapshots to be deleted.') -def do_cgsnapshot_delete(cs, args): - """Removes one or more cgsnapshots.""" - failure_count = 0 - for cgsnapshot in args.cgsnapshot: - try: - shell_utils.find_cgsnapshot(cs, cgsnapshot).delete() - except Exception as e: - failure_count += 1 - print("Delete for cgsnapshot %s failed: %s" % (cgsnapshot, e)) - if failure_count == len(args.cgsnapshot): - raise exceptions.CommandError("Unable to delete any of the specified " - "cgsnapshots.") - - -@utils.arg('--detail', - action='store_true', - help='Show detailed information about pools.') -def do_get_pools(cs, args): - """Show pool information for backends. Admin only.""" - pools = cs.volumes.get_pools(args.detail) - infos = dict() - infos.update(pools._info) - - for info in infos['pools']: - backend = dict() - backend['name'] = info['name'] - if args.detail: - backend.update(info['capabilities']) - utils.print_dict(backend) - - -@utils.arg('host', - metavar='', - help='Cinder host to show backend volume stats and properties; ' - 'takes the form: host@backend-name') -def do_get_capabilities(cs, args): - """Show backend volume stats and properties. Admin only.""" - - capabilities = cs.capabilities.get(args.host) - infos = dict() - infos.update(capabilities._info) - - prop = infos.pop('properties', None) - utils.print_dict(infos, "Volume stats") - utils.print_dict(prop, "Backend properties", - formatters=sorted(prop.keys())) - - -@utils.arg('volume', - metavar='', - help='Cinder volume that already exists in the volume backend.') -@utils.arg('identifier', - metavar='', - help='Name or other identifier for existing snapshot. This is ' - 'backend specific.') -@utils.arg('--id-type', - metavar='', - default='source-name', - help='Type of backend device identifier provided, ' - 'typically source-name or source-id (Default=source-name).') -@utils.arg('--name', - metavar='', - help='Snapshot name (Default=None).') -@utils.arg('--description', - metavar='', - help='Snapshot description (Default=None).') -@utils.arg('--metadata', - nargs='*', - metavar='', - help='Metadata key=value pairs (Default=None).') -def do_snapshot_manage(cs, args): - """Manage an existing snapshot.""" - snapshot_metadata = None - if args.metadata is not None: - snapshot_metadata = shell_utils.extract_metadata(args) - - # Build a dictionary of key/value pairs to pass to the API. - ref_dict = {args.id_type: args.identifier} - - if hasattr(args, 'source_name') and args.source_name is not None: - ref_dict['source-name'] = args.source_name - if hasattr(args, 'source_id') and args.source_id is not None: - ref_dict['source-id'] = args.source_id - - volume = utils.find_volume(cs, args.volume) - snapshot = cs.volume_snapshots.manage(volume_id=volume.id, - ref=ref_dict, - name=args.name, - description=args.description, - metadata=snapshot_metadata) - - info = {} - snapshot = cs.volume_snapshots.get(snapshot.id) - info.update(snapshot._info) - info.pop('links', None) - utils.print_dict(info) - - -@utils.arg('snapshot', metavar='', - help='Name or ID of the snapshot to unmanage.') -def do_snapshot_unmanage(cs, args): - """Stop managing a snapshot.""" - snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) - cs.volume_snapshots.unmanage(snapshot.id) - - -@utils.arg('host', metavar='', help='Host name.') -def do_freeze_host(cs, args): - """Freeze and disable the specified cinder-volume host.""" - cs.services.freeze_host(args.host) - - -@utils.arg('host', metavar='', help='Host name.') -def do_thaw_host(cs, args): - """Thaw and enable the specified cinder-volume host.""" - cs.services.thaw_host(args.host) - - -@utils.arg('host', metavar='', help='Host name.') -@utils.arg('--backend_id', - metavar='', - help='ID of backend to failover to (Default=None)') -def do_failover_host(cs, args): - """Failover a replicating cinder-volume host.""" - cs.services.failover_host(args.host, args.backend_id) - - -@utils.arg('host', - metavar='', - help='Cinder host on which to list manageable volumes; ' - 'takes the form: host@backend-name#pool') -@utils.arg('--detailed', - metavar='', - default=True, - help='Returned detailed information (default true).') -@utils.arg('--marker', - metavar='', - default=None, - help='Begin returning volumes that appear later in the volume ' - 'list than that represented by this volume id. ' - 'Default=None.') -@utils.arg('--limit', - metavar='', - default=None, - help='Maximum number of volumes to return. Default=None.') -@utils.arg('--offset', - metavar='', - default=None, - help='Number of volumes to skip after marker. Default=None.') -@utils.arg('--sort', - metavar='[:]', - default=None, - help=(('Comma-separated list of sort keys and directions in the ' - 'form of [:]. ' - 'Valid keys: %s. ' - 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) -def do_manageable_list(cs, args): - """Lists all manageable volumes.""" - detailed = strutils.bool_from_string(args.detailed) - volumes = cs.volumes.list_manageable(host=args.host, detailed=detailed, - marker=args.marker, limit=args.limit, - offset=args.offset, sort=args.sort) - columns = ['reference', 'size', 'safe_to_manage'] - if detailed: - columns.extend(['reason_not_safe', 'cinder_id', 'extra_info']) - utils.print_list(volumes, columns, sortby_index=None) - - -@utils.arg('host', - metavar='', - help='Cinder host on which to list manageable snapshots; ' - 'takes the form: host@backend-name#pool') -@utils.arg('--detailed', - metavar='', - default=True, - help='Returned detailed information (default true).') -@utils.arg('--marker', - metavar='', - default=None, - help='Begin returning snapshots that appear later in the snapshot ' - 'list than that represented by this snapshot id. ' - 'Default=None.') -@utils.arg('--limit', - metavar='', - default=None, - help='Maximum number of snapshots to return. Default=None.') -@utils.arg('--offset', - metavar='', - default=None, - help='Number of snapshots to skip after marker. Default=None.') -@utils.arg('--sort', - metavar='[:]', - default=None, - help=(('Comma-separated list of sort keys and directions in the ' - 'form of [:]. ' - 'Valid keys: %s. ' - 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) -def do_snapshot_manageable_list(cs, args): - """Lists all manageable snapshots.""" - detailed = strutils.bool_from_string(args.detailed) - snapshots = cs.volume_snapshots.list_manageable(host=args.host, - detailed=detailed, - marker=args.marker, - limit=args.limit, - offset=args.offset, - sort=args.sort) - columns = ['reference', 'size', 'safe_to_manage', 'source_reference'] - if detailed: - columns.extend(['reason_not_safe', 'cinder_id', 'extra_info']) - utils.print_list(snapshots, columns, sortby_index=None) diff --git a/cinderclient/v3/availability_zones.py b/cinderclient/v3/availability_zones.py index 3b99540..db6b8da 100644 --- a/cinderclient/v3/availability_zones.py +++ b/cinderclient/v3/availability_zones.py @@ -16,4 +16,27 @@ """Availability Zone interface (v3 extension)""" -from cinderclient.v2.availability_zones import * # noqa +from cinderclient import base + + +class AvailabilityZone(base.Resource): + NAME_ATTR = 'display_name' + + def __repr__(self): + return "" % 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/v3/shell.py b/cinderclient/v3/shell.py index 6d7d1eb..afbe369 100644 --- a/cinderclient/v3/shell.py +++ b/cinderclient/v3/shell.py @@ -27,8 +27,8 @@ from cinderclient import exceptions from cinderclient import shell_utils from cinderclient import utils -from cinderclient.v2.shell import * # noqa -from cinderclient.v2.shell import CheckSizeArgForCreate +from cinderclient.v3.shell_base import * # noqa +from cinderclient.v3.shell_base import CheckSizeArgForCreate FILTER_DEPRECATED = ("This option is deprecated and will be removed in " "newer release. Please use '--filters' option which " diff --git a/cinderclient/v3/shell_base.py b/cinderclient/v3/shell_base.py new file mode 100644 index 0000000..e3f8682 --- /dev/null +++ b/cinderclient/v3/shell_base.py @@ -0,0 +1,2475 @@ +# Copyright (c) 2013-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. + +import argparse +import collections +import copy +import os + +from oslo_utils import strutils + +from cinderclient import base +from cinderclient import exceptions +from cinderclient import shell_utils +from cinderclient import utils +from cinderclient.v2 import availability_zones + + +def _translate_attachments(info): + attachments = [] + attached_servers = [] + for attachment in info['attachments']: + attachments.append(attachment['attachment_id']) + attached_servers.append(attachment['server_id']) + info.pop('attachments', None) + info['attachment_ids'] = attachments + info['attached_servers'] = attached_servers + return 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) +@utils.arg('--name', + metavar='', + default=None, + help='Filters results by a name. Default=None.') +@utils.arg('--display-name', + help=argparse.SUPPRESS) +@utils.arg('--status', + metavar='', + default=None, + help='Filters results by a status. Default=None.') +@utils.arg('--bootable', + metavar='', + const=True, + nargs='?', + choices=['True', 'true', 'False', 'false'], + help='Filters results by bootable status. Default=None.') +@utils.arg('--migration_status', + metavar='', + default=None, + help='Filters results by a migration status. Default=None. ' + 'Admin only.') +@utils.arg('--metadata', + nargs='*', + metavar='', + default=None, + help='Filters results by a image metadata key and value pair. ' + 'Default=None.') +@utils.arg('--marker', + metavar='', + default=None, + help='Begin returning volumes that appear later in the volume ' + 'list than that represented by this volume id. ' + 'Default=None.') +@utils.arg('--limit', + metavar='', + default=None, + help='Maximum number of volumes to return. Default=None.') +@utils.arg('--fields', + default=None, + metavar='', + help='Comma-separated list of fields to display. ' + 'Use the show command to see which fields are available. ' + 'Unavailable/non-existent fields will be ignored. ' + 'Default=None.') +@utils.arg('--sort', + metavar='[:]', + default=None, + help=(('Comma-separated list of sort keys and directions in the ' + 'form of [:]. ' + 'Valid keys: %s. ' + 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) +@utils.arg('--tenant', + type=str, + dest='tenant', + nargs='?', + metavar='', + help='Display information from single tenant (Admin only).') +def do_list(cs, args): + """Lists all volumes.""" + # NOTE(thingee): Backwards-compatibility with v1 args + if args.display_name is not None: + args.name = args.display_name + + 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, + 'name': args.name, + 'status': args.status, + 'bootable': args.bootable, + 'migration_status': args.migration_status, + 'metadata': (shell_utils.extract_metadata(args) if args.metadata + else None), + } + + # If unavailable/non-existent fields are specified, these fields will + # be removed from key_list at the print_list() during key validation. + field_titles = [] + if args.fields: + for field_title in args.fields.split(','): + field_titles.append(field_title) + + volumes = cs.volumes.list(search_opts=search_opts, marker=args.marker, + limit=args.limit, sort=args.sort) + shell_utils.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 field_titles: + # Remove duplicate fields + key_list = ['ID'] + unique_titles = [k for k in collections.OrderedDict.fromkeys( + [x.title().strip() for x in field_titles]) if k != 'Id'] + key_list.extend(unique_titles) + else: + key_list = ['ID', 'Status', 'Name', 'Size', 'Volume Type', + 'Bootable', 'Attached to'] + # If all_tenants is specified, print + # Tenant ID as well. + if search_opts['all_tenants']: + key_list.insert(1, 'Tenant ID') + + if args.sort: + sortby_index = None + else: + sortby_index = 0 + utils.print_list(volumes, key_list, exclude_unavailable=True, + sortby_index=sortby_index) + + +@utils.arg('volume', + metavar='', + help='Name or ID of volume.') +def do_show(cs, args): + """Shows volume details.""" + info = dict() + volume = utils.find_volume(cs, args.volume) + info.update(volume._info) + + if 'readonly' in info['metadata']: + info['readonly'] = info['metadata']['readonly'] + + info.pop('links', None) + info = _translate_attachments(info) + utils.print_dict(info, + formatters=['metadata', 'volume_image_metadata', + 'attachment_ids', 'attached_servers']) + + +class CheckSizeArgForCreate(argparse.Action): + def __call__(self, parser, args, values, option_string=None): + if ((args.snapshot_id or args.source_volid) + is None and values is None): + if not hasattr(args, 'backup_id') or args.backup_id is None: + parser.error('Size is a required parameter if snapshot ' + 'or source volume or backup is not specified.') + setattr(args, self.dest, values) + + +@utils.arg('size', + metavar='', + nargs='?', + type=int, + action=CheckSizeArgForCreate, + help='Size of volume, in GiBs. (Required unless ' + 'snapshot-id/source-volid is specified).') +@utils.arg('--consisgroup-id', + metavar='', + default=None, + help='ID of a consistency group where the new volume belongs to. ' + 'Default=None.') +@utils.arg('--snapshot-id', + metavar='', + default=None, + help='Creates volume from snapshot ID. Default=None.') +@utils.arg('--snapshot_id', + help=argparse.SUPPRESS) +@utils.arg('--source-volid', + metavar='', + default=None, + help='Creates volume from volume ID. Default=None.') +@utils.arg('--source_volid', + help=argparse.SUPPRESS) +@utils.arg('--image-id', + metavar='', + default=None, + help='Creates volume from image ID. Default=None.') +@utils.arg('--image_id', + help=argparse.SUPPRESS) +@utils.arg('--image', + metavar='', + default=None, + help='Creates a volume from image (ID or name). Default=None.') +@utils.arg('--image_ref', + help=argparse.SUPPRESS) +@utils.arg('--name', + metavar='', + default=None, + help='Volume name. Default=None.') +@utils.arg('--display-name', + help=argparse.SUPPRESS) +@utils.arg('--display_name', + help=argparse.SUPPRESS) +@utils.arg('--description', + metavar='', + default=None, + help='Volume description. Default=None.') +@utils.arg('--display-description', + help=argparse.SUPPRESS) +@utils.arg('--display_description', + help=argparse.SUPPRESS) +@utils.arg('--volume-type', + metavar='', + default=None, + help='Volume type. Default=None.') +@utils.arg('--volume_type', + help=argparse.SUPPRESS) +@utils.arg('--availability-zone', + metavar='', + default=None, + help='Availability zone for volume. Default=None.') +@utils.arg('--availability_zone', + help=argparse.SUPPRESS) +@utils.arg('--metadata', + nargs='*', + metavar='', + default=None, + help='Metadata key and value pairs. Default=None.') +@utils.arg('--hint', + metavar='', + dest='scheduler_hints', + action='append', + default=[], + help='Scheduler hint, similar to nova. Repeat option to set ' + 'multiple hints. Values with the same key will be stored ' + 'as a list.') +def do_create(cs, args): + """Creates a volume.""" + # NOTE(thingee): Backwards-compatibility with v1 args + if args.display_name is not None: + args.name = args.display_name + + if args.display_description is not None: + args.description = args.display_description + + volume_metadata = None + if args.metadata is not None: + volume_metadata = shell_utils.extract_metadata(args) + + # NOTE(N.S.): take this piece from novaclient + hints = {} + if args.scheduler_hints: + for hint in args.scheduler_hints: + key, _sep, value = hint.partition('=') + # NOTE(vish): multiple copies of same hint will + # result in a list of values + if key in hints: + if isinstance(hints[key], str): + hints[key] = [hints[key]] + hints[key] += [value] + else: + hints[key] = value + # NOTE(N.S.): end of taken piece + + # Keep backward compatibility with image_id, favoring explicit ID + image_ref = args.image_id or args.image or args.image_ref + + volume = cs.volumes.create(args.size, + args.consisgroup_id, + args.snapshot_id, + args.source_volid, + args.name, + args.description, + args.volume_type, + availability_zone=args.availability_zone, + imageRef=image_ref, + metadata=volume_metadata, + scheduler_hints=hints) + + info = dict() + volume = cs.volumes.get(volume.id) + info.update(volume._info) + + if 'readonly' in info['metadata']: + info['readonly'] = info['metadata']['readonly'] + + info.pop('links', None) + info = _translate_attachments(info) + utils.print_dict(info) + + +@utils.arg('--cascade', + action='store_true', + default=False, + help='Remove any snapshots along with volume. Default=False.') +@utils.arg('volume', + metavar='', nargs='+', + help='Name or ID of volume or volumes to delete.') +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(cascade=args.cascade) + 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='', nargs='+', + help='Name or ID of volume or volumes to delete.') +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='', nargs='+', + help='Name or ID of volume to modify.') +@utils.arg('--state', metavar='', default=None, + help=('The state to assign to the volume. Valid values are ' + '"available", "error", "creating", "deleting", "in-use", ' + '"attaching", "detaching", "error_deleting" and ' + '"maintenance". ' + 'NOTE: This command simply changes the state of the ' + 'Volume in the DataBase with no regard to actual status, ' + 'exercise caution when using. Default=None, that means the ' + 'state is unchanged.')) +@utils.arg('--attach-status', metavar='', default=None, + help=('The attach status to assign to the volume in the DataBase, ' + 'with no regard to the actual status. Valid values are ' + '"attached" and "detached". Default=None, that means the ' + 'status is unchanged.')) +@utils.arg('--reset-migration-status', + action='store_true', + help=('Clears the migration status of the volume in the DataBase ' + 'that indicates the volume is source or destination of ' + 'volume migration, with no regard to the actual status.')) +def do_reset_state(cs, args): + """Explicitly updates the volume state in the Cinder database. + + Note that this does not affect whether the volume is actually attached to + the Nova compute host or instance and can result in an unusable volume. + Being a database change only, this has no impact on the true state of the + volume and may not match the actual state. This can render a volume + unusable in the case of change to the 'available' state. + """ + failure_flag = False + migration_status = 'none' if args.reset_migration_status else None + if not (args.state or args.attach_status or migration_status): + # Nothing specified, default to resetting state + args.state = 'available' + + for volume in args.volume: + try: + utils.find_volume(cs, volume).reset_state(args.state, + args.attach_status, + migration_status) + 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='', + help='Name or ID of volume to rename.') +@utils.arg('name', + nargs='?', + metavar='', + help='New name for volume.') +@utils.arg('--description', metavar='', + help='Volume description. Default=None.', + default=None) +@utils.arg('--display-description', + help=argparse.SUPPRESS) +@utils.arg('--display_description', + help=argparse.SUPPRESS) +def do_rename(cs, args): + """Renames a volume.""" + kwargs = {} + + if args.name is not None: + kwargs['name'] = args.name + if args.display_description is not None: + kwargs['description'] = args.display_description + elif args.description is not None: + kwargs['description'] = args.description + + if not any(kwargs): + msg = 'Must supply either name or description.' + raise exceptions.ClientException(code=1, message=msg) + + utils.find_volume(cs, args.volume).update(**kwargs) + + +@utils.arg('volume', + metavar='', + help='Name or ID of volume for which to update metadata.') +@utils.arg('action', + metavar='', + choices=['set', 'unset'], + help='The action. Valid values are "set" or "unset."') +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='Metadata key and value pair to set or unset. ' + 'For unset, specify only the key.') +def do_metadata(cs, args): + """Sets or deletes volume metadata.""" + volume = utils.find_volume(cs, args.volume) + metadata = shell_utils.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('volume', + metavar='', + help='Name or ID of volume for which to update metadata.') +@utils.arg('action', + metavar='', + choices=['set', 'unset'], + help="The action. Valid values are 'set' or 'unset.'") +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='Metadata key and value pair to set or unset. ' + 'For unset, specify only the key.') +def do_image_metadata(cs, args): + """Sets or deletes volume image metadata.""" + volume = utils.find_volume(cs, args.volume) + metadata = shell_utils.extract_metadata(args) + + if args.action == 'set': + cs.volumes.set_image_metadata(volume, metadata) + elif args.action == 'unset': + cs.volumes.delete_image_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('--name', + metavar='', + default=None, + help='Filters results by a name. Default=None.') +@utils.arg('--display-name', + help=argparse.SUPPRESS) +@utils.arg('--display_name', + help=argparse.SUPPRESS) +@utils.arg('--status', + metavar='', + default=None, + help='Filters results by a status. Default=None.') +@utils.arg('--volume-id', + metavar='', + default=None, + help='Filters results by a volume ID. Default=None.') +@utils.arg('--volume_id', + help=argparse.SUPPRESS) +@utils.arg('--marker', + metavar='', + default=None, + help='Begin returning snapshots that appear later in the snapshot ' + 'list than that represented by this id. ' + 'Default=None.') +@utils.arg('--limit', + metavar='', + default=None, + help='Maximum number of snapshots to return. Default=None.') +@utils.arg('--sort', + metavar='[:]', + default=None, + help=(('Comma-separated list of sort keys and directions in the ' + 'form of [:]. ' + 'Valid keys: %s. ' + 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) +@utils.arg('--tenant', + type=str, + dest='tenant', + nargs='?', + metavar='', + help='Display information from single tenant (Admin only).') +def do_snapshot_list(cs, args): + """Lists all snapshots.""" + all_tenants = (1 if args.tenant else + int(os.environ.get("ALL_TENANTS", args.all_tenants))) + + if args.display_name is not None: + args.name = args.display_name + + search_opts = { + 'all_tenants': all_tenants, + 'name': args.name, + 'status': args.status, + 'volume_id': args.volume_id, + 'project_id': args.tenant, + } + + snapshots = cs.volume_snapshots.list(search_opts=search_opts, + marker=args.marker, + limit=args.limit, + sort=args.sort) + shell_utils.translate_volume_snapshot_keys(snapshots) + if args.sort: + sortby_index = None + else: + sortby_index = 0 + + utils.print_list(snapshots, + ['ID', 'Volume ID', 'Status', 'Name', 'Size'], + sortby_index=sortby_index) + + +@utils.arg('snapshot', + metavar='', + help='Name or ID of snapshot.') +def do_snapshot_show(cs, args): + """Shows snapshot details.""" + snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) + shell_utils.print_volume_snapshot(snapshot) + + +@utils.arg('volume', + metavar='', + help='Name or ID of volume to snapshot.') +@utils.arg('--force', + metavar='', + const=True, + nargs='?', + 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('--name', + metavar='', + default=None, + help='Snapshot name. Default=None.') +@utils.arg('--display-name', + help=argparse.SUPPRESS) +@utils.arg('--display_name', + help=argparse.SUPPRESS) +@utils.arg('--description', + metavar='', + default=None, + help='Snapshot description. Default=None.') +@utils.arg('--display-description', + help=argparse.SUPPRESS) +@utils.arg('--display_description', + help=argparse.SUPPRESS) +@utils.arg('--metadata', + nargs='*', + metavar='', + default=None, + help='Snapshot metadata key and value pairs. Default=None.') +def do_snapshot_create(cs, args): + """Creates a snapshot.""" + if args.display_name is not None: + args.name = args.display_name + + if args.display_description is not None: + args.description = args.display_description + + snapshot_metadata = None + if args.metadata is not None: + snapshot_metadata = shell_utils.extract_metadata(args) + + volume = utils.find_volume(cs, args.volume) + snapshot = cs.volume_snapshots.create(volume.id, + args.force, + args.name, + args.description, + metadata=snapshot_metadata) + shell_utils.print_volume_snapshot(snapshot) + + +@utils.arg('snapshot', + metavar='', nargs='+', + help='Name or ID of the snapshot(s) to delete.') +@utils.arg('--force', + action="store_true", + help='Allows deleting snapshot of a volume ' + 'when its status is other than "available" or "error". ' + 'Default=False.') +def do_snapshot_delete(cs, args): + """Removes one or more snapshots.""" + failure_count = 0 + + for snapshot in args.snapshot: + try: + shell_utils.find_volume_snapshot(cs, snapshot).delete(args.force) + 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='', + help='Name or ID of snapshot.') +@utils.arg('name', nargs='?', metavar='', + help='New name for snapshot.') +@utils.arg('--description', metavar='', + default=None, + help='Snapshot description. Default=None.') +@utils.arg('--display-description', + help=argparse.SUPPRESS) +@utils.arg('--display_description', + help=argparse.SUPPRESS) +def do_snapshot_rename(cs, args): + """Renames a snapshot.""" + kwargs = {} + + if args.name is not None: + kwargs['name'] = args.name + + if args.description is not None: + kwargs['description'] = args.description + elif args.display_description is not None: + kwargs['description'] = args.display_description + + if not any(kwargs): + msg = 'Must supply either name or description.' + raise exceptions.ClientException(code=1, message=msg) + + shell_utils.find_volume_snapshot(cs, args.snapshot).update(**kwargs) + print("Request to rename snapshot '%s' has been accepted." % ( + args.snapshot)) + + +@utils.arg('snapshot', metavar='', nargs='+', + help='Name or ID of snapshot to modify.') +@utils.arg('--state', metavar='', + 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: + shell_utils.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 do_type_list(cs, args): + """Lists available 'volume types'. + + (Only admin and tenant users will see private types) + """ + vtypes = cs.volume_types.list() + shell_utils.print_volume_type_list(vtypes) + + +def do_type_default(cs, args): + """List the default volume type.""" + vtype = cs.volume_types.default() + shell_utils.print_volume_type_list([vtype]) + + +@utils.arg('volume_type', + metavar='', + help='Name or ID of the volume type.') +def do_type_show(cs, args): + """Show volume type details.""" + vtype = shell_utils.find_vtype(cs, args.volume_type) + info = dict() + info.update(vtype._info) + + info.pop('links', None) + utils.print_dict(info, formatters=['extra_specs']) + + +@utils.arg('id', + metavar='', + help='ID of the volume type.') +@utils.arg('--name', + metavar='', + help='Name of the volume type.') +@utils.arg('--description', + metavar='', + help='Description of the volume type.') +@utils.arg('--is-public', + metavar='', + help='Make type accessible to the public or not.') +def do_type_update(cs, args): + """Updates volume type name, description, and/or is_public.""" + is_public = args.is_public + if args.name is None and args.description is None and is_public is None: + raise exceptions.CommandError('Specify a new type name, description, ' + 'is_public or a combination thereof.') + + if is_public is not None: + is_public = strutils.bool_from_string(args.is_public, strict=True) + vtype = cs.volume_types.update(args.id, args.name, args.description, + is_public) + shell_utils.print_volume_type_list([vtype]) + + +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='', + help='Name of new volume type.') +@utils.arg('--description', + metavar='', + help='Description of new volume type.') +@utils.arg('--is-public', + metavar='', + default=True, + help='Make type accessible to the public (default true).') +def do_type_create(cs, args): + """Creates a volume type.""" + is_public = strutils.bool_from_string(args.is_public, strict=True) + vtype = cs.volume_types.create(args.name, args.description, is_public) + shell_utils.print_volume_type_list([vtype]) + + +@utils.arg('vol_type', + metavar='', nargs='+', + help='Name or ID of volume type or types to delete.') +def do_type_delete(cs, args): + """Deletes volume type or types.""" + failure_count = 0 + for vol_type in args.vol_type: + try: + vtype = shell_utils.find_volume_type(cs, vol_type) + cs.volume_types.delete(vtype) + print("Request to delete volume type %s has been accepted." + % (vol_type)) + except Exception as e: + failure_count += 1 + print("Delete for volume type %s failed: %s" % (vol_type, e)) + if failure_count == len(args.vol_type): + raise exceptions.CommandError("Unable to delete any of the " + "specified types.") + + +@utils.arg('vtype', + metavar='', + help='Name or ID of volume type.') +@utils.arg('action', + metavar='', + choices=['set', 'unset'], + help='The action. Valid values are "set" or "unset."') +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='The extra specs key and value pair to set or unset. ' + 'For unset, specify only the key.') +def do_type_key(cs, args): + """Sets or unsets extra_spec for a volume type.""" + vtype = shell_utils.find_volume_type(cs, args.vtype) + keypair = shell_utils.extract_metadata(args) + + if args.action == 'set': + vtype.set_keys(keypair) + elif args.action == 'unset': + vtype.unset_keys(list(keypair)) + + +@utils.arg('--volume-type', metavar='', required=True, + help='Filter results by volume type name or ID.') +def do_type_access_list(cs, args): + """Print access information about the given volume type.""" + volume_type = shell_utils.find_volume_type(cs, args.volume_type) + if volume_type.is_public: + raise exceptions.CommandError("Failed to get access list " + "for public volume type.") + access_list = cs.volume_type_access.list(volume_type) + + columns = ['Volume_type_ID', 'Project_ID'] + utils.print_list(access_list, columns) + + +@utils.arg('--volume-type', metavar='', required=True, + help='Volume type name or ID to add access for the given project.') +@utils.arg('--project-id', metavar='', required=True, + help='Project ID to add volume type access for.') +def do_type_access_add(cs, args): + """Adds volume type access for the given project.""" + vtype = shell_utils.find_volume_type(cs, args.volume_type) + cs.volume_type_access.add_project_access(vtype, args.project_id) + + +@utils.arg('--volume-type', metavar='', required=True, + help=('Volume type name or ID to remove access ' + 'for the given project.')) +@utils.arg('--project-id', metavar='', required=True, + help='Project ID to remove volume type access for.') +def do_type_access_remove(cs, args): + """Removes volume type access for the given project.""" + vtype = shell_utils.find_volume_type(cs, args.volume_type) + cs.volume_type_access.remove_project_access( + vtype, args.project_id) + + +@utils.arg('tenant', + metavar='', + help='ID of tenant for which to list quotas.') +def do_quota_show(cs, args): + """Lists quotas for a tenant.""" + + shell_utils.quota_show(cs.quotas.get(args.tenant)) + + +@utils.arg('tenant', metavar='', + help='ID of tenant for which to list quota usage.') +def do_quota_usage(cs, args): + """Lists quota usage for a tenant.""" + + shell_utils.quota_usage_show(cs.quotas.get(args.tenant, usage=True)) + + +@utils.arg('tenant', + metavar='', + help='ID of tenant for which to list quota defaults.') +def do_quota_defaults(cs, args): + """Lists default quotas for a tenant.""" + + shell_utils.quota_show(cs.quotas.defaults(args.tenant)) + + +@utils.arg('tenant', + metavar='', + help='ID of tenant for which to set quotas.') +@utils.arg('--volumes', + metavar='', + type=int, default=None, + help='The new "volumes" quota value. Default=None.') +@utils.arg('--snapshots', + metavar='', + type=int, default=None, + help='The new "snapshots" quota value. Default=None.') +@utils.arg('--gigabytes', + metavar='', + type=int, default=None, + help='The new "gigabytes" quota value. Default=None.') +@utils.arg('--backups', + metavar='', + type=int, default=None, + help='The new "backups" quota value. Default=None.') +@utils.arg('--backup-gigabytes', + metavar='', + type=int, default=None, + help='The new "backup_gigabytes" quota value. Default=None.') +@utils.arg('--volume-type', + metavar='', + default=None, + help='Volume type. Default=None.') +@utils.arg('--per-volume-gigabytes', + metavar='', + type=int, default=None, + help='Set max volume size limit. Default=None.') +def do_quota_update(cs, args): + """Updates quotas for a tenant.""" + + shell_utils.quota_update(cs.quotas, args.tenant, args) + + +@utils.arg('tenant', metavar='', + 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='', + help='Name of quota class for which to list quotas.') +def do_quota_class_show(cs, args): + """Lists quotas for a quota class.""" + + shell_utils.quota_show(cs.quota_classes.get(args.class_name)) + + +@utils.arg('class_name', + metavar='', + help='Name of quota class for which to set quotas.') +@utils.arg('--volumes', + metavar='', + type=int, default=None, + help='The new "volumes" quota value. Default=None.') +@utils.arg('--snapshots', + metavar='', + type=int, default=None, + help='The new "snapshots" quota value. Default=None.') +@utils.arg('--gigabytes', + metavar='', + type=int, default=None, + help='The new "gigabytes" quota value. Default=None.') +@utils.arg('--backups', + metavar='', + type=int, default=None, + help='The new "backups" quota value. Default=None.') +@utils.arg('--backup-gigabytes', + metavar='', + type=int, default=None, + help='The new "backup_gigabytes" quota value. Default=None.') +@utils.arg('--volume-type', + metavar='', + default=None, + help='Volume type. Default=None.') +@utils.arg('--per-volume-gigabytes', + metavar='', + type=int, default=None, + help='Set max volume size limit. Default=None.') +def do_quota_class_update(cs, args): + """Updates quotas for a quota class.""" + + shell_utils.quota_update(cs.quota_classes, args.class_name, args) + + +@utils.arg('tenant', + metavar='', + nargs='?', + default=None, + help='Display information for a single tenant (Admin only).') +def do_absolute_limits(cs, args): + """Lists absolute limits for a user.""" + limits = cs.limits.get(args.tenant).absolute + columns = ['Name', 'Value'] + utils.print_list(limits, columns) + + +@utils.arg('tenant', + metavar='', + nargs='?', + default=None, + help='Display information for a single tenant (Admin only).') +def do_rate_limits(cs, args): + """Lists rate limits for a user.""" + limits = cs.limits.get(args.tenant).rate + columns = ['Verb', 'URI', 'Value', 'Remain', 'Unit', 'Next_Available'] + utils.print_list(limits, columns) + + +@utils.arg('volume', + metavar='', + help='Name or ID of volume to snapshot.') +@utils.arg('--force', + metavar='', + const=True, + nargs='?', + default=False, + help='Enables or disables upload of ' + 'a volume that is attached to an instance. ' + 'Default=False. ' + 'This option may not be supported by your cloud.') +@utils.arg('--container-format', + metavar='', + default='bare', + help='Container format type. ' + 'Default is bare.') +@utils.arg('--container_format', + help=argparse.SUPPRESS) +@utils.arg('--disk-format', + metavar='', + default='raw', + help='Disk format type. ' + 'Default is raw.') +@utils.arg('--disk_format', + help=argparse.SUPPRESS) +@utils.arg('image_name', + metavar='', + help='The new image name.') +@utils.arg('--image_name', + help=argparse.SUPPRESS) +def do_upload_to_image(cs, args): + """Uploads volume to Image Service as an image.""" + volume = utils.find_volume(cs, args.volume) + shell_utils.print_volume_image( + volume.upload_to_image(args.force, + args.image_name, + args.container_format, + args.disk_format)) + + +@utils.arg('volume', metavar='', help='ID of volume to migrate.') +@utils.arg('host', metavar='', help='Destination host. Takes the form: ' + 'host@backend-name#pool') +@utils.arg('--force-host-copy', metavar='', + choices=['True', 'False'], + required=False, + const=True, + nargs='?', + default=False, + help='Enables or disables generic host-based ' + 'force-migration, which bypasses driver ' + 'optimizations. Default=False.') +@utils.arg('--lock-volume', metavar='', + choices=['True', 'False'], + required=False, + const=True, + nargs='?', + default=False, + help='Enables or disables the termination of volume migration ' + 'caused by other commands. This option applies to the ' + 'available volume. True means it locks the volume ' + 'state and does not allow the migration to be aborted. The ' + 'volume status will be in maintenance during the ' + 'migration. False means it allows the volume migration ' + 'to be aborted. The volume status is still in the original ' + 'status. Default=False.') +def do_migrate(cs, args): + """Migrates volume to a new host.""" + volume = utils.find_volume(cs, args.volume) + try: + volume.migrate_volume(args.host, args.force_host_copy, + args.lock_volume) + print("Request to migrate volume %s has been accepted." % (volume.id)) + except Exception as e: + print("Migration for volume %s failed: %s." % (volume.id, e)) + + +@utils.arg('volume', metavar='', + help='Name or ID of volume for which to modify type.') +@utils.arg('new_type', metavar='', help='New volume type.') +@utils.arg('--migration-policy', metavar='', required=False, + choices=['never', 'on-demand'], default='never', + help='Migration policy during retype of volume.') +def do_retype(cs, args): + """Changes the volume type for a volume.""" + volume = utils.find_volume(cs, args.volume) + volume.retype(args.new_type, args.migration_policy) + + +@utils.arg('volume', metavar='', + help='Name or ID of volume to backup.') +@utils.arg('--container', metavar='', + default=None, + help='Backup container name. Default=None.') +@utils.arg('--display-name', + help=argparse.SUPPRESS) +@utils.arg('--name', metavar='', + default=None, + help='Backup name. Default=None.') +@utils.arg('--display-description', + help=argparse.SUPPRESS) +@utils.arg('--description', + metavar='', + default=None, + help='Backup description. Default=None.') +@utils.arg('--incremental', + action='store_true', + help='Incremental backup. Default=False.', + default=False) +@utils.arg('--force', + action='store_true', + help='Allows or disallows backup of a volume ' + 'when the volume is attached to an instance. ' + 'If set to True, backs up the volume whether ' + 'its status is "available" or "in-use". The backup ' + 'of an "in-use" volume means your data is crash ' + 'consistent. Default=False.', + default=False) +@utils.arg('--snapshot-id', + metavar='', + default=None, + help='ID of snapshot to backup. Default=None.') +def do_backup_create(cs, args): + """Creates a volume backup.""" + if args.display_name is not None: + args.name = args.display_name + + if args.display_description is not None: + args.description = args.display_description + + volume = utils.find_volume(cs, args.volume) + backup = cs.backups.create(volume.id, + args.container, + args.name, + args.description, + args.incremental, + args.force, + args.snapshot_id) + + info = {"volume_id": volume.id} + info.update(backup._info) + + if 'links' in info: + info.pop('links') + + utils.print_dict(info) + + +@utils.arg('backup', metavar='', help='Name or ID of backup.') +def do_backup_show(cs, args): + """Shows backup details.""" + backup = shell_utils.find_backup(cs, args.backup) + info = dict() + info.update(backup._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('--all-tenants', + metavar='', + 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('--name', + metavar='', + default=None, + help='Filters results by a name. Default=None.') +@utils.arg('--status', + metavar='', + default=None, + help='Filters results by a status. Default=None.') +@utils.arg('--volume-id', + metavar='', + default=None, + help='Filters results by a volume ID. Default=None.') +@utils.arg('--volume_id', + help=argparse.SUPPRESS) +@utils.arg('--marker', + metavar='', + default=None, + help='Begin returning backups that appear later in the backup ' + 'list than that represented by this id. ' + 'Default=None.') +@utils.arg('--limit', + metavar='', + default=None, + help='Maximum number of backups to return. Default=None.') +@utils.arg('--sort', + metavar='[:]', + default=None, + help=(('Comma-separated list of sort keys and directions in the ' + 'form of [:]. ' + 'Valid keys: %s. ' + 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) +def do_backup_list(cs, args): + """Lists all backups.""" + + search_opts = { + 'all_tenants': args.all_tenants, + 'name': args.name, + 'status': args.status, + 'volume_id': args.volume_id, + } + + backups = cs.backups.list(search_opts=search_opts, + marker=args.marker, + limit=args.limit, + sort=args.sort) + shell_utils.translate_volume_snapshot_keys(backups) + columns = ['ID', 'Volume ID', 'Status', 'Name', 'Size', 'Object Count', + 'Container'] + if args.sort: + sortby_index = None + else: + sortby_index = 0 + utils.print_list(backups, columns, sortby_index=sortby_index) + + +@utils.arg('--force', + action="store_true", + help='Allows deleting backup of a volume ' + 'when its status is other than "available" or "error". ' + 'Default=False.') +@utils.arg('backup', metavar='', nargs='+', + help='Name or ID of backup(s) to delete.') +def do_backup_delete(cs, args): + """Removes one or more backups.""" + failure_count = 0 + for backup in args.backup: + try: + shell_utils.find_backup(cs, backup).delete(args.force) + print("Request to delete backup %s has been accepted." % (backup)) + except Exception as e: + failure_count += 1 + print("Delete for backup %s failed: %s" % (backup, e)) + if failure_count == len(args.backup): + raise exceptions.CommandError("Unable to delete any of the specified " + "backups.") + + +@utils.arg('backup', metavar='', + help='Name or ID of backup to restore.') +@utils.arg('--volume-id', metavar='', + default=None, + help=argparse.SUPPRESS) +@utils.arg('--volume', metavar='', + default=None, + help='Name or ID of existing volume to which to restore. ' + 'This is mutually exclusive with --name and takes priority. ' + 'Default=None.') +@utils.arg('--name', metavar='', + default=None, + help='Use the name for new volume creation to restore. ' + 'This is mutually exclusive with --volume (or the deprecated ' + '--volume-id) and --volume (or --volume-id) takes priority. ' + 'Default=None.') +def do_backup_restore(cs, args): + """Restores a backup.""" + vol = args.volume or args.volume_id + if vol: + volume_id = utils.find_volume(cs, vol).id + if args.name: + args.name = None + print('Mutually exclusive options are specified simultaneously: ' + '"--volume (or the deprecated --volume-id) and --name". ' + 'The --volume (or --volume-id) option takes priority.') + else: + volume_id = None + + backup = shell_utils.find_backup(cs, args.backup) + restore = cs.restores.restore(backup.id, volume_id, args.name) + + info = {"backup_id": backup.id} + info.update(restore._info) + + info.pop('links', None) + + utils.print_dict(info) + + +@utils.arg('backup', metavar='', + help='ID of the backup to export.') +def do_backup_export(cs, args): + """Export backup metadata record.""" + info = cs.backups.export_record(args.backup) + utils.print_dict(info) + + +@utils.arg('backup_service', metavar='', + help='Backup service to use for importing the backup.') +@utils.arg('backup_url', metavar='', + help='Backup URL for importing the backup metadata.') +def do_backup_import(cs, args): + """Import backup metadata record.""" + info = cs.backups.import_record(args.backup_service, args.backup_url) + info.pop('links', None) + + utils.print_dict(info) + + +@utils.arg('backup', metavar='', nargs='+', + help='Name or ID of the backup to modify.') +@utils.arg('--state', metavar='', + default='available', + help='The state to assign to the backup. Valid values are ' + '"available", "error". Default=available.') +def do_backup_reset_state(cs, args): + """Explicitly updates the backup state.""" + failure_count = 0 + + single = (len(args.backup) == 1) + + for backup in args.backup: + try: + shell_utils.find_backup(cs, backup).reset_state(args.state) + print("Request to update backup '%s' has been accepted." % backup) + except Exception as e: + failure_count += 1 + msg = "Reset state for backup %s failed: %s" % (backup, e) + if not single: + print(msg) + + if failure_count == len(args.backup): + if not single: + msg = ("Unable to reset the state for any of the specified " + "backups.") + raise exceptions.CommandError(msg) + + +@utils.arg('volume', metavar='', + help='Name or ID of volume to transfer.') +@utils.arg('--name', + metavar='', + default=None, + help='Transfer name. Default=None.') +@utils.arg('--display-name', + help=argparse.SUPPRESS) +def do_transfer_create(cs, args): + """Creates a volume transfer.""" + if args.display_name is not None: + args.name = args.display_name + + volume = utils.find_volume(cs, args.volume) + transfer = cs.transfers.create(volume.id, + args.name) + info = dict() + info.update(transfer._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('transfer', metavar='', + help='Name or ID of transfer to delete.') +def do_transfer_delete(cs, args): + """Undoes a transfer.""" + transfer = shell_utils.find_transfer(cs, args.transfer) + transfer.delete() + + +@utils.arg('transfer', metavar='', + help='ID of transfer to accept.') +@utils.arg('auth_key', metavar='', + 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) + + info.pop('links', None) + 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='', + help='Name or ID of transfer to accept.') +def do_transfer_show(cs, args): + """Shows transfer details.""" + transfer = shell_utils.find_transfer(cs, args.transfer) + info = dict() + info.update(transfer._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('volume', metavar='', + help='Name or ID of volume to extend.') +@utils.arg('new_size', + metavar='', + type=int, + help='New 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='', default=None, + help='Host name. Default=None.') +@utils.arg('--binary', metavar='', default=None, + help='Service binary. Default=None.') +@utils.arg('--withreplication', + metavar='', + const=True, + nargs='?', + default=False, + help='Enables or disables display of ' + 'Replication info for c-vol services. Default=False.') +def do_service_list(cs, args): + """Lists all services. Filter by host and service binary.""" + replication = strutils.bool_from_string(args.withreplication, + strict=True) + result = cs.services.list(host=args.host, binary=args.binary) + columns = ["Binary", "Host", "Zone", "Status", "State", "Updated_at"] + if replication: + columns.extend(["Replication Status", "Active Backend ID", "Frozen"]) + # 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='', help='Host name.') +@utils.arg('binary', metavar='', 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='', help='Host name.') +@utils.arg('binary', metavar='', help='Service binary.') +@utils.arg('--reason', metavar='', + 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) + shell_utils.translate_availability_zone_keys(result) + utils.print_list(result, ['Name', 'Status']) + + +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='', + type=str, + help='Name or ID of volume type.') +def do_encryption_type_show(cs, args): + """Shows encryption type details for a volume type. Admin only.""" + volume_type = shell_utils.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'): + shell_utils.print_volume_encryption_type_list([result]) + else: + shell_utils.print_volume_encryption_type_list([]) + + +@utils.arg('volume_type', + metavar='', + type=str, + help='Name or ID of volume type.') +@utils.arg('provider', + metavar='', + type=str, + help='The encryption provider format. ' + 'For example, "luks" or "plain".') +@utils.arg('--cipher', + metavar='', + type=str, + required=False, + default=None, + help='The encryption algorithm or mode. ' + 'For example, aes-xts-plain64. Default=None.') +@utils.arg('--key-size', + metavar='', + type=int, + required=False, + default=None, + help='Size of encryption key, in bits. ' + 'For example, 128 or 256. Default=None.') +@utils.arg('--key_size', + type=int, + required=False, + default=None, + help=argparse.SUPPRESS) +@utils.arg('--control-location', + metavar='', + 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".') +@utils.arg('--control_location', + type=str, + required=False, + default='front-end', + help=argparse.SUPPRESS) +def do_encryption_type_create(cs, args): + """Creates encryption type for a volume type. Admin only.""" + volume_type = shell_utils.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) + shell_utils.print_volume_encryption_type_list([result]) + + +@utils.arg('volume_type', + metavar='', + type=str, + help="Name or ID of the volume type") +@utils.arg('--provider', + metavar='', + type=str, + required=False, + default=argparse.SUPPRESS, + help="Encryption provider format (e.g. 'luks' or 'plain').") +@utils.arg('--cipher', + metavar='', + type=str, + nargs='?', + required=False, + default=argparse.SUPPRESS, + const=None, + help="Encryption algorithm/mode to use (e.g., aes-xts-plain64). " + "Provide parameter without value to set to provider default.") +@utils.arg('--key-size', + dest='key_size', + metavar='', + type=int, + nargs='?', + required=False, + default=argparse.SUPPRESS, + const=None, + help="Size of the encryption key, in bits (e.g., 128, 256). " + "Provide parameter without value to set to provider default. ") +@utils.arg('--control-location', + dest='control_location', + metavar='', + choices=['front-end', 'back-end'], + type=str, + required=False, + default=argparse.SUPPRESS, + help="Notional service where encryption is performed (e.g., " + "front-end=Nova). Values: 'front-end', 'back-end'") +def do_encryption_type_update(cs, args): + """Update encryption type information for a volume type (Admin Only).""" + volume_type = shell_utils.find_volume_type(cs, args.volume_type) + + # An argument should only be pulled if the user specified the parameter. + body = {} + for attr in ['provider', 'cipher', 'key_size', 'control_location']: + if hasattr(args, attr): + body[attr] = getattr(args, attr) + + cs.volume_encryption_types.update(volume_type, body) + result = cs.volume_encryption_types.get(volume_type) + shell_utils.print_volume_encryption_type_list([result]) + + +@utils.arg('volume_type', + metavar='', + 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 = shell_utils.find_volume_type(cs, args.volume_type) + cs.volume_encryption_types.delete(volume_type) + + +@utils.arg('name', + metavar='', + help='Name of new QoS specifications.') +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='QoS specifications.') +def do_qos_create(cs, args): + """Creates a qos specs.""" + keypair = None + if args.metadata is not None: + keypair = shell_utils.extract_metadata(args) + qos_specs = cs.qos_specs.create(args.name, keypair) + shell_utils.print_qos_specs(qos_specs) + + +def do_qos_list(cs, args): + """Lists qos specs.""" + qos_specs = cs.qos_specs.list() + shell_utils.print_qos_specs_list(qos_specs) + + +@utils.arg('qos_specs', metavar='', + help='ID of QoS specifications to show.') +def do_qos_show(cs, args): + """Shows qos specs details.""" + qos_specs = shell_utils.find_qos_specs(cs, args.qos_specs) + shell_utils.print_qos_specs(qos_specs) + + +@utils.arg('qos_specs', metavar='', + help='ID of QoS specifications to delete.') +@utils.arg('--force', + metavar='', + const=True, + nargs='?', + 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 = shell_utils.find_qos_specs(cs, args.qos_specs) + cs.qos_specs.delete(qos_specs, force) + + +@utils.arg('qos_specs', metavar='', + help='ID of QoS specifications.') +@utils.arg('vol_type_id', metavar='', + help='ID of volume type with which to associate ' + 'QoS specifications.') +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='', + help='ID of QoS specifications.') +@utils.arg('vol_type_id', metavar='', + help='ID of volume type with which to associate ' + 'QoS specifications.') +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='', + help='ID of QoS specifications on which to operate.') +def do_qos_disassociate_all(cs, args): + """Disassociates qos specs from all its associations.""" + cs.qos_specs.disassociate_all(args.qos_specs) + + +@utils.arg('qos_specs', metavar='', + help='ID of QoS specifications.') +@utils.arg('action', + metavar='', + 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 = shell_utils.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='', + help='ID of QoS specifications.') +def do_qos_get_association(cs, args): + """Lists all associations for specified qos specs.""" + associations = cs.qos_specs.get_associations(args.qos_specs) + shell_utils.print_associations_list(associations) + + +@utils.arg('snapshot', + metavar='', + help='ID of snapshot for which to update metadata.') +@utils.arg('action', + metavar='', + choices=['set', 'unset'], + help='The action. Valid values are "set" or "unset."') +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='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 = shell_utils.find_volume_snapshot(cs, args.snapshot) + metadata = shell_utils.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='', + help='ID of snapshot.') +def do_snapshot_metadata_show(cs, args): + """Shows snapshot metadata.""" + snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) + utils.print_dict(snapshot._info['metadata'], 'Metadata-property') + + +@utils.arg('volume', metavar='', + 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='', + help='ID of volume.') +def do_image_metadata_show(cs, args): + """Shows volume image metadata.""" + volume = utils.find_volume(cs, args.volume) + resp, body = volume.show_image_metadata(volume) + utils.print_dict(body['metadata'], 'Metadata-property') + + +@utils.arg('volume', + metavar='', + help='ID of volume for which to update metadata.') +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='Metadata key and value pair or pairs to update.') +def do_metadata_update_all(cs, args): + """Updates volume metadata.""" + volume = utils.find_volume(cs, args.volume) + metadata = shell_utils.extract_metadata(args) + metadata = volume.update_all_metadata(metadata) + utils.print_dict(metadata['metadata'], 'Metadata-property') + + +@utils.arg('snapshot', + metavar='', + help='ID of snapshot for which to update metadata.') +@utils.arg('metadata', + metavar='', + nargs='+', + default=[], + help='Metadata key and value pair to update.') +def do_snapshot_metadata_update_all(cs, args): + """Updates snapshot metadata.""" + snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) + metadata = shell_utils.extract_metadata(args) + metadata = snapshot.update_all_metadata(metadata) + utils.print_dict(metadata) + + +@utils.arg('volume', metavar='', help='ID of volume to update.') +@utils.arg('read_only', + metavar='', + 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='', help='ID of the volume to update.') +@utils.arg('bootable', + metavar='', + 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)) + + +@utils.arg('host', + metavar='', + help='Cinder host on which the existing volume resides; ' + 'takes the form: host@backend-name#pool') +@utils.arg('identifier', + metavar='', + help='Name or other Identifier for existing volume') +@utils.arg('--id-type', + metavar='', + default='source-name', + help='Type of backend device identifier provided, ' + 'typically source-name or source-id (Default=source-name)') +@utils.arg('--name', + metavar='', + help='Volume name (Default=None)') +@utils.arg('--description', + metavar='', + help='Volume description (Default=None)') +@utils.arg('--volume-type', + metavar='', + help='Volume type (Default=None)') +@utils.arg('--availability-zone', + metavar='', + help='Availability zone for volume (Default=None)') +@utils.arg('--metadata', + nargs='*', + metavar='', + help='Metadata key=value pairs (Default=None)') +@utils.arg('--bootable', + action='store_true', + help='Specifies that the newly created volume should be' + ' marked as bootable') +def do_manage(cs, args): + """Manage an existing volume.""" + volume_metadata = None + if args.metadata is not None: + volume_metadata = shell_utils.extract_metadata(args) + + # Build a dictionary of key/value pairs to pass to the API. + ref_dict = {args.id_type: args.identifier} + + # The recommended way to specify an existing volume is by ID or name, and + # have the Cinder driver look for 'source-name' or 'source-id' elements in + # the ref structure. To make things easier for the user, we have special + # --source-name and --source-id CLI options that add the appropriate + # element to the ref structure. + # + # Note how argparse converts hyphens to underscores. We use hyphens in the + # dictionary so that it is consistent with what the user specified on the + # CLI. + + if hasattr(args, 'source_name') and args.source_name is not None: + ref_dict['source-name'] = args.source_name + if hasattr(args, 'source_id') and args.source_id is not None: + ref_dict['source-id'] = args.source_id + + volume = cs.volumes.manage(host=args.host, + ref=ref_dict, + name=args.name, + description=args.description, + volume_type=args.volume_type, + availability_zone=args.availability_zone, + metadata=volume_metadata, + bootable=args.bootable) + + info = {} + volume = cs.volumes.get(volume.id) + info.update(volume._info) + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('volume', metavar='', + help='Name or ID of the volume to unmanage.') +def do_unmanage(cs, args): + """Stop managing a volume.""" + volume = utils.find_volume(cs, args.volume) + cs.volumes.unmanage(volume.id) + + +@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.') +def do_consisgroup_list(cs, args): + """Lists all consistency groups.""" + consistencygroups = cs.consistencygroups.list() + + columns = ['ID', 'Status', 'Name'] + utils.print_list(consistencygroups, columns) + + +@utils.arg('consistencygroup', + metavar='', + help='Name or ID of a consistency group.') +def do_consisgroup_show(cs, args): + """Shows details of a consistency group.""" + info = dict() + consistencygroup = shell_utils.find_consistencygroup(cs, + args.consistencygroup) + info.update(consistencygroup._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('volumetypes', + metavar='', + help='Volume types.') +@utils.arg('--name', + metavar='', + help='Name of a consistency group.') +@utils.arg('--description', + metavar='', + default=None, + help='Description of a consistency group. Default=None.') +@utils.arg('--availability-zone', + metavar='', + default=None, + help='Availability zone for volume. Default=None.') +def do_consisgroup_create(cs, args): + """Creates a consistency group.""" + + consistencygroup = cs.consistencygroups.create( + args.volumetypes, + args.name, + args.description, + availability_zone=args.availability_zone) + + info = dict() + consistencygroup = cs.consistencygroups.get(consistencygroup.id) + info.update(consistencygroup._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('--cgsnapshot', + metavar='', + help='Name or ID of a cgsnapshot. Default=None.') +@utils.arg('--source-cg', + metavar='', + help='Name or ID of a source CG. Default=None.') +@utils.arg('--name', + metavar='', + help='Name of a consistency group. Default=None.') +@utils.arg('--description', + metavar='', + help='Description of a consistency group. Default=None.') +def do_consisgroup_create_from_src(cs, args): + """Creates a consistency group from a cgsnapshot or a source CG.""" + if not args.cgsnapshot and not args.source_cg: + msg = ('Cannot create consistency group because neither ' + 'cgsnapshot nor source CG is provided.') + raise exceptions.ClientException(code=1, message=msg) + if args.cgsnapshot and args.source_cg: + msg = ('Cannot create consistency group because both ' + 'cgsnapshot and source CG are provided.') + raise exceptions.ClientException(code=1, message=msg) + cgsnapshot = None + if args.cgsnapshot: + cgsnapshot = shell_utils.find_cgsnapshot(cs, args.cgsnapshot) + source_cg = None + if args.source_cg: + source_cg = shell_utils.find_consistencygroup(cs, args.source_cg) + info = cs.consistencygroups.create_from_src( + cgsnapshot.id if cgsnapshot else None, + source_cg.id if source_cg else None, + args.name, + args.description) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('consistencygroup', + metavar='', nargs='+', + help='Name or ID of one or more consistency groups ' + 'to be deleted.') +@utils.arg('--force', + action='store_true', + default=False, + help='Allows or disallows consistency groups ' + 'to be deleted. If the consistency group is empty, ' + 'it can be deleted without the force flag. ' + 'If the consistency group is not empty, the force ' + 'flag is required for it to be deleted.') +def do_consisgroup_delete(cs, args): + """Removes one or more consistency groups.""" + failure_count = 0 + for consistencygroup in args.consistencygroup: + try: + shell_utils.find_consistencygroup( + cs, consistencygroup).delete(args.force) + except Exception as e: + failure_count += 1 + print("Delete for consistency group %s failed: %s" % + (consistencygroup, e)) + if failure_count == len(args.consistencygroup): + raise exceptions.CommandError("Unable to delete any of the specified " + "consistency groups.") + + +@utils.arg('consistencygroup', + metavar='', + help='Name or ID of a consistency group.') +@utils.arg('--name', metavar='', + help='New name for consistency group. Default=None.') +@utils.arg('--description', metavar='', + help='New description for consistency group. Default=None.') +@utils.arg('--add-volumes', + metavar='', + help='UUID of one or more volumes ' + 'to be added to the consistency group, ' + 'separated by commas. Default=None.') +@utils.arg('--remove-volumes', + metavar='', + help='UUID of one or more volumes ' + 'to be removed from the consistency group, ' + 'separated by commas. Default=None.') +def do_consisgroup_update(cs, args): + """Updates a consistency group.""" + kwargs = {} + + if args.name is not None: + kwargs['name'] = args.name + + if args.description is not None: + kwargs['description'] = args.description + + if args.add_volumes is not None: + kwargs['add_volumes'] = args.add_volumes + + if args.remove_volumes is not None: + kwargs['remove_volumes'] = args.remove_volumes + + if not kwargs: + msg = ('At least one of the following args must be supplied: ' + 'name, description, add-volumes, remove-volumes.') + raise exceptions.ClientException(code=1, message=msg) + + shell_utils.find_consistencygroup( + cs, args.consistencygroup).update(**kwargs) + print("Request to update consistency group '%s' has been accepted." % ( + args.consistencygroup)) + + +@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('--status', + metavar='', + default=None, + help='Filters results by a status. Default=None.') +@utils.arg('--consistencygroup-id', + metavar='', + default=None, + help='Filters results by a consistency group ID. Default=None.') +def do_cgsnapshot_list(cs, args): + """Lists all cgsnapshots.""" + + all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants)) + + search_opts = { + 'all_tenants': all_tenants, + 'status': args.status, + 'consistencygroup_id': args.consistencygroup_id, + } + + cgsnapshots = cs.cgsnapshots.list(search_opts=search_opts) + + columns = ['ID', 'Status', 'Name'] + utils.print_list(cgsnapshots, columns) + + +@utils.arg('cgsnapshot', + metavar='', + help='Name or ID of cgsnapshot.') +def do_cgsnapshot_show(cs, args): + """Shows cgsnapshot details.""" + info = dict() + cgsnapshot = shell_utils.find_cgsnapshot(cs, args.cgsnapshot) + info.update(cgsnapshot._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('consistencygroup', + metavar='', + help='Name or ID of a consistency group.') +@utils.arg('--name', + metavar='', + default=None, + help='Cgsnapshot name. Default=None.') +@utils.arg('--description', + metavar='', + default=None, + help='Cgsnapshot description. Default=None.') +def do_cgsnapshot_create(cs, args): + """Creates a cgsnapshot.""" + consistencygroup = shell_utils.find_consistencygroup(cs, + args.consistencygroup) + cgsnapshot = cs.cgsnapshots.create( + consistencygroup.id, + args.name, + args.description) + + info = dict() + cgsnapshot = cs.cgsnapshots.get(cgsnapshot.id) + info.update(cgsnapshot._info) + + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('cgsnapshot', + metavar='', nargs='+', + help='Name or ID of one or more cgsnapshots to be deleted.') +def do_cgsnapshot_delete(cs, args): + """Removes one or more cgsnapshots.""" + failure_count = 0 + for cgsnapshot in args.cgsnapshot: + try: + shell_utils.find_cgsnapshot(cs, cgsnapshot).delete() + except Exception as e: + failure_count += 1 + print("Delete for cgsnapshot %s failed: %s" % (cgsnapshot, e)) + if failure_count == len(args.cgsnapshot): + raise exceptions.CommandError("Unable to delete any of the specified " + "cgsnapshots.") + + +@utils.arg('--detail', + action='store_true', + help='Show detailed information about pools.') +def do_get_pools(cs, args): + """Show pool information for backends. Admin only.""" + pools = cs.volumes.get_pools(args.detail) + infos = dict() + infos.update(pools._info) + + for info in infos['pools']: + backend = dict() + backend['name'] = info['name'] + if args.detail: + backend.update(info['capabilities']) + utils.print_dict(backend) + + +@utils.arg('host', + metavar='', + help='Cinder host to show backend volume stats and properties; ' + 'takes the form: host@backend-name') +def do_get_capabilities(cs, args): + """Show backend volume stats and properties. Admin only.""" + + capabilities = cs.capabilities.get(args.host) + infos = dict() + infos.update(capabilities._info) + + prop = infos.pop('properties', None) + utils.print_dict(infos, "Volume stats") + utils.print_dict(prop, "Backend properties", + formatters=sorted(prop.keys())) + + +@utils.arg('volume', + metavar='', + help='Cinder volume that already exists in the volume backend.') +@utils.arg('identifier', + metavar='', + help='Name or other identifier for existing snapshot. This is ' + 'backend specific.') +@utils.arg('--id-type', + metavar='', + default='source-name', + help='Type of backend device identifier provided, ' + 'typically source-name or source-id (Default=source-name).') +@utils.arg('--name', + metavar='', + help='Snapshot name (Default=None).') +@utils.arg('--description', + metavar='', + help='Snapshot description (Default=None).') +@utils.arg('--metadata', + nargs='*', + metavar='', + help='Metadata key=value pairs (Default=None).') +def do_snapshot_manage(cs, args): + """Manage an existing snapshot.""" + snapshot_metadata = None + if args.metadata is not None: + snapshot_metadata = shell_utils.extract_metadata(args) + + # Build a dictionary of key/value pairs to pass to the API. + ref_dict = {args.id_type: args.identifier} + + if hasattr(args, 'source_name') and args.source_name is not None: + ref_dict['source-name'] = args.source_name + if hasattr(args, 'source_id') and args.source_id is not None: + ref_dict['source-id'] = args.source_id + + volume = utils.find_volume(cs, args.volume) + snapshot = cs.volume_snapshots.manage(volume_id=volume.id, + ref=ref_dict, + name=args.name, + description=args.description, + metadata=snapshot_metadata) + + info = {} + snapshot = cs.volume_snapshots.get(snapshot.id) + info.update(snapshot._info) + info.pop('links', None) + utils.print_dict(info) + + +@utils.arg('snapshot', metavar='', + help='Name or ID of the snapshot to unmanage.') +def do_snapshot_unmanage(cs, args): + """Stop managing a snapshot.""" + snapshot = shell_utils.find_volume_snapshot(cs, args.snapshot) + cs.volume_snapshots.unmanage(snapshot.id) + + +@utils.arg('host', metavar='', help='Host name.') +def do_freeze_host(cs, args): + """Freeze and disable the specified cinder-volume host.""" + cs.services.freeze_host(args.host) + + +@utils.arg('host', metavar='', help='Host name.') +def do_thaw_host(cs, args): + """Thaw and enable the specified cinder-volume host.""" + cs.services.thaw_host(args.host) + + +@utils.arg('host', metavar='', help='Host name.') +@utils.arg('--backend_id', + metavar='', + help='ID of backend to failover to (Default=None)') +def do_failover_host(cs, args): + """Failover a replicating cinder-volume host.""" + cs.services.failover_host(args.host, args.backend_id) + + +@utils.arg('host', + metavar='', + help='Cinder host on which to list manageable volumes; ' + 'takes the form: host@backend-name#pool') +@utils.arg('--detailed', + metavar='', + default=True, + help='Returned detailed information (default true).') +@utils.arg('--marker', + metavar='', + default=None, + help='Begin returning volumes that appear later in the volume ' + 'list than that represented by this volume id. ' + 'Default=None.') +@utils.arg('--limit', + metavar='', + default=None, + help='Maximum number of volumes to return. Default=None.') +@utils.arg('--offset', + metavar='', + default=None, + help='Number of volumes to skip after marker. Default=None.') +@utils.arg('--sort', + metavar='[:]', + default=None, + help=(('Comma-separated list of sort keys and directions in the ' + 'form of [:]. ' + 'Valid keys: %s. ' + 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) +def do_manageable_list(cs, args): + """Lists all manageable volumes.""" + detailed = strutils.bool_from_string(args.detailed) + volumes = cs.volumes.list_manageable(host=args.host, detailed=detailed, + marker=args.marker, limit=args.limit, + offset=args.offset, sort=args.sort) + columns = ['reference', 'size', 'safe_to_manage'] + if detailed: + columns.extend(['reason_not_safe', 'cinder_id', 'extra_info']) + utils.print_list(volumes, columns, sortby_index=None) + + +@utils.arg('host', + metavar='', + help='Cinder host on which to list manageable snapshots; ' + 'takes the form: host@backend-name#pool') +@utils.arg('--detailed', + metavar='', + default=True, + help='Returned detailed information (default true).') +@utils.arg('--marker', + metavar='', + default=None, + help='Begin returning snapshots that appear later in the snapshot ' + 'list than that represented by this snapshot id. ' + 'Default=None.') +@utils.arg('--limit', + metavar='', + default=None, + help='Maximum number of snapshots to return. Default=None.') +@utils.arg('--offset', + metavar='', + default=None, + help='Number of snapshots to skip after marker. Default=None.') +@utils.arg('--sort', + metavar='[:]', + default=None, + help=(('Comma-separated list of sort keys and directions in the ' + 'form of [:]. ' + 'Valid keys: %s. ' + 'Default=None.') % ', '.join(base.SORT_KEY_VALUES))) +def do_snapshot_manageable_list(cs, args): + """Lists all manageable snapshots.""" + detailed = strutils.bool_from_string(args.detailed) + snapshots = cs.volume_snapshots.list_manageable(host=args.host, + detailed=detailed, + marker=args.marker, + limit=args.limit, + offset=args.offset, + sort=args.sort) + columns = ['reference', 'size', 'safe_to_manage', 'source_reference'] + if detailed: + columns.extend(['reason_not_safe', 'cinder_id', 'extra_info']) + utils.print_list(snapshots, columns, sortby_index=None) -- cgit v1.2.1