added account flag to islcli

Author: allmightyspiff

SoftLayer/API.py

@@ -646,6 +646,11 @@ class EmployeeClient(BaseClient):
     :param transport: An object that's callable with this signature: transport(SoftLayer.transports.Request)
     """
 
+    def __init__(self, auth=None, transport=None, config_file=None, account_id=None):
+        BaseClient.__init__(self, auth, transport, config_file)
+        self.account_id = account_id
+
+
     def authenticate_with_password(self, username, password, security_token=None):
         """Performs IBM IAM Username/Password Authentication
 
@@ -687,34 +692,40 @@ def refresh_token(self, userId, auth_token):
         """Refreshes the login token"""
 
         self.auth = None
-        auth_result = self.call('SoftLayer_User_Employee', 'refreshEncryptedToken', auth_token, id=userId)
+
+        # Go directly to base client, to avoid infite loop if the token is super expired.
+        auth_result = BaseClient.call(self, 'SoftLayer_User_Employee', 'refreshEncryptedToken', auth_token, id=userId)
         if len(auth_result) > 1:
             for returned_data in auth_result:
                 # Access tokens should be 188 characters, but just incase its longer or something.
                 if len(returned_data) > 180:
                     self.settings['softlayer']['access_token'] = returned_data
         else:
-            message = "Excepted 2 properties from refreshEncryptedToken, got |{}|".format(auth_result)
+            message = "Excepted 2 properties from refreshEncryptedToken, got {}|".format(auth_result)
             raise exceptions.SoftLayerAPIError(message)
 
         config.write_config(self.settings, self.config_file)
         self.auth = slauth.EmployeeAuthentication(userId, auth_result[0])
         return auth_result
 
     def call(self, service, method, *args, **kwargs):
-        """Handles refreshing IAM tokens in case of a HTTP 401 error"""
+        """Handles refreshing Employee tokens in case of a HTTP 401 error"""
+        if (service == 'SoftLayer_Account' or service == 'Account') and not kwargs.get('id'):
+            if not self.account_id:
+                raise exceptions.SoftLayerError("SoftLayer_Account service requires an ID")
+            kwargs['id'] = self.account_id
+
         try:
-            return super().call(service, method, *args, **kwargs)
+            return BaseClient.call(self, service, method, *args, **kwargs)
         except exceptions.SoftLayerAPIError as ex:
-
-            if ex.faultCode == 401:
-                LOGGER.warning("Token has expired, trying to refresh. %s", ex.faultString)
-                return ex
             if ex.faultCode == "SoftLayer_Exception_EncryptedToken_Expired":
                 userId = self.settings['softlayer'].get('userId')
                 access_token = self.settings['softlayer'].get('access_token')
-                LOGGER.warning("Token has expired2, trying to refresh. %s", ex.faultString)
-                self.refresh_token()
+                LOGGER.warning("Token has expired, trying to refresh. %s", ex.faultString)
+                self.refresh_token(userId, access_token)
+                # Try the Call again this time....
+                return BaseClient.call(self, service, method, *args, **kwargs)
+
             else:
                 raise ex
 

SoftLayer/CLI/core.py

@@ -70,9 +70,8 @@ def get_version_message(ctx, param, value):
     ctx.exit()
 
 
