openstack/python-cinderclient
Code Issues Proposed changes

cinder list now supports filter by tenant

Browse Source 
Admin can now filter volumes on the basis of tenant.
Also updated help argument, to be consistent over the
v1 and v2 shell module.

Closes-Bug: #1341411
Change-Id: I647f0c9331ee4cd27acbfada6cdb9a56f80701b4
This commit is contained in:
yatin karel
2015-04-12 16:53:35 +05:30
parent de36755657
commit fa8c7e3d84
5 changed files with 186 additions and 145 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
cinderclient/tests/unit/v1/test_shell.py
View File

@@ -112,6 +112,16 @@ class ShellTest(utils.TestCase):
# 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 --tenant=123 --all-tenants 1')
self.assert_called('GET',
'/volumes/detail?all_tenants=1&project_id=123')
def test_list_filter_tenant_without_all_tenants(self):
self.run_command('list --tenant=123')
self.assert_called('GET',
'/volumes/detail?all_tenants=1&project_id=123')
def test_metadata_args_with_limiter(self):
self.run_command('create --metadata key1="--test1" 1')
expected = {'volume': {'snapshot_id': None,

10
cinderclient/tests/unit/v2/test_shell.py
View File

@@ -85,6 +85,16 @@ class ShellTest(utils.TestCase):
# 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')

87
cinderclient/v1/shell.py
View File

@@ -160,15 +160,24 @@ def _extract_metadata(args):
type=str,
nargs='*',
metavar='<key=value>',
default=None,
help='Filters list by metadata key and value pair. '
'Default=None.',
default=None)
'Default=None.')
@utils.arg(
'--tenant',
type=str,
dest='tenant',
nargs='?',
metavar='<tenant>',
help='Display information from single tenant (Admin only).')
@utils.service_type('volume')
def do_list(cs, args):
"""Lists all volumes."""
all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants))
all_tenants = 1 if args.tenant else \
int(os.environ.get("ALL_TENANTS", args.all_tenants))
search_opts = {
'all_tenants': all_tenants,
'project_id': args.tenant,
'display_name': args.display_name,
'status': args.status,
'metadata': _extract_metadata(args) if args.metadata else None,
@@ -268,9 +277,9 @@ def do_show(cs, args):
type=str,
nargs='*',
metavar='<key=value>',
default=None,
help='Metadata key and value pairs. '
'Default=None.',
default=None)
'Default=None.')
@utils.service_type('volume')
def do_create(cs, args):
"""Creates a volume."""
@@ -360,8 +369,7 @@ def do_reset_state(cs, args):
@utils.arg('display_name', nargs='?', metavar='<display-name>',
help='New display name for volume.')
@utils.arg('--display-description', metavar='<display-description>',
help='Volume description. Default=None.',
default=None)
default=None, help='Volume description. Default=None.')
@utils.service_type('volume')
def do_rename(cs, args):
"""Renames a volume."""
@@ -384,7 +392,7 @@ def do_rename(cs, args):
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',
@@ -467,13 +475,13 @@ def do_snapshot_show(cs, args):
help='Name or ID of volume to snapshot.')
@utils.arg('--force',
metavar='<True|False>',
default=False,
help='Allows or disallows snapshot of '
'a volume when the volume is attached to an instance. '
'If set to True, ignores the current status of the '
'volume when attempting to snapshot it rather '
'than forcing it to be available. '
'Default=False.',
default=False)
'Default=False.')
@utils.arg(
'--display-name',
metavar='<display-name>',
@@ -524,8 +532,7 @@ def do_snapshot_delete(cs, args):
@utils.arg('display_name', nargs='?', metavar='<display-name>',
help='New display name for snapshot.')
@utils.arg('--display-description', metavar='<display-description>',
help='Snapshot description. Default=None.',
default=None)
default=None, help='Snapshot description. Default=None.')
@utils.service_type('volume')
def do_snapshot_rename(cs, args):
"""Renames a snapshot."""
@@ -594,7 +601,7 @@ def do_extra_specs_list(cs, args):
@utils.arg('name',
metavar='<name>',
help="Name for the volume type.")
help='Name for the volume type.')
@utils.service_type('volume')
def do_type_create(cs, args):
"""Creates a volume type."""
@@ -604,7 +611,7 @@ def do_type_create(cs, args):
@utils.arg('id',
metavar='<id>',
help="ID of volume type to delete.")
help='ID of volume type to delete.')
@utils.service_type('volume')
def do_type_delete(cs, args):
"""Deletes a specified volume type."""
@@ -614,11 +621,11 @@ def do_type_delete(cs, args):
@utils.arg('vtype',
metavar='<vtype>',
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata',
metavar='<key=value>',
nargs='*',
@@ -829,20 +836,20 @@ def _find_volume_type(cs, vtype):
help='Name or ID of volume to upload to an image.')
@utils.arg('--force',
metavar='<True|False>',
default=False,
help='Enables or disables upload of '
'a volume that is attached to an instance. '
'Default=False.',
default=False)
'Default=False.')
@utils.arg('--container-format',
metavar='<container-format>',
default='bare',
help='Container format type. '
'Default is bare.',
default='bare')
'Default is bare.')
@utils.arg('--disk-format',
metavar='<disk-format>',
default='raw',
help='Disk format type. '
'Default is raw.',
default='raw')
'Default is raw.')
@utils.arg('image_name',
metavar='<image-name>',
help='The new image name.')
@@ -859,14 +866,14 @@ def do_upload_to_image(cs, args):
@utils.arg('volume', metavar='<volume>',
help='Name or ID of volume to back up.')
@utils.arg('--container', metavar='<container>',
help='Backup container name. Default=None.',
default=None)
default=None,
help='Backup container name. Default=None.')
@utils.arg('--display-name', metavar='<display-name>',
help='Backup name. Default=None.',
default=None)
default=None,
help='Backup name. Default=None.')
@utils.arg('--display-description', metavar='<display-description>',
help='Backup description. Default=None.',
default=None)
default=None,
help='Backup description. Default=None.')
@utils.service_type('volume')
def do_backup_create(cs, args):
"""Creates a volume backup."""
@@ -920,9 +927,9 @@ def do_backup_delete(cs, args):
@utils.arg('backup', metavar='<backup>',
help='ID of backup to restore.')
@utils.arg('--volume-id', metavar='<volume>',
default=None,
help='ID or name of backup volume to '
'which to restore. Default=None.',
default=None)
'which to restore. Default=None.')
@utils.service_type('volume')
def do_backup_restore(cs, args):
"""Restores a backup."""
@@ -936,8 +943,8 @@ def do_backup_restore(cs, args):
@utils.arg('volume', metavar='<volume>',
help='Name or ID of volume to transfer.')
@utils.arg('--display-name', metavar='<display-name>',
help='Transfer name. Default=None.',
default=None)
default=None,
help='Transfer name. Default=None.')
@utils.service_type('volume')
def do_transfer_create(cs, args):
"""Creates a volume transfer."""
@@ -1159,7 +1166,7 @@ def do_encryption_type_list(cs, args):
@utils.arg('volume_type',
metavar='<volume_type>',
type=str,
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.service_type('volume')
def do_encryption_type_show(cs, args):
"""Shows encryption type details for volume type. Admin only."""
@@ -1177,7 +1184,7 @@ def do_encryption_type_show(cs, args):
@utils.arg('volume_type',
metavar='<volume_type>',
type=str,
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.arg('provider',
metavar='<provider>',
type=str,
@@ -1225,7 +1232,7 @@ def do_encryption_type_create(cs, args):
@utils.arg('volume_type',
metavar='<volume_type>',
type=str,
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.service_type('volume')
def do_encryption_type_delete(cs, args):
"""Deletes encryption type for a volume type. Admin only."""
@@ -1237,10 +1244,10 @@ def do_encryption_type_delete(cs, args):
@utils.arg('host', metavar='<host>', help='Destination host.')
@utils.arg('--force-host-copy', metavar='<True|False>',
choices=['True', 'False'], required=False,
default=False,
help='Enables or disables generic host-based '
'force-migration, which bypasses driver '
'optimizations. Default=False.',
default=False)
'optimizations. Default=False.')
@utils.service_type('volume')
def do_migrate(cs, args):
"""Migrates volume to a new host."""
@@ -1267,7 +1274,7 @@ def _print_associations_list(associations):
@utils.arg('name',
metavar='<name>',
help="Name of new QoS specifications.")
help='Name of new QoS specifications.')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',
@@ -1347,7 +1354,7 @@ def do_qos_disassociate_all(cs, args):
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata', metavar='key=value',
nargs='+',
default=[],
@@ -1378,7 +1385,7 @@ def do_qos_get_association(cs, args):
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',

8
cinderclient/v1/volumes.py
View File

@@ -205,7 +205,13 @@ class VolumeManager(base.ManagerWithFind):
if val:
qparams[opt] = val
query_string = "?%s" % urlencode(qparams) if qparams else ""
# Transform the dict to a sequence of two-element tuples in fixed
# order, then the encoded string will be consistent in Python 2&3.
if qparams:
new_qparams = sorted(qparams.items(), key=lambda x: x[0])
query_string = "?%s" % urlencode(new_qparams)
else:
query_string = ""
detail = ""
if detailed:

114
cinderclient/v2/shell.py
View File

@@ -164,9 +164,9 @@ def _extract_metadata(args):
type=str,
nargs='*',
metavar='<key=value>',
default=None,
help='Filters results by a metadata key and value pair. '
'OPTIONAL: Default=None.',
default=None)
'OPTIONAL: Default=None.')
@utils.arg('--marker',
metavar='<marker>',
default=None,
@@ -190,8 +190,14 @@ def _extract_metadata(args):
default=None,
help=(('Comma-separated list of sort keys and directions in the '
'form of <key>[:<asc|desc>]. '
'Valid keys: %s. '
'OPTIONAL: Default=None.') % ', '.join(volumes.SORT_KEY_VALUES)))
'Valid keys: %s. OPTIONAL: '
'Default=None.') % ', '.join(volumes.SORT_KEY_VALUES)))
@utils.arg('--tenant',
type=str,
dest='tenant',
nargs='?',
metavar='<tenant>',
help='Display information from single tenant (Admin only).')
@utils.service_type('volumev2')
def do_list(cs, args):
"""Lists all volumes."""
@@ -199,9 +205,11 @@ def do_list(cs, args):
if args.display_name is not None:
args.name = args.display_name
all_tenants = int(os.environ.get("ALL_TENANTS", args.all_tenants))
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,
'metadata': _extract_metadata(args) if args.metadata else None,
@@ -332,8 +340,8 @@ class CheckSizeArgForCreate(argparse.Action):
type=str,
nargs='*',
metavar='<key=value>',
help='Metadata key and value pairs. Default=None.',
default=None)
default=None,
help='Metadata key and value pairs. Default=None.')
@utils.arg('--hint',
metavar='<key=value>',
dest='scheduler_hints',
@@ -502,7 +510,7 @@ def do_rename(cs, args):
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',
@@ -590,13 +598,13 @@ def do_snapshot_show(cs, args):
help='Name or ID of volume to snapshot.')
@utils.arg('--force',
metavar='<True|False>',
default=False,
help='Allows or disallows snapshot of '
'a volume when the volume is attached to an instance. '
'If set to True, ignores the current status of the '
'volume when attempting to snapshot it rather '
'than forcing it to be available. '
'Default=False.',
default=False)
'Default=False.')
@utils.arg('--name',
metavar='<name>',
default=None,
@@ -617,8 +625,8 @@ def do_snapshot_show(cs, args):
type=str,
nargs='*',
metavar='<key=value>',
help='Snapshot metadata key and value pairs. Default=None.',
default=None)
default=None,
help='Snapshot metadata key and value pairs. Default=None.')
@utils.service_type('volumev2')
def do_snapshot_create(cs, args):
"""Creates a snapshot."""
@@ -664,8 +672,8 @@ def do_snapshot_delete(cs, args):
@utils.arg('name', nargs='?', metavar='<name>',
help='New name for snapshot.')
@utils.arg('--description', metavar='<description>',
help='Snapshot description. Default=None.',
default=None)
default=None,
help='Snapshot description. Default=None.')
@utils.arg('--display-description',
help=argparse.SUPPRESS)
@utils.arg('--display_description',
@@ -751,13 +759,13 @@ def do_type_default(cs, args):
@utils.arg('id',
metavar='<id>',
help="ID of the volume type.")
help='ID of the volume type.')
@utils.arg('--name',
metavar='<name>',
help="Name of the volume type.")
help='Name of the volume type.')
@utils.arg('--description',
metavar='<description>',
help="Description of the volume type.")
help='Description of the volume type.')
@utils.service_type('volumev2')
def do_type_update(cs, args):
"""Updates volume type name and/or description."""
@@ -774,14 +782,14 @@ def do_extra_specs_list(cs, args):
@utils.arg('name',
metavar='<name>',
help="Name of new volume type.")
help='Name of new volume type.')
@utils.arg('--description',
metavar='<description>',
help="Description of new volume type.")
help='Description of new volume type.')
@utils.arg('--is-public',
metavar='<is-public>',
help="Make type accessible to the public (default true).",
default=True)
default=True,
help='Make type accessible to the public (default true).')
@utils.service_type('volumev2')
def do_type_create(cs, args):
"""Creates a volume type."""
@@ -792,7 +800,7 @@ def do_type_create(cs, args):
@utils.arg('id',
metavar='<id>',
help="ID of volume type to delete.")
help='ID of volume type to delete.')
@utils.service_type('volumev2')
def do_type_delete(cs, args):
"""Deletes a volume type."""
@@ -801,11 +809,11 @@ def do_type_delete(cs, args):
@utils.arg('vtype',
metavar='<vtype>',
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',
@@ -825,7 +833,7 @@ def do_type_key(cs, args):
@utils.arg('--volume-type', metavar='<volume_type>', required=True,
help="Filter results by volume type name or ID.")
help='Filter results by volume type name or ID.')
@utils.service_type('volumev2')
def do_type_access_list(cs, args):
"""Print access information about the given volume type."""
@@ -840,7 +848,7 @@ def do_type_access_list(cs, args):
@utils.arg('--volume-type', metavar='<volume_type>', required=True,
help="Volume type name or ID to add access for the given project.")
help='Volume type name or ID to add access for the given project.')
@utils.arg('--project-id', metavar='<project_id>', required=True,
help='Project ID to add volume type access for.')
@utils.service_type('volumev2')
@@ -1065,22 +1073,22 @@ def _find_volume_type(cs, vtype):
help='Name or ID of volume to snapshot.')
@utils.arg('--force',
metavar='<True|False>',
default=False,
help='Enables or disables upload of '
'a volume that is attached to an instance. '
'Default=False.',
default=False)
'Default=False.')
@utils.arg('--container-format',
metavar='<container-format>',
default='bare',
help='Container format type. '
'Default is bare.',
default='bare')
'Default is bare.')
@utils.arg('--container_format',
help=argparse.SUPPRESS)
@utils.arg('--disk-format',
metavar='<disk-format>',
default='raw',
help='Disk format type. '
'Default is raw.',
default='raw')
'Default is raw.')
@utils.arg('--disk_format',
help=argparse.SUPPRESS)
@utils.arg('image_name',
@@ -1102,10 +1110,10 @@ def do_upload_to_image(cs, args):
@utils.arg('host', metavar='<host>', help='Destination host.')
@utils.arg('--force-host-copy', metavar='<True|False>',
choices=['True', 'False'], required=False,
default=False,
help='Enables or disables generic host-based '
'force-migration, which bypasses driver '
'optimizations. Default=False.',
default=False)
'optimizations. Default=False.')
@utils.service_type('volumev2')
def do_migrate(cs, args):
"""Migrates volume to a new host."""
@@ -1129,13 +1137,13 @@ def do_retype(cs, args):
@utils.arg('volume', metavar='<volume>',
help='Name or ID of volume to backup.')
@utils.arg('--container', metavar='<container>',
help='Backup container name. Default=None.',
default=None)
default=None,
help='Backup container name. Default=None.')
@utils.arg('--display-name',
help=argparse.SUPPRESS)
@utils.arg('--name', metavar='<name>',
help='Backup name. Default=None.',
default=None)
default=None,
help='Backup name. Default=None.')
@utils.arg('--display-description',
help=argparse.SUPPRESS)
@utils.arg('--description',
@@ -1199,12 +1207,12 @@ def do_backup_delete(cs, args):
@utils.arg('backup', metavar='<backup>',
help='ID of backup to restore.')
@utils.arg('--volume-id', metavar='<volume>',
help=argparse.SUPPRESS,
default=None)
default=None,
help=argparse.SUPPRESS)
@utils.arg('--volume', metavar='<volume>',
default=None,
help='Name or ID of volume to which to restore. '
'Default=None.',
default=None)
'Default=None.')
@utils.service_type('volumev2')
def do_backup_restore(cs, args):
"""Restores a backup."""
@@ -1462,7 +1470,7 @@ def do_encryption_type_list(cs, args):
@utils.arg('volume_type',
metavar='<volume_type>',
type=str,
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.service_type('volumev2')
def do_encryption_type_show(cs, args):
"""Shows encryption type details for a volume type. Admin only."""
@@ -1480,7 +1488,7 @@ def do_encryption_type_show(cs, args):
@utils.arg('volume_type',
metavar='<volume_type>',
type=str,
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.arg('provider',
metavar='<provider>',
type=str,
@@ -1527,7 +1535,7 @@ def do_encryption_type_create(cs, args):
@utils.arg('volume_type',
metavar='<volume_type>',
type=str,
help="Name or ID of volume type.")
help='Name or ID of volume type.')
@utils.service_type('volumev2')
def do_encryption_type_delete(cs, args):
"""Deletes encryption type for a volume type. Admin only."""
@@ -1553,12 +1561,12 @@ def _print_associations_list(associations):
@utils.arg('name',
metavar='<name>',
help="Name of new QoS specifications.")
help='Name of new QoS specifications.')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',
default=[],
help="QoS specifications.")
help='QoS specifications.')
@utils.service_type('volumev2')
def do_qos_create(cs, args):
"""Creates a qos specs."""
@@ -1577,7 +1585,7 @@ def do_qos_list(cs, args):
@utils.arg('qos_specs', metavar='<qos_specs>',
help="ID of QoS specifications to show.")
help='ID of QoS specifications to show.')
@utils.service_type('volumev2')
def do_qos_show(cs, args):
"""Shows qos specs details."""
@@ -1586,7 +1594,7 @@ def do_qos_show(cs, args):
@utils.arg('qos_specs', metavar='<qos_specs>',
help="ID of QoS specifications to delete.")
help='ID of QoS specifications to delete.')
@utils.arg('--force',
metavar='<True|False>',
default=False,
@@ -1635,7 +1643,7 @@ def do_qos_disassociate_all(cs, args):
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata', metavar='key=value',
nargs='+',
default=[],
@@ -1666,7 +1674,7 @@ def do_qos_get_association(cs, args):
@utils.arg('action',
metavar='<action>',
choices=['set', 'unset'],
help="The action. Valid values are 'set' or 'unset.'")
help='The action. Valid values are "set" or "unset."')
@utils.arg('metadata',
metavar='<key=value>',
nargs='+',
@@ -1938,12 +1946,12 @@ def do_consisgroup_create(cs, args):
'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.',
default=False)
'flag is required for it to be deleted.')
@utils.service_type('volumev2')
def do_consisgroup_delete(cs, args):
"""Removes one or more consistency groups."""