Fix volume transfers request commands

* Fix volume transfer request accept to actually not crash when
  trying to call Volume API.
* Fix volume transfer request accept syntax to have only one
  positional argument, which is the ID of the resource in the command
* Change the output column order in volume transfer request list to
  have ID followed by Name then the remaining columns.

Closes-bug: 1633582
Change-Id: I5cc005f039d171cc70859f60e7fe649b09ead229

Author: Dean Troyer

doc/source/backwards-incompatible.rst

@@ -16,6 +16,17 @@ this backwards incompatible change handling.
 Backwards Incompatible Changes
 ==============================
 
+.. Carry this section as comments until 4.0 release
+.. Release 4.0
+.. -----------
+
+.. 1. Change ``volume transfer request accept`` to use new option ``--auth-key``
+..    rather than a second positional argument.
+
+..   * As of: 4.0
+..   * Remove in: <5.0>
+..   * Commit: <tbd>
+
 Release 3.0
 -----------
 

doc/source/command-objects/volume-transfer-request.rst

@@ -13,17 +13,19 @@ Accept volume transfer request
 .. code:: bash
 
     openstack volume transfer request accept
-        <transfer-request>
-        <auth-key>
+        --auth-key <key>
+        <transfer-request-id>
 
-.. _volume_transfer_request_accept:
-.. describe:: <transfer-request>
+.. option:: --auth-key <key>
 
-    Volume transfer request to accept (name or ID)
+    Volume transfer request authentication key
+
+.. _volume_transfer_request_accept:
+.. describe:: <transfer-request-id>
 
-.. describe:: <auth-key>
+    Volume transfer request to accept (ID only)
 
-    Authentication key of transfer request
+    Non-admin users are only able to specify the transfer request by ID.
 
 volume transfer request create
 ------------------------------
@@ -65,7 +67,7 @@ Delete volume transfer request(s)
 volume transfer request list
 ----------------------------
 
-Lists all volume transfer requests.
+Lists all volume transfer requests
 
 .. program:: volume transfer request list
 .. code:: bash
@@ -75,8 +77,7 @@ Lists all volume transfer requests.
 
 .. option:: --all-projects
 
-    Shows detail for all projects. Admin only.
-    (defaults to False)
+    Include all projects (admin only)
 
 volume transfer request show
 ----------------------------

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

@@ -10,6 +10,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import json
 import uuid
 
 from openstackclient.tests.functional.volume.v1 import common
@@ -67,11 +68,12 @@ def test_volume_transfer_request_accept(self):
         self.assertNotEqual('', auth_key)
 
         # accept the volume transfer request
-        opts = self.get_opts(self.FIELDS)
-        raw_output = self.openstack(
-            'volume transfer request accept ' + name +
-            ' ' + auth_key + opts)
-        self.assertEqual(name + '\n', raw_output)
+        json_output = json.loads(self.openstack(
+            'volume transfer request accept -f json ' +
+            name + ' ' +
+            '--auth-key ' + auth_key
+        ))
+        self.assertEqual(name, json_output.get('name'))
 
         # the volume transfer will be removed by default after accepted
         # so just need to delete the volume here

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

@@ -10,6 +10,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import json
 import uuid
 
 from openstackclient.tests.functional.volume.v2 import common
@@ -67,11 +68,12 @@ def test_volume_transfer_request_accept(self):
         self.assertNotEqual('', auth_key)
 
         # accept the volume transfer request
-        opts = self.get_opts(self.FIELDS)
-        raw_output = self.openstack(
-            'volume transfer request accept ' + name +
-            ' ' + auth_key + opts)
-        self.assertEqual(name + '\n', raw_output)
+        json_output = json.loads(self.openstack(
+            'volume transfer request accept -f json ' +
+            name + ' ' +
+            '--auth-key ' + auth_key
+        ))
+        self.assertEqual(name, json_output.get('name'))
 
         # the volume transfer will be removed by default after accepted
         # so just need to delete the volume here

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

@@ -64,24 +64,62 @@ def setUp(self):
 
     def test_transfer_accept(self):
         arglist = [
+            '--auth-key', 'key_value',
             self.volume_transfer.id,
-            'auth_key',
         ]
         verifylist = [
             ('transfer_request', self.volume_transfer.id),
-            ('auth_key', 'auth_key'),
+            ('auth_key', 'key_value'),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
 
         self.transfer_mock.get.assert_called_once_with(
-            self.volume_transfer.id)
+            self.volume_transfer.id,
+        )
         self.transfer_mock.accept.assert_called_once_with(
-            self.volume_transfer.id, 'auth_key')
+            self.volume_transfer.id,
+            'key_value',
+        )
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)
 
