def __init__(self, username=None, api_key=None, project_id=None,
auth_url='', insecure=False, timeout=None, tenant_id=None,
proxy_tenant_id=None, proxy_token=None, region_name=None,
endpoint_type='publicURL', extensions=None,
service_type='volumev3', service_name=None,
volume_service_name=None, os_endpoint=None, retries=0,
http_log_debug=False, cacert=None, auth_system='keystone',
auth_plugin=None, session=None, api_version=None,
logger=None, **kwargs):
# FIXME(comstud): Rename the api_key argument above when we
# know it's not being used as keyword argument
password = api_key
self.version = '3.0'
self.limits = limits.LimitsManager(self)
self.api_version = api_version or api_versions.APIVersion(self.version)
self.volumes = volumes.VolumeManager(self)
self.volume_snapshots = volume_snapshots.SnapshotManager(self)
self.volume_types = volume_types.VolumeTypeManager(self)
self.group_types = group_types.GroupTypeManager(self)
self.volume_type_access = \
volume_type_access.VolumeTypeAccessManager(self)
self.volume_encryption_types = \
volume_encryption_types.VolumeEncryptionTypeManager(self)
self.default_types = default_types.DefaultVolumeTypeManager(self)
self.qos_specs = qos_specs.QoSSpecsManager(self)
self.quota_classes = quota_classes.QuotaClassSetManager(self)
self.quotas = quotas.QuotaSetManager(self)
self.backups = volume_backups.VolumeBackupManager(self)
self.messages = messages.MessageManager(self)
self.resource_filters = resource_filters.ResourceFilterManager(self)
self.restores = volume_backups_restore.VolumeBackupRestoreManager(self)
self.transfers = volume_transfers.VolumeTransferManager(self)
self.services = services.ServiceManager(self)
self.clusters = clusters.ClusterManager(self)
self.workers = workers.WorkerManager(self)
self.consistencygroups = consistencygroups.\
ConsistencygroupManager(self)
self.groups = groups.GroupManager(self)
self.cgsnapshots = cgsnapshots.CgsnapshotManager(self)
self.group_snapshots = group_snapshots.GroupSnapshotManager(self)
self.availability_zones = \
availability_zones.AvailabilityZoneManager(self)
self.pools = pools.PoolManager(self)
self.capabilities = capabilities.CapabilitiesManager(self)
self.attachments = \
attachments.VolumeAttachmentManager(self)
# Add in any extensions...
if extensions:
for extension in extensions:
if extension.manager_class:
setattr(self, extension.name,
extension.manager_class(self))
self.client = client._construct_http_client(
username=username,
password=password,
project_id=project_id,
auth_url=auth_url,
insecure=insecure,
timeout=timeout,
tenant_id=tenant_id,
proxy_tenant_id=tenant_id,
proxy_token=proxy_token,
region_name=region_name,
endpoint_type=endpoint_type,
service_type=service_type,
service_name=service_name,
volume_service_name=volume_service_name,
os_endpoint=os_endpoint,
retries=retries,
http_log_debug=http_log_debug,
cacert=cacert,
auth_system=auth_system,
auth_plugin=auth_plugin,
session=session,
api_version=self.api_version,
logger=logger,
**kwargs)
def data(TEST):
TEST.cinder_messages = utils.TestDataContainer()
TEST.cinder_services = utils.TestDataContainer()
TEST.cinder_volumes = utils.TestDataContainer()
TEST.cinder_volume_backups = utils.TestDataContainer()
TEST.cinder_volume_encryption_types = utils.TestDataContainer()
TEST.cinder_volume_types = utils.TestDataContainer()
TEST.cinder_type_access = utils.TestDataContainer()
TEST.cinder_volume_encryption = utils.TestDataContainer()
TEST.cinder_bootable_volumes = utils.TestDataContainer()
TEST.cinder_qos_specs = utils.TestDataContainer()
TEST.cinder_qos_spec_associations = utils.TestDataContainer()
TEST.cinder_volume_snapshots = utils.TestDataContainer()
TEST.cinder_extensions = utils.TestDataContainer()
TEST.cinder_quotas = utils.TestDataContainer()
TEST.cinder_quota_usages = utils.TestDataContainer()
TEST.cinder_availability_zones = utils.TestDataContainer()
TEST.cinder_volume_transfers = utils.TestDataContainer()
TEST.cinder_pools = utils.TestDataContainer()
TEST.cinder_groups = utils.TestDataContainer()
TEST.cinder_group_types = utils.TestDataContainer()
TEST.cinder_group_snapshots = utils.TestDataContainer()
TEST.cinder_group_volumes = utils.TestDataContainer()
TEST.cinder_volume_snapshots_with_groups = utils.TestDataContainer()
# Services
service_1 = services.Service(
services.ServiceManager(None), {
"service": "cinder-scheduler",
"status": "enabled",
"binary": "cinder-scheduler",
"zone": "internal",
"state": "up",
"updated_at": "2013-07-08T05:21:00.000000",
"host": "devstack001",
"disabled_reason": None
})
service_2 = services.Service(
services.ServiceManager(None), {
"service": "cinder-volume",
"status": "enabled",
"binary": "cinder-volume",
"zone": "nova",
"state": "up",
"updated_at": "2013-07-08T05:20:51.000000",
"host": "devstack001",
"disabled_reason": None
})
TEST.cinder_services.add(service_1)
TEST.cinder_services.add(service_2)
# Volumes - Cinder v1
volume = volumes.Volume(
volumes.VolumeManager(None), {
'id': "11023e92-8008-4c8b-8059-7f2293ff3887",
'status': 'available',
'size': 40,
'name': 'Volume name',
'display_description': 'Volume description',
'created_at': '2014-01-27 10:30:00',
'volume_type': None,
'bootable': 'false',
'attachments': []
})
nameless_volume = volumes.Volume(
volumes.VolumeManager(None), {
"id": "4b069dd0-6eaa-4272-8abc-5448a68f1cce",
"status": 'available',
"size": 10,
"name": '',
"display_description": '',
"device": "/dev/hda",
"created_at": '2010-11-21 18:34:25',
"volume_type": 'vol_type_1',
'bootable': 'true',
"attachments": []
})
other_volume = volumes.Volume(
volumes.VolumeManager(None), {
'id':
"21023e92-8008-1234-8059-7f2293ff3889",
'status':
'in-use',
'size':
10,
'name':
'my_volume',
'display_description':
'',
'created_at':
'2013-04-01 10:30:00',
'volume_type':
None,
'bootable':
'true',
'attachments': [{
"id": "21023e92-8008-1234-8059-7f2293ff3889",
"server_id": '1',
"device": "/dev/hda"
}]
})
volume_with_type = volumes.Volume(
volumes.VolumeManager(None), {
'id':
"7dcb47fd-07d9-42c2-9647-be5eab799ebe",
'name':
'my_volume2',
'status':
'in-use',
'size':
10,
'name':
'my_volume2',
'display_description':
'',
'created_at':
'2013-04-01 10:30:00',
'volume_type':
'vol_type_2',
'bootable':
'false',
'attachments': [{
"id": "7dcb47fd-07d9-42c2-9647-be5eab799ebe",
"server_id": '2',
"device": "/dev/hdb"
}]
})
non_bootable_volume = volumes.Volume(
volumes.VolumeManager(None), {
'id':
"21023e92-8008-1234-8059-7f2293ff3890",
'status':
'in-use',
'size':
10,
'name':
'my_volume',
'display_description':
'',
'created_at':
'2013-04-01 10:30:00',
'volume_type':
None,
'bootable':
'false',
'attachments': [{
"id": "21023e92-8008-1234-8059-7f2293ff3890",
"server_id": '1',
"device": "/dev/hda"
}]
})
volume.bootable = 'true'
nameless_volume.bootable = 'true'
other_volume.bootable = 'true'
TEST.cinder_volumes.add(api.cinder.Volume(volume))
TEST.cinder_volumes.add(api.cinder.Volume(nameless_volume))
TEST.cinder_volumes.add(api.cinder.Volume(other_volume))
TEST.cinder_volumes.add(api.cinder.Volume(volume_with_type))
TEST.cinder_bootable_volumes.add(api.cinder.Volume(non_bootable_volume))
vol_type1 = volume_types.VolumeType(
volume_types.VolumeTypeManager(None), {
'id': '1',
'name': 'vol_type_1',
'description': 'type 1 description',
'extra_specs': {
'foo': 'bar',
'volume_backend_name': 'backend_1'
}
})
vol_type2 = volume_types.VolumeType(volume_types.VolumeTypeManager(None), {
'id': '2',
'name': 'vol_type_2',
'description': 'type 2 description'
})
vol_type3 = volume_types.VolumeType(
volume_types.VolumeTypeManager(None), {
'id': '3',
'name': 'vol_type_3',
'is_public': False,
'description': 'type 3 description'
})
TEST.cinder_volume_types.add(vol_type1, vol_type2, vol_type3)
vol_type_access1 = volume_type_access.VolumeTypeAccess(
volume_type_access.VolumeTypeAccessManager(None), {
'volume_type_id': '1',
'project_id': '1'
})
TEST.cinder_type_access.add(vol_type_access1)
# Volumes - Cinder v3 (v2 removed in Xena)
volume_v3 = volumes.Volume(
volumes.VolumeManager(None), {
'id': "31023e92-8008-4c8b-8059-7f2293ff1234",
'name': 'v3_volume',
'description': "v3 Volume Description",
'status': 'available',
'size': 20,
'created_at': '2014-01-27 10:30:00',
'volume_type': None,
'os-vol-host-attr:host': 'host@backend-name#pool',
'bootable': 'true',
'attachments': []
})
volume_v3.bootable = 'true'
TEST.cinder_volumes.add(api.cinder.Volume(volume_v3))
snapshot = vol_snaps.Snapshot(
vol_snaps.SnapshotManager(None), {
'id': '5f3d1c33-7d00-4511-99df-a2def31f3b5d',
'display_name': 'test snapshot',
'display_description': 'volume snapshot',
'size': 40,
'created_at': '2014-01-27 10:30:00',
'status': 'available',
'volume_id': '11023e92-8008-4c8b-8059-7f2293ff3887'
})
snapshot2 = vol_snaps.Snapshot(
vol_snaps.SnapshotManager(None), {
'id': 'c9d0881a-4c0b-4158-a212-ad27e11c2b0f',
'name': '',
'description': 'v3 volume snapshot description',
'size': 80,
'created_at': '2014-01-27 10:30:00',
'status': 'available',
'volume_id': '31023e92-8008-4c8b-8059-7f2293ff1234'
})
snapshot3 = vol_snaps.Snapshot(
vol_snaps.SnapshotManager(None), {
'id': 'c9d0881a-4c0b-4158-a212-ad27e11c2b0e',
'name': '',
'description': 'v3 volume snapshot description 2',
'size': 80,
'created_at': '2014-01-27 10:30:00',
'status': 'available',
'volume_id': '31023e92-8008-4c8b-8059-7f2293ff1234'
})
snapshot4 = vol_snaps.Snapshot(
vol_snaps.SnapshotManager(None), {
'id': 'cd6be1eb-82ca-4587-8036-13c37c00c2b1',
'name': '',
'description': 'v3 volume snapshot with metadata description',
'size': 80,
'created_at': '2014-01-27 10:30:00',
'status': 'available',
'volume_id': '31023e92-8008-4c8b-8059-7f2293ff1234',
'metadata': {
'snapshot_meta_key': 'snapshot_meta_value'
}
})
snapshot.bootable = 'true'
snapshot2.bootable = 'true'
TEST.cinder_volume_snapshots.add(api.cinder.VolumeSnapshot(snapshot))
TEST.cinder_volume_snapshots.add(api.cinder.VolumeSnapshot(snapshot2))
TEST.cinder_volume_snapshots.add(api.cinder.VolumeSnapshot(snapshot3))
TEST.cinder_volume_snapshots.add(api.cinder.VolumeSnapshot(snapshot4))
TEST.cinder_volume_snapshots.first()._volume = volume
# Volume Type Encryption
vol_enc_type1 = vol_enc_types.VolumeEncryptionType(
vol_enc_types.VolumeEncryptionTypeManager(None), {
'volume_type_id': '1',
'control_location': "front-end",
'key_size': 512,
'provider': "a-provider",
'cipher': "a-cipher"
})
vol_enc_type2 = vol_enc_types.VolumeEncryptionType(
vol_enc_types.VolumeEncryptionTypeManager(None), {
'volume_type_id': '2',
'control_location': "front-end",
'key_size': 256,
'provider': "a-provider",
'cipher': "a-cipher"
})
vol_unenc_type1 = vol_enc_types.VolumeEncryptionType(
vol_enc_types.VolumeEncryptionTypeManager(None), {})
TEST.cinder_volume_encryption_types.add(vol_enc_type1, vol_enc_type2,
vol_unenc_type1)
volume_backup1 = vol_backups.VolumeBackup(
vol_backups.VolumeBackupManager(None), {
'id': 'a374cbb8-3f99-4c3f-a2ef-3edbec842e31',
'name': 'backup1',
'description': 'volume backup 1',
'size': 10,
'status': 'available',
'container_name': 'volumebackups',
'snapshot_id': None,
'volume_id': '11023e92-8008-4c8b-8059-7f2293ff3887'
})
volume_backup2 = vol_backups.VolumeBackup(
vol_backups.VolumeBackupManager(None), {
'id': 'c321cbb8-3f99-4c3f-a2ef-3edbec842e52',
'name': 'backup2',
'description': 'volume backup 2',
'size': 20,
'status': 'available',
'snapshot_id': snapshot2.id,
'container_name': 'volumebackups',
'volume_id': '31023e92-8008-4c8b-8059-7f2293ff1234'
})
volume_backup3 = vol_backups.VolumeBackup(
vol_backups.VolumeBackupManager(None), {
'id': 'c321cbb8-3f99-4c3f-a2ef-3edbec842e53',
'name': 'backup3',
'description': 'volume backup 3',
'size': 20,
'snapshot_id': None,
'status': 'available',
'container_name': 'volumebackups',
'volume_id': '31023e92-8008-4c8b-8059-7f2293ff1234'
})
TEST.cinder_volume_backups.add(volume_backup1)
TEST.cinder_volume_backups.add(volume_backup2)
TEST.cinder_volume_backups.add(volume_backup3)
# Volume Encryption
vol_enc_metadata1 = volumes.Volume(
volumes.VolumeManager(None), {
'cipher': 'test-cipher',
'key_size': 512,
'provider': 'test-provider',
'control_location': 'front-end'
})
vol_unenc_metadata1 = volumes.Volume(volumes.VolumeManager(None), {})
TEST.cinder_volume_encryption.add(vol_enc_metadata1)
TEST.cinder_volume_encryption.add(vol_unenc_metadata1)
# v3 extensions
extensions = [
{
'alias': 'os-services',
'description': 'Services support.',
'links': '[]',
'name': 'Services',
'updated': '2012-10-28T00:00:00-00:00'
},
{
'alias': 'os-admin-actions',
'description': 'Enable admin actions.',
'links': '[]',
'name': 'AdminActions',
'updated': '2012-08-25T00:00:00+00:00'
},
]
extensions = [
cinder_list_extensions.ListExtResource(
cinder_list_extensions.ListExtManager(None), ext)
for ext in extensions
]
TEST.cinder_extensions.add(*extensions)
# Quota Sets
quota_data = dict(volumes='1', snapshots='1', gigabytes='1000')
quota = quotas.QuotaSet(quotas.QuotaSetManager(None), quota_data)
TEST.cinder_quotas.add(api.base.QuotaSet(quota))
# Quota Usages
quota_usage_data = {
'gigabytes': {
'used': 0,
'quota': 1000
},
'volumes': {
'used': 0,
'quota': 10
},
'snapshots': {
'used': 0,
'quota': 10
}
}
quota_usage = usage_quotas.QuotaUsage()
for k, v in quota_usage_data.items():
quota_usage.add_quota(api.base.Quota(k, v['quota']))
quota_usage.tally(k, v['used'])
TEST.cinder_quota_usages.add(quota_usage)
# Availability Zones
# Cinder returns the following structure from os-availability-zone
# {"availabilityZoneInfo":
# [{"zoneState": {"available": true}, "zoneName": "nova"}]}
# Note that the default zone is still "nova" even though this is cinder
TEST.cinder_availability_zones.add(
availability_zones.AvailabilityZone(
availability_zones.AvailabilityZoneManager(None), {
'zoneName': 'nova',
'zoneState': {
'available': True
}
}))
# Cinder Limits
limits = {
"absolute": {
"totalVolumesUsed": 4,
"totalGigabytesUsed": 400,
'totalSnapshotsUsed': 3,
"maxTotalVolumes": 20,
"maxTotalVolumeGigabytes": 1000,
'maxTotalSnapshots': 10,
}
}
TEST.cinder_limits = limits
# QOS Specs
qos_spec1 = qos_specs.QoSSpecs(
qos_specs.QoSSpecsManager(None), {
"id": "418db45d-6992-4674-b226-80aacad2073c",
"name": "high_iops",
"consumer": "back-end",
"specs": {
"minIOPS": "1000",
"maxIOPS": '100000'
}
})
qos_spec2 = qos_specs.QoSSpecs(
qos_specs.QoSSpecsManager(None), {
"id": "6ed7035f-992e-4075-8ed6-6eff19b3192d",
"name": "high_bws",
"consumer": "back-end",
"specs": {
"maxBWS": '5000'
}
})
TEST.cinder_qos_specs.add(qos_spec1, qos_spec2)
vol_type1.associated_qos_spec = qos_spec1.name
TEST.cinder_qos_spec_associations.add(vol_type1)
# volume_transfers
transfer_1 = volume_transfers.VolumeTransfer(
volume_transfers.VolumeTransferManager(None), {
'id': '99999999-8888-7777-6666-555555555555',
'name': 'test transfer',
'volume_id': volume.id,
'auth_key': 'blah',
'created_at': ''
})
TEST.cinder_volume_transfers.add(transfer_1)
# Pools
pool1 = pools.Pool(
pools.PoolManager(None), {
"QoS_support": False,
"allocated_capacity_gb": 0,
"driver_version": "3.0.0",
"free_capacity_gb": 10,
"extra_specs": {
"description": "LVM Extra specs",
"display_name": "LVMDriver",
"namespace": "OS::Cinder::LVMDriver",
"type": "object",
},
"name": "devstack@lvmdriver-1#lvmdriver-1",
"pool_name": "lvmdriver-1",
"reserved_percentage": 0,
"storage_protocol": "iSCSI",
"total_capacity_gb": 10,
"vendor_name": "Open Source",
"volume_backend_name": "lvmdriver-1"
})
pool2 = pools.Pool(
pools.PoolManager(None), {
"QoS_support": False,
"allocated_capacity_gb": 2,
"driver_version": "3.0.0",
"free_capacity_gb": 5,
"extra_specs": {
"description": "LVM Extra specs",
"display_name": "LVMDriver",
"namespace": "OS::Cinder::LVMDriver",
"type": "object",
},
"name": "devstack@lvmdriver-2#lvmdriver-2",
"pool_name": "lvmdriver-2",
"reserved_percentage": 0,
"storage_protocol": "iSCSI",
"total_capacity_gb": 10,
"vendor_name": "Open Source",
"volume_backend_name": "lvmdriver-2"
})
TEST.cinder_pools.add(pool1)
TEST.cinder_pools.add(pool2)
group_type_1 = group_types.GroupType(
group_types.GroupTypeManager(None), {
"is_public": True,
"group_specs": {},
"id": "4645cbf7-8aa6-4d42-a5f7-24e6ebe5ba79",
"name": "group-type-1",
"description": None,
})
TEST.cinder_group_types.add(group_type_1)
group_1 = groups.Group(
groups.GroupManager(None), {
"availability_zone": "nova",
"created_at": "2018-01-09T07:27:22.000000",
"description": "description for group1",
"group_snapshot_id": None,
"group_type": group_type_1.id,
"id": "f64646ac-9bf7-483f-bd85-96c34050a528",
"name": "group1",
"replication_status": "disabled",
"source_group_id": None,
"status": "available",
"volume_types": [
vol_type1.id,
]
})
TEST.cinder_groups.add(cinder_api.Group(group_1))
group_snapshot_1 = group_snapshots.GroupSnapshot(
group_snapshots.GroupSnapshotManager(None), {
"created_at": "2018-01-09T07:46:03.000000",
"description": "",
"group_id": group_1.id,
"group_type_id": group_type_1.id,
"id": "1036d913-9cb8-46a1-9f56-2f99dc1f14ed",
"name": "group-snap1",
"status": "available",
})
TEST.cinder_group_snapshots.add(group_snapshot_1)
group_volume_1 = volumes.Volume(
volumes.VolumeManager(None), {
'id': "fe9a2664-0f49-4354-bab6-11b2ad352630",
'status': 'available',
'size': 2,
'name': 'group1-volume1',
'display_description': 'Volume 1 in Group 1',
'created_at': '2014-01-27 10:30:00',
'volume_type': 'vol_type_1',
'group_id': group_1.id,
'attachments': []
})
group_volume_2 = volumes.Volume(
volumes.VolumeManager(None), {
'id': "a7fb0402-88dc-45a3-970c-d732da63466e",
'status': 'available',
'size': 1,
'name': 'group1-volume2',
'display_description': 'Volume 2 in Group 1',
'created_at': '2014-01-30 10:31:00',
'volume_type': 'vol_type_1',
'group_id': group_1.id,
'attachments': []
})
TEST.cinder_group_volumes.add(group_volume_1)
TEST.cinder_group_volumes.add(group_volume_2)
snapshot5 = vol_snaps.Snapshot(
vol_snaps.SnapshotManager(None), {
'id': 'cd6be1eb-82ca-4587-8036-13c37c00c2b1',
'name': '',
'description': 'v3 volume snapshot with metadata description',
'size': 80,
'status': 'available',
'volume_id': '7e4efa56-9ca1-45ff-b83c-2efb2383930d',
'metadata': {
'snapshot_meta_key': 'snapshot_meta_value'
},
'group_snapshot_id': group_snapshot_1.id
})
TEST.cinder_volume_snapshots_with_groups.add(
api.cinder.VolumeSnapshot(snapshot5))
# Cinder Messages
messages_1 = messages.Message(
messages.MessageManager(None), {
'created_at': '2020-07-08T17:12:06.000000',
'event_id': 'VOLUME_VOLUME_001_001',
'guaranteed_until': '2020-08-07T17:12:06.000000',
'id': '2d2bb0d7-af28-4566-9a65-6d987c19093c',
'resource_type': 'VOLUME',
'resource_uuid': '6d53d143-e10f-440a-a65f-16a6b6d068f7',
'message_level': 'ERROR',
'user_message':
'schedule allocate volume:An unknown error occurred.'
})
messages_2 = messages.Message(
messages.MessageManager(None), {
'created_at': '2020-07-12T12:56:43.000000',
'event_id': 'VOLUME_VOLUME_SNAPSHOT_009_015',
'guaranteed_until': '2020-08-11T12:56:43.000000',
'id': 'd360b4e2-bda5-4289-b673-714a90cde80b',
'resource_type': 'VOLUME_SNAPSHOT',
'resource_uuid': '761634b0-fa1c-4e59-b8ad-d720807cb355',
'message_level': 'ERROR',
'user_message': 'create snapshot:Snapshot is busy.'
})
messages_3 = messages.Message(
messages.MessageManager(None), {
'created_at':
'2020-09-24T11:03:31.000000',
'event_id':
'VOLUME_VOLUME_001_003',
'guaranteed_until':
'2020-10-24T11:03:31.000000',
'id':
'1f481885-9e1b-4d67-bdb5-b9db461391d3',
'resource_type':
'VOLUME',
'resource_uuid':
'f227c02d-91d7-4c3f-90d8-d8f261d0331a',
'message_level':
'ERROR',
'user_message': ('schedule allocate volume:'
'Could not find any available weighted backend.'),
})
TEST.cinder_messages.add(api.cinder.Message(messages_1))
TEST.cinder_messages.add(api.cinder.Message(messages_2))
TEST.cinder_messages.add(api.cinder.Message(messages_3))