Fix team code review

caberos · caberos · commit 345ae1f09055 · 2022-08-31T12:00:14.000-04:00
diff --git a/SoftLayer/CLI/core.py b/SoftLayer/CLI/core.py
@@ -44,7 +44,7 @@
 def get_latest_version():
     """Gets the latest version of the Softlayer library."""
     try:
-        result = requests.get('https://pypi.org/pypi/SoftLayer/json')
+        result = requests.get('https://pypi.org/pypi/SoftLayer/json',  timeout=60)
         json_result = result.json()
         latest = 'v{}'.format(json_result['info']['version'])
     except Exception:
diff --git a/SoftLayer/CLI/hardware/guests.py b/SoftLayer/CLI/hardware/guests.py
diff --git a/SoftLayer/CLI/routes.py b/SoftLayer/CLI/routes.py
@@ -214,6 +214,7 @@
     ('ipsec:translation-update', 'SoftLayer.CLI.vpn.ipsec.translation.update:cli'),
     ('ipsec:update', 'SoftLayer.CLI.vpn.ipsec.update:cli'),
     ('ipsec:order', 'SoftLayer.CLI.vpn.ipsec.order:cli'),
+    ('ipsec:cancel', 'SoftLayer.CLI.vpn.ipsec.cancel:cli'),
 
     ('loadbal', 'SoftLayer.CLI.loadbal'),
     ('loadbal:detail', 'SoftLayer.CLI.loadbal.detail:cli'),
@@ -273,7 +274,6 @@
     ('hardware:detail', 'SoftLayer.CLI.hardware.detail:cli'),
     ('hardware:billing', 'SoftLayer.CLI.hardware.billing:cli'),
     ('hardware:edit', 'SoftLayer.CLI.hardware.edit:cli'),
-    ('hardware:guests', 'SoftLayer.CLI.hardware.guests:cli'),
     ('hardware:list', 'SoftLayer.CLI.hardware.list:cli'),
     ('hardware:power-cycle', 'SoftLayer.CLI.hardware.power:power_cycle'),
     ('hardware:power-off', 'SoftLayer.CLI.hardware.power:power_off'),
@@ -334,6 +334,7 @@
     ('subnet:lookup', 'SoftLayer.CLI.subnet.lookup:cli'),
     ('subnet:edit-ip', 'SoftLayer.CLI.subnet.edit_ip:cli'),
     ('subnet:route', 'SoftLayer.CLI.subnet.route:cli'),
+    ('subnet:clear-route', 'SoftLayer.CLI.subnet.clear_route:cli'),
 
     ('tags', 'SoftLayer.CLI.tags'),
     ('tags:cleanup', 'SoftLayer.CLI.tags.cleanup:cli'),
diff --git a/SoftLayer/CLI/subnet/clear_route.py b/SoftLayer/CLI/subnet/clear_route.py
@@ -0,0 +1,24 @@
+"""Remove the route of your Account Owned subnets."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('identifier')
+@environment.pass_env
+def cli(env, identifier):
+    """Remove the route of your Account Owned subnets."""
+
+    mgr = SoftLayer.NetworkManager(env.client)
+
+    subnet = mgr.clear_route(identifier)
+
+    if subnet:
+        click.secho("The transaction to clear the route is created, routes will be updated in one or two minutes.")
+    else:
+        raise exceptions.CLIAbort('Failed to clear the route for the subnet.')
diff --git a/SoftLayer/CLI/virt/access.py b/SoftLayer/CLI/virt/access.py
@@ -1,4 +1,4 @@
-"""Command lines which modify power states."""
+"""Get user access details a virtual server."""
 # :license: MIT, see LICENSE for more details.
 
 import click
diff --git a/SoftLayer/CLI/virt/list.py b/SoftLayer/CLI/virt/list.py
@@ -36,9 +36,12 @@
 DEFAULT_COLUMNS = [
     'id',
     'hostname',
+    'domain',
+    'deviceStatus.name',
+    'datacenter',
     'primary_ip',
     'backend_ip',
-    'datacenter',
+    'createDate',
     'action',
 ]
 
diff --git a/SoftLayer/CLI/vpn/ipsec/cancel.py b/SoftLayer/CLI/vpn/ipsec/cancel.py
@@ -0,0 +1,31 @@
+"""Cancel an IPSec service."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('identifier')
+@click.option('--immediate',
+              is_flag=True,
+              default=False,
+              help="Cancels the service  immediately (instead of on the billing anniversary)")
+@click.option('--reason',
+              help="An optional cancellation reason. See cancel-reasons for a list of available options")
+@environment.pass_env
+def cli(env, identifier, immediate, reason):
+    """Cancel a IPSEC VPN tunnel context."""
+
+    manager = SoftLayer.IPSECManager(env.client)
+    context = manager.get_tunnel_context(identifier, mask='billingItem')
+
+    if 'billingItem' not in context:
+        raise SoftLayer.SoftLayerError("Cannot locate billing. May already be cancelled.")
+
+    result = manager.cancel_item(context['billingItem']['id'], immediate, reason)
+
+    if result:
+        env.fout("Ipsec {} was cancelled.".format(identifier))
diff --git a/SoftLayer/fixtures/SoftLayer_Account.py b/SoftLayer/fixtures/SoftLayer_Account.py
@@ -845,7 +845,7 @@
         'createDate': '2015-05-05T16:23:52-06:00',
         'id': 11449,
         'modifyDate': '2015-05-05T16:24:09-06:00',
