Replace "Display Name" by "Name" in volume list

Current "volume list --name" command use "display_name" as search_opts
to send to cinder API, and show the result table with "Display Name"
column title in osc, cinder list API support "name" as search opts too,
and there is "name" attribute in volume response body, so we can replace
all "Display Name" by "Name" in order to keep "volume list" command
consistent with other commands, like: server list, network list and so
on, only use "Name" attribute for all objects.

Support a mapping for volume list -c "Display Name" (Volume v1 and v2)
and volume create/show -c "display_name" (Volume v1) for minimal
backward compatibility until R release.

Change-Id: I120be0118e7bb30093b4237c5eeb69a9eedef077
Closes-Bug: #1657956
Depends-On: I1fb62219b092346ea380099811cbd082cae5bafe

Author: kiwik

doc/source/backwards-incompatible.rst

@@ -27,6 +27,27 @@ Backwards Incompatible Changes
 ..   * Remove in: <5.0>
 ..   * Commit: <tbd>
 
+Release 3.12.0
+--------------
+
+1. Replace ``Display Name`` by ``Name`` in volume list.
+
+  Change column name ``Display Name`` to ``Name`` in ``volume list`` output.
+  Current ``volume list --name`` command uses ``display_name`` as search_opts
+  to send to cinder API, and show the result table with ``Display Name``
+  as column title. Replace all ``Display Name`` by ``Name`` to be consistent
+  with other list commands.
+
+  Support a mapping for volume list -c ``Display Name`` (Volume v1 and v2)
+  and volume create/show -c ``display_name`` (Volume v1) to maintain backward
+  compatibility until the next major release.
+
+  * In favor of: ``openstack volume list -c Name``
+  * As of: 3.12.0
+  * Removed in: n/a
+  * Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1657956
+  * Commit: https://review.openstack.org/#/c/423081/
+
 Release 3.10
 ------------
 
@@ -62,6 +83,7 @@ Release 3.0
   * Bug: n/a
   * Commit: https://review.openstack.org/332938
 
+
 Releases Before 3.0
 -------------------
 

openstackclient/tests/functional/volume/v1/test_transfer_request.py

@@ -27,7 +27,7 @@ def setUpClass(cls):
         super(TransferRequestTests, cls).setUpClass()
         cmd_output = json.loads(cls.openstack(
             'volume create -f json --size 1 ' + cls.VOLUME_NAME))
-        cls.assertOutput(cls.VOLUME_NAME, cmd_output['display_name'])
+        cls.assertOutput(cls.VOLUME_NAME, cmd_output['name'])
 
         cmd_output = json.loads(cls.openstack(
             'volume transfer request create -f json ' +
@@ -51,7 +51,7 @@ def test_volume_transfer_request_accept(self):
         # create a volume
         cmd_output = json.loads(self.openstack(
             'volume create -f json --size 1 ' + volume_name))
-        self.assertEqual(volume_name, cmd_output['display_name'])
+        self.assertEqual(volume_name, cmd_output['name'])
 
         # create volume transfer request for the volume
         # and get the auth_key of the new transfer request

openstackclient/tests/functional/volume/v1/test_volume.py

@@ -81,7 +81,7 @@ def test_volume_list(self):
         cmd_output = json.loads(self.openstack(
             'volume list -f json '
         ))
-        names = [x["Display Name"] for x in cmd_output]
+        names = [x["Name"] for x in cmd_output]
         self.assertIn(name1, names)
         self.assertIn(name2, names)
 
@@ -97,7 +97,7 @@ def test_volume_list(self):
             'volume list -f json ' +
             '--name ' + name1
         ))
-        names = [x["Display Name"] for x in cmd_output]
+        names = [x["Name"] for x in cmd_output]
         self.assertIn(name1, names)
         self.assertNotIn(name2, names)
 
