cancel-guests returns a dictionary about delete status

Author: acamacho82

SoftLayer/CLI/dedicatedhost/cancel_guests.py

@@ -26,9 +26,18 @@ def cli(env, identifier):
     if not (env.skip_confirmations or formatting.no_going_back(host_id)):
         raise exceptions.CLIAbort('Aborted')
 
+    table = formatting.Table(['id', 'server name', 'status'])
+
     result = dh_mgr.cancel_guests(host_id)
 
-    if result is True:
-        click.secho('All guests into the dedicated host %s were cancelled' % host_id, fg='green')
+    if result:
+        for status in result:
+            table.add_row([
+                status['id'],
+                status['fqdn'],
+                status['status']
+            ])
+
+        env.fout(table)
     else:
         click.secho('There is not any guest into the dedicated host %s' % host_id, fg='red')

SoftLayer/managers/dedicated_host.py

@@ -57,20 +57,26 @@ def cancel_guests(self, host_id):
         To cancel an specified guest use the method VSManager.cancel_instance()
 
         :param host_id: The ID of the dedicated host.
-        :return: True on success, False if there isn't any guest or
-                 an exception from the API
+        :return: The id, fqdn and status of all guests into a dictionary. The status
+                 could be 'Cancelled' or an exception message, The dictionary is empty
+                 if there isn't any guest in the dedicated host.
 
         Example::
             # Cancel guests of dedicated host id 12345
             result = mgr.cancel_guests(12345)
         """
-        result = False
+        result = []
 
-        guests = self.host.getGuests(id=host_id, mask='id')
+        guests = self.host.getGuests(id=host_id, mask='id,fullyQualifiedDomainName')
 
         if guests:
             for vs in guests:
-                result = self.guest.deleteObject(id=vs['id'])
+                status_info = {
+                    'id': vs['id'],
+                    'fqdn': vs['fullyQualifiedDomainName'],
+                    'status': self._delete_guest(vs['id'])
+                }
+                result.append(status_info)
 
         return result
 
@@ -512,3 +518,13 @@ def get_router_options(self, datacenter=None, flavor=None):
         item = self._get_item(package, flavor)
 
         return self._get_backend_router(location['location']['locationPackageDetails'], item)
+
+    def _delete_guest(self, guest_id):
+        """Deletes a guest and returns 'Cancelled' or and Exception message"""
+        msg = 'Cancelled'
+        try:
+            self.guest.deleteObject(id=guest_id)
+        except SoftLayer.SoftLayerAPIError as e:
+            msg = 'Exception: ' + e.faultString
+
+        return msg

tests/CLI/modules/dedicatedhost_tests.py

@@ -353,13 +353,19 @@ def test_cancel_host_abort(self):
         self.assertIsInstance(result.exception, exceptions.CLIAbort)
 
     def test_cancel_guests(self):
+        vs1 = {'id': 987, 'fullyQualifiedDomainName': 'foobar.example.com'}
+        vs2 = {'id': 654, 'fullyQualifiedDomainName': 'wombat.example.com'}
         guests = self.set_mock('SoftLayer_Virtual_DedicatedHost', 'getGuests')
-        guests.return_value = [{'id': 987}, {'id': 654}]
+        guests.return_value = [vs1, vs2]
+
+        vs_status1 = {'id': 987, 'server name': 'foobar.example.com', 'status': 'Cancelled'}
+        vs_status2 = {'id': 654, 'server name': 'wombat.example.com', 'status': 'Cancelled'}
+        expected_result = [vs_status1, vs_status2]
 
         result = self.run_command(['--really', 'dedicatedhost', 'cancel-guests', '12345'])
         self.assert_no_fail(result)
 
-        self.assertEqual(str(result.output), 'All guests into the dedicated host 12345 were cancelled\n')
+        self.assertEqual(expected_result, json.loads(result.output))
 
     def test_cancel_guests_empty_list(self):
         guests = self.set_mock('SoftLayer_Virtual_DedicatedHost', 'getGuests')
@@ -393,3 +399,8 @@ def test_list_guests(self):
                            'id': 202,
                            'power_state': 'Running',
                            'backend_ip': '10.45.19.35'}])
+
+    def _get_cancel_guests_return(self):
+        vs_status1 = {'id': 123, 'fqdn': 'foobar.example.com', 'status': 'Cancelled'}
+        vs_status2 = {'id': 456, 'fqdn': 'wombat.example.com', 'status': 'Cancelled'}
+        return [vs_status1, vs_status2]

tests/managers/dedicated_host_tests.py

@@ -547,20 +547,39 @@ def test_cancel_host(self):
         self.assert_called_with('SoftLayer_Virtual_DedicatedHost', 'deleteObject', identifier=789)
 
     def test_cancel_guests(self):
+        vs1 = {'id': 987, 'fullyQualifiedDomainName': 'foobar.example.com'}
+        vs2 = {'id': 654, 'fullyQualifiedDomainName': 'wombat.example.com'}
         self.dedicated_host.host = mock.Mock()
-        self.dedicated_host.host.getGuests.return_value = [{'id': 987}, {'id': 654}]
+        self.dedicated_host.host.getGuests.return_value = [vs1, vs2]
+
+        # Expected result
+        vs_status1 = {'id': 987, 'fqdn': 'foobar.example.com', 'status': 'Cancelled'}
+        vs_status2 = {'id': 654, 'fqdn': 'wombat.example.com', 'status': 'Cancelled'}
+        delete_status = [vs_status1, vs_status2]
 
         result = self.dedicated_host.cancel_guests(789)
 
-        self.assertEqual(result, True)
+        self.assertEqual(result, delete_status)
 
     def test_cancel_guests_empty_list(self):
         self.dedicated_host.host = mock.Mock()
         self.dedicated_host.host.getGuests.return_value = []
 
         result = self.dedicated_host.cancel_guests(789)
 
-        self.assertEqual(result, False)
+        self.assertEqual(result, [])
+
+    def test_delete_guest(self):
+        result = self.dedicated_host._delete_guest(123)
+        self.assertEqual(result, 'Cancelled')
+
+        # delete_guest should return the exception message in case it fails
+        error_raised = SoftLayer.SoftLayerAPIError('SL Exception', 'SL message')
+        self.dedicated_host.guest = mock.Mock()
+        self.dedicated_host.guest.deleteObject.side_effect = error_raised
+
+        result = self.dedicated_host._delete_guest(369)
+        self.assertEqual(result, 'Exception: SL message')
 
     def _get_routers_sample(self):
         routers = [