Make use of comparable 'FormattableColumn' subclasses

This requires fixes found in cliff 3.5.0 [1] and osc-lib 2.3.0 [2]. With
these fixes in place, we can remove the icky, still broken
'assertItemEqual' and 'assertListItemEqual' helpers.

[1] https://review.opendev.org/761421
[2] https://review.opendev.org/761394

Change-Id: Id6c26b37c3c7d5ec6761361abca57f9219b76838
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>

Author: stephenfin

lower-constraints.txt

@@ -5,7 +5,7 @@ Babel==2.6.0
 bcrypt==3.2.0
 cachetools==2.0.0
 cffi==1.14.0
-cliff==3.4.0
+cliff==3.5.0
 cmd2==0.8.0
 coverage==4.0
 cryptography==2.7
@@ -42,7 +42,7 @@ openstacksdk==0.52.0
 os-client-config==2.1.0
 os-service-types==1.7.0
 os-testr==1.0.0
-osc-lib==2.2.0
+osc-lib==2.3.0
 oslo.concurrency==3.26.0
 oslo.config==5.2.0
 oslo.context==2.19.2

openstackclient/identity/v2_0/catalog.py

@@ -91,7 +91,7 @@ def take_action(self, parsed_args):
         for service in auth_ref.service_catalog.catalog:
             if (service.get('name') == parsed_args.service or
                     service.get('type') == parsed_args.service):
-                data = service
+                data = service.copy()
                 data['endpoints'] = EndpointsColumn(data['endpoints'])
                 if 'endpoints_links' in data:
                     data.pop('endpoints_links')

openstackclient/tests/unit/compute/v2/test_aggregate.py

@@ -88,7 +88,7 @@ def test_aggregate_add_host(self):
         self.sdk_client.add_host_to_aggregate.assert_called_once_with(
             self.fake_ag.id, parsed_args.host)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
 
 class TestAggregateCreate(TestAggregate):
@@ -112,7 +112,7 @@ def test_aggregate_create(self):
         self.sdk_client.create_aggregate.assert_called_once_with(
             name=parsed_args.name)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
     def test_aggregate_create_with_zone(self):
         arglist = [
@@ -129,7 +129,7 @@ def test_aggregate_create_with_zone(self):
         self.sdk_client.create_aggregate.assert_called_once_with(
             name=parsed_args.name, availability_zone=parsed_args.zone)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
     def test_aggregate_create_with_property(self):
         arglist = [
@@ -148,7 +148,7 @@ def test_aggregate_create_with_property(self):
         self.sdk_client.set_aggregate_metadata.assert_called_once_with(
             self.fake_ag.id, parsed_args.property)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
 
 class TestAggregateDelete(TestAggregate):
@@ -265,7 +265,7 @@ def test_aggregate_list(self):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.assertEqual(self.list_columns, columns)
-        self.assertItemEqual(self.list_data, tuple(data))
+        self.assertItemsEqual(self.list_data, tuple(data))
 
     def test_aggregate_list_with_long(self):
         arglist = [
@@ -278,7 +278,7 @@ def test_aggregate_list_with_long(self):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.assertEqual(self.list_columns_long, columns)
-        self.assertListItemEqual(self.list_data_long, tuple(data))
+        self.assertItemsEqual(self.list_data_long, tuple(data))
 
 
 class TestAggregateRemoveHost(TestAggregate):
@@ -306,7 +306,7 @@ def test_aggregate_remove_host(self):
         self.sdk_client.remove_host_from_aggregate.assert_called_once_with(
             self.fake_ag.id, parsed_args.host)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
 
 class TestAggregateSet(TestAggregate):
@@ -492,7 +492,7 @@ def test_aggregate_show(self):
             parsed_args.aggregate, ignore_missing=False)
 
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, tuple(data))
+        self.assertItemsEqual(self.data, tuple(data))
 
 
 class TestAggregateUnset(TestAggregate):

openstackclient/tests/unit/compute/v2/test_flavor.py

@@ -133,7 +133,7 @@ def test_flavor_create_default_options(self):
         self.sdk_client.create_flavor.assert_called_once_with(**default_args)
 
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
     def test_flavor_create_all_options(self):
 
@@ -201,8 +201,8 @@ def test_flavor_create_all_options(self):
                 create_flavor, props)
             self.sdk_client.get_flavor_access.assert_not_called()
 
-            self.assertEqual(self.columns, columns)
-            self.assertItemEqual(tuple(cmp_data), data)
+        self.assertEqual(self.columns, columns)
+        self.assertItemsEqual(tuple(cmp_data), data)
 
     def test_flavor_create_other_options(self):
 