@@ -113,7 +113,7 @@ def test_volume_set_and_unset(self):
         ))
         self.assertEqual(
             name,
-            cmd_output["display_name"],
+            cmd_output["name"],
         )
         self.assertEqual(
             1,
@@ -155,7 +155,7 @@ def test_volume_set_and_unset(self):
         ))
         self.assertEqual(
             new_name,
-            cmd_output["display_name"],
+            cmd_output["name"],
         )
         self.assertEqual(
             2,
@@ -191,6 +191,49 @@ def test_volume_set_and_unset(self):
             cmd_output["properties"],
         )
 
+    def test_volume_create_and_list_and_show_backward_compatibility(self):
+        """Test backward compatibility of create, list, show"""
+        name1 = uuid.uuid4().hex
+        json_output = json.loads(self.openstack(
+            'volume create -f json ' +
+            '-c display_name -c id ' +
+            '--size 1 ' +
+            name1
+        ))
+        self.assertIn('display_name', json_output)
+        self.assertEqual(name1, json_output['display_name'])
+        self.assertIn('id', json_output)
+        volume_id = json_output['id']
+        self.assertIsNotNone(volume_id)
+        self.assertNotIn('name', json_output)
+        self.addCleanup(self.openstack, 'volume delete ' + volume_id)
+
+        self.wait_for("volume", name1, "available")
+
+        json_output = json.loads(self.openstack(
+            'volume list -f json ' +
+            '-c "Display Name"'
+        ))
+        for each_volume in json_output:
+            self.assertIn('Display Name', each_volume)
+
+        json_output = json.loads(self.openstack(
+            'volume list -f json ' +
+            '-c "Name"'
+        ))
+        for each_volume in json_output:
+            self.assertIn('Name', each_volume)
+
+        json_output = json.loads(self.openstack(
+            'volume show -f json ' +
+            '-c display_name -c id ' +
+            name1
+        ))
+        self.assertIn('display_name', json_output)
+        self.assertEqual(name1, json_output['display_name'])
+        self.assertIn('id', json_output)
+        self.assertNotIn('name', json_output)
+
     def wait_for(self, check_type, check_name, desired_status, wait=120,
                  interval=5, failures=['ERROR']):
         status = "notset"

openstackclient/tests/functional/volume/v2/test_volume.py

@@ -90,7 +90,7 @@ def test_volume_list(self):
             'volume list -f json ' +
             '--long'
         ))
-        names = [x["Display Name"] for x in cmd_output]
+        names = [x["Name"] for x in cmd_output]
         self.assertIn(name1, names)
         self.assertIn(name2, names)
 
@@ -99,7 +99,7 @@ def test_volume_list(self):
             'volume list -f json ' +
             '--status error'
         ))
-        names = [x["Display Name"] for x in cmd_output]
+        names = [x["Name"] for x in cmd_output]
         self.assertNotIn(name1, names)
         self.assertIn(name2, names)
 
@@ -249,6 +249,37 @@ def test_volume_snapshot(self):
             'volume snapshot delete ' + snapshot_name)
         self.assertOutput('', raw_output)
 
+    def test_volume_list_backward_compatibility(self):
+        """Test backward compatibility of list command"""
+        name1 = uuid.uuid4().hex
+        cmd_output = json.loads(self.openstack(
+            'volume create -f json ' +
+            '--size 1 ' +
+            name1
+        ))
+        self.addCleanup(self.openstack, 'volume delete ' + name1)
+        self.assertEqual(
+            1,
+            cmd_output["size"],
+        )
+        self.wait_for("volume", name1, "available")
+
+        # Test list -c "Display Name"
+        cmd_output = json.loads(self.openstack(
+            'volume list -f json ' +
+            '-c "Display Name"'
+        ))
+        for each_volume in cmd_output:
+            self.assertIn('Display Name', each_volume)
+
+        # Test list -c "Name"
+        cmd_output = json.loads(self.openstack(
+            'volume list -f json ' +
+            '-c "Name"'
+        ))
+        for each_volume in cmd_output:
+            self.assertIn('Name', each_volume)
+
     def wait_for(self, check_type, check_name, desired_status, wait=120,
                  interval=5, failures=['ERROR']):
         status = "notset"

openstackclient/tests/unit/volume/v1/test_volume.py