-        'name': 'SLADC307608-1',
+        'name': 'TEST307608-1',
         'typeId': 2,
         'description': 'Citrix NetScaler VPX 10.5 10Mbps Standard',
         'managementIpAddress': '10.11.11.112',
diff --git a/SoftLayer/fixtures/SoftLayer_Hardware_Server.py b/SoftLayer/fixtures/SoftLayer_Hardware_Server.py
@@ -278,26 +278,6 @@
     }
 ]
 
-getVirtualHost = {
-    "accountId": 11111,
-    "createDate": "2018-10-08T10:54:48-06:00",
-    "description": "host16.vmware.chechu.com",
-    "hardwareId": 22222,
-    "id": 33333,
-    "name": "host16.vmware.chechu.com",
-    "uuid": "00000000-0000-0000-0000-0cc11111",
-    "hardware": {
-        "accountId": 11111,
-        "domain": "chechu.com",
-        "hostname": "host16.vmware",
-        "id": 22222,
-        "hardwareStatus": {
-            "id": 5,
-            "status": "ACTIVE"
-        }
-    }
-}
-
 getUpgradeItemPrices = [
     {
         "id": 21525,
diff --git a/SoftLayer/fixtures/SoftLayer_Network_Application_Delivery_Controller.py b/SoftLayer/fixtures/SoftLayer_Network_Application_Delivery_Controller.py
@@ -3,7 +3,7 @@
     'createDate': '2015-05-05T16:23:52-06:00',
     'id': 11449,
     'modifyDate': '2015-05-05T16:24:09-06:00',
-    'name': 'SLADC307608-1',
+    'name': 'TEST307608-1',
     'typeId': 2,
     'description': 'Citrix NetScaler VPX 10.5 10Mbps Standard',
     'managementIpAddress': '10.11.11.112',
diff --git a/SoftLayer/fixtures/SoftLayer_Network_Storage_Hub_Cleversafe_Account.py b/SoftLayer/fixtures/SoftLayer_Network_Storage_Hub_Cleversafe_Account.py
@@ -67,12 +67,12 @@
 
 getObject = {
     'id': 123456,
-    'username': 'SLOSC307608-1',
+    'username': 'TEST307608-1',
     'credentials': [
         {
             'id': 1933496,
-            'password': 'Um1Bp420FIFNvAg2QHjn5Sci2c2x4RNDXpVDDvnf',
-            'username': 'Kv9aNIhtNa7ZRceCTgep',
+            'password': 'Um1Bp420FIFNvAg2QHjn5Sci2c2x4RNDXpVDDvnfsdsd1010',
+            'username': 'Kv9aNIhtNa7ZRceabecs',
             'type': {
                 'description': 'A credential for generating S3 Compatible Signatures.',
                 'keyName': 'S3_COMPATIBLE_SIGNATURE'
diff --git a/SoftLayer/fixtures/SoftLayer_Network_Subnet.py b/SoftLayer/fixtures/SoftLayer_Network_Subnet.py
@@ -45,3 +45,4 @@
 setTags = True
 cancel = True
 route = True
+clearRoute = True
diff --git a/SoftLayer/fixtures/SoftLayer_Virtual_Guest.py b/SoftLayer/fixtures/SoftLayer_Virtual_Guest.py
@@ -929,7 +929,7 @@
         "message": "User connected",
         "sourceIp": "44.200.9.0",
         "sourcePort": 47097,
-        "username": "307608_sebastian.chaparro@ibm.com"
+        "username": "testuser@ibm.com@ibm.com"
     },
     {
         "createDate": "2022-03-07T07:58:27-06:00",
@@ -938,5 +938,5 @@
         "message": "User connected",
         "sourceIp": "44.200.9.0",
         "sourcePort": 41185,
-        "username": "307608_sebastian.chaparro@ibm.com"
+        "username": "testuser@ibm.com"
     }]
diff --git a/SoftLayer/managers/hardware.py b/SoftLayer/managers/hardware.py
@@ -769,18 +769,6 @@ def get_hard_drives(self, instance_id):
         """
         return self.hardware.getHardDrives(id=instance_id)
 
-    def get_hardware_guests(self, instance_id):
-        """Returns the hardware server guests.
-
-        :param int instance_id: Id of the hardware server.
-        """
-        mask = "mask[id]"
-        virtual_host = self.hardware.getVirtualHost(mask=mask, id=instance_id)
-        if virtual_host:
-            return self.client.call('SoftLayer_Virtual_Host', 'getGuests', mask='mask[powerState]',
-                                    id=virtual_host['id'])
-        return virtual_host
-
     def get_hardware_item_prices(self, location):
         """Returns the hardware server item prices by location.
 
diff --git a/SoftLayer/managers/ipsec.py b/SoftLayer/managers/ipsec.py
@@ -299,3 +299,21 @@ def order(self, datacenter, item_package):
                                             item_keynames=item_package,
                                             complex_type=complex_type,
                                             hourly=False)
+
+    def cancel_item(self, identifier, immediate, reason):
+        """Cancels the specified billing item Ipsec.
+
+        Example::
+
+            # Cancels ipsec id 1234
+            result = mgr.cancel_item(billing_item_id=1234)
+
+        :param int billing_id: The ID of the billing item to be cancelled.
+        :param string reason: The reason code for the cancellation. This should come from
+                              :func:`get_cancellation_reasons`.
+        :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
+        """
+        return self.client.call('SoftLayer_Billing_Item', 'cancelItem',
+                                True, immediate, reason, id=identifier)
diff --git a/SoftLayer/managers/network.py b/SoftLayer/managers/network.py
@@ -880,3 +880,10 @@ def get_datacenter_by_keyname(self, keyname=None):
         if len(result) >= 1:
             return result[0]
         return {}
+
+    def clear_route(self, identifier):
+        """Calls SoftLayer_Network_Subnet::clearRoute()
+
+        returns  true or false.
+        """
+        return self.client.call('SoftLayer_Network_Subnet', 'clearRoute', id=identifier)
diff --git a/docs/cli/hardware.rst b/docs/cli/hardware.rst
@@ -120,10 +120,6 @@ This function updates the firmware of a server. If already at the latest version
    :prog: hardware storage
    :show-nested:
 
-.. click:: SoftLayer.CLI.hardware.guests:cli
-   :prog: hardware guests
-   :show-nested:
-
 .. click:: SoftLayer.CLI.hardware.authorize_storage:cli
    :prog: hardware authorize-storage
    :show-nested:
diff --git a/docs/cli/ipsec.rst b/docs/cli/ipsec.rst
@@ -275,4 +275,8 @@ The following is an example of updating an existing address translation entry.
 
 .. click:: SoftLayer.CLI.vpn.ipsec.order:cli
     :prog: ipsec order
+    :show-nested:
+
+.. click:: SoftLayer.CLI.vpn.ipsec.cancel:cli
+    :prog: ipsec cancel
     :show-nested:
diff --git a/docs/cli/subnet.rst b/docs/cli/subnet.rst
@@ -30,6 +30,11 @@ Subnets
 .. click:: SoftLayer.CLI.subnet.edit_ip:cli
     :prog: subnet edit-ip
     :show-nested:
+
 .. click:: SoftLayer.CLI.subnet.route:cli
     :prog: subnet route
     :show-nested:
+
+.. click:: SoftLayer.CLI.subnet.clear_route:cli
+    :prog: subnet clear-route
+    :show-nested:
diff --git a/tests/CLI/modules/ipsec_tests.py b/tests/CLI/modules/ipsec_tests.py
@@ -7,7 +7,6 @@
 
 import json
 
-
 from SoftLayer.CLI.exceptions import ArgumentError
 from SoftLayer.CLI.exceptions import CLIHalt
 from SoftLayer.fixtures import SoftLayer_Product_Order
@@ -520,3 +519,41 @@ def test_ipsec_order(self):
         order_mock.return_value = SoftLayer_Product_Order.ipsec_placeOrder
         result = self.run_command(['ipsec', 'order', '-d', 'dal13'])
         self.assert_no_fail(result)
+
+    def test_ipsec_cancel(self):
+        mock = self.set_mock('SoftLayer_Account', 'getNetworkTunnelContexts')
+        mock.return_value = [{
+            "createDate": "2013-11-05T16:03:53-06:00",
+            "id": 445,
+            "internalPeerIpAddress": "184.172.127.9",
+            "modifyDate": "2022-07-19T09:34:53-06:00",
+            "name": "ipsec003",
+            "phaseOneAuthentication": "MD5",
+            "phaseOneDiffieHellmanGroup": 2,
+            "phaseOneEncryption": "3DES",
+            "phaseOneKeylife": 14400,
+            "phaseTwoAuthentication": "MD5",
+            "phaseTwoDiffieHellmanGroup": 2,
+            "phaseTwoEncryption": "3DES",
+            "phaseTwoKeylife": 3600,
+            "phaseTwoPerfectForwardSecrecy": 1,
+            "billingItem": {
+                "allowCancellationFlag": 1,
+                "categoryCode": "network_tunnel",
+                "createDate": "2022-07-19T09:34:52-06:00",
+                "cycleStartDate": "2022-08-03T23:07:43-06:00",
+                "description": "IPSEC - Standard",
+                "id": 977194617,
+                "lastBillDate": "2022-08-03T23:07:43-06:00",
+                "modifyDate": "2022-08-03T23:07:43-06:00",
+                "nextBillDate": "2022-09-03T23:00:00-06:00",
+                "oneTimeFee": "0",
+                "orderItemId": 932515967,
+                "recurringMonths": 1,
+                "serviceProviderId": 1,
+            }}]
+
+        mock = self.set_mock('SoftLayer_Billing_Item', 'cancelItem')
+        mock.return_value = True
+        result = self.run_command(['ipsec', 'cancel', '445', '--immediate', '--reason', 'test'])
+        self.assert_no_fail(result)
diff --git a/tests/CLI/modules/server_tests.py b/tests/CLI/modules/server_tests.py
@@ -910,18 +910,6 @@ def test_create_hw_no_confirm(self, confirm_mock):
 
         self.assertEqual(result.exit_code, 2)
 
-    def test_get_hardware_guests(self):
-        result = self.run_command(['hw', 'guests', '123456'])
-        self.assert_no_fail(result)
-
-    def test_hardware_guests_empty(self):
-        mock = self.set_mock('SoftLayer_Virtual_Host', 'getGuests')
-        mock.return_value = None
-
-        result = self.run_command(['hw', 'guests', '123456'])
-        self.assertEqual(result.exit_code, 2)
-        self.assertIsInstance(result.exception, exceptions.CLIAbort)
-
     @mock.patch('SoftLayer.CLI.formatting.confirm')
     def test_authorize_hw_no_confirm(self, confirm_mock):
         confirm_mock.return_value = False
diff --git a/tests/CLI/modules/subnet_tests.py b/tests/CLI/modules/subnet_tests.py
@@ -190,3 +190,7 @@ def test_route(self):
 
         self.assert_no_fail(result)
         self.assertEqual(result.exit_code, 0)
+
+    def test_clear_route(self):
+        result = self.run_command(['subnet', 'clear-route', '123456'])
+        self.assert_no_fail(result)
diff --git a/tests/managers/hardware_tests.py b/tests/managers/hardware_tests.py
diff --git a/tests/managers/ipsec_tests.py b/tests/managers/ipsec_tests.py
diff --git a/tests/managers/network_tests.py b/tests/managers/network_tests.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""Command lines which modify power states."""`
	`1`	`+"""Get user access details a virtual server."""`
`2`	`2`	`# :license: MIT, see LICENSE for more details.`
`3`	`3`
`4`	`4`	`import click`