cancel-all-guests command was refactored and unittests were added on managers and cli

Author: acamacho82

SoftLayer/CLI/dedicatedhost/cancel_guests.py

@@ -14,26 +14,21 @@
 @click.argument('identifier')
 @environment.pass_env
 def cli(env, identifier):
-    """Cancel all virtual guests of the dedicated host immediately"""
+    """Cancel all virtual guests of the dedicated host immediately.
+
+       Use the 'slcli vs cancel' command to cancel an specific guest
+    """
 
     dh_mgr = SoftLayer.DedicatedHostManager(env.client)
-    vs_mgr = SoftLayer.VSManager(env.client)
 
     host_id = helpers.resolve_id(dh_mgr.resolve_ids, identifier, 'dedicated host')
 
-    guests = dh_mgr.list_guests(host_id)
-
-    if guests:
-        msg = '%s guest(s) will be cancelled, ' \
-              'do you want to continue?' % len(guests)
+    if not (env.skip_confirmations or formatting.no_going_back(host_id)):
+        raise exceptions.CLIAbort('Aborted')
 
-        if not (env.skip_confirmations or formatting.confirm(msg)):
-            raise exceptions.CLIAbort('Aborted')
-
-        for guest in guests:
-            vs_mgr.cancel_instance(guest['id'])
+    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')
-
     else:
         click.secho('There is not any guest into the dedicated host %s' % host_id, fg='red')

SoftLayer/CLI/dedicatedhost/list_guests.py

@@ -1,4 +1,4 @@
-"""List dedicated servers."""
+"""List guests which are in a dedicated host server."""
 # :license: MIT, see LICENSE for more details.
 
 import click
@@ -55,12 +55,13 @@
               show_default=True)
 @environment.pass_env
 def cli(env, identifier, sortby, cpu, domain, hostname, memory, tag, columns):
-    """List guests into the dedicated host."""
+    """List guests which are in a dedicated host server."""
+
     mgr = SoftLayer.DedicatedHostManager(env.client)
     guests = mgr.list_guests(host_id=identifier,
                              cpus=cpu,
                              hostname=hostname,
-                             domain= domain,
+                             domain=domain,
                              memory=memory,
                              tags=tag,
                              mask=columns.mask())

SoftLayer/fixtures/SoftLayer_Virtual_DedicatedHost.py

@@ -80,8 +80,7 @@
 deleteObject = True
 
 getGuests = [{
-    'id': 100,
-    'metricTrackingObjectId': 1,
+    'id': 200,
     'hostname': 'vs-test1',
     'domain': 'test.sftlyr.ws',
     'fullyQualifiedDomainName': 'vs-test1.test.sftlyr.ws',
@@ -95,7 +94,6 @@
     'globalIdentifier': '1a2b3c-1701',
     'primaryBackendIpAddress': '10.45.19.37',
     'hourlyBillingFlag': False,
-
     'billingItem': {
         'id': 6327,
         'recurringFee': 1.54,
@@ -108,8 +106,7 @@
         }
     },
 }, {
-    'id': 104,
-    'metricTrackingObjectId': 2,
+    'id': 202,
     'hostname': 'vs-test2',
     'domain': 'test.sftlyr.ws',
     'fullyQualifiedDomainName': 'vs-test2.test.sftlyr.ws',
@@ -133,6 +130,5 @@
                 }
             }
         }
-    },
-    'virtualRack': {'id': 1, 'bandwidthAllotmentTypeId': 2},
+    }
 }]

SoftLayer/managers/dedicated_host.py

@@ -33,6 +33,7 @@ def __init__(self, client, ordering_manager=None):
         self.client = client
         self.account = client['Account']
         self.host = client['Virtual_DedicatedHost']
+        self.guest = client['Virtual_Guest']
 
         if ordering_manager is None:
             self.ordering_manager = ordering.OrderingManager(client)
@@ -50,26 +51,47 @@ def cancel_host(self, host_id):
         """
         return self.host.deleteObject(id=host_id)
 
+    def cancel_guests(self, host_id):
+        """Cancel all guests into the dedicated host immediately.
+
+        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
+
+        Example::
+            # Cancel guests of dedicated host id 12345
+            result = mgr.cancel_guests(12345)
+        """
+        result = False
+
+        guest_list = self.host.getGuests(id=host_id, mask="id")
+
+        if guest_list:
+            for virtual_guest in guest_list:
+                result = self.guest.deleteObject(virtual_guest['id'])
+
+        return result
+
     def list_guests(self, host_id, tags=None, cpus=None, memory=None, hostname=None,
                     domain=None, local_disk=None, nic_speed=None, public_ip=None,
                     private_ip=None, **kwargs):
         """Retrieve a list of all virtual servers on the dedicated host.
 
         Example::
 
-            # Print out a list of hourly instances in the host id 12345.
+            # Print out a list of instances with 4 cpu cores in the host id 12345.
 
