Cancel dedicated hosts option and unittests

Author: acamacho82

SoftLayer/CLI/dedicatedhost/cancel.py

@@ -0,0 +1,32 @@
+"""Cancel a dedicated host."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--immediate',
+              is_flag=True,
+              default=False,
+              help="Cancels the dedicated host immediately (instead of on the billing anniversary)")
+@environment.pass_env
+def cli(env, identifier, immediate):
+    """Cancel a dedicated host server."""
+
+    mgr = SoftLayer.DedicatedHostManager(env.client)
+
+    host_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'dedicated host')
+
+    if not (env.skip_confirmations or formatting.no_going_back(host_id)):
+        raise exceptions.CLIAbort('Aborted')
+
+    mgr.cancel_host(host_id, immediate)
+
+    click.secho('Dedicated Host %s was successfully cancelled' % host_id, fg='green')

SoftLayer/CLI/routes.py

@@ -37,6 +37,7 @@
     ('dedicatedhost:create', 'SoftLayer.CLI.dedicatedhost.create:cli'),
     ('dedicatedhost:create-options', 'SoftLayer.CLI.dedicatedhost.create_options:cli'),
     ('dedicatedhost:detail', 'SoftLayer.CLI.dedicatedhost.detail:cli'),
+    ('dedicatedhost:cancel', 'SoftLayer.CLI.dedicatedhost.cancel:cli'),
 
     ('cdn', 'SoftLayer.CLI.cdn'),
     ('cdn:detail', 'SoftLayer.CLI.cdn.detail:cli'),

SoftLayer/managers/dedicated_host.py

@@ -37,6 +37,30 @@ def __init__(self, client, ordering_manager=None):
         if ordering_manager is None:
             self.ordering_manager = ordering.OrderingManager(client)
 
+    def cancel_host(self, host_id, immediate=True):
+        """Cancels a dedicated host server.
+
+        Example::
+            # Cancels dedicated host id 1234
+            result = mgr.cancel_host(host_id=1234)
+
+        :param host_id: The ID of the dedicated host to be cancelled.
+        :param immediate: If False the dedicated host will be reclaimed in the anniversary date.
+                          Default is True
+        :return: True on success or an exception
+        """
+        mask = 'mask[id,billingItem[id,hourlyFlag]]'
+        host_billing = self.get_host(host_id, mask=mask)
+        billing_id = host_billing['billingItem']['id']
+        is_hourly = host_billing['billingItem']['hourlyFlag']
+
+        if is_hourly and immediate is False:
+            raise SoftLayer.SoftLayerError("Hourly Dedicated Hosts can only be cancelled immediately.")
+        else:
+            # Monthly dedicated host can be reclaimed immediately and no reasons are required
+            result = self.client['Billing_Item'].cancelItem(immediate, False, id=billing_id)
+        return result
+
     def list_instances(self, tags=None, cpus=None, memory=None, hostname=None,
                        disk=None, datacenter=None, **kwargs):
         """Retrieve a list of all dedicated hosts on the account

tests/CLI/modules/dedicatedhost_tests.py

@@ -337,3 +337,15 @@ def test_create_verify_no_price_or_more_than_one(self):
             'quantity': 1},)
 
         self.assert_called_with('SoftLayer_Product_Order', 'verifyOrder', args=args)
+
+    @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, False)
+        self.assertEqual(str(result.output), 'Dedicated Host 12345 was successfully 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)

tests/managers/dedicated_host_tests.py

@@ -540,6 +540,28 @@ def test_get_default_router_no_router_found(self):
         self.assertRaises(exceptions.SoftLayerError,
                           self.dedicated_host._get_default_router, routers, 'notFound')
 
+    def test_cancel_host(self):
+        self.dedicated_host.host = mock.Mock()
+        self.dedicated_host.host.getObject.return_value = {'id': 987, 'billingItem': {
+                                                           'id': 1234, 'hourlyFlag': False}}
+        # Immediate cancellation
+        result = self.dedicated_host.cancel_host(987)
+        self.assertEqual(True, result)
+
+        # Cancellation on anniversary
+        result = self.dedicated_host.cancel_host(987, immediate=False)
+        self.assertEqual(True, result)
+
+    def test_cancel_host_billing_hourly_no_immediate(self):
+        self.dedicated_host.host = mock.Mock()
+        self.dedicated_host.host.getObject.return_value = {'id': 987, 'billingItem': {
+                                                           'id': 1234, 'hourlyFlag': True}}
+
+        ex = self.assertRaises(SoftLayer.SoftLayerError,
+                               self.dedicated_host.cancel_host,
+                               987, immediate=False)
+        self.assertEqual("Hourly Dedicated Hosts can only be cancelled immediately.", str(ex))
+
     def _get_routers_sample(self):
         routers = [
             {