@@ -277,7 +277,7 @@ def test_flavor_create_other_options(self):
         self.sdk_client.create_flavor_extra_specs.assert_called_with(
             create_flavor, props)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(cmp_data, data)
+        self.assertItemsEqual(cmp_data, data)
 
     def test_public_flavor_create_with_project(self):
         arglist = [
@@ -350,7 +350,7 @@ def test_flavor_create_with_description_api_newer(self):
         self.sdk_client.create_flavor.assert_called_once_with(**args)
 
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data_private, data)
+        self.assertItemsEqual(self.data_private, data)
 
     def test_flavor_create_with_description_api_older(self):
         arglist = [
@@ -633,7 +633,7 @@ def test_flavor_list_long(self):
         )
 
         self.assertEqual(self.columns_long, columns)
-        self.assertListItemEqual(self.data_long, tuple(data))
+        self.assertItemsEqual(self.data_long, tuple(data))
 
 
 class TestFlavorSet(TestFlavor):
@@ -920,7 +920,7 @@ def test_public_flavor_show(self):
         columns, data = self.cmd.take_action(parsed_args)
 
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(self.data, data)
+        self.assertItemsEqual(self.data, data)
 
     def test_private_flavor_show(self):
         private_flavor = compute_fakes.FakeFlavor.create_one_flavor(
@@ -960,7 +960,7 @@ def test_private_flavor_show(self):
         self.sdk_client.get_flavor_access.assert_called_with(
             flavor=private_flavor.id)
         self.assertEqual(self.columns, columns)
-        self.assertItemEqual(data_with_project, data)
+        self.assertItemsEqual(data_with_project, data)
 
 
 class TestFlavorUnset(TestFlavor):

openstackclient/tests/unit/compute/v2/test_server_backup.py

@@ -139,7 +139,7 @@ def test_server_backup_defaults(self):
         )
 
         self.assertEqual(self.image_columns(images[0]), columns)
-        self.assertItemEqual(self.image_data(images[0]), data)
+        self.assertItemsEqual(self.image_data(images[0]), data)
 
     def test_server_backup_create_options(self):
         servers = self.setup_servers_mock(count=1)
@@ -173,7 +173,7 @@ def test_server_backup_create_options(self):
         )
 
         self.assertEqual(self.image_columns(images[0]), columns)
-        self.assertItemEqual(self.image_data(images[0]), data)
+        self.assertItemsEqual(self.image_data(images[0]), data)
 
     @mock.patch.object(common_utils, 'wait_for_status', return_value=False)
     def test_server_backup_wait_fail(self, mock_wait_for_status):
@@ -269,4 +269,4 @@ def test_server_backup_wait_ok(self, mock_wait_for_status):
         )
 
         self.assertEqual(self.image_columns(images[0]), columns)
-        self.assertItemEqual(self.image_data(images[0]), data)
+        self.assertItemsEqual(self.image_data(images[0]), data)

openstackclient/tests/unit/compute/v2/test_server_image.py

@@ -133,7 +133,7 @@ def test_server_image_create_defaults(self):
         )
 
         self.assertEqual(self.image_columns(images[0]), columns)
-        self.assertItemEqual(self.image_data(images[0]), data)
+        self.assertItemsEqual(self.image_data(images[0]), data)
 
     def test_server_image_create_options(self):
         servers = self.setup_servers_mock(count=1)
@@ -161,7 +161,7 @@ def test_server_image_create_options(self):
         )
 
         self.assertEqual(self.image_columns(images[0]), columns)
-        self.assertItemEqual(self.image_data(images[0]), data)
+        self.assertItemsEqual(self.image_data(images[0]), data)
 
     @mock.patch.object(common_utils, 'wait_for_status', return_value=False)
     def test_server_create_image_wait_fail(self, mock_wait_for_status):
@@ -229,4 +229,4 @@ def test_server_create_image_wait_ok(self, mock_wait_for_status):
         )
 
         self.assertEqual(self.image_columns(images[0]), columns)
-        self.assertItemEqual(self.image_data(images[0]), data)
+        self.assertItemsEqual(self.image_data(images[0]), data)

openstackclient/tests/unit/identity/v2_0/test_catalog.py

@@ -71,9 +71,10 @@ def test_catalog_list(self):
         datalist = ((
             'supernova',
             'compute',
-            catalog.EndpointsColumn(self.service_catalog['endpoints']),
+            catalog.EndpointsColumn(
+                auth_ref.service_catalog.catalog[0]['endpoints']),
         ), )
