Merge branch 'master' of github.com:allmightyspiff/softlayer-python into xport-enhancements

Author: allmightyspiff

CHANGELOG.md

@@ -1,7 +1,16 @@
 # Change Log
 
+## [5.4.3] - 2018-03-30
+ - Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.2...master
+
+- Corrected to current create-options output
+- Allow ordering of account restricted presets
+- Added lookup function for datacenter names and ability to use `slcli order` with short DC names
+- Changed locatoinGroupId to check for None instead of empty string
+- Added a way to try to cancel montly bare metal immediately. THis is done by automatically updating the cancellation request. A human still needs to read the ticket and process it for the reclaim to complete.
+
 ## [5.4.2] - 2018-02-22
- - Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.1...master
+ - Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.1...v5.4.2
 
 - add GPU to the virtual create-options table
 - Remove 'virtual' from the hardware ready command.

SoftLayer/CLI/hardware/cancel.py

@@ -15,13 +15,11 @@
 @click.option('--immediate',
               is_flag=True,
               default=False,
-              help="""Cancels the server immediately (instead of on the billing
- anniversary)""")
+              help="Cancels the server immediately (instead of on the billing anniversary)")
 @click.option('--comment',
               help="An optional comment to add to the cancellation ticket")
 @click.option('--reason',
-              help="""An optional cancellation reason. See cancel-reasons for
- a list of available options""")
+              help="An optional cancellation reason. See cancel-reasons for a list of available options")
 @environment.pass_env
 def cli(env, identifier, immediate, comment, reason):
     """Cancel a dedicated server."""

SoftLayer/consts.py

@@ -5,7 +5,7 @@
 
     :license: MIT, see LICENSE for more details.
 """
-VERSION = 'v5.4.2'
+VERSION = 'v5.4.3'
 API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/xmlrpc/v3.1/'
 API_PRIVATE_ENDPOINT = 'https://api.service.softlayer.com/xmlrpc/v3.1/'
 API_PUBLIC_ENDPOINT_REST = 'https://api.softlayer.com/rest/v3.1/'

SoftLayer/fixtures/SoftLayer_Location.py

@@ -9,3 +9,4 @@
         "longName": "San Jose 1",
         "name": "sjc01"
     }]
+getDatacenters = [{'id': 1854895, 'name': 'dal13', 'regions': [{'keyname': 'DALLAS13'}]}]

SoftLayer/fixtures/SoftLayer_Product_Package.py

@@ -666,15 +666,27 @@
     ]
 }
 
+activePreset1 = {
+    'description': 'Single Xeon 1270, 8GB Ram, 2x1TB SATA disks, Non-RAID',
+    'id': 64,
+    'isActive': '1',
+    'keyName': 'S1270_8GB_2X1TBSATA_NORAID',
+    'name': 'S1270 8GB 2X1TBSATA NORAID',
+    'packageId': 200
+}
+
+activePreset2 = {
+    'description': 'Dual Xeon Gold, 384GB Ram, 4x960GB SSD, RAID 10',
+    'id': 65,
+    'isActive': '1',
+    'keyName': 'DGOLD_6140_384GB_4X960GB_SSD_SED_RAID_10',
+    'name': 'DGOLD 6140 384GB 4X960GB SSD SED RAID 10',
+    'packageId': 200
+}
+
 getAllObjects = [{
-    'activePresets': [{
-        'description': 'Single Xeon 1270, 8GB Ram, 2x1TB SATA disks, Non-RAID',
-        'id': 64,
-        'isActive': '1',
-        'keyName': 'S1270_8GB_2X1TBSATA_NORAID',
-        'name': 'S1270 8GB 2X1TBSATA NORAID',
-        'packageId': 200
-    }],
+    'activePresets': [activePreset1],
+    'accountRestrictedActivePresets': [activePreset2],
     'description': 'Bare Metal Server',
     'firstOrderStepId': 1,
     'id': 200,

SoftLayer/managers/hardware.py

@@ -9,6 +9,7 @@
 import socket
 import time
 
+
 import SoftLayer
 from SoftLayer.decoration import retry
 from SoftLayer.managers import ordering
@@ -56,8 +57,7 @@ def __init__(self, client, ordering_manager=None):
         else:
             self.ordering_manager = ordering_manager
 
-    def cancel_hardware(self, hardware_id, reason='unneeded', comment='',
-                        immediate=False):
+    def cancel_hardware(self, hardware_id, reason='unneeded', comment='', immediate=False):
         """Cancels the specified dedicated server.
 
         Example::
