Use cliff formattable columns in volume v1 commands

Partial-Bug: #1687955
Partially implement blueprint osc-formattable-columns

Change-Id: Ib4c5798171e32a8ddc08a37ee1d416e366a71d76

4 files changed, 119 insertions, 59 deletions

diff --git a/openstackclient/tests/unit/volume/v1/test_qos_specs.py b/openstackclient/tests/unit/volume/v1/test_qos_specs.py
index 442840f9..11dc8084 100644
--- a/openstackclient/tests/unit/volume/v1/test_qos_specs.py
+++ b/openstackclient/tests/unit/volume/v1/test_qos_specs.py
@@ -17,6 +17,8 @@ import copy
 
 import mock
 from mock import call
+
+from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -85,7 +87,7 @@ class TestQosCreate(TestQos):
             self.new_qos_spec.consumer,
             self.new_qos_spec.id,
             self.new_qos_spec.name,
-            utils.format_dict(self.new_qos_spec.specs)
+            format_columns.DictColumn(self.new_qos_spec.specs)
         )
         self.qos_mock.create.return_value = self.new_qos_spec
         # Get the command object to test
@@ -108,7 +110,7 @@ class TestQosCreate(TestQos):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_qos_create_with_consumer(self):
         arglist = [
@@ -128,7 +130,7 @@ class TestQosCreate(TestQos):
             {'consumer': self.new_qos_spec.consumer}
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_qos_create_with_properties(self):
         arglist = [
@@ -154,7 +156,7 @@ class TestQosCreate(TestQos):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
 
 class TestQosDelete(TestQos):
@@ -326,8 +328,8 @@ class TestQosList(TestQos):
             q.id,
             q.name,
             q.consumer,
-            qos_association.name,
-            utils.format_dict(q.specs),
+            format_columns.ListColumn([qos_association.name]),
+            format_columns.DictColumn(q.specs),
         ))
 
     def setUp(self):
@@ -349,7 +351,7 @@ class TestQosList(TestQos):
         self.qos_mock.list.assert_called_with()
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, list(data))
+        self.assertListItemEqual(self.data, list(data))
 
     def test_qos_list_no_association(self):
         self.qos_mock.reset_mock()
@@ -373,10 +375,10 @@ class TestQosList(TestQos):
             self.qos_specs[1].id,
             self.qos_specs[1].name,
             self.qos_specs[1].consumer,
-            None,
-            utils.format_dict(self.qos_specs[1].specs),
+            format_columns.ListColumn(None),
+            format_columns.DictColumn(self.qos_specs[1].specs),
         )
-        self.assertEqual(ex_data, list(data))
+        self.assertListItemEqual(ex_data, list(data))
 
 
 class TestQosSet(TestQos):
@@ -447,13 +449,13 @@ class TestQosShow(TestQos):
         )
         self.assertEqual(collist, columns)
         datalist = (
-            self.qos_association.name,
+            format_columns.ListColumn([self.qos_association.name]),
             self.qos_spec.consumer,
             self.qos_spec.id,
             self.qos_spec.name,
-            utils.format_dict(self.qos_spec.specs),
+            format_columns.DictColumn(self.qos_spec.specs),
         )
-        self.assertEqual(datalist, tuple(data))
+        self.assertItemEqual(datalist, tuple(data))
 
 
 class TestQosUnset(TestQos):
diff --git a/openstackclient/tests/unit/volume/v1/test_type.py b/openstackclient/tests/unit/volume/v1/test_type.py
index dcdd3d56..beff8336 100644
--- a/openstackclient/tests/unit/volume/v1/test_type.py
+++ b/openstackclient/tests/unit/volume/v1/test_type.py
@@ -15,6 +15,7 @@
 import mock
 from mock import call
 
+from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -77,7 +78,7 @@ class TestTypeCreate(TestType):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, data)
+        self.assertItemEqual(self.data, data)
 
     def test_type_create_with_encryption(self):
         encryption_info = {
@@ -102,7 +103,7 @@ class TestTypeCreate(TestType):
         )
         encryption_data = (
             self.new_volume_type.description,
-            utils.format_dict(encryption_info),
+            format_columns.DictColumn(encryption_info),
             self.new_volume_type.id,
             True,
             self.new_volume_type.name,
@@ -138,7 +139,7 @@ class TestTypeCreate(TestType):
             body,
         )
         self.assertEqual(encryption_columns, columns)
-        self.assertEqual(encryption_data, data)
+        self.assertItemEqual(encryption_data, data)
 
 
 class TestTypeDelete(TestType):