@@ -68,8 +68,8 @@ class TestVolumeCreate(TestVolume):
         'bootable',
         'created_at',
         'display_description',
-        'display_name',
         'id',
+        'name',
         'properties',
         'size',
         'snapshot_id',
@@ -86,8 +86,8 @@ def setUp(self):
             self.new_volume.bootable,
             self.new_volume.created_at,
             self.new_volume.display_description,
-            self.new_volume.display_name,
             self.new_volume.id,
+            self.new_volume.display_name,
             utils.format_dict(self.new_volume.metadata),
             self.new_volume.size,
             self.new_volume.snapshot_id,
@@ -598,6 +598,38 @@ def test_volume_create_with_multi_source(self):
         self.assertRaises(tests_utils.ParserException, self.check_parser,
                           self.cmd, arglist, verifylist)
 
+    def test_volume_create_backward_compatibility(self):
+        arglist = [
+            '-c', 'display_name',
+            '--size', str(self.new_volume.size),
+            self.new_volume.display_name,
+        ]
+        verifylist = [
+            ('columns', ['display_name']),
+            ('size', self.new_volume.size),
+            ('name', self.new_volume.display_name),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volumes_mock.create.assert_called_with(
+            self.new_volume.size,
+            None,
+            None,
+            self.new_volume.display_name,
+            None,
+            None,
+            None,
+            None,
+            None,
+            None,
+            None,
+        )
+        self.assertIn('display_name', columns)
+        self.assertNotIn('name', columns)
+        self.assertIn(self.new_volume.display_name, data)
+
 
 class TestVolumeDelete(TestVolume):
 
@@ -695,7 +727,7 @@ class TestVolumeList(TestVolume):
     _volume = volume_fakes.FakeVolume.create_one_volume()
     columns = (
         'ID',
-        'Display Name',
+        'Name',
         'Status',
         'Size',
         'Attached to',
@@ -806,7 +838,7 @@ def test_volume_list_long(self):
 
         collist = (
             'ID',
-            'Display Name',
+            'Name',
             'Status',
             'Size',
             'Type',
@@ -863,6 +895,27 @@ def test_volume_list_negative_limit(self):
         self.assertRaises(argparse.ArgumentTypeError, self.check_parser,
                           self.cmd, arglist, verifylist)
 
+    def test_volume_list_backward_compatibility(self):
+        arglist = [
+            '-c', 'Display Name',
+        ]
+        verifylist = [
+            ('columns', ['Display Name']),
+            ('long', False),
+            ('all_projects', False),
+            ('name', None),
+            ('status', None),
+            ('limit', None),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.assertIn('Display Name', columns)
+        self.assertNotIn('Name', columns)
+        for each_volume in data:
+            self.assertIn(self._volume.display_name, each_volume)
+
 
 class TestVolumeMigrate(TestVolume):
 
@@ -1178,8 +1231,8 @@ class TestVolumeShow(TestVolume):
         'bootable',
         'created_at',
         'display_description',
-        'display_name',
         'id',
+        'name',
         'properties',
         'size',
         'snapshot_id',
@@ -1196,8 +1249,8 @@ def setUp(self):
             self._volume.bootable,
             self._volume.created_at,
             self._volume.display_description,
-            self._volume.display_name,
             self._volume.id,
+            self._volume.display_name,
             utils.format_dict(self._volume.metadata),
             self._volume.size,
             self._volume.snapshot_id,
@@ -1223,6 +1276,25 @@ def test_volume_show(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.datalist, data)
 
+    def test_volume_show_backward_compatibility(self):
+        arglist = [
+            '-c', 'display_name',
+            self._volume.id,
+        ]
+        verifylist = [
+            ('columns', ['display_name']),
+            ('volume', self._volume.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.volumes_mock.get.assert_called_with(self._volume.id)
+
+        self.assertIn('display_name', columns)
+        self.assertNotIn('name', columns)
+        self.assertIn(self._volume.display_name, data)
+
 
 class TestVolumeUnset(TestVolume):