-        self.assertListItemEqual(datalist, tuple(data))
+        self.assertItemsEqual(datalist, tuple(data))
 
     def test_catalog_list_with_endpoint_url(self):
         attr = {
@@ -113,9 +114,10 @@ def test_catalog_list_with_endpoint_url(self):
         datalist = ((
             'supernova',
             'compute',
-            catalog.EndpointsColumn(service_catalog['endpoints']),
+            catalog.EndpointsColumn(
+                auth_ref.service_catalog.catalog[0]['endpoints']),
         ), )
-        self.assertListItemEqual(datalist, tuple(data))
+        self.assertItemsEqual(datalist, tuple(data))
 
 
 class TestCatalogShow(TestCatalog):
@@ -150,16 +152,17 @@ def test_catalog_show(self):
         collist = ('endpoints', 'id', 'name', 'type')
         self.assertEqual(collist, columns)
         datalist = (
-            catalog.EndpointsColumn(self.service_catalog['endpoints']),
+            catalog.EndpointsColumn(
+                auth_ref.service_catalog.catalog[0]['endpoints']),
             self.service_catalog.id,
             'supernova',
             'compute',
         )
-        self.assertItemEqual(datalist, data)
+        self.assertItemsEqual(datalist, data)
 
 
 class TestFormatColumns(TestCatalog):
-    def test_endpoints_column_human_readabale(self):
+    def test_endpoints_column_human_readable(self):
         col = catalog.EndpointsColumn(self.service_catalog['endpoints'])
         self.assertEqual(
             'one\n  publicURL: https://public.one.example.com\n  '

openstackclient/tests/unit/identity/v2_0/test_project.py

@@ -643,7 +643,7 @@ def test_project_show(self):
             self.fake_proj_show.name,
             format_columns.DictColumn({}),
         )
-        self.assertItemEqual(datalist, data)
+        self.assertItemsEqual(datalist, data)
 
 
 class TestProjectUnset(TestProject):

openstackclient/tests/unit/identity/v2_0/test_user.py

@@ -482,7 +482,7 @@ def test_user_list_no_options(self):
         self.users_mock.list.assert_called_with(tenant_id=None)
 
         self.assertEqual(self.columns, columns)
-        self.assertListItemEqual(self.datalist, tuple(data))
+        self.assertItemsEqual(self.datalist, tuple(data))
 
     def test_user_list_project(self):
         arglist = [
@@ -502,7 +502,7 @@ def test_user_list_project(self):
         self.users_mock.list.assert_called_with(tenant_id=project_id)
 
         self.assertEqual(self.columns, columns)
-        self.assertListItemEqual(self.datalist, tuple(data))
+        self.assertItemsEqual(self.datalist, tuple(data))
 
     def test_user_list_long(self):
         arglist = [
@@ -531,7 +531,7 @@ def test_user_list_long(self):
             self.fake_user_l.email,
             True,
         ), )
-        self.assertListItemEqual(datalist, tuple(data))
+        self.assertItemsEqual(datalist, tuple(data))
 
 
 class TestUserSet(TestUser):
@@ -819,4 +819,4 @@ def test_user_show(self):
             self.fake_user.name,
             self.fake_project.id,
         )
-        self.assertItemEqual(datalist, data)
+        self.assertItemsEqual(datalist, data)

openstackclient/tests/unit/identity/v3/test_catalog.py

@@ -91,9 +91,10 @@ def test_catalog_list(self):
         datalist = ((
             'supernova',
             'compute',
-            catalog.EndpointsColumn(self.fake_service['endpoints']),
+            catalog.EndpointsColumn(
+                auth_ref.service_catalog.catalog[0]['endpoints']),
         ), )
-        self.assertListItemEqual(datalist, tuple(data))
+        self.assertItemsEqual(datalist, tuple(data))
 
 
 class TestCatalogShow(TestCatalog):
@@ -128,12 +129,13 @@ def test_catalog_show(self):
         collist = ('endpoints', 'id', 'name', 'type')
         self.assertEqual(collist, columns)
         datalist = (
-            catalog.EndpointsColumn(self.fake_service['endpoints']),
+            catalog.EndpointsColumn(
+                auth_ref.service_catalog.catalog[0]['endpoints']),
             'qwertyuiop',
             'supernova',
             'compute',
         )
-        self.assertItemEqual(datalist, data)
+        self.assertItemsEqual(datalist, data)
 
 
 class TestFormatColumns(TestCatalog):