fixed code review comments, a few more unit tests

allmightyspiff · allmightyspiff · commit 8aa65113dd3b · 2021-03-29T16:57:48.000-05:00
diff --git a/SoftLayer/API.py b/SoftLayer/API.py
@@ -175,7 +175,8 @@ def __init__(self, auth=None, transport=None, config_file=None):
                 transport = transports.RestTransport(
                     endpoint_url=url,
                     proxy=self.settings['softlayer'].get('proxy'),
-                    timeout=self.settings['softlayer'].getint('timeout'),
+                    # prevents an exception incase timeout is a float number.
+                    timeout=int(self.settings['softlayer'].getfloat('timeout')),
                     user_agent=consts.USER_AGENT,
                     verify=self.settings['softlayer'].getboolean('verify'),
                 )
@@ -184,7 +185,7 @@ def __init__(self, auth=None, transport=None, config_file=None):
                 transport = transports.XmlRpcTransport(
                     endpoint_url=url,
                     proxy=self.settings['softlayer'].get('proxy'),
-                    timeout=self.settings['softlayer'].getint('timeout'),
+                    timeout=int(self.settings['softlayer'].getfloat('timeout')),
                     user_agent=consts.USER_AGENT,
                     verify=self.settings['softlayer'].getboolean('verify'),
                 )
@@ -387,19 +388,25 @@ def authenticate_with_password(self, username, password, security_question_id=No
             'username': username
         }
 
-        response = iam_client.request(
-            'POST',
-            'https://iam.cloud.ibm.com/identity/token',
-            data=data,
-            headers=headers,
-            auth=requests.auth.HTTPBasicAuth('bx', 'bx')
-        )
-        if response.status_code != 200:
-            LOGGER.error("Unable to login: %s", response.text)
+        try:
+            response = iam_client.request(
+                'POST',
+                'https://iam.cloud.ibm.com/identity/token',
+                data=data,
+                headers=headers,
+                auth=requests.auth.HTTPBasicAuth('bx', 'bx')
+            )
+            if response.status_code != 200:
+                LOGGER.error("Unable to login: %s", response.text)
 
-        response.raise_for_status()
+            response.raise_for_status()
+            tokens = json.loads(response.text)
+        except requests.HTTPError as ex:
+            error = json.loads(response.text)
+            raise exceptions.IAMError(response.status_code,
+                                      error.get('errorMessage'),
+                                      'https://iam.cloud.ibm.com/identity/token')
 
-        tokens = json.loads(response.text)
         self.settings['softlayer']['access_token'] = tokens['access_token']
         self.settings['softlayer']['refresh_token'] = tokens['refresh_token']
 
@@ -427,19 +434,26 @@ def authenticate_with_passcode(self, passcode):
             'response_type': 'cloud_iam'
         }
 
-        response = iam_client.request(
-            'POST',
-            'https://iam.cloud.ibm.com/identity/token',
-            data=data,
-            headers=headers,
-            auth=requests.auth.HTTPBasicAuth('bx', 'bx')
-        )
-        if response.status_code != 200:
-            LOGGER.error("Unable to login: %s", response.text)
+        try:
+            response = iam_client.request(
+                'POST',
+                'https://iam.cloud.ibm.com/identity/token',
+                data=data,
+                headers=headers,
+                auth=requests.auth.HTTPBasicAuth('bx', 'bx')
+            )
+            if response.status_code != 200:
+                LOGGER.error("Unable to login: %s", response.text)
+
+            response.raise_for_status()
+            tokens = json.loads(response.text)
 
-        response.raise_for_status()
+        except requests.HTTPError as ex:
+            error = json.loads(response.text)
+            raise exceptions.IAMError(response.status_code,
+                                      error.get('errorMessage'),
+                                      'https://iam.cloud.ibm.com/identity/token')
 
-        tokens = json.loads(response.text)
         self.settings['softlayer']['access_token'] = tokens['access_token']
         self.settings['softlayer']['refresh_token'] = tokens['refresh_token']
         a_expire = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(tokens['expiration']))
@@ -483,20 +497,27 @@ def refresh_iam_token(self, r_token, account_id=None, ims_account=None):
         data['account'] = account_id
         data['ims_account'] = ims_account
 
-        response = iam_client.request(
-            'POST',
-            'https://iam.cloud.ibm.com/identity/token',
-            data=data,
-            headers=headers,
-            auth=requests.auth.HTTPBasicAuth('bx', 'bx')
-        )
+        try:
+            response = iam_client.request(
+                'POST',
+                'https://iam.cloud.ibm.com/identity/token',
+                data=data,
+                headers=headers,
+                auth=requests.auth.HTTPBasicAuth('bx', 'bx')
+            )
+
+            if response.status_code != 200:
+                LOGGER.warning("Unable to refresh IAM Token. %s", response.text)
 
-        if response.status_code != 200:
-            LOGGER.warning("Unable to refresh IAM Token. %s", response.text)
+            response.raise_for_status()
+            tokens = json.loads(response.text)
 
-        response.raise_for_status()
+        except requests.HTTPError as ex:
+            error = json.loads(response.text)
+            raise exceptions.IAMError(response.status_code,
+                                      error.get('errorMessage'),
+                                      'https://iam.cloud.ibm.com/identity/token')
 
-        tokens = json.loads(response.text)
         a_expire = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(tokens['expiration']))
         r_expire = time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(tokens['refresh_token_expiration']))
         LOGGER.warning("Tokens retrieved, expires at %s, Refresh expires at %s", a_expire, r_expire)
diff --git a/SoftLayer/CLI/config/setup.py b/SoftLayer/CLI/config/setup.py
@@ -88,8 +88,8 @@ def cli(env, auth):
         new_client = SoftLayer.Client(username=username, api_key=secret, endpoint_url=endpoint_url, timeout=timeout)
         api_key = get_api_key(new_client, username, secret)
 
-    # Ask for timeout
-    timeout = env.input('Timeout', default=defaults['timeout'] or 0)
+    # Ask for timeout, convert to float, then to int
+    timeout = int(float(env.input('Timeout', default=defaults['timeout'] or 0)))
 
     path = '~/.softlayer'
     if env.config_file:
diff --git a/SoftLayer/exceptions.py b/SoftLayer/exceptions.py
@@ -15,6 +15,21 @@ class SoftLayerError(Exception):
 class Unauthenticated(SoftLayerError):
     """Unauthenticated."""
 
+class IAMError(SoftLayerError):
+    """Errors from iam.cloud.ibm.com"""
+
+    def __init__(self, fault_code, fault_string, url=None):
+        SoftLayerError.__init__(self, fault_string)
+        self.faultCode = fault_code
+        self.faultString = fault_string
+        self.url = url
+
+    def __repr__(self):
+        return "{} ({}): {}".format(self.url, self.faultCode, self.faultString)
+
+    def __str__(self):
+        return "{} ({}): {}".format(self.url, self.faultCode, self.faultString)
+
 
 class SoftLayerAPIError(SoftLayerError):
     """SoftLayerAPIError is an exception raised during API errors.
diff --git a/tests/CLI/modules/config_tests.py b/tests/CLI/modules/config_tests.py
@@ -5,6 +5,7 @@
     :license: MIT, see LICENSE for more details.
 """
 import json
+import os
 import sys
 import tempfile
 
@@ -50,6 +51,12 @@ def set_up(self):
         self.env.client = SoftLayer.BaseClient(transport=transport)
         self.config_file = "./test_config_file"
 
+    def tearDown(self):
+        # Windows doesn't let you write and read from temp files
+        # So use a real file instead.
+        if os.path.exists(self.config_file):
+            os.remove(self.config_file)
+
     @mock.patch('SoftLayer.Client')
     @mock.patch('SoftLayer.CLI.formatting.confirm')
     @mock.patch('SoftLayer.CLI.environment.Environment.getpass')
@@ -74,6 +81,30 @@ def test_setup(self, mocked_input, getpass, confirm_mock, client):
             self.assertIn('api_key = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA', contents)
             self.assertIn('endpoint_url = %s' % consts.API_PUBLIC_ENDPOINT, contents)
 
+    @mock.patch('SoftLayer.Client')
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    @mock.patch('SoftLayer.CLI.environment.Environment.getpass')
+    @mock.patch('SoftLayer.CLI.environment.Environment.input')
+    def test_setup_float_timeout(self, mocked_input, getpass, confirm_mock, client):
+        client.return_value = self.env.client
+        confirm_mock.return_value = True
+        getpass.return_value = 'A' * 64
+        mocked_input.side_effect = ['public', 'user', 10.0]
+
+        result = self.run_command(['--config=%s' % self.config_file, 'config', 'setup'])
+
+        self.assert_no_fail(result)
+        self.assertIn('Configuration Updated Successfully', result.output)
+
+        with open(self.config_file, 'r') as config_file:
+            contents = config_file.read()
+            self.assertIn('[softlayer]', contents)
+            self.assertIn('username = user', contents)
+            self.assertIn('api_key = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA', contents)
+            self.assertIn('endpoint_url = %s' % consts.API_PUBLIC_ENDPOINT, contents)
+            self.assertNotIn('timeout = 10.0\n', contents)
+            self.assertIn('timeout = 10\n', contents)
+
     @mock.patch('SoftLayer.Client')
     @mock.patch('SoftLayer.CLI.formatting.confirm')
     @mock.patch('SoftLayer.CLI.environment.Environment.getpass')
@@ -118,3 +149,28 @@ def test_get_endpoint(self, mocked_input, getpass):
         # test-endpoint
         endpoint_url = config.get_endpoint_url(self.env)
         self.assertEqual(endpoint_url, 'test-endpoint')
+
+    @mock.patch('SoftLayer.CLI.environment.Environment.input')
+    @mock.patch('SoftLayer.CLI.config.setup.get_sso_url')
+    @mock.patch('SoftLayer.CLI.config.setup.get_accounts')
+    @mock.patch('SoftLayer.API.IAMClient.authenticate_with_passcode')
+    @mock.patch('SoftLayer.API.IAMClient.refresh_iam_token')
+    @mock.patch('SoftLayer.API.IAMClient.call')
+    def test_sso_login(self, api_call, token, passcode, get_accounts, get_sso_url, mocked_input):
+        """Tests to make sure directly using an endpoint works"""
+        mocked_input.side_effect = ['n', '123qweasd']
+        get_sso_url.return_value = "https://test.com/"
+        get_accounts.return_value = {"account_id": 12345, "ims_id": 5555}
+        passcode.return_value = {"access_token": "aassddffggh", "refresh_token": "qqqqqqq"}
+        token.return_value = {"access_token": "zzzzzz", "refresh_token": "fffffff"}
+        test_key = "zz112233"
+        user_object_1 = {
+            "apiAuthenticationKeys": [{"authenticationKey":test_key}],
+            "username":"testerson",
+            "id":99}
+        api_call.side_effect = [user_object_1]
+
+        user, apikey = config.sso_login(self.env)
+        self.assertEqual("testerson", user)
+        self.assertEqual(test_key, apikey)
+        
