Merge pull request #1499 from caberos/issue1496

allmightyspiff · web-flow · commit 706845bb12d4 · 2021-07-15T14:55:52.000-05:00
add new feature on vlan cli
diff --git a/SoftLayer/CLI/routes.py b/SoftLayer/CLI/routes.py
@@ -346,6 +346,7 @@
     ('user:vpn-subnet', 'SoftLayer.CLI.user.vpn_subnet:cli'),
 
     ('vlan', 'SoftLayer.CLI.vlan'),
+    ('vlan:create', 'SoftLayer.CLI.vlan.create:cli'),
     ('vlan:detail', 'SoftLayer.CLI.vlan.detail:cli'),
     ('vlan:edit', 'SoftLayer.CLI.vlan.edit:cli'),
     ('vlan:list', 'SoftLayer.CLI.vlan.list:cli'),
diff --git a/SoftLayer/CLI/vlan/create.py b/SoftLayer/CLI/vlan/create.py
@@ -0,0 +1,58 @@
+"""Order/create a VLAN instance."""
+# :license: MIT, see LICENSE for more details.
+import click
+import SoftLayer
+from SoftLayer.managers import ordering
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import formatting
+
+
+@click.command()
+@click.option('--name', required=False, prompt=True, help="Vlan name")
+@click.option('--datacenter', '-d', required=False, help="Datacenter shortname")
+@click.option('--pod', '-p', required=False, help="Pod name. E.g dal05.pod01")
+@click.option('--network', default='public', show_default=True, type=click.Choice(['public', 'private']),
+              help='Network vlan type')
+@click.option('--billing', default='hourly', show_default=True, type=click.Choice(['hourly', 'monthly']),
+              help="Billing rate")
+@environment.pass_env
+def cli(env, name, datacenter, pod, network, billing):
+    """Order/create a VLAN instance."""
+
+    item_package = ['PUBLIC_NETWORK_VLAN']
+    complex_type = 'SoftLayer_Container_Product_Order_Network_Vlan'
+    extras = {'name': name}
+    if pod:
+        datacenter = pod.split('.')[0]
+        mgr = SoftLayer.NetworkManager(env.client)
+        pods = mgr.get_pods()
+        for router in pods:
+            if router.get('name') == pod:
+                if network == 'public':
+                    extras['routerId'] = router.get('frontendRouterId')
+                elif network == 'private':
+                    extras['routerId'] = router.get('backendRouterId')
+                break
+        if not extras.get('routerId'):
+            raise exceptions.CLIAbort(
+                "Unable to find pod name: {}".format(pod))
+    if network == 'private':
+        item_package = ['PRIVATE_NETWORK_VLAN']
+
+    ordering_manager = ordering.OrderingManager(env.client)
+    result = ordering_manager.place_order(package_keyname='NETWORK_VLAN',
+                                          location=datacenter,
+                                          item_keynames=item_package,
+                                          complex_type=complex_type,
+                                          hourly=billing,
+                                          extras=extras)
+    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']])
+    table.add_row(['name', result['orderDetails']['orderContainers'][0]['name']])
+
+    env.fout(table)
diff --git a/SoftLayer/fixtures/SoftLayer_Network_Pod.py b/SoftLayer/fixtures/SoftLayer_Network_Pod.py
@@ -18,5 +18,15 @@
         'frontendRouterId': 1114993,
         'frontendRouterName': 'fcr01a.wdc07',
         'name': 'wdc07.pod01'
+    },
+    {
+        'backendRouterId': 1234567,
+        'backendRouterName': 'bcr01a.wdc07',
+        'datacenterId': 2017603,
+        'datacenterLongName': 'Washington 7',
+        'datacenterName': 'wdc07',
+        'frontendRouterId': 258741369,
+        'frontendRouterName': 'fcr01a.wdc07',
+        'name': 'TEST00.pod2'
     }
 ]
diff --git a/SoftLayer/fixtures/SoftLayer_Product_Order.py b/SoftLayer/fixtures/SoftLayer_Product_Order.py
@@ -284,3 +284,22 @@
             }
         }
     ]}
+
+vlan_placeOrder = {"orderDate": "2021-06-02 15:23:47",
+                   "orderId": 123456,
+                   "orderDetails": {
+                       "orderContainers": [{
+                           "name": "test"}]},
+                   "prices": [{
+                       "id": 2018,
+                       "itemId": 1071,
+                       "categories": [{
+                           "categoryCode": "network_vlan",
+                           "id": 113,
+                           "name": "Network Vlan"}],
+                       "item": {
+                           "capacity": "0",
+                           "description": "Public Network Vlan",
+                           "id": 1071,
+                           "keyName": "PUBLIC_NETWORK_VLAN"}}
+                   ]}
diff --git a/SoftLayer/fixtures/SoftLayer_Product_Package.py b/SoftLayer/fixtures/SoftLayer_Product_Package.py
@@ -2081,3 +2081,66 @@
             "sort": 0,
         }
     ]}]
