#1038 allowed 'NONE' to be used as a location if needed

Author: allmightyspiff

SoftLayer/CLI/order/place.py

@@ -42,40 +42,26 @@ def cli(env, package_keyname, location, preset, verify, billing, complex_type,
         quantity, extras, order_items):
     """Place or verify an order.
 
-    This CLI command is used for placing/verifying an order of the specified package in
-    the given location (denoted by a datacenter's long name). Orders made via the CLI
-    can then be converted to be made programmatically by calling
-    SoftLayer.OrderingManager.place_order() with the same keynames.
-
-    Packages for ordering can be retrieved from `slcli order package-list`
-    Presets for ordering can be retrieved from `slcli order preset-list` (not all packages
-    have presets)
-
-    Items can be retrieved from `slcli order item-list`. In order to find required
-    items for the order, use `slcli order category-list`, and then provide the
-    --category option for each category code in `slcli order item-list`.
-
+\b
+1. Find the package keyName from `slcli order package-list` 
+2. Find the location from `slcli order package-locations PUBLIC_CLOUD_SERVER`
+  If the package does not require a location, use 'NONE' instead.
+3. Find the needed items `slcli order item-list PUBLIC_CLOUD_SERVER`
+  Some packages, like PUBLIC_CLOUD_SERVER need presets, `slcli order preset-list PUBLIC_CLOUD_SERVER`
+4. Find the complex type from https://sldn.softlayer.com/reference
+5. Use that complex type to fill out any --extras
 
     Example::
 
-        # Order an hourly VSI with 4 CPU, 16 GB RAM, 100 GB SAN disk,
-        # Ubuntu 16.04, and 1 Gbps public & private uplink in dal13
-        slcli order place --billing hourly CLOUD_SERVER DALLAS13 \\
-            GUEST_CORES_4 \\
-            RAM_16_GB \\
-            REBOOT_REMOTE_CONSOLE \\
-            1_GBPS_PUBLIC_PRIVATE_NETWORK_UPLINKS \\
-            BANDWIDTH_0_GB_2 \\
-            1_IP_ADDRESS \\
-            GUEST_DISK_100_GB_SAN \\
-            OS_UBUNTU_16_04_LTS_XENIAL_XERUS_MINIMAL_64_BIT_FOR_VSI \\
-            MONITORING_HOST_PING \\
-            NOTIFICATION_EMAIL_AND_TICKET \\
-            AUTOMATED_NOTIFICATION \\
-            UNLIMITED_SSL_VPN_USERS_1_PPTP_VPN_USER_PER_ACCOUNT \\
-            NESSUS_VULNERABILITY_ASSESSMENT_REPORTING \\
-            --extras '{"virtualGuests": [{"hostname": "test", "domain": "softlayer.com"}]}' \\
-            --complex-type SoftLayer_Container_Product_Order_Virtual_Guest
+        slcli order place --verify --preset B1_2X8X100 --billing hourly 
+        --complex-type SoftLayer_Container_Product_Order_Virtual_Guest
+        --extras '{"virtualGuests": [{"hostname": "test", "domain": "ibm.com"}]}'
+        PUBLIC_CLOUD_SERVER DALLAS13
+        BANDWIDTH_0_GB_2 MONITORING_HOST_PING NOTIFICATION_EMAIL_AND_TICKET
+        OS_DEBIAN_9_X_STRETCH_LAMP_64_BIT 1_IP_ADDRESS 1_IPV6_ADDRESS
+        1_GBPS_PUBLIC_PRIVATE_NETWORK_UPLINKS REBOOT_REMOTE_CONSOLE
+        AUTOMATED_NOTIFICATION UNLIMITED_SSL_VPN_USERS_1_PPTP_VPN_USER_PER_ACCOUNT
+        NESSUS_VULNERABILITY_ASSESSMENT_REPORTING
 
     """
     manager = ordering.OrderingManager(env.client)
@@ -118,3 +104,4 @@ def cli(env, package_keyname, location, preset, verify, billing, complex_type,
         table.add_row(['created', order['orderDate']])
         table.add_row(['status', order['placedOrder']['status']])
     env.fout(table)
+

SoftLayer/managers/ordering.py

@@ -634,6 +634,9 @@ def get_location_id(self, location):
 
         if isinstance(location, int):
             return location
+        # Some orders dont require a location, just use 0
+        if location.upper() == "NONE":
+            return 0
         mask = "mask[id,name,regions[keyname]]"
         if match(r'[a-zA-Z]{3}[0-9]{2}', location) is not None:
             search = {'name': {'operation': location}}

tests/managers/ordering_tests.py

@@ -594,6 +594,10 @@ def test_get_location_id_int(self):
         dc_id = self.ordering.get_location_id(1234)
         self.assertEqual(1234, dc_id)
 
+    def test_get_location_id_NONE(self):
+        dc_id = self.ordering.get_location_id("NONE")
+        self.assertEqual(0, dc_id)
+
     def test_location_group_id_none(self):
         # RestTransport uses None for empty locationGroupId
         category1 = {'categoryCode': 'cat1'}