+    def test_transfer_accept_deprecated(self):
+        arglist = [
+            self.volume_transfer.id,
+            'key_value',
+        ]
+        verifylist = [
+            ('transfer_request', self.volume_transfer.id),
+            ('old_auth_key', 'key_value'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.transfer_mock.accept.assert_called_once_with(
+            self.volume_transfer.id,
+            'key_value',
+        )
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, data)
+
+    def test_transfer_accept_no_option(self):
+        arglist = [
+            self.volume_transfer.id,
+        ]
+        verifylist = [
+            ('transfer_request', self.volume_transfer.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.assertRaises(
+            exceptions.CommandError,
+            self.cmd.take_action,
+            parsed_args,
+        )
+
 
 class TestTransferCreate(TestTransfer):
 
@@ -219,7 +257,7 @@ def test_delete_multiple_transfers_with_exception(self):
                 self.fail('CommandError should be raised.')
             except exceptions.CommandError as e:
                 self.assertEqual('1 of 2 volume transfer requests failed '
-                                 'to delete.', str(e))
+                                 'to delete', str(e))
 
             find_mock.assert_any_call(
                 self.transfer_mock, self.volume_transfers[0].id)
@@ -256,17 +294,17 @@ def test_transfer_list_without_argument(self):
 
         expected_columns = [
             'ID',
-            'Volume',
             'Name',
+            'Volume',
         ]
 
         # confirming if all expected columns are present in the result.
         self.assertEqual(expected_columns, columns)
 
         datalist = ((
             self.volume_transfers.id,
-            self.volume_transfers.volume_id,
             self.volume_transfers.name,
+            self.volume_transfers.volume_id,
         ), )
 
         # confirming if all expected values are present in the result.
@@ -295,17 +333,17 @@ def test_transfer_list_with_argument(self):
 
         expected_columns = [
             'ID',
-            'Volume',
             'Name',
+            'Volume',
         ]
 
         # confirming if all expected columns are present in the result.
         self.assertEqual(expected_columns, columns)
 
         datalist = ((
             self.volume_transfers.id,
-            self.volume_transfers.volume_id,
             self.volume_transfers.name,
+            self.volume_transfers.volume_id,
         ), )
 
         # confirming if all expected values are present in the result.

openstackclient/tests/unit/volume/v2/test_transfer_request.py

@@ -64,24 +64,62 @@ def setUp(self):
 
     def test_transfer_accept(self):
         arglist = [
+            '--auth-key', 'key_value',
             self.volume_transfer.id,
-            'auth_key',
         ]
         verifylist = [
             ('transfer_request', self.volume_transfer.id),
-            ('auth_key', 'auth_key'),
+            ('auth_key', 'key_value'),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
         columns, data = self.cmd.take_action(parsed_args)
 
         self.transfer_mock.get.assert_called_once_with(
-            self.volume_transfer.id)
+            self.volume_transfer.id,
+        )
         self.transfer_mock.accept.assert_called_once_with(
-            self.volume_transfer.id, 'auth_key')
+            self.volume_transfer.id,
+            'key_value',
+        )
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, data)
 
+    def test_transfer_accept_deprecated(self):
+        arglist = [
+            self.volume_transfer.id,
+            'key_value',
+        ]
+        verifylist = [
+            ('transfer_request', self.volume_transfer.id),
+            ('old_auth_key', 'key_value'),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.transfer_mock.accept.assert_called_once_with(
+            self.volume_transfer.id,
+            'key_value',
+        )
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data, data)
+
+    def test_transfer_accept_no_option(self):
+        arglist = [
+            self.volume_transfer.id,
+        ]
+        verifylist = [
+            ('transfer_request', self.volume_transfer.id),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.assertRaises(
+            exceptions.CommandError,
+            self.cmd.take_action,
+            parsed_args,
+        )
+
 
 class TestTransferCreate(TestTransfer):
 
@@ -219,7 +257,7 @@ def test_delete_multiple_transfers_with_exception(self):
                 self.fail('CommandError should be raised.')
             except exceptions.CommandError as e:
                 self.assertEqual('1 of 2 volume transfer requests failed '
-                                 'to delete.', str(e))
+                                 'to delete', str(e))
 
             find_mock.assert_any_call(
                 self.transfer_mock, self.volume_transfers[0].id)
@@ -256,17 +294,17 @@ def test_transfer_list_without_argument(self):
 
         expected_columns = [
             'ID',
-            'Volume',
             'Name',
+            'Volume',
         ]
 
         # confirming if all expected columns are present in the result.
         self.assertEqual(expected_columns, columns)
 
         datalist = ((
             self.volume_transfers.id,
-            self.volume_transfers.volume_id,
             self.volume_transfers.name,
+            self.volume_transfers.volume_id,
         ), )
 
         # confirming if all expected values are present in the result.
@@ -295,17 +333,17 @@ def test_transfer_list_with_argument(self):
 
         expected_columns = [
             'ID',
-            'Volume',
             'Name',
+            'Volume',
         ]
 
         # confirming if all expected columns are present in the result.
         self.assertEqual(expected_columns, columns)
 
         datalist = ((
             self.volume_transfers.id,
-            self.volume_transfers.volume_id,
             self.volume_transfers.name,
+            self.volume_transfers.volume_id,
         ), )
 
         # confirming if all expected values are present in the result.