+
+getItemsVLAN = [{
+    "description": "Private Network Vlan",
+    "id": 1072,
+    "itemTaxCategoryId": 166,
+    "keyName": "PRIVATE_NETWORK_VLAN",
+    "itemCategory": {
+        "categoryCode": "network_vlan",
+        "id": 113,
+        "name": "Network Vlan"},
+    "prices": [{
+        "id": 203707,
+        "itemId": 1072,
+        "laborFee": "0",
+        "locationGroupId": 505,
+        "oneTimeFee": "0",
+        "recurringFee": "0",
+        "setupFee": "0",
+        "sort": 10,
+    },
+        {
+            "id": 203727,
+            "itemId": 1072,
+            "laborFee": "0",
+            "locationGroupId": 545,
+            "oneTimeFee": "0",
+            "recurringFee": "0",
+            "setupFee": "0",
+            "sort": 10,
+        }]
+}, {
+    "description": "Public Network Vlan",
+    "id": 1071,
+    "itemTaxCategoryId": 166,
+    "keyName": "PUBLIC_NETWORK_VLAN",
+    "units": "N/A",
+    "itemCategory": {
+        "categoryCode": "network_vlan",
+        "id": 113,
+        "name": "Network Vlan",
+    },
+    "prices": [{
+        "id": 203637,
+        "itemId": 1071,
+        "laborFee": "0",
+        "locationGroupId": 509,
+        "oneTimeFee": "0",
+        "recurringFee": "0",
+        "setupFee": "0",
+        "sort": 10,
+    },
+        {
+            "id": 203667,
+            "itemId": 1071,
+            "laborFee": "0",
+            "locationGroupId": 545,
+            "oneTimeFee": "0",
+            "recurringFee": "0",
+            "setupFee": "0",
+            "sort": 10,
+        }]
+}
+]
diff --git a/SoftLayer/managers/network.py b/SoftLayer/managers/network.py
@@ -778,3 +778,14 @@ def cancel_item(self, identifier, cancel_immediately,
                                 reason_cancel,
                                 customer_note,
                                 id=identifier)
+
+    def get_pods(self, datacenter=None):
+        """Calls SoftLayer_Network_Pod::getAllObjects()
+
+        returns list of all network pods and their routers.
+        """
+        _filter = None
+        if datacenter:
+            _filter = {"datacenterName": {"operation": datacenter}}
+
+        return self.client.call('SoftLayer_Network_Pod', 'getAllObjects', filter=_filter)
diff --git a/SoftLayer/utils.py b/SoftLayer/utils.py
@@ -228,7 +228,7 @@ def build_filter_orderby(orderby):
     for keyword in reverse_filter:
         _aux_filter = {}
         if '=' in keyword:
-            _aux_filter[str(keyword).split('=',  maxsplit=1)[0]] = query_filter_orderby(str(keyword).split('=')[1])
+            _aux_filter[str(keyword).split('=', maxsplit=1)[0]] = query_filter_orderby(str(keyword).split('=')[1])
             _filters = _aux_filter
         elif keyword == list(reverse_filter)[0]:
             _aux_filter[keyword] = query_filter_orderby('DESC')
diff --git a/docs/cli/vlan.rst b/docs/cli/vlan.rst
@@ -3,6 +3,10 @@
 VLANs
 =====
 
+.. click:: SoftLayer.CLI.vlan.create:cli
+    :prog: vlan create
+    :show-nested:
+
 .. click:: SoftLayer.CLI.vlan.detail:cli
     :prog: vlan detail
     :show-nested:
diff --git a/tests/CLI/modules/vlan_tests.py b/tests/CLI/modules/vlan_tests.py
@@ -4,8 +4,11 @@
 
     :license: MIT, see LICENSE for more details.
 """
+import json
 from unittest import mock as mock
 
+from SoftLayer.fixtures import SoftLayer_Product_Order
+from SoftLayer.fixtures import SoftLayer_Product_Package
 from SoftLayer import testing
 
 
@@ -136,6 +139,42 @@ def test_vlan_list(self):
         self.assert_no_fail(result)
         self.assert_called_with('SoftLayer_Account', 'getNetworkVlans')
 
+    def test_create_vlan(self):
+        _mock = self.set_mock('SoftLayer_Product_Package', 'getItems')
+        _mock.return_value = SoftLayer_Product_Package.getItemsVLAN
+
+        order_mock = self.set_mock('SoftLayer_Product_Order', 'placeOrder')
+        order_mock.return_value = SoftLayer_Product_Order.vlan_placeOrder
+
+        result = self.run_command(['vlan', 'create',
+                                   '--name', 'test',
+                                   '-d TEST00',
+                                   '--network', 'public',
+                                   '--billing', 'hourly'
+                                   ])
+
+        self.assert_no_fail(result)
+        self.assertEqual(json.loads(result.output),
+                         {'id': 123456, 'created': '2021-06-02 15:23:47', 'name': 'test'})
+
+    def test_create_vlan_pod(self):
+        _mock = self.set_mock('SoftLayer_Product_Package', 'getItems')
+        _mock.return_value = SoftLayer_Product_Package.getItemsVLAN
+
+        order_mock = self.set_mock('SoftLayer_Product_Order', 'placeOrder')
+        order_mock.return_value = SoftLayer_Product_Order.vlan_placeOrder
+
+        result = self.run_command(['vlan', 'create',
+                                   '--name', 'test',
+                                   '-p', 'TEST00.pod2',
+                                   '--network', 'public',
+                                   '--billing', 'hourly'
+                                   ])
+
+        self.assert_no_fail(result)
+        self.assertEqual(json.loads(result.output),
+                         {'id': 123456, 'created': '2021-06-02 15:23:47', 'name': 'test'})
+
     @mock.patch('SoftLayer.CLI.formatting.no_going_back')
     def test_vlan_cancel(self, confirm_mock):
         confirm_mock.return_value = True
diff --git a/tests/managers/network_tests.py b/tests/managers/network_tests.py
@@ -624,3 +624,7 @@ def test_vlan_edit(self):
 
         self.network.edit(vlan_id, name, note, tags)
         self.assert_called_with('SoftLayer_Network_Vlan', 'editObject')
+
+    def test_get_all_pods(self):
+        self.network.get_pods()
+        self.assert_called_with('SoftLayer_Network_Pod', 'getAllObjects')
