Merge "Add volume summary command"

1 files changed, 121 insertions, 0 deletions

diff --git a/openstackclient/tests/unit/volume/v3/test_volume.py b/openstackclient/tests/unit/volume/v3/test_volume.py
new file mode 100644
index 00000000..783f0852
--- /dev/null
+++ b/openstackclient/tests/unit/volume/v3/test_volume.py
@@ -0,0 +1,121 @@
+#
+#   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.
+#
+
+import copy
+
+from cinderclient import api_versions
+from osc_lib.cli import format_columns
+from osc_lib import exceptions
+
+from openstackclient.tests.unit.volume.v2 import fakes as volume_fakes
+from openstackclient.volume.v3 import volume
+
+
+class TestVolumeSummary(volume_fakes.TestVolume):
+
+    columns = [
+        'Total Count',
+        'Total Size',
+    ]
+
+    def setUp(self):
+        super().setUp()
+
+        self.volumes_mock = self.app.client_manager.volume.volumes
+        self.volumes_mock.reset_mock()
+        self.mock_vol_1 = volume_fakes.create_one_volume()
+        self.mock_vol_2 = volume_fakes.create_one_volume()
+        self.return_dict = {
+            'volume-summary': {
+                'total_count': 2,
+                'total_size': self.mock_vol_1.size + self.mock_vol_2.size}}
+        self.volumes_mock.summary.return_value = self.return_dict
+
+        # Get the command object to test
+        self.cmd = volume.VolumeSummary(self.app, None)
+
+    def test_volume_summary(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.12')
+        arglist = [
+            '--all-projects',
+        ]
+        verifylist = [
+            ('all_projects', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volumes_mock.summary.assert_called_once_with(
+            all_tenants=True,
+        )
+
+        self.assertEqual(self.columns, columns)
+
+        datalist = (
+            2,
+            self.mock_vol_1.size + self.mock_vol_2.size)
+        self.assertCountEqual(datalist, tuple(data))
+
+    def test_volume_summary_pre_312(self):
+        arglist = [
+            '--all-projects',
+        ]
+        verifylist = [
+            ('all_projects', 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.12 or greater is required',
+            str(exc))
+
+    def test_volume_summary_with_metadata(self):
+        self.app.client_manager.volume.api_version = \
+            api_versions.APIVersion('3.36')
+
+        combine_meta = {**self.mock_vol_1.metadata, **self.mock_vol_2.metadata}
+        meta_dict = copy.deepcopy(self.return_dict)
+        meta_dict['volume-summary']['metadata'] = combine_meta
+        self.volumes_mock.summary.return_value = meta_dict
+
+        new_cols = copy.deepcopy(self.columns)
+        new_cols.extend(['Metadata'])
+
+        arglist = [
+            '--all-projects',
+        ]
+        verifylist = [
+            ('all_projects', True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volumes_mock.summary.assert_called_once_with(
+            all_tenants=True,
+        )
+
+        self.assertEqual(new_cols, columns)
+
+        datalist = (
+            2,
+            self.mock_vol_1.size + self.mock_vol_2.size,
+            format_columns.DictColumn(combine_meta))
+        self.assertCountEqual(datalist, tuple(data))