Add amphora delete command

This patch adds the "openstack loadbalancer amphora delete" command.

Depends-On: https://review.opendev.org/718293
Change-Id: I415d2438ddfe994631ef02637c216f4579dd81a1

octaviaclient/api/v2/octavia.py

@@ -764,6 +764,20 @@ class OctaviaAPI(api.BaseAPI):
 
         return response
 
+    @correct_return_codes
+    def amphora_delete(self, amphora_id):
+        """Delete an amphora
+
+        :param string amphora_id:
+            The ID of the amphora to delete
+        :return:
+            Response Code from the API
+        """
+        url = const.BASE_SINGLE_AMPHORA_URL.format(uuid=amphora_id)
+        response = self._delete(url)
+
+        return response
+
     @correct_return_codes
     def amphora_failover(self, amphora_id):
         """Force failover an amphorae

octaviaclient/osc/v2/amphora.py

@@ -251,3 +251,34 @@ class ShowAmphoraStats(command.ShowOne):
 
         return (rows, (utils.get_dict_properties(
             total_stats, rows, formatters={})))
+
+
+class DeleteAmphora(command.Command):
+    """Delete a amphora"""
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+
+        parser.add_argument(
+            'amphora_id',
+            metavar='<amphora-id>',
+            help='UUID of the amphora to delete.',
+        )
+        parser.add_argument(
+            '--wait',
+            action='store_true',
+            help='Wait for action to complete',
+        )
+
+        return parser
+
+    def take_action(self, parsed_args):
+
+        self.app.client_manager.load_balancer.amphora_delete(
+            amphora_id=parsed_args.amphora_id)
+
+        if parsed_args.wait:
+            v2_utils.wait_for_delete(
+                status_f=self.app.client_manager.load_balancer.amphora_show,
+                res_id=parsed_args.amphora_id, status_field=const.STATUS
+            )

octaviaclient/osc/v2/constants.py

@@ -357,6 +357,7 @@ AVAILABILITYZONEPROFILE_COLUMNS = (
 )
 
 PROVISIONING_STATUS = 'provisioning_status'
+STATUS = 'status'
 
 # TCP/UDP port min/max
 MIN_PORT_NUMBER = 1

octaviaclient/osc/v2/utils.py

@@ -616,7 +616,8 @@ def wait_for_active(status_f, res_id):
             message="The resource did not successfully reach ACTIVE status.")
 
 
-def wait_for_delete(status_f, res_id):
+def wait_for_delete(status_f, res_id,
+                    status_field=constants.PROVISIONING_STATUS):
     class Getter(object):
         @staticmethod
         def get(id):
@@ -626,7 +627,7 @@ def wait_for_delete(status_f, res_id):
         success = utils.wait_for_delete(
             manager=Getter,
             res_id=res_id,
-            status_field=constants.PROVISIONING_STATUS,
+            status_field=status_field,
             sleep_time=3
         )
         if not success:

octaviaclient/tests/unit/api/test_octavia.py

@@ -969,6 +969,15 @@ class TestLoadBalancer(TestOctaviaClient):
                                self.api.amphora_configure,
                                FAKE_AMP)
 
+    def test_delete_amphora(self):
+        self.requests_mock.register_uri(
+            'DELETE',
+            FAKE_OCTAVIA_URL + 'amphorae/' + FAKE_AMP,
+            status_code=200
+        )
+        ret = self.api.amphora_delete(FAKE_AMP)
+        self.assertEqual(200, ret.status_code)
+
     def test_stats_show_amphora(self):
         self.requests_mock.register_uri(
             'GET',

octaviaclient/tests/unit/osc/v2/test_amphora.py

@@ -283,3 +283,39 @@ class TestAmphoraStatsShow(TestAmphora):
         column_idx = columns.index('bytes_in')
         bytes_in = self.stats[listener_id]
         self.assertEqual(data[column_idx], bytes_in)
+
+
+class TestAmphoraDelete(TestAmphora):
+
+    def setUp(self):
+        super(TestAmphoraDelete, self).setUp()
+        self.cmd = amphora.DeleteAmphora(self.app, None)
+
+    def test_amphora_delete(self):
+        arglist = [self._amp.id]
+        verifylist = [
+            ('amphora_id', self._amp.id)
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        self.cmd.take_action(parsed_args)
+        self.api_mock.amphora_delete.assert_called_with(
+            amphora_id=self._amp.id)
+
+    @mock.patch('osc_lib.utils.wait_for_delete')
+    def test_amphora_delete_wait(self, mock_wait):
+        arglist = [self._amp.id, '--wait']
+        verifylist = [
+            ('amphora_id', self._amp.id),
+            ('wait', True),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        self.cmd.take_action(parsed_args)
+        self.api_mock.amphora_delete.assert_called_with(
+            amphora_id=self._amp.id)
+        mock_wait.assert_called_once_with(
+            manager=mock.ANY,
+            res_id=self._amp.id,
+            sleep_time=mock.ANY,
+            status_field='status')

releasenotes/notes/add-amphora-delete-0fe5f2097da92b5c.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Added the amphora delete command.

setup.cfg

@@ -84,6 +84,7 @@ openstack.load_balancer.v2 =
     loadbalancer_amphora_list = octaviaclient.osc.v2.amphora:ListAmphora
     loadbalancer_amphora_show = octaviaclient.osc.v2.amphora:ShowAmphora
     loadbalancer_amphora_configure = octaviaclient.osc.v2.amphora:ConfigureAmphora
+    loadbalancer_amphora_delete = octaviaclient.osc.v2.amphora:DeleteAmphora
     loadbalancer_amphora_failover = octaviaclient.osc.v2.amphora:FailoverAmphora
     loadbalancer_amphora_stats_show = octaviaclient.osc.v2.amphora:ShowAmphoraStats
     loadbalancer_provider_list = octaviaclient.osc.v2.provider:ListProvider