python-openstackclient 10.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

openstackclient/tests/unit/volume/v2/test_volume_snapshot.py

@@ -343,6 +343,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=None,
             status=None,
@@ -376,6 +377,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=2,
             marker=self.snapshots[0].id,
+            max_items=None,
             all_projects=True,
             project_id=self.project.id,
             name=None,
@@ -397,6 +399,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=True,
             name=None,
             status=None,
@@ -423,6 +426,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=self.snapshots[0].name,
             status=None,
@@ -449,6 +453,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=None,
             status='available',
@@ -475,6 +480,7 @@ class TestVolumeSnapshotList(volume_fakes.TestVolume):
         self.volume_sdk_client.snapshots.assert_called_once_with(
             limit=None,
             marker=None,
+            max_items=None,
             all_projects=False,
             name=None,
             status=None,

openstackclient/tests/unit/volume/v3/fakes.py

@@ -40,12 +40,10 @@ class FakeVolumeClient:
         self.management_url = kwargs['endpoint']
         self.api_version = api_versions.APIVersion('3.0')
 
-        self.attachments = mock.Mock()
-        self.attachments.resource_class = fakes.FakeResource(None, {})
-        self.availability_zones = mock.Mock()
-        self.availability_zones.resource_class = fakes.FakeResource(None, {})
         self.backups = mock.Mock()
         self.backups.resource_class = fakes.FakeResource(None, {})
+        self.cgsnapshots = mock.Mock()
+        self.cgsnapshots.resource_class = fakes.FakeResource(None, {})
         self.consistencygroups = mock.Mock()
         self.consistencygroups.resource_class = fakes.FakeResource(None, {})
         self.clusters = mock.Mock()
@@ -58,10 +56,10 @@ class FakeVolumeClient:
         self.group_types.resource_class = fakes.FakeResource(None, {})
         self.messages = mock.Mock()
         self.messages.resource_class = fakes.FakeResource(None, {})
-        self.resource_filters = mock.Mock()
-        self.resource_filters.resource_class = fakes.FakeResource(None, {})
-        self.restores = mock.Mock()
-        self.restores.resource_class = fakes.FakeResource(None, {})
+        self.qos_specs = mock.Mock()
+        self.qos_specs.resource_class = fakes.FakeResource(None, {})
+        self.services = mock.Mock()
+        self.services.resource_class = fakes.FakeResource(None, {})
         self.transfers = mock.Mock()
         self.transfers.resource_class = fakes.FakeResource(None, {})
         self.volume_encryption_types = mock.Mock()
@@ -76,8 +74,6 @@ class FakeVolumeClient:
         self.volume_types.resource_class = fakes.FakeResource(None, {})
         self.volumes = mock.Mock()
         self.volumes.resource_class = fakes.FakeResource(None, {})
-        self.services = mock.Mock()
-        self.services.resource_class = fakes.FakeResource(None, {})
         self.workers = mock.Mock()
         self.workers.resource_class = fakes.FakeResource(None, {})
 
@@ -140,6 +136,8 @@ class TestVolume(
 
 
 # TODO(stephenfin): Check if the responses are actually the same
+create_one_capability = volume_v2_fakes.create_one_capability
+create_one_pool = volume_v2_fakes.create_one_pool
 create_one_snapshot = volume_v2_fakes.create_one_snapshot
 create_one_service = volume_v2_fakes.create_one_service
 
@@ -232,6 +230,99 @@ def create_consistency_groups(attrs=None, count=2):
     return consistency_groups
 
 
+def get_consistency_groups(consistency_groups=None, count=2):
+    """Note:
+
+    Get an iterable MagicMock object with a list of faked
+    consistency_groups.
+
+    If consistency_groups list is provided, then initialize
+    the Mock object with the list. Otherwise create one.
+
+    :param List consistency_groups:
+        A list of FakeResource objects faking consistency_groups
+    :param Integer count:
+        The number of consistency_groups to be faked
+    :return
+        An iterable Mock object with side_effect set to a list of faked
+        consistency_groups
+    """
+    if consistency_groups is None:
+        consistency_groups = create_consistency_groups(count)
+
+    return mock.Mock(side_effect=consistency_groups)
+
+
+def create_one_consistency_group_snapshot(attrs=None):
+    """Create a fake consistency group snapshot.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :return:
+        A FakeResource object with id, name, description, etc.
+    """
+    attrs = attrs or {}
+
+    # Set default attributes.
+    consistency_group_snapshot_info = {
+        "id": 'id-' + uuid.uuid4().hex,
+        "name": 'backup-name-' + uuid.uuid4().hex,
+        "description": 'description-' + uuid.uuid4().hex,
+        "status": "error",
+        "consistencygroup_id": 'consistency-group-id' + uuid.uuid4().hex,
+        "created_at": 'time-' + uuid.uuid4().hex,
+    }
+
+    # Overwrite default attributes.
+    consistency_group_snapshot_info.update(attrs)
+
+    consistency_group_snapshot = fakes.FakeResource(
+        info=copy.deepcopy(consistency_group_snapshot_info), loaded=True
+    )
+    return consistency_group_snapshot
+
+
+def create_consistency_group_snapshots(attrs=None, count=2):
+    """Create multiple fake consistency group snapshots.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :param int count:
+        The number of consistency group snapshots to fake
+    :return:
+        A list of FakeResource objects faking the
+        consistency group snapshots
+    """
+    consistency_group_snapshots = []
+    for i in range(0, count):
+        consistency_group_snapshot = create_one_consistency_group_snapshot(
+            attrs,
+        )
+        consistency_group_snapshots.append(consistency_group_snapshot)
+
+    return consistency_group_snapshots
+
+
+def get_consistency_group_snapshots(snapshots=None, count=2):
+    """Get an iterable MagicMock object with a list of faked cgsnapshots.
+
+    If consistenct group snapshots list is provided, then initialize
+    the Mock object with the list. Otherwise create one.
+
+    :param List snapshots:
+        A list of FakeResource objects faking consistency group snapshots
+    :param Integer count:
+        The number of consistency group snapshots to be faked
+    :return
+        An iterable Mock object with side_effect set to a list of faked
+        consistency groups
+    """
+    if snapshots is None:
+        snapshots = create_consistency_group_snapshots(count)
+
+    return mock.Mock(side_effect=snapshots)
+
+
 def create_one_extension(attrs=None):
     """Create a fake extension.
 
@@ -304,42 +395,33 @@ def create_one_backup(attrs=None):
     return backup
 
 
-def create_backups(attrs=None, count=2):
-    """Create multiple fake backups.
+def create_backup_record():
+    """Gets a fake backup record for a given backup.
 
-    :param dict attrs:
-        A dictionary with all attributes
-    :param int count:
-        The number of backups to fake
-    :return: A list of fake
-        openstack.block_storage.v3.backup.Backup objects
+    :return: An "exported" backup record.
     """
-    backups = []
-    for i in range(0, count):
-        backup = create_one_backup(attrs)
-        backups.append(backup)
 
-    return backups
+    return {
+        'backup_service': 'cinder.backup.drivers.swift.SwiftBackupDriver',
+        'backup_url': 'eyJzdGF0dXMiOiAiYXZh',
+    }
 
 
-def get_backups(backups=None, count=2):
-    """Get an iterable MagicMock object with a list of faked backups.
+def import_backup_record():
+    """Creates a fake backup record import response from a backup.
 
-    If backups list is provided, then initialize the Mock object with the
-    list. Otherwise create one.
-
-    :param List backups:
-        A list of FakeResource objects faking backups
-    :param Integer count:
-        The number of backups to be faked
-    :return
-        An iterable Mock object with side_effect set to a list of faked
-        backups
+    :return: The fake backup object that was encoded.
     """
-    if backups is None:
-        backups = create_backups(count)
-
-    return mock.Mock(side_effect=backups)
+    return {
+        'backup': {
+            'id': 'backup.id',
+            'name': 'backup.name',
+            'links': [
+                {'href': 'link1', 'rel': 'self'},
+                {'href': 'link2', 'rel': 'bookmark'},
+            ],
+        },
+    }
 
 
 def create_one_cluster(attrs=None):
@@ -713,23 +795,6 @@ def create_one_sdk_volume(attrs=None):
     return _volume.Volume(**volume_info)
 
 
-def create_sdk_volumes(attrs=None, count=2):
-    """Create multiple fake volumes.
-
-    :param dict attrs:
-        A dictionary with all attributes of volume
-    :param Integer count:
-        The number of volumes to be faked
-    :return:
-        A list of FakeResource objects
-    """
-    volumes = []
-    for n in range(0, count):
-        volumes.append(create_one_sdk_volume(attrs))
-
-    return volumes
-
-
 def create_one_volume_group(attrs=None):
     """Create a fake group.
 
@@ -811,20 +876,6 @@ def create_one_volume_group_snapshot(attrs=None, methods=None):
     return group_snapshot
 
 
-def create_volume_group_snapshots(attrs=None, count=2):
-    """Create multiple fake group snapshots.
-
-    :param attrs: A dictionary with all attributes of group snapshot
-    :param count: The number of group snapshots to be faked
-    :return: A list of FakeResource objects
-    """
-    group_snapshots = []
-    for n in range(0, count):
-        group_snapshots.append(create_one_volume_group_snapshot(attrs))
-
-    return group_snapshots
-
-
 def create_one_volume_group_type(attrs=None, methods=None):
     """Create a fake group type.
 
@@ -994,22 +1045,93 @@ def create_volume_attachments(attrs=None, count=2):
     return attachments
 
 
-def get_volume_attachments(attachments=None, count=2):
-    """Get an iterable MagicMock object with a list of faked volumes.
+def create_one_qos(attrs=None):
+    """Create a fake Qos specification.
 
-    If attachments list is provided, then initialize the Mock object with
-    the list. Otherwise create one.
+    :param dict attrs:
+        A dictionary with all attributes
+    :return:
+        A FakeResource object with id, name, consumer, etc.
+    """
+    attrs = attrs or {}
 
-    :param attachments: A list of FakeResource objects faking volume
-        attachments
-    :param count: The number of volume attachments to be faked
-    :return An iterable Mock object with side_effect set to a list of faked
-        volume attachments
+    # Set default attributes.
+    qos_info = {
+        "id": 'qos-id-' + uuid.uuid4().hex,
+        "name": 'qos-name-' + uuid.uuid4().hex,
+        "consumer": 'front-end',
+        "specs": {"foo": "bar", "iops": "9001"},
+    }
+
+    # Overwrite default attributes.
+    qos_info.update(attrs)
+
+    qos = fakes.FakeResource(info=copy.deepcopy(qos_info), loaded=True)
+    return qos
+
+
+def create_one_qos_association(attrs=None):
+    """Create a fake Qos specification association.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :return:
+        A FakeResource object with id, name, association_type, etc.
     """
-    if attachments is None:
-        attachments = create_volume_attachments(count)
+    attrs = attrs or {}
 
-    return mock.Mock(side_effect=attachments)
+    # Set default attributes.
+    qos_association_info = {
+        "id": 'type-id-' + uuid.uuid4().hex,
+        "name": 'type-name-' + uuid.uuid4().hex,
+        "association_type": 'volume_type',
+    }
+
+    # Overwrite default attributes.
+    qos_association_info.update(attrs)
+
+    qos_association = fakes.FakeResource(
+        info=copy.deepcopy(qos_association_info), loaded=True
+    )
+    return qos_association
+
+
+def create_qoses(attrs=None, count=2):
+    """Create multiple fake Qos specifications.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :param int count:
+        The number of Qos specifications to fake
+    :return:
+        A list of FakeResource objects faking the Qos specifications
+    """
+    qoses = []
+    for i in range(0, count):
+        qos = create_one_qos(attrs)
+        qoses.append(qos)
+
+    return qoses
+
+
+def get_qoses(qoses=None, count=2):
+    """Get an iterable MagicMock object with a list of faked qoses.
+
+    If qoses list is provided, then initialize the Mock object with the
+    list. Otherwise create one.
+
+    :param List qoses:
+        A list of FakeResource objects faking qoses
+    :param Integer count:
+        The number of qoses to be faked
+    :return
+        An iterable Mock object with side_effect set to a list of faked
+        qoses
+    """
+    if qoses is None:
+        qoses = create_qoses(count)
+
+    return mock.Mock(side_effect=qoses)
 
 
 def create_one_volume_type(attrs=None, methods=None):
@@ -1081,24 +1203,6 @@ def get_volume_types(volume_types=None, count=2):
     return mock.Mock(side_effect=volume_types)
 
 
-def create_service_log_level_entry(attrs=None):
-    service_log_level_info = {
-        'host': 'host_test',
-        'binary': 'cinder-api',
-        'prefix': 'cinder.api.common',
-        'level': 'DEBUG',
-    }
-    # Overwrite default attributes if there are some attributes set
-    attrs = attrs or {}
-
-    service_log_level_info.update(attrs)
-
-    service_log_level = fakes.FakeResource(
-        None, service_log_level_info, loaded=True
-    )
-    return service_log_level
-
-
 def create_cleanup_records():
     """Create fake service cleanup records.
 

openstackclient/tests/unit/volume/v3/test_backup_record.py

@@ -0,0 +1,114 @@
+#
+#   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 openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
+from openstackclient.volume.v3 import backup_record
+
+
+class TestBackupRecord(volume_fakes.TestVolume):
+    def setUp(self):
+        super().setUp()
+
+        self.backups_mock = self.volume_client.backups
+        self.backups_mock.reset_mock()
+
+
+class TestBackupRecordExport(TestBackupRecord):
+    new_backup = volume_fakes.create_one_backup(
+        attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
+    )
+    new_record = volume_fakes.create_backup_record()
+
+    def setUp(self):
+        super().setUp()
+
+        self.backups_mock.export_record.return_value = self.new_record
+        self.backups_mock.get.return_value = self.new_backup
+
+        # Get the command object to mock
+        self.cmd = backup_record.ExportBackupRecord(self.app, None)
+
+    def test_backup_export_table(self):
+        arglist = [
+            self.new_backup.name,
+        ]
+        verifylist = [
+            ("backup", self.new_backup.name),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        parsed_args.formatter = 'table'
+        columns, __ = self.cmd.take_action(parsed_args)
+
+        self.backups_mock.export_record.assert_called_with(
+            self.new_backup.id,
+        )
+
+        expected_columns = ('Backup Service', 'Metadata')
+        self.assertEqual(columns, expected_columns)
+
+    def test_backup_export_json(self):
+        arglist = [
+            self.new_backup.name,
+        ]
+        verifylist = [
+            ("backup", self.new_backup.name),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        parsed_args.formatter = 'json'
+        columns, __ = self.cmd.take_action(parsed_args)
+
+        self.backups_mock.export_record.assert_called_with(
+            self.new_backup.id,
+        )
+
+        expected_columns = ('backup_service', 'backup_url')
+        self.assertEqual(columns, expected_columns)
+
+
+class TestBackupRecordImport(TestBackupRecord):
+    new_backup = volume_fakes.create_one_backup(
+        attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
+    )
+    new_import = volume_fakes.import_backup_record()
+
+    def setUp(self):
+        super().setUp()
+
+        self.backups_mock.import_record.return_value = self.new_import
+
+        # Get the command object to mock
+        self.cmd = backup_record.ImportBackupRecord(self.app, None)
+
+    def test_backup_import(self):
+        arglist = [
+            "cinder.backup.drivers.swift.SwiftBackupDriver",
+            "fake_backup_record_data",
+        ]
+        verifylist = [
+            (
+                "backup_service",
+                "cinder.backup.drivers.swift.SwiftBackupDriver",
+            ),
+            ("backup_metadata", "fake_backup_record_data"),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        columns, __ = self.cmd.take_action(parsed_args)
+
+        self.backups_mock.import_record.assert_called_with(
+            "cinder.backup.drivers.swift.SwiftBackupDriver",
+            "fake_backup_record_data",
+        )
+        self.assertEqual(columns, ('backup',))