volume: add v3-specific volume type module

This makes testing easier.

Change-Id: If1ed8d5003160e45d503971ae722fd9983d3dd6d
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

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

@@ -15,7 +15,6 @@
 from unittest import mock
 from unittest.mock import call
 
-from cinderclient import api_versions
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
@@ -333,7 +332,7 @@ class TestTypeList(TestType):
         "Name",
         "Is Public",
     ]
-    columns_long = columns + ["Description", "Properties"]
+    columns_long = columns + ["Description"]
     data_with_default_type = [(volume_types[0].id, volume_types[0].name, True)]
     data = []
     for t in volume_types:
@@ -352,7 +351,6 @@ class TestTypeList(TestType):
                 t.name,
                 t.is_public,
                 t.description,
-                format_columns.DictColumn(t.extra_specs),
             )
         )
 
@@ -374,9 +372,7 @@ def test_type_list_without_options(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        self.volume_types_mock.list.assert_called_once_with(
-            search_opts={}, is_public=None
-        )
+        self.volume_types_mock.list.assert_called_once_with(is_public=None)
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data, list(data))
 
@@ -393,9 +389,7 @@ def test_type_list_with_options(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        self.volume_types_mock.list.assert_called_once_with(
-            search_opts={}, is_public=True
-        )
+        self.volume_types_mock.list.assert_called_once_with(is_public=True)
         self.assertEqual(self.columns_long, columns)
         self.assertCountEqual(self.data_long, list(data))
 
@@ -411,9 +405,7 @@ def test_type_list_with_private_option(self):
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
-        self.volume_types_mock.list.assert_called_once_with(
-            search_opts={}, is_public=False
-        )
+        self.volume_types_mock.list.assert_called_once_with(is_public=False)
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data, list(data))
 
@@ -434,77 +426,6 @@ def test_type_list_with_default_option(self):
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data_with_default_type, list(data))
 