-            for vsi in mgr.list_guests(host_id=12345, hourly=True):
+            for vsi in mgr.list_guests(host_id=12345, cpus=4):
                print vsi['fullyQualifiedDomainName'], vsi['primaryIpAddress']
 
             # Using a custom object-mask. Will get ONLY what is specified
             object_mask = "mask[hostname,monitoringRobot[robotStatus]]"
-            for vsi in mgr.list_guests(mask=object_mask,hourly=True):
+            for vsi in mgr.list_guests(mask=object_mask,cpus=4):
                 print vsi
 
         :param integer host_id: the identifier of dedicated host
-        :param boolean hourly: include hourly instances
-        :param boolean monthly: include monthly instances
         :param list tags: filter based on list of tags
         :param integer cpus: filter based on number of CPUS
         :param integer memory: filter based on amount of memory

tests/CLI/modules/dedicatedhost_tests.py

@@ -341,25 +341,39 @@ def test_create_verify_no_price_or_more_than_one(self):
     @mock.patch('SoftLayer.DedicatedHostManager.cancel_host')
     def test_cancel_host(self, cancel_mock):
         result = self.run_command(['--really', 'dedicatedhost', 'cancel', '12345'])
+
         self.assert_no_fail(result)
         cancel_mock.assert_called_with(12345)
+
         self.assertEqual(str(result.output), 'Dedicated Host 12345 was cancelled\n')
 
     def test_cancel_host_abort(self):
         result = self.run_command(['dedicatedhost', 'cancel', '12345'])
         self.assertEqual(result.exit_code, 2)
         self.assertIsInstance(result.exception, exceptions.CLIAbort)
 
-    @mock.patch('SoftLayer.DedicatedHostManager.cancel_host')
-    def test_cancel_all_guest(self, cancel_mock):
-        result = self.run_command(['--really', 'dedicatedhost', 'cancel', '12345'])
+    def test_cancel_all_guests(self):
+        guests = self.set_mock('SoftLayer_Virtual_DedicatedHost', 'getGuests')
+        guests.return_value = [{'id': 987}, {'id': 654}]
+
+        result = self.run_command(['--really', 'dedicatedhost', 'cancel-all-guests', '12345'])
         self.assert_no_fail(result)
-        cancel_mock.assert_called_with(12345)
-        self.assertEqual(str(result.output), 'Dedicated Host 12345 was cancelled\n')
 
-    def test_cancel_all_guest_empty_list(self):
+        self.assertEqual(str(result.output), 'All guests into the dedicated host 12345 were cancelled\n')
+
+    def test_cancel_all_guests_empty_list(self):
+        guests = self.set_mock('SoftLayer_Virtual_DedicatedHost', 'getGuests')
+        guests.return_value = []
+
+        result = self.run_command(['--really', 'dedicatedhost', 'cancel-all-guests', '12345'])
+        self.assert_no_fail(result)
+
+        self.assertEqual(str(result.output), 'There is not any guest into the dedicated host 12345\n')
+
+    def test_cancel_all_guests_abort(self):
         result = self.run_command(['dedicatedhost', 'cancel', '12345'])
         self.assertEqual(result.exit_code, 2)
+
         self.assertIsInstance(result.exception, exceptions.CLIAbort)
 
     def test_list_guests(self):
@@ -370,12 +384,12 @@ def test_list_guests(self):
                          [{'hostname': 'vs-test1',
                            'domain': 'test.sftlyr.ws',
                            'primary_ip': '172.16.240.2',
-                           'id': 100,
+                           'id': 200,
                            'power_state': 'Running',
                            'backend_ip': '10.45.19.37'},
                           {'hostname': 'vs-test2',
                            'domain': 'test.sftlyr.ws',
                            'primary_ip': '172.16.240.7',
-                           'id': 104,
+                           'id': 202,
                            'power_state': 'Running',
                            'backend_ip': '10.45.19.35'}])

tests/managers/dedicated_host_tests.py

@@ -546,6 +546,22 @@ def test_cancel_host(self):
         self.assertEqual(result, True)
         self.assert_called_with('SoftLayer_Virtual_DedicatedHost', 'deleteObject', identifier=789)
 
+    def test_cancel_guests(self):
+        self.dedicated_host.host = mock.Mock()
+        self.dedicated_host.host.getGuests.return_value = [{'id': 987}, {'id': 654}]
+
+        result = self.dedicated_host.cancel_guests(789)
+
+        self.assertEqual(result, True)
+
+    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)
+
     def _get_routers_sample(self):
         routers = [
             {
@@ -658,7 +674,7 @@ def test_list_guests(self):
         results = self.dedicated_host.list_guests(12345)
 
         for result in results:
-            self.assertIn(result['id'], [100, 104])
+            self.assertIn(result['id'], [200, 202])
         self.assert_called_with('SoftLayer_Virtual_DedicatedHost', 'getGuests', identifier=12345)
 
     def test_list_guests_with_filters(self):
@@ -683,4 +699,4 @@ def test_list_guests_with_filters(self):
             }
         }
         self.assert_called_with('SoftLayer_Virtual_DedicatedHost', 'getGuests',
-                                identifier=12345, filter=_filter)
+                                identifier=12345, filter=_filter)