@@ -246,7 +247,7 @@ class TestTypeList(TestType):
             t.id,
             t.name,
             t.is_public,
-            utils.format_dict(t.extra_specs),
+            format_columns.DictColumn(t.extra_specs),
         ))
 
     def setUp(self):
@@ -269,7 +270,7 @@ class TestTypeList(TestType):
         columns, data = self.cmd.take_action(parsed_args)
         self.types_mock.list.assert_called_once_with()
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, list(data))
+        self.assertListItemEqual(self.data, list(data))
 
     def test_type_list_with_options(self):
         arglist = [
@@ -283,7 +284,7 @@ class TestTypeList(TestType):
         columns, data = self.cmd.take_action(parsed_args)
         self.types_mock.list.assert_called_once_with()
         self.assertEqual(self.columns_long, columns)
-        self.assertEqual(self.data_long, list(data))
+        self.assertListItemEqual(self.data_long, list(data))
 
     def test_type_list_with_encryption(self):
         encryption_type = volume_fakes.FakeType.create_one_encryption_type(
@@ -302,13 +303,16 @@ class TestTypeList(TestType):
             self.volume_types[0].id,
             self.volume_types[0].name,
             self.volume_types[0].is_public,
-            utils.format_dict(encryption_info),
+            volume_type.EncryptionInfoColumn(
+                self.volume_types[0].id,
+                {self.volume_types[0].id: encryption_info}),
         ))
         encryption_data.append((
             self.volume_types[1].id,
             self.volume_types[1].name,
             self.volume_types[1].is_public,
-            '-',
+            volume_type.EncryptionInfoColumn(
+                self.volume_types[1].id, {}),
         ))
 
         self.encryption_types_mock.list.return_value = [encryption_type]
@@ -324,7 +328,7 @@ class TestTypeList(TestType):
         self.encryption_types_mock.list.assert_called_once_with()
         self.types_mock.list.assert_called_once_with()
         self.assertEqual(encryption_columns, columns)
-        self.assertEqual(encryption_data, list(data))
+        self.assertListItemEqual(encryption_data, list(data))
 
 
 class TestTypeSet(TestType):
@@ -443,7 +447,7 @@ class TestTypeShow(TestType):
             self.volume_type.id,
             True,
             self.volume_type.name,
-            utils.format_dict(self.volume_type.extra_specs)
+            format_columns.DictColumn(self.volume_type.extra_specs)
         )
 
         self.types_mock.get.return_value = self.volume_type
@@ -465,7 +469,7 @@ class TestTypeShow(TestType):
         self.types_mock.get.assert_called_with(self.volume_type.id)
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, data)
+        self.assertItemEqual(self.data, data)
 
     def test_type_show_with_encryption(self):
         encryption_type = volume_fakes.FakeType.create_one_encryption_type()