-    def test_type_list_with_properties(self):
-        self.app.client_manager.volume.api_version = api_versions.APIVersion(
-            '3.52'
-        )
-
-        arglist = [
-            "--property",
-            "foo=bar",
-            "--multiattach",
-            "--cacheable",
-            "--replicated",
-            "--availability-zone",
-            "az1",
-        ]
-        verifylist = [
-            ("encryption_type", False),
-            ("long", False),
-            ("is_public", None),
-            ("default", False),
-            ("properties", {"foo": "bar"}),
-            ("multiattach", True),
-            ("cacheable", True),
-            ("replicated", True),
-            ("availability_zones", ["az1"]),
-        ]
-        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-
-        columns, data = self.cmd.take_action(parsed_args)
-        self.volume_types_mock.list.assert_called_once_with(
-            search_opts={
-                "extra_specs": {
-                    "foo": "bar",
-                    "multiattach": "<is> True",
-                    "cacheable": "<is> True",
-                    "replication_enabled": "<is> True",
-                    "RESKEY:availability_zones": "az1",
-                }
-            },
-            is_public=None,
-        )
-        self.assertEqual(self.columns, columns)
-        self.assertCountEqual(self.data, list(data))
-
-    def test_type_list_with_properties_pre_v352(self):
-        self.app.client_manager.volume.api_version = api_versions.APIVersion(
-            '3.51'
-        )
-
-        arglist = [
-            "--property",
-            "foo=bar",
-        ]
-        verifylist = [
-            ("encryption_type", False),
-            ("long", False),
-            ("is_public", None),
-            ("default", False),
-            ("properties", {"foo": "bar"}),
-        ]
-        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
-
-        exc = self.assertRaises(
-            exceptions.CommandError,
-            self.cmd.take_action,
-            parsed_args,
-        )
-        self.assertIn(
-            '--os-volume-api-version 3.52 or greater is required',
-            str(exc),
-        )
-
     def test_type_list_with_encryption(self):
         encryption_type = volume_fakes.create_one_encryption_volume_type(
             attrs={'volume_type_id': self.volume_types[0].id},
@@ -550,9 +471,7 @@ def test_type_list_with_encryption(self):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.volume_encryption_types_mock.list.assert_called_once_with()
-        self.volume_types_mock.list.assert_called_once_with(
-            search_opts={}, is_public=None
-        )
+        self.volume_types_mock.list.assert_called_once_with(is_public=None)
         self.assertEqual(encryption_columns, columns)
         self.assertCountEqual(encryption_data, list(data))
 

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

@@ -62,12 +62,18 @@ def __init__(self, **kwargs):
         self.resource_filters.resource_class = fakes.FakeResource(None, {})
         self.restores = mock.Mock()
         self.restores.resource_class = fakes.FakeResource(None, {})
-        self.volumes = mock.Mock()
-        self.volumes.resource_class = fakes.FakeResource(None, {})
+        self.volume_encryption_types = mock.Mock()
+        self.volume_encryption_types.resource_class = fakes.FakeResource(
+            None, {}
+        )
         self.volume_snapshots = mock.Mock()
         self.volume_snapshots.resource_class = fakes.FakeResource(None, {})
+        self.volume_type_access = mock.Mock()
+        self.volume_type_access.resource_class = fakes.FakeResource(None, {})
         self.volume_types = mock.Mock()
         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()
@@ -118,7 +124,6 @@ def setUp(self):
 
 # TODO(stephenfin): Check if the responses are actually the same
 create_one_snapshot = volume_v2_fakes.create_one_snapshot
-create_one_volume_type = volume_v2_fakes.create_one_volume_type
 
 
 def create_one_availability_zone(attrs=None):
@@ -364,6 +369,34 @@ def create_clusters(attrs=None, count=2):
     return clusters
 
 
+def create_one_encryption_volume_type(attrs=None):
+    """Create a fake encryption volume type.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :return:
+        A FakeResource object with volume_type_id etc.
+    """
+    attrs = attrs or {}
+
+    # Set default attributes.
+    encryption_info = {
+        "volume_type_id": 'type-id-' + uuid.uuid4().hex,
+        'provider': 'LuksEncryptor',
+        'cipher': None,
+        'key_size': None,
+        'control_location': 'front-end',
+    }
+
+    # Overwrite default attributes.
+    encryption_info.update(attrs)
+
+    encryption_type = fakes.FakeResource(
+        info=copy.deepcopy(encryption_info), loaded=True
+    )
+    return encryption_type
+
+
 def create_one_resource_filter(attrs=None):
     """Create a fake resource filter.
 
@@ -405,6 +438,31 @@ def create_resource_filters(attrs=None, count=2):
     return resource_filters
 
 
+def create_one_type_access(attrs=None):
+    """Create a fake volume type access for project.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :return:
+        A FakeResource object, with  Volume_type_ID and Project_ID.
+    """
+    if attrs is None:
+        attrs = {}
+
+    # Set default attributes.
+    type_access_attrs = {
+        'volume_type_id': 'volume-type-id-' + uuid.uuid4().hex,
+        'project_id': 'project-id-' + uuid.uuid4().hex,
+    }
+
+    # Overwrite default attributes.
+    type_access_attrs.update(attrs)
+
+    type_access = fakes.FakeResource(None, type_access_attrs, loaded=True)
+
+    return type_access
+
+
 def create_one_volume(attrs=None):
     """Create a fake volume.
 
@@ -821,6 +879,75 @@ def get_volume_attachments(attachments=None, count=2):
     return mock.Mock(side_effect=attachments)
 
 
+def create_one_volume_type(attrs=None, methods=None):
+    """Create a fake volume type.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :param dict methods:
+        A dictionary with all methods
+    :return:
+        A FakeResource object with id, name, description, etc.
+    """
+    attrs = attrs or {}
+    methods = methods or {}
+
+    # Set default attributes.
+    volume_type_info = {
+        "id": 'type-id-' + uuid.uuid4().hex,
+        "name": 'type-name-' + uuid.uuid4().hex,
+        "description": 'type-description-' + uuid.uuid4().hex,
+        "extra_specs": {"foo": "bar"},
+        "is_public": True,
+    }
+
+    # Overwrite default attributes.
+    volume_type_info.update(attrs)
+
+    volume_type = fakes.FakeResource(
+        info=copy.deepcopy(volume_type_info), methods=methods, loaded=True
+    )
+    return volume_type
+
+
+def create_volume_types(attrs=None, count=2):
+    """Create multiple fake volume_types.
+
+    :param dict attrs:
+        A dictionary with all attributes
+    :param int count:
+        The number of types to fake
+    :return:
+        A list of FakeResource objects faking the types
+    """
+    volume_types = []
+    for i in range(0, count):
+        volume_type = create_one_volume_type(attrs)
+        volume_types.append(volume_type)
+
+    return volume_types
+
+
+def get_volume_types(volume_types=None, count=2):
+    """Get an iterable MagicMock object with a list of faked volume types.
+
+    If volume_types list is provided, then initialize the Mock object with
+    the list. Otherwise create one.
+
+    :param List volume_types:
+        A list of FakeResource objects faking volume types
+    :param Integer count:
+        The number of volume types to be faked
+    :return
+        An iterable Mock object with side_effect set to a list of faked
+        volume types
+    """
+    if volume_types is None:
+        volume_types = create_volume_types(count)
+
+    return mock.Mock(side_effect=volume_types)
+
+
 def create_service_log_level_entry(attrs=None):
     service_log_level_info = {
         'host': 'host_test',