Adjusting token cache format #19
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| import logging | ||
| import base64 | ||
| import json | ||
|
|
||
| from msal.token_cache import * | ||
| from tests import unittest | ||
|
|
||
|
|
||
| logger = logging.getLogger(__name__) | ||
| logging.basicConfig(level=logging.DEBUG) | ||
|
|
||
|
|
||
| class TokenCacheTestCase(unittest.TestCase): | ||
|
|
||
| def setUp(self): | ||
| self.cache = TokenCache() | ||
|
|
||
| def testAdd(self): | ||
| client_info = base64.b64encode(b''' | ||
| {"uid": "uid", "utid": "utid"} | ||
| ''').decode('utf-8') | ||
| id_token = "header.%s.signature" % base64.b64encode(b'''{ | ||
| "sub": "subject", | ||
| "oid": "object1234", | ||
| "preferred_username": "John Doe" | ||
| }''').decode('utf-8') | ||
| self.cache.add({ | ||
| "client_id": "my_client_id", | ||
| "scope": ["s2", "s1", "s3"], # Not in particular order | ||
| "token_endpoint": "https://login.example.com/contoso/v2/token", | ||
| "response": { | ||
| "access_token": "an access token", | ||
| "token_type": "some type", | ||
| "expires_in": 3600, | ||
| "refresh_token": "a refresh token", | ||
| "client_info": client_info, | ||
| "id_token": id_token, | ||
| }, | ||
| }, now=1000) | ||
| self.assertEqual( | ||
| { | ||
| 'cached_at': "1000", | ||
| 'client_id': 'my_client_id', | ||
| 'credential_type': 'AccessToken', | ||
| 'environment': 'login.example.com', | ||
| 'expires_on': "4600", | ||
| 'extended_expires_on': "4600", | ||
| 'home_account_id': "uid.utid", | ||
| 'realm': 'contoso', | ||
| 'secret': 'an access token', | ||
| 'target': 's2 s1 s3', | ||
| }, | ||
| self.cache._cache["AccessToken"].get( | ||
| 'uid.utid-login.example.com-accesstoken-my_client_id-contoso-s2 s1 s3') | ||
| ) | ||
| self.assertEqual( | ||
| { | ||
| 'client_id': 'my_client_id', | ||
| 'credential_type': 'RefreshToken', | ||
| 'environment': 'login.example.com', | ||
| 'home_account_id': "uid.utid", | ||
| 'secret': 'a refresh token', | ||
| 'target': 's2 s1 s3', | ||
| }, | ||
| self.cache._cache["RefreshToken"].get( | ||
| 'uid.utid-login.example.com-refreshtoken-my_client_id--s2 s1 s3') | ||
| ) | ||
| self.assertEqual( | ||
| { | ||
| 'home_account_id': "uid.utid", | ||
| 'environment': 'login.example.com', | ||
| 'realm': 'contoso', | ||
| 'local_account_id': "object1234", | ||
| 'username': "John Doe", | ||
| 'authority_type': "MSSTS", | ||
| }, | ||
| self.cache._cache["Account"].get('uid.utid-login.example.com-contoso') | ||
| ) | ||
| self.assertEqual( | ||
| { | ||
| 'credential_type': 'IdToken', | ||
| 'secret': id_token, | ||
| 'home_account_id': "uid.utid", | ||
| 'environment': 'login.example.com', | ||
| 'realm': 'contoso', | ||
| 'client_id': 'my_client_id', | ||
| }, | ||
| self.cache._cache["IdToken"].get( | ||
| 'uid.utid-login.example.com-idtoken-my_client_id-contoso-') | ||
| ) | ||
|
|
||
|
|
||
| class SerializableTokenCacheTestCase(TokenCacheTestCase): | ||
| # Run all inherited test methods, and have extra check in tearDown() | ||
|
|
||
| def setUp(self): | ||
| self.cache = SerializableTokenCache() | ||
| self.cache.deserialize(""" | ||
| { | ||
| "AccessToken": { | ||
| "an-entry": { | ||
| "foo": "bar" | ||
| } | ||
| }, | ||
| "customized": "whatever" | ||
| } | ||
| """) | ||
|
|
||
| def tearDown(self): | ||
| state = self.cache.serialize() | ||
| logger.debug("serialize() = %s", state) | ||
| # Now assert all extended content are kept intact | ||
| output = json.loads(state) | ||
| self.assertEqual(output.get("customized"), "whatever", | ||
| "Undefined cache keys and their values should be intact") | ||
| self.assertEqual( | ||
| output.get("AccessToken", {}).get("an-entry"), {"foo": "bar"}, | ||
| "Undefined token keys and their values should be intact") | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it seems like expires_in is already an int? Did -now change it to something else? Should that then have been converted to an int?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question! It is true that the
expires_inin the original server-side response is an integer. But here in this code path we hit a token in the cache, and then re-calculate a newexpires_inbased on its original value and the current time(), which happens to be a float in Python. So we do a Forceful Unobvious Conversion to Keep the Integer Time, at the exact place where it is needed.