@@ -489,11 +493,11 @@ class TestTypeShow(TestType):
         )
         encryption_data = (
             self.volume_type.description,
-            utils.format_dict(encryption_info),
+            format_columns.DictColumn(encryption_info),
             self.volume_type.id,
             True,
             self.volume_type.name,
-            utils.format_dict(self.volume_type.extra_specs)
+            format_columns.DictColumn(self.volume_type.extra_specs)
         )
         arglist = [
             '--encryption-type',
@@ -509,7 +513,7 @@ class TestTypeShow(TestType):
         self.types_mock.get.assert_called_with(self.volume_type.id)
         self.encryption_types_mock.get.assert_called_with(self.volume_type.id)
         self.assertEqual(encryption_columns, columns)
-        self.assertEqual(encryption_data, data)
+        self.assertItemEqual(encryption_data, data)
 
 
 class TestTypeUnset(TestType):
@@ -587,3 +591,30 @@ class TestTypeUnset(TestType):
         result = self.cmd.take_action(parsed_args)
         self.encryption_types_mock.delete.assert_called_with(self.volume_type)
         self.assertIsNone(result)
+
+
+class TestColumns(TestType):
+
+    def test_encryption_info_column_with_info(self):
+        fake_volume_type = volume_fakes.FakeType.create_one_type()
+        type_id = fake_volume_type.id
+
+        encryption_info = {
+            'provider': 'LuksEncryptor',
+            'cipher': None,
+            'key_size': None,
+            'control_location': 'front-end',
+        }
+        col = volume_type.EncryptionInfoColumn(type_id,
+                                               {type_id: encryption_info})
+        self.assertEqual(utils.format_dict(encryption_info),
+                         col.human_readable())
+        self.assertEqual(encryption_info, col.machine_readable())
+
+    def test_encryption_info_column_without_info(self):
+        fake_volume_type = volume_fakes.FakeType.create_one_type()
+        type_id = fake_volume_type.id
+
+        col = volume_type.EncryptionInfoColumn(type_id, {})
+        self.assertEqual('-', col.human_readable())
+        self.assertIsNone(col.machine_readable())
diff --git a/openstackclient/tests/unit/volume/v1/test_volume.py b/openstackclient/tests/unit/volume/v1/test_volume.py
index eee5acd7..c4154555 100644
--- a/openstackclient/tests/unit/volume/v1/test_volume.py
+++ b/openstackclient/tests/unit/volume/v1/test_volume.py
@@ -17,6 +17,8 @@ import argparse
 
 import mock
 from mock import call
+
+from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -88,7 +90,7 @@ class TestVolumeCreate(TestVolume):
             self.new_volume.display_description,
             self.new_volume.id,
             self.new_volume.display_name,
-            utils.format_dict(self.new_volume.metadata),
+            format_columns.DictColumn(self.new_volume.metadata),
             self.new_volume.size,
             self.new_volume.snapshot_id,
             self.new_volume.status,
@@ -134,7 +136,7 @@ class TestVolumeCreate(TestVolume):
             None,
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_options(self):
         arglist = [
@@ -178,7 +180,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_user_project_id(self):
         # Return a project
@@ -225,7 +227,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_user_project_name(self):
         # Return a project
@@ -272,7 +274,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_properties(self):
         arglist = [
@@ -313,7 +315,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_image_id(self):
         image = image_fakes.FakeImage.create_one_image()
@@ -356,7 +358,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_image_name(self):
         image = image_fakes.FakeImage.create_one_image()
@@ -399,7 +401,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_with_source(self):
         self.volumes_mock.get.return_value = self.new_volume
@@ -429,7 +431,7 @@ class TestVolumeCreate(TestVolume):
             None,
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_create_with_bootable_and_readonly(self):
         arglist = [
@@ -467,7 +469,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
         self.volumes_mock.set_bootable.assert_called_with(
             self.new_volume.id, True)
         self.volumes_mock.update_readonly_flag.assert_called_with(
@@ -509,7 +511,7 @@ class TestVolumeCreate(TestVolume):
         )
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
         self.volumes_mock.set_bootable.assert_called_with(
             self.new_volume.id, False)
         self.volumes_mock.update_readonly_flag.assert_called_with(
@@ -561,7 +563,7 @@ class TestVolumeCreate(TestVolume):
 
         self.assertEqual(2, mock_error.call_count)
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
         self.volumes_mock.set_bootable.assert_called_with(
             self.new_volume.id, True)
         self.volumes_mock.update_readonly_flag.assert_called_with(
@@ -732,16 +734,13 @@ class TestVolumeList(TestVolume):
         'Size',
         'Attached to',
     )
-    server = _volume.attachments[0]['server_id']
-    device = _volume.attachments[0]['device']
-    msg = 'Attached to %s on %s ' % (server, device)
     datalist = (
         (
             _volume.id,
             _volume.display_name,
             _volume.status,
             _volume.size,
-            msg,
+            volume.AttachmentsColumn(_volume.attachments),
         ),
     )
 
@@ -767,7 +766,7 @@ class TestVolumeList(TestVolume):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, tuple(data))
+        self.assertListItemEqual(self.datalist, tuple(data))
 
     def test_volume_list_name(self):
         arglist = [
@@ -784,7 +783,7 @@ class TestVolumeList(TestVolume):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.assertEqual(self.columns, tuple(columns))
-        self.assertEqual(self.datalist, tuple(data))
+        self.assertListItemEqual(self.datalist, tuple(data))
 
     def test_volume_list_status(self):
         arglist = [
@@ -801,7 +800,7 @@ class TestVolumeList(TestVolume):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.assertEqual(self.columns, tuple(columns))
-        self.assertEqual(self.datalist, tuple(data))
+        self.assertListItemEqual(self.datalist, tuple(data))
 
     def test_volume_list_all_projects(self):
         arglist = [
@@ -818,7 +817,7 @@ class TestVolumeList(TestVolume):
 
         columns, data = self.cmd.take_action(parsed_args)
         self.assertEqual(self.columns, tuple(columns))
-        self.assertEqual(self.datalist, tuple(data))
+        self.assertListItemEqual(self.datalist, tuple(data))
 
     def test_volume_list_long(self):
         arglist = [
@@ -855,10 +854,10 @@ class TestVolumeList(TestVolume):
             self._volume.size,
             self._volume.volume_type,
             self._volume.bootable,
-            self.msg,
-            utils.format_dict(self._volume.metadata),
+            volume.AttachmentsColumn(self._volume.attachments),
+            format_columns.DictColumn(self._volume.metadata),
         ), )
-        self.assertEqual(datalist, tuple(data))
+        self.assertListItemEqual(datalist, tuple(data))
 
     def test_volume_list_with_limit(self):
         arglist = [
@@ -883,7 +882,7 @@ class TestVolumeList(TestVolume):
                 'all_tenants': False, }
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, tuple(data))
+        self.assertListItemEqual(self.datalist, tuple(data))
 
     def test_volume_list_negative_limit(self):
         arglist = [
@@ -1251,7 +1250,7 @@ class TestVolumeShow(TestVolume):
             self._volume.display_description,
             self._volume.id,
             self._volume.display_name,
-            utils.format_dict(self._volume.metadata),
+            format_columns.DictColumn(self._volume.metadata),
             self._volume.size,
             self._volume.snapshot_id,
             self._volume.status,
@@ -1274,7 +1273,7 @@ class TestVolumeShow(TestVolume):
         self.volumes_mock.get.assert_called_with(self._volume.id)
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.datalist, data)
+        self.assertItemEqual(self.datalist, data)
 
     def test_volume_show_backward_compatibility(self):
         arglist = [
@@ -1339,3 +1338,31 @@ class TestVolumeUnset(TestVolume):
             self._volume.id, ['myprop']
         )
         self.assertIsNone(result)
+
+
+class TestColumns(TestVolume):
+
+    def test_attachments_column_without_server_cache(self):
+        _volume = volume_fakes.FakeVolume.create_one_volume()
+        server_id = _volume.attachments[0]['server_id']
+        device = _volume.attachments[0]['device']
+
+        col = volume.AttachmentsColumn(_volume.attachments, {})
+        self.assertEqual('Attached to %s on %s ' % (server_id, device),
+                         col.human_readable())
+        self.assertEqual(_volume.attachments, col.machine_readable())
+
+    def test_attachments_column_with_server_cache(self):
+        _volume = volume_fakes.FakeVolume.create_one_volume()
+
+        server_id = _volume.attachments[0]['server_id']
+        device = _volume.attachments[0]['device']
+        fake_server = mock.Mock()
+        fake_server.name = 'fake-server-name'
+        server_cache = {server_id: fake_server}
+
+        col = volume.AttachmentsColumn(_volume.attachments, server_cache)
+        self.assertEqual(
+            'Attached to %s on %s ' % ('fake-server-name', device),
+            col.human_readable())
+        self.assertEqual(_volume.attachments, col.machine_readable())
diff --git a/openstackclient/tests/unit/volume/v1/test_volume_backup.py b/openstackclient/tests/unit/volume/v1/test_volume_backup.py
index 22c1f8cf..20be6e46 100644
--- a/openstackclient/tests/unit/volume/v1/test_volume_backup.py
+++ b/openstackclient/tests/unit/volume/v1/test_volume_backup.py
@@ -100,7 +100,7 @@ class TestBackupCreate(TestBackup):
             self.new_backup.description,
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, data)
+        self.assertItemEqual(self.data, data)
 
     def test_backup_create_without_name(self):
         arglist = [
@@ -124,7 +124,7 @@ class TestBackupCreate(TestBackup):
             self.new_backup.description,
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, data)
+        self.assertItemEqual(self.data, data)
 
 
 class TestBackupDelete(TestBackup):
@@ -240,7 +240,7 @@ class TestBackupList(TestBackup):
             b.status,
             b.size,
             b.availability_zone,
-            b.volume_id,
+            volume_backup.VolumeIdColumn(b.volume_id),
             b.container,
         ))
 
@@ -277,7 +277,7 @@ class TestBackupList(TestBackup):
             search_opts=search_opts,
         )
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, list(data))
+        self.assertListItemEqual(self.data, list(data))
 
     def test_backup_list_with_options(self):
         arglist = [
@@ -309,7 +309,7 @@ class TestBackupList(TestBackup):
             search_opts=search_opts,
         )
         self.assertEqual(self.columns_long, columns)
-        self.assertEqual(self.data_long, list(data))
+        self.assertListItemEqual(self.data_long, list(data))
 
 
 class TestBackupRestore(TestBackup):
@@ -391,4 +391,4 @@ class TestBackupShow(TestBackup):
         self.backups_mock.get.assert_called_with(self.backup.id)
 
         self.assertEqual(self.columns, columns)
-        self.assertEqual(self.data, data)
+        self.assertItemEqual(self.data, data)