@@ -66,27 +66,46 @@ def cancel_hardware(self, hardware_id, reason='unneeded', comment='',
             result = mgr.cancel_hardware(hardware_id=1234)
 
         :param int hardware_id: The ID of the hardware to be cancelled.
-        :param string reason: The reason code for the cancellation. This should
-                              come from :func:`get_cancellation_reasons`.
-        :param string comment: An optional comment to include with the
-                               cancellation.
+        :param string reason: The reason code for the cancellation. This should come from
+                              :func:`get_cancellation_reasons`.
+        :param string comment: An optional comment to include with the cancellation.
+        :param bool immediate: If set to True, will automatically update the cancelation ticket to request
+                               the resource be reclaimed asap. This request still has to be reviewed by a human
+        :returns: True on success or an exception
         """
 
         # Get cancel reason
         reasons = self.get_cancellation_reasons()
         cancel_reason = reasons.get(reason, reasons['unneeded'])
+        ticket_mgr = SoftLayer.TicketManager(self.client)
+        mask = 'mask[id, hourlyBillingFlag, billingItem[id], openCancellationTicket[id]]'
+        hw_billing = self.get_hardware(hardware_id, mask=mask)
 
-        hw_billing = self.get_hardware(hardware_id,
-                                       mask='mask[id, billingItem.id]')
         if 'billingItem' not in hw_billing:
-            raise SoftLayer.SoftLayerError(
-                "No billing item found for hardware")
+            raise SoftLayer.SoftLayerError("Ticket #%s already exists for this server" %
+                                           hw_billing['openCancellationTicket']['id'])
 
         billing_id = hw_billing['billingItem']['id']
 
-        return self.client.call('Billing_Item', 'cancelItem',
-                                immediate, False, cancel_reason, comment,
-                                id=billing_id)
+        if immediate and not hw_billing['hourlyBillingFlag']:
+            LOGGER.warning("Immediate cancelation of montly servers is not guaranteed. " +
+                           "Please check the cancelation ticket for updates.")
+
+            result = self.client.call('Billing_Item', 'cancelItem',
+                                      False, False, cancel_reason, comment, id=billing_id)
+            hw_billing = self.get_hardware(hardware_id, mask=mask)
+            ticket_number = hw_billing['openCancellationTicket']['id']
+            cancel_message = "Please reclaim this server ASAP, it is no longer needed. Thankyou."
+            ticket_mgr.update_ticket(ticket_number, cancel_message)
+            LOGGER.info("Cancelation ticket #%s has been updated requesting immediate reclaim", ticket_number)
+        else:
+            result = self.client.call('Billing_Item', 'cancelItem',
+                                      immediate, False, cancel_reason, comment, id=billing_id)
+            hw_billing = self.get_hardware(hardware_id, mask=mask)
+            ticket_number = hw_billing['openCancellationTicket']['id']
+            LOGGER.info("Cancelation ticket #%s has been created", ticket_number)
+
+        return result
 
     @retry(logger=LOGGER)
     def list_hardware(self, tags=None, cpus=None, memory=None, hostname=None,
@@ -359,7 +378,7 @@ def get_create_options(self):
 
         # Sizes
         sizes = []
-        for preset in package['activePresets']:
+        for preset in package['activePresets'] + package['accountRestrictedActivePresets']:
             sizes.append({
                 'name': preset['description'],
                 'key': preset['keyName']
@@ -418,6 +437,7 @@ def _get_package(self):
                 prices
             ],
             activePresets,
+            accountRestrictedActivePresets,
             regions[location[location[priceGroups]]]
             '''
 
@@ -774,7 +794,7 @@ def _get_location(package, location):
 
 def _get_preset_id(package, size):
     """Get the preset id given the keyName of the preset."""
-    for preset in package['activePresets']:
+    for preset in package['activePresets'] + package['accountRestrictedActivePresets']:
         if preset['keyName'] == size or preset['id'] == size:
             return preset['id']
 

SoftLayer/managers/ordering.py

@@ -7,6 +7,8 @@
 """
 # pylint: disable=no-self-use
 
+from re import match
+
 from SoftLayer import exceptions
 
 CATEGORY_MASK = '''id,
@@ -341,7 +343,7 @@ def get_price_id_list(self, package_keyname, item_keynames):
             # can take that ID and create the proper price for us in the location
             # in which the order is made
             price_id = [p['id'] for p in matching_item['prices']
-                        if p['locationGroupId'] == ''][0]
+                        if p['locationGroupId'] is None][0]
             prices.append(price_id)
 
         return prices
@@ -443,7 +445,7 @@ def generate_order(self, package_keyname, location, item_keynames, complex_type=
         #                                    'domain': 'softlayer.com'}]}
         order.update(extras)
         order['packageId'] = package['id']
-        order['location'] = location
+        order['location'] = self.get_location_id(location)
         order['quantity'] = quantity
         order['useHourlyPricing'] = hourly
 
@@ -471,3 +473,23 @@ def package_locations(self, package_keyname):
 
         regions = self.package_svc.getRegions(id=package['id'], mask=mask)
         return regions
+
+    def get_location_id(self, location):
+        """Finds the location ID of a given datacenter
+
+        This is mostly used so either a dc name, or regions keyname can be used when ordering
+        :param str location: Region Keyname (DALLAS13) or datacenter name (dal13)
+        :returns: integer id of the datacenter
+        """
+
+        if isinstance(location, int):
+            return location
+        mask = "mask[id,name,regions[keyname]]"
+        if match(r'[a-zA-Z]{3}[0-9]{2}', location) is not None:
+            search = {'name': {'operation': location}}
+        else:
+            search = {'regions': {'keyname': {'operation': location}}}
+        datacenter = self.client.call('SoftLayer_Location', 'getDatacenters', mask=mask, filter=search)
+        if len(datacenter) != 1:
+            raise exceptions.SoftLayerError("Unable to find location: %s" % location)
+        return datacenter[0]['id']

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name='SoftLayer',
-    version='5.4.2',
+    version='5.4.3',
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
     author='SoftLayer Technologies, Inc.',

snap/snapcraft.yaml

@@ -1,5 +1,5 @@
 name: slcli # check to see if it's available
-version: '5.4.2.0+git' # check versioning
+version: '5.4.3.0+git' # check versioning
 summary: Python based SoftLayer API Tool. # 79 char long summary
 description: |
     A command-line interface is also included and can be used to manage various SoftLayer products and services.

tests/CLI/modules/order_tests.py

@@ -210,9 +210,9 @@ def test_location_list(self):
 
     def _get_order_items(self):
         item1 = {'keyName': 'ITEM1', 'description': 'description1',
-                 'prices': [{'id': 1111, 'locationGroupId': ''}]}
+                 'prices': [{'id': 1111, 'locationGroupId': None}]}
         item2 = {'keyName': 'ITEM2', 'description': 'description2',
-                 'prices': [{'id': 2222, 'locationGroupId': ''}]}
+                 'prices': [{'id': 2222, 'locationGroupId': None}]}
 
         return [item1, item2]