create a new commands on slcli that create/cancel a VMware licenses simulate to IBMCloud portal

Author: caberos

SoftLayer/CLI/licenses/__init__.py

@@ -0,0 +1,37 @@
+"""Cancel VMware licenses."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+from SoftLayer import utils
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.managers.license import LicensesManager
+
+
+@click.command()
+@click.argument('key')
+@click.option('--immediate', is_flag=True, help='Immediate cancellation')
+@environment.pass_env
+def cli(env, key, immediate):
+    """Cancel VMware license."""
+
+    if not immediate:
+        immediate = False
+    vmware_find = False
+    license = LicensesManager(env.client)
+
+    vmware_licenses = license.get_all_objects()
+
+    for vmware in vmware_licenses:
+        if vmware.get('key') == key:
+            vmware_find = True
+            license.cancel_item(utils.lookup(vmware, 'billingItem', 'id'),
+                                immediate,
+                                'Cancel by cli command',
+                                'Cancel by cli command')
+            break
+
+    if not vmware_find:
+        raise exceptions.CLIAbort(
+            "The VMware not found, try whit another key")

SoftLayer/CLI/licenses/cancel.py

@@ -0,0 +1,33 @@
+"""Order/create a vwmare licenses."""
+# :licenses: MIT, see LICENSE for more details.
+
+import click
+from SoftLayer.managers import ordering
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+@click.command()
+@click.option('--key', '-k', required=True, prompt=True, help="The License Key for this specific Account License.")
+@click.option('--datacenter', '-d', required=True, prompt=True, help="Datacenter shortname")
+@environment.pass_env
+def cli(env, key, datacenter):
+    """Order/create a vlan instance."""
+
+    complex_type = 'SoftLayer_Container_Product_Order_Software_License'
+    item_package = [key]
+
+    ordering_manager = ordering.OrderingManager(env.client)
+    result = ordering_manager.place_order(package_keyname='SOFTWARE_LICENSE_PACKAGE',
+                                          location=datacenter,
+                                          item_keynames=item_package,
+                                          complex_type=complex_type,
+                                          hourly=False)
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+    table.add_row(['id', result['orderId']])
+    table.add_row(['created', result['orderDate']])
+
+    env.fout(table)

SoftLayer/CLI/licenses/create.py

@@ -217,6 +217,10 @@
     ('nas:list', 'SoftLayer.CLI.nas.list:cli'),
     ('nas:credentials', 'SoftLayer.CLI.nas.credentials:cli'),
 
+    ('licenses', 'SoftLayer.CLI.licenses'),
+    ('licenses:create', 'SoftLayer.CLI.licenses.create:cli'),
+    ('licenses:cancel', 'SoftLayer.CLI.licenses.cancel:cli'),
+
     ('object-storage', 'SoftLayer.CLI.object_storage'),
 
     ('object-storage:accounts', 'SoftLayer.CLI.object_storage.list_accounts:cli'),

SoftLayer/CLI/routes.py

@@ -252,3 +252,35 @@
         ]
     }
 }
+
+wmware_placeOrder = {
+    "orderDate": "2021-06-02 15:23:47",
+    "orderId": 123456,
+    "prices": [
+        {
+            "id": 176535,
+            "itemId": 8109,
+            "categories": [
+                {
+                    "categoryCode": "software_license",
+                    "id": 438,
+                    "name": "Software License"
+                }
+            ],
+            "item": {
+                "capacity": "1",
+                "description": "VMware vSAN Advanced Tier III 64 - 124 TB 6.x",
+                "id": 8109,
+                "keyName": "VMWARE_VSAN_ADVANCE_TIER_III_64_124_6_X",
+                "softwareDescription": {
+                    "id": 1795,
+                },
+                "thirdPartyPolicyAssignments": [
+                    {
+                        "id": 29263,
+                        "policyName": "3rd Party Software Terms VMWare v4"
+                    }
+                ]
+            }
+        }
+    ]}

SoftLayer/fixtures/SoftLayer_Product_Order.py

@@ -2055,3 +2055,29 @@
             "categoryCode": "dedicated_virtual_hosts"
         }
     }]}
+
+getItems_vmware = [{
+    "capacity": "2",
+    "description": "VMware vSAN Enterprise Tier III 65 - 124 TB 6.x",
+    "id": 9567,
+    "itemTaxCategoryId": 166,
+    "keyName": "VMWARE_VSAN_ENTERPRISE_TIER_III_65_124_TB_6_X_2",
+    "softwareDescriptionId": 1979,
+    "units": "CPU",
+    "itemCategory": {
+        "categoryCode": "software_license",
+        "id": 438,
+        "name": "Software License",
+        "quantityLimit": 1,
+    },
+    "prices": [
+        {
+            "id": 245164,
+            "itemId": 9567,
+            "laborFee": "0",
+            "locationGroupId": None,
+            "oneTimeFee": "0",
+            "setupFee": "0",
+            "sort": 0,
+        }
+    ]}]

SoftLayer/fixtures/SoftLayer_Product_Package.py

@@ -0,0 +1,51 @@
+getAllObjects = [{
+        "capacity": "4",
+        "key": "ABCDE-6CJ8L-J8R9H-000R0-CDR70",
+        "units": "CPU",
+        "billingItem": {
+            "allowCancellationFlag": 1,
+            "categoryCode": "software_license",
+            "createDate": "2018-10-22T11:16:48-06:00",
+            "cycleStartDate": "2021-06-03T23:11:22-06:00",
+            "description": "vCenter Server Appliance 6.0",
+            "id": 123654789,
+            "lastBillDate": "2021-06-03T23:11:22-06:00",
+            "modifyDate": "2021-06-03T23:11:22-06:00",
+            "nextBillDate": "2021-07-03T23:00:00-06:00",
+            "orderItemId": 385054741,
+            "recurringMonths": 1,
+            "serviceProviderId": 1,
+        },
+        "softwareDescription": {
+            "id": 1529,
+            "longDescription": "VMware vCenter 6.0",
+            "manufacturer": "VMware",
+            "name": "vCenter",
+            "version": "6.0",
+            "requiredUser": "administrator@vsphere.local"
+        }
+    },
+    {
+        "capacity": "1",
+        "key": "CBERT-4RL92-K8999-031K4-AJF5J",
+        "units": "CPU",
+        "billingItem": {
+            "allowCancellationFlag": 1,
+            "categoryCode": "software_license",
+            "createDate": "2021-06-09T14:51:38-06:00",
+            "cycleStartDate": "2021-06-09T14:51:38-06:00",
+            "description": "VMware vSAN Advanced Tier III 64 - 124 TB 6.x",
+            "id": 369852174,
+            "nextBillDate": "2021-07-03T23:00:00-06:00",
+            "orderItemId": 836502628,
+            "recurringMonths": 1,
+            "serviceProviderId": 1,
+        },
+        "softwareDescription": {
+            "id": 1795,
+            "longDescription": "VMware Virtual SAN Advanced Tier III 6.2",
+            "manufacturer": "VMware",
+            "name": "Virtual SAN Advanced Tier III",
+            "version": "6.2",
+        }
+    }]

SoftLayer/fixtures/SoftLayer_Software_AccountLicense.py

@@ -0,0 +1,40 @@
+"""
+    SoftLayer.license
+    ~~~~~~~~~~~~~~~
+    License Manager
+
+    :license: MIT, see LICENSE for more details.
+"""
+
+
+# pylint: disable=too-many-public-methods
+
+
+class LicensesManager(object):
+    """Manages account lincese."""
+
+    def __init__(self, client):
+        self.client = client
+
+    def get_all_objects(self):
+        """Show the all VM ware licenses of account.
+
+         """
+        _mask = '''softwareDescription,billingItem'''
+
+        return self.client.call('SoftLayer_Software_AccountLicense',
+                                'getAllObjects', mask=_mask)
+
+    def cancel_item(self, identifier, cancel_immediately,
+                    reason_cancel, customer_note):
+        """Cancel a billing item immediately, deleting all its data.
+
+        :param integer identifier: the instance ID to cancel
+        :param string reason_cancel: reason cancel
+        """
+        return self.client.call('SoftLayer_Billing_Item', 'cancelItem',
+                                cancel_immediately,
+                                True,
+                                reason_cancel,
+                                customer_note,
+                                id=identifier)

SoftLayer/managers/license.py

@@ -0,0 +1,12 @@
+.. _cli_licenses:
+
+licenses Commands
+=================
+
+.. click:: SoftLayer.CLI.licenses.create:cli
+    :prog: licenses create
+    :show-nested:
+
+.. click:: SoftLayer.CLI.licenses.cancel:cli
+    :prog: licenses cancel
+    :show-nested:

docs/cli/licenses.rst

@@ -0,0 +1,34 @@
+"""
+    SoftLayer.tests.CLI.modules.licenses_tests
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    :license: MIT, see LICENSE for more details.
+"""
+
+from SoftLayer.fixtures import SoftLayer_Product_Order
+from SoftLayer.fixtures import SoftLayer_Product_Package
+
+from SoftLayer import testing
+
+
+class LicensesTests(testing.TestCase):
+
+    def test_create(self):
+        _mock = self.set_mock('SoftLayer_Product_Package', 'getItems')
+
+        _mock.return_value = SoftLayer_Product_Package.getItems_vmware
+
+        order_mock = self.set_mock('SoftLayer_Product_Order', 'placeOrder')
+        order_mock.return_value = SoftLayer_Product_Order.wmware_placeOrder
+        result = self.run_command(['licenses',
+                                   'create',
+                                   '-k', 'VMWARE_VSAN_ENTERPRISE_TIER_III_65_124_TB_6_X_2',
+                                   '-d dal03'])
+        self.assert_no_fail(result)
+
+    def test_cancel(self):
+        result = self.run_command(['licenses',
+                                   'cancel',
+                                   'ABCDE-6CJ8L-J8R9H-000R0-CDR70',
+                                   '--immediate'])
+        self.assert_no_fail(result)