-@click.group(help="SoftLayer Command-line Client",
-             epilog="""To use most commands your SoftLayer username and api_key need to be configured.
-The easiest way to do that is to use: 'slcli setup'""",
+@click.group(help="SoftLayer Employee Command-line Client",
+             epilog="""Run 'islcli login' to authenticate""",
              cls=CommandLoader,
              context_settings=CONTEXT_SETTINGS)
 @click.option('--format',
@@ -103,6 +102,7 @@ def get_version_message(ctx, param, value):
               help="Use demo data instead of actually making API calls")
 @click.option('--version', is_flag=True, expose_value=False, is_eager=True, callback=get_version_message,
               help="Show version information.",  allow_from_autoenv=False,)
+@click.option('-a', '--account', help="Account Id")
 @environment.pass_env
 def cli(env,
         format='table',
@@ -111,6 +111,7 @@ def cli(env,
         proxy=None,
         really=False,
         demo=False,
+        account_id=None,
         **kwargs):
     """Main click CLI entry-point."""
 
@@ -133,6 +134,7 @@ def cli(env,
     env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
     env.vars['verbose'] = verbose
     env.client.transport = env.vars['_timings']
+    env.client.account_id = account_id
 
 
 @cli.result_callback()

SoftLayer/fixtures/xmlrpc/Employee_getObject.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<params>
+    <param>
+        <value>
+            <struct>
+                <member>
+                    <name>id</name>
+                    <value>
+                        <int>5555</int>
+                    </value>
+                </member>
+                <member>
+                    <name>username</name>
+                    <value>
+                        <string>testUser</string>
+                    </value>
+                </member>
+            </struct>
+        </value>
+    </param>
+</params>

SoftLayer/fixtures/xmlrpc/expiredToken.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<methodResponse>
+    <fault>
+        <value>
+            <struct>
+                <member>
+                    <name>faultCode</name>
+                    <value>
+                        <string>SoftLayer_Exception_EncryptedToken_Expired</string>
+                    </value>
+                </member>
+                <member>
+                    <name>faultString</name>
+                    <value>
+                        <string>The token has expired.</string>
+                    </value>
+                </member>
+            </struct>
+        </value>
+    </fault>
+</methodResponse>

tests/api_tests.py

@@ -14,6 +14,7 @@
 from SoftLayer import testing
 from SoftLayer import transports
 from SoftLayer import exceptions
+from SoftLayer import auth as slauth
 
 
 class Initialization(testing.TestCase):
@@ -323,7 +324,6 @@ class EmployeeClientTests(testing.TestCase):
     def setup_response(filename, status_code=200, total_items=1):
         basepath = os.path.dirname(__file__)
         body = b''
-        print(f"Base Path: {basepath}")
         with open(f"{basepath}/../SoftLayer/fixtures/xmlrpc/{filename}.xml", 'rb') as fixture:
             body = fixture.read()
         response = requests.Response()
@@ -366,4 +366,46 @@ def test_refresh_token(self, api_response):
         result = self.client.refresh_token(9999, 'qweasdzxcqweasdzxcqweasdzxc')
         self.assertEqual(self.client.auth.user_id, 9999)
         self.assertIn('REFRESHEDTOKENaaaa', self.client.auth.hash)
-        
+    
+    @mock.patch('SoftLayer.transports.xmlrpc.requests.Session.request')
+    def test_expired_token_is_refreshed(self, api_response):
+        api_response.side_effect = [
+            self.setup_response('expiredToken'),
+            self.setup_response('refreshSuccess'),
+            self.setup_response('Employee_getObject')
+        ]
+        self.client.auth = slauth.EmployeeAuthentication(5555, 'aabbccee')
+        self.client.settings['softlayer']['userid'] = '5555'
+        result = self.client.call('SoftLayer_User_Employee', 'getObject', id=5555)
+        self.assertIn('REFRESHEDTOKENaaaa', self.client.auth.hash)
+        self.assertEqual('testUser', result['username'])
+        
+    @mock.patch('SoftLayer.transports.xmlrpc.requests.Session.request')
+    def test_expired_token_is_really_expored(self, api_response):
+        api_response.side_effect = [
+            self.setup_response('expiredToken'),
+            self.setup_response('expiredToken')
+        ]
+        self.client.auth = slauth.EmployeeAuthentication(5555, 'aabbccee')
+        self.client.settings['softlayer']['userid'] = '5555'
+        exception = self.assertRaises(
+            exceptions.SoftLayerAPIError,
+            self.client.call, 'SoftLayer_User_Employee', 'getObject', id=5555)
+        self.assertEqual(None, self.client.auth)
+        self.assertEqual(exception.faultCode, "SoftLayer_Exception_EncryptedToken_Expired")
+
+    @mock.patch('SoftLayer.API.BaseClient.call')
+    def test_account_check(self, _call):
+        self.client.transport = self.mocks
+        exception = self.assertRaises(
+            exceptions.SoftLayerError,
+            self.client.call, "SoftLayer_Account", "getObject")
+        self.assertEqual(str(exception), "SoftLayer_Account service requires an ID")
+        self.client.account_id = 1234
+        self.client.call("SoftLayer_Account", "getObject")
+        self.client.call("SoftLayer_Account", "getObject1", id=9999)
+
+        _call.assert_has_calls([
+            mock.call(self.client, 'SoftLayer_Account', 'getObject', id=1234),
+            mock.call(self.client, 'SoftLayer_Account', 'getObject1', id=9999),
+        ])