Merge "volume: Add 'volume group type *' commands"

2 files changed, 478 insertions, 1 deletions

diff --git a/openstackclient/tests/unit/volume/v3/fakes.py b/openstackclient/tests/unit/volume/v3/fakes.py
index b0c96290..c300ca38 100644
--- a/openstackclient/tests/unit/volume/v3/fakes.py
+++ b/openstackclient/tests/unit/volume/v3/fakes.py
@@ -129,10 +129,11 @@ class FakeVolumeGroupType:
     """Fake one or more volume group types."""
 
     @staticmethod
-    def create_one_volume_group_type(attrs=None):
+    def create_one_volume_group_type(attrs=None, methods=None):
         """Create a fake group type.
 
         :param attrs: A dictionary with all attributes of group type
+        :param methods: A dictionary with all methods
         :return: A FakeResource object with id, name, description, etc.
         """
         attrs = attrs or {}
@@ -152,6 +153,7 @@ class FakeVolumeGroupType:
         group_type = fakes.FakeResource(
             None,
             group_type_info,
+            methods=methods,
             loaded=True)
         return group_type
 
diff --git a/openstackclient/tests/unit/volume/v3/test_volume_group_type.py b/openstackclient/tests/unit/volume/v3/test_volume_group_type.py
new file mode 100644
index 00000000..7e758a2c
--- /dev/null
+++ b/openstackclient/tests/unit/volume/v3/test_volume_group_type.py
@@ -0,0 +1,475 @@
+# 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 cinderclient import api_versions
+from osc_lib.cli import format_columns
+from osc_lib import exceptions
+
+from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
+from openstackclient.volume.v3 import volume_group_type
+
+
+class TestVolumeGroupType(volume_fakes.TestVolume):
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock = \
+            self.app.client_manager.volume.group_types
+        self.volume_group_types_mock.reset_mock()
+
+
+class TestVolumeGroupTypeCreate(TestVolumeGroupType):
+
+    maxDiff = 2000
+
+    fake_volume_group_type = \
+        volume_fakes.FakeVolumeGroupType.create_one_volume_group_type()
+
+    columns = (
+        'ID',
+        'Name',
+        'Description',
+        'Is Public',
+        'Properties',
+    )
+    data = (
+        fake_volume_group_type.id,
+        fake_volume_group_type.name,
+        fake_volume_group_type.description,
+        fake_volume_group_type.is_public,
+        format_columns.DictColumn(fake_volume_group_type.group_specs),
+    )
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock.create.return_value = \
+            self.fake_volume_group_type
+
+        self.cmd = volume_group_type.CreateVolumeGroupType(self.app, None)
+
+    def test_volume_group_type_create(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+            self.fake_volume_group_type.name,
+        ]
+        verifylist = [
+            ('name', self.fake_volume_group_type.name),
+            ('description', None),
+            ('is_public', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.create.assert_called_once_with(
+            self.fake_volume_group_type.name,
+            None,
+            True)
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_volume_group_type_create_with_options(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+            self.fake_volume_group_type.name,
+            '--description', 'foo',
+            '--private',
+        ]
+        verifylist = [
+            ('name', self.fake_volume_group_type.name),
+            ('description', 'foo'),
+            ('is_public', False),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.create.assert_called_once_with(
+            self.fake_volume_group_type.name,
+            'foo',
+            False)
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_volume_group_type_create_pre_v311(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.10')
+
+        arglist = [
+            self.fake_volume_group_type.name,
+        ]
+        verifylist = [
+            ('name', self.fake_volume_group_type.name),
+            ('description', None),
+            ('is_public', True),
+        ]
+        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.11 or greater is required',
+            str(exc))
+
+
+class TestVolumeGroupTypeDelete(TestVolumeGroupType):
+
+    fake_volume_group_type = \
+        volume_fakes.FakeVolumeGroupType.create_one_volume_group_type()
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock.get.return_value = \
+            self.fake_volume_group_type
+        self.volume_group_types_mock.delete.return_value = None
+
+        self.cmd = volume_group_type.DeleteVolumeGroupType(self.app, None)
+
+    def test_volume_group_type_delete(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.delete.assert_called_once_with(
+            self.fake_volume_group_type.id,
+        )
+        self.assertIsNone(result)
+
+    def test_volume_group_type_delete_pre_v311(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.10')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+        ]
+        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.11 or greater is required',
+            str(exc))
+
+
+class TestVolumeGroupTypeSet(TestVolumeGroupType):
+
+    fake_volume_group_type = \
+        volume_fakes.FakeVolumeGroupType.create_one_volume_group_type(
+            methods={
+                'get_keys': {'foo': 'bar'},
+                'set_keys': None,
+                'unset_keys': None,
+            })
+
+    columns = (
+        'ID',
+        'Name',
+        'Description',
+        'Is Public',
+        'Properties',
+    )
+    data = (
+        fake_volume_group_type.id,
+        fake_volume_group_type.name,
+        fake_volume_group_type.description,
+        fake_volume_group_type.is_public,
+        format_columns.DictColumn(fake_volume_group_type.group_specs),
+    )
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock.get.return_value = \
+            self.fake_volume_group_type
+        self.volume_group_types_mock.update.return_value = \
+            self.fake_volume_group_type
+
+        self.cmd = volume_group_type.SetVolumeGroupType(self.app, None)
+
+    def test_volume_group_type_set(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        self.fake_volume_group_type.set_keys.return_value = None
+
+        arglist = [
+            self.fake_volume_group_type.id,
+            '--name', 'foo',
+            '--description', 'hello, world',
+            '--public',
+            '--property', 'fizz=buzz',
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+            ('name', 'foo'),
+            ('description', 'hello, world'),
+            ('is_public', True),
+            ('no_property', False),
+            ('properties', {'fizz': 'buzz'}),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.update.assert_called_once_with(
+            self.fake_volume_group_type.id,
+            name='foo',
+            description='hello, world',
+            is_public=True,
+        )
+        self.fake_volume_group_type.set_keys.assert_called_once_with(
+            {'fizz': 'buzz'},
+        )
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_volume_group_type_with_no_property_option(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+            '--no-property',
+            '--property', 'fizz=buzz',
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+            ('name', None),
+            ('description', None),
+            ('is_public', None),
+            ('no_property', True),
+            ('properties', {'fizz': 'buzz'}),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.get.assert_called_once_with(
+            self.fake_volume_group_type.id)
+        self.fake_volume_group_type.get_keys.assert_called_once_with()
+        self.fake_volume_group_type.unset_keys.assert_called_once_with(
+            {'foo': 'bar'}.keys())
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_volume_group_type_set_pre_v311(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.10')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+            '--name', 'foo',
+            '--description', 'hello, world',
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+            ('name', 'foo'),
+            ('description', 'hello, world'),
+            ('is_public', None),
+            ('no_property', False),
+            ('properties', None),
+        ]
+        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.11 or greater is required',
+            str(exc))
+
+
+class TestVolumeGroupTypeUnset(TestVolumeGroupType):
+
+    fake_volume_group_type = \
+        volume_fakes.FakeVolumeGroupType.create_one_volume_group_type(
+            methods={'unset_keys': None})
+
+    columns = (
+        'ID',
+        'Name',
+        'Description',
+        'Is Public',
+        'Properties',
+    )
+    data = (
+        fake_volume_group_type.id,
+        fake_volume_group_type.name,
+        fake_volume_group_type.description,
+        fake_volume_group_type.is_public,
+        format_columns.DictColumn(fake_volume_group_type.group_specs),
+    )
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock.get.return_value = \
+            self.fake_volume_group_type
+
+        self.cmd = volume_group_type.UnsetVolumeGroupType(self.app, None)
+
+    def test_volume_group_type_unset(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+            '--property', 'fizz',
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+            ('properties', ['fizz']),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.get.assert_has_calls([
+            mock.call(self.fake_volume_group_type.id),
+            mock.call(self.fake_volume_group_type.id),
+        ])
+        self.fake_volume_group_type.unset_keys.assert_called_once_with(
+            ['fizz'])
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(self.data, data)
+
+    def test_volume_group_type_unset_pre_v311(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.10')
+
+        arglist = [
+            self.fake_volume_group_type.id,
+            '--property', 'fizz',
+        ]
+        verifylist = [
+            ('group_type', self.fake_volume_group_type.id),
+            ('properties', ['fizz']),
+        ]
+        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.11 or greater is required',
+            str(exc))
+
+
+class TestVolumeGroupTypeList(TestVolumeGroupType):
+
+    fake_volume_group_types = \
+        volume_fakes.FakeVolumeGroupType.create_volume_group_types()
+
+    columns = (
+        'ID',
+        'Name',
+        'Is Public',
+        'Properties',
+    )
+    data = [
+        (
+            fake_volume_group_type.id,
+            fake_volume_group_type.name,
+            fake_volume_group_type.is_public,
+            fake_volume_group_type.group_specs,
+        ) for fake_volume_group_type in fake_volume_group_types
+    ]
+
+    def setUp(self):
+        super().setUp()
+
+        self.volume_group_types_mock.list.return_value = \
+            self.fake_volume_group_types
+        self.volume_group_types_mock.default.return_value = \
+            self.fake_volume_group_types[0]
+
+        self.cmd = volume_group_type.ListVolumeGroupType(self.app, None)
+
+    def test_volume_group_type_list(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+        ]
+        verifylist = [
+            ('show_default', False),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.list.assert_called_once_with()
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(tuple(self.data), data)
+
+    def test_volume_group_type_list_with_default_option(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.11')
+
+        arglist = [
+            '--default',
+        ]
+        verifylist = [
+            ('show_default', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volume_group_types_mock.default.assert_called_once_with()
+        self.assertEqual(self.columns, columns)
+        self.assertCountEqual(tuple([self.data[0]]), data)
+
+    def test_volume_group_type_list_pre_v311(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.10')
+
+        arglist = [
+        ]
+        verifylist = [
+        ]
+        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.11 or greater is required',
+            str(exc))