def _invalidate_encrypted_token(self, encrypted_token):
'''This method invalidates a given encrypted token using tokens service implementation.'''
db_conn = None
conn_manager = None
request_id = None
try:
conn_manager, request_id, db_conn = self._get_db_conn()
tokens_service = TokensService(db_conn)
token = tokens_service.decrypt(encrypted_token)
tokens_service.invalidate(token)
finally:
if db_conn != None:
conn_manager.close_connection(request_id)
def _invalidate_encrypted_token(self, encrypted_token):
'''This method invalidates a given encrypted token using tokens service implementation.'''
db_conn = None
conn_manager = None
request_id = None
try:
conn_manager, request_id, db_conn = self._get_db_conn()
tokens_service = TokensService(db_conn)
token = tokens_service.decrypt(encrypted_token)
tokens_service.invalidate(token)
finally:
if db_conn != None:
conn_manager.close_connection(request_id)
class TokensServiceTests(FantasticoUnitTestsCase):
'''This class provides the tests suite for tokens service implementation.'''
_tokens_service = None
_tokens_generator = None
_tokens_factory = None
_client_repo = None
_encryptor = None
_db_conn = None
def init(self):
'''This method is invoked automatically in order to setup common dependencies for all test cases.'''
self._db_conn = Mock()
self._tokens_generator = Mock()
self._tokens_factory = Mock()
self._tokens_factory.get_generator = Mock(
return_value=self._tokens_generator)
factory_cls = Mock(return_value=self._tokens_factory)
self._client_repo = Mock()
client_repo_cls = Mock(return_value=self._client_repo)
self._encryptor = Mock()
encryptor_cls = Mock(return_value=self._encryptor)
self._tokens_service = TokensService(self._db_conn,
factory_cls,
client_repo_cls,
encryptor_cls=encryptor_cls)
factory_cls.assert_called_once_with()
client_repo_cls.assert_called_once_with(self._db_conn)
def test_generate_ok(self):
'''This test case ensures tokens service can generate a token starting from a given dictionary.'''
token_type = "mock-type"
token_desc = {"client_id": "abc", "test_attr": 1}
expected_token = Token(token_desc)
self._tokens_generator.generate = Mock(return_value=expected_token)
token = self._tokens_service.generate(token_desc, token_type)
self.assertEqual(expected_token, token)
self._tokens_factory.get_generator.assert_called_once_with(
token_type, self._db_conn)
self._tokens_generator.generate.assert_called_once_with(token_desc)
def test_generate_factory_oauth2ex(self):
'''This test case ensures all oauth2 exceptions raised from factory class are bubbled up.'''
ex = OAuth2Error(error_code=-1)
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.generate({}, "unknown")
self.assertEqual(ex, ctx.exception)
def test_generate_factory_ex(self):
'''This test case ensures all unexpected exceptions are casted to oauth2 exceptions.'''
ex = Exception("Unexpected exception.")
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.generate({}, "unknown")
def test_generate_generator_oauth2ex(self):
'''This test case ensures generator oauth2 exceptions are bubbled up.'''
token_type = "mock-type"
token_desc = {"client_id": "abc", "test_attr": 1}
ex = OAuth2Error(error_code=-1)
self._tokens_generator.generate = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.generate(token_desc, token_type)
self.assertEqual(ex, ctx.exception)
def test_generate_generator_ex(self):
'''This test case ensures generator unexpected exceptions are casted to oauth2 exceptions.'''
token_type = "mock-type"
token_desc = {"client_id": "abc", "test_attr": 1}
ex = Exception("Unexpected exception.")
self._tokens_generator.generate = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.generate(token_desc, token_type)
def test_validate_ok(self):
'''This test case ensures token validation works correctly for a given token.'''
token_desc = {
"client_id": "abc",
"type": "mock-type",
"attr": "test-attr"
}
token = Token(token_desc)
self._tokens_generator.validate = Mock(return_value=True)
self.assertTrue(self._tokens_service.validate(token))
self._tokens_factory.get_generator.assert_called_once_with(
token.type, self._db_conn)
self._tokens_generator.validate.assert_called_once_with(token)
def test_validate_factory_oauth2ex(self):
'''This test case ensures factory oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code=-1)
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.validate(token)
self.assertEqual(ex, ctx.exception)
def test_validate_factory_ex(self):
'''This test case ensures factory unexpected errors are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.validate(token)
def test_validate_generator_oauth2ex(self):
'''This test case ensures generator oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code=-1)
self._tokens_generator.validate = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.validate(token)
self.assertEqual(ex, ctx.exception)
def test_validate_generator_ex(self):
'''This test case ensures generator unexpected exceptions are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_generator.validate = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.validate(token)
def test_invalidate_ok(self):
'''This test case ensures tokens can be invalidated successfully.'''
token = Token({"type": "mock-type"})
self._tokens_generator.invalidate = Mock()
self.assertIsNone(self._tokens_service.invalidate(token))
self._tokens_factory.get_generator.assert_called_once_with(
token.type, self._db_conn)
self._tokens_generator.invalidate.assert_called_once_with(token)
def test_invalidate_factory_oauth2ex(self):
'''This test case ensures factory oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code=-1)
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.invalidate(token)
self.assertEqual(ex, ctx.exception)
def test_invalidate_factory_ex(self):
'''This test case ensures factory unexpected exceptions are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.invalidate(token)
def test_invalidate_generator_oauth2ex(self):
'''This test case ensures generator oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code=-1)
self._tokens_generator.invalidate = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.invalidate(token)
self.assertEqual(ex, ctx.exception)
def test_invalidate_generator_ex(self):
'''This test case ensures generator unexpected exceptions are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_generator.invalidate = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.invalidate(token)
def test_encrypt_ok(self):
'''This test case ensures a token can be correctly encrypted.'''
client_id = "mock client"
token_iv = "token iv".encode()
token_key = "token_key".encode()
token = Token({})
encrypted_str = "abcd"
client = Client(token_iv=base64.b64encode(token_iv).decode(),
token_key=base64.b64encode(token_key).decode())
self._client_repo.load = Mock(return_value=client)
self._encryptor.encrypt_token = Mock(return_value=encrypted_str)
result = self._tokens_service.encrypt(token, client_id)
self.assertEqual(encrypted_str, result)
self._client_repo.load.assert_called_once_with(client_id)
self._encryptor.encrypt_token.assert_called_once_with(
token, token_iv, token_key)
def test_encrypt_invalidclient(self):
'''This test case ensures all exceptions occuring during client load are converted to oauth2 invalid client exceptions.'''
self._client_repo.load = Mock(
side_effect=Exception("Unexpected exception."))
with self.assertRaises(OAuth2InvalidClientError):
self._tokens_service.encrypt(Token({}), "mock-client")
def test_encrypt_ex(self):
'''This test case ensures all encryption exceptions are bubbled up.'''
client_id = "mock client"
token_iv = "token iv".encode()
token_key = "token_key".encode()
token = Token({})
client = Client(token_iv=base64.b64encode(token_iv).decode(),
token_key=base64.b64encode(token_key).decode())
ex = Exception("Unexpected exception.")
self._client_repo.load = Mock(return_value=client)
self._encryptor.encrypt_token = Mock(side_effect=ex)
with self.assertRaises(Exception) as ctx:
self._tokens_service.encrypt(token, client_id)
self.assertEqual(ex, ctx.exception)
def test_decrypt_ok(self):
'''This test case ensures an encrypted string can be correctly decrypted.'''
encrypted_str = "abcd"
decrypted_str = "decryption succeeded."
self._encryptor.decrypt_token = Mock(return_value=decrypted_str)
result = self._tokens_service.decrypt(encrypted_str)
self.assertEqual(decrypted_str, result)
self._encryptor.decrypt_token.assert_called_once_with(
encrypted_str, client_repo=self._client_repo)
def test_decrypt_ex(self):
'''This test case ensures all decrypt exceptions are bubbled up.'''
ex = Exception("Unexpected exception.")
self._encryptor.decrypt_token = Mock(side_effect=ex)
with self.assertRaises(Exception) as ctx:
self._tokens_service.decrypt("encrypted text.")
self.assertEqual(ex, ctx.exception)
class TokensServiceTests(FantasticoUnitTestsCase):
'''This class provides the tests suite for tokens service implementation.'''
_tokens_service = None
_tokens_generator = None
_tokens_factory = None
_client_repo = None
_encryptor = None
_db_conn = None
def init(self):
'''This method is invoked automatically in order to setup common dependencies for all test cases.'''
self._db_conn = Mock()
self._tokens_generator = Mock()
self._tokens_factory = Mock()
self._tokens_factory.get_generator = Mock(return_value=self._tokens_generator)
factory_cls = Mock(return_value=self._tokens_factory)
self._client_repo = Mock()
client_repo_cls = Mock(return_value=self._client_repo)
self._encryptor = Mock()
encryptor_cls = Mock(return_value=self._encryptor)
self._tokens_service = TokensService(self._db_conn, factory_cls, client_repo_cls, encryptor_cls=encryptor_cls)
factory_cls.assert_called_once_with()
client_repo_cls.assert_called_once_with(self._db_conn)
def test_generate_ok(self):
'''This test case ensures tokens service can generate a token starting from a given dictionary.'''
token_type = "mock-type"
token_desc = {"client_id": "abc",
"test_attr": 1}
expected_token = Token(token_desc)
self._tokens_generator.generate = Mock(return_value=expected_token)
token = self._tokens_service.generate(token_desc, token_type)
self.assertEqual(expected_token, token)
self._tokens_factory.get_generator.assert_called_once_with(token_type, self._db_conn)
self._tokens_generator.generate.assert_called_once_with(token_desc)
def test_generate_factory_oauth2ex(self):
'''This test case ensures all oauth2 exceptions raised from factory class are bubbled up.'''
ex = OAuth2Error(error_code= -1)
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.generate({}, "unknown")
self.assertEqual(ex, ctx.exception)
def test_generate_factory_ex(self):
'''This test case ensures all unexpected exceptions are casted to oauth2 exceptions.'''
ex = Exception("Unexpected exception.")
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.generate({}, "unknown")
def test_generate_generator_oauth2ex(self):
'''This test case ensures generator oauth2 exceptions are bubbled up.'''
token_type = "mock-type"
token_desc = {"client_id": "abc",
"test_attr": 1}
ex = OAuth2Error(error_code= -1)
self._tokens_generator.generate = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.generate(token_desc, token_type)
self.assertEqual(ex, ctx.exception)
def test_generate_generator_ex(self):
'''This test case ensures generator unexpected exceptions are casted to oauth2 exceptions.'''
token_type = "mock-type"
token_desc = {"client_id": "abc",
"test_attr": 1}
ex = Exception("Unexpected exception.")
self._tokens_generator.generate = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.generate(token_desc, token_type)
def test_validate_ok(self):
'''This test case ensures token validation works correctly for a given token.'''
token_desc = {"client_id": "abc",
"type": "mock-type",
"attr": "test-attr"}
token = Token(token_desc)
self._tokens_generator.validate = Mock(return_value=True)
self.assertTrue(self._tokens_service.validate(token))
self._tokens_factory.get_generator.assert_called_once_with(token.type, self._db_conn)
self._tokens_generator.validate.assert_called_once_with(token)
def test_validate_factory_oauth2ex(self):
'''This test case ensures factory oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code= -1)
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.validate(token)
self.assertEqual(ex, ctx.exception)
def test_validate_factory_ex(self):
'''This test case ensures factory unexpected errors are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.validate(token)
def test_validate_generator_oauth2ex(self):
'''This test case ensures generator oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code= -1)
self._tokens_generator.validate = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.validate(token)
self.assertEqual(ex, ctx.exception)
def test_validate_generator_ex(self):
'''This test case ensures generator unexpected exceptions are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_generator.validate = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.validate(token)
def test_invalidate_ok(self):
'''This test case ensures tokens can be invalidated successfully.'''
token = Token({"type": "mock-type"})
self._tokens_generator.invalidate = Mock()
self.assertIsNone(self._tokens_service.invalidate(token))
self._tokens_factory.get_generator.assert_called_once_with(token.type, self._db_conn)
self._tokens_generator.invalidate.assert_called_once_with(token)
def test_invalidate_factory_oauth2ex(self):
'''This test case ensures factory oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code= -1)
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.invalidate(token)
self.assertEqual(ex, ctx.exception)
def test_invalidate_factory_ex(self):
'''This test case ensures factory unexpected exceptions are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_factory.get_generator = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.invalidate(token)
def test_invalidate_generator_oauth2ex(self):
'''This test case ensures generator oauth2 exceptions are bubbled up.'''
token = Token({"type": "mock-type"})
ex = OAuth2Error(error_code= -1)
self._tokens_generator.invalidate = Mock(side_effect=ex)
with self.assertRaises(OAuth2Error) as ctx:
self._tokens_service.invalidate(token)
self.assertEqual(ex, ctx.exception)
def test_invalidate_generator_ex(self):
'''This test case ensures generator unexpected exceptions are converted to oauth2 concrete exceptions.'''
token = Token({"type": "mock-type"})
ex = Exception("Unexpected exception.")
self._tokens_generator.invalidate = Mock(side_effect=ex)
with self.assertRaises(OAuth2InvalidTokenTypeError):
self._tokens_service.invalidate(token)
def test_encrypt_ok(self):
'''This test case ensures a token can be correctly encrypted.'''
client_id = "mock client"
token_iv = "token iv".encode()
token_key = "token_key".encode()
token = Token({})
encrypted_str = "abcd"
client = Client(token_iv=base64.b64encode(token_iv).decode(),
token_key=base64.b64encode(token_key).decode())
self._client_repo.load = Mock(return_value=client)
self._encryptor.encrypt_token = Mock(return_value=encrypted_str)
result = self._tokens_service.encrypt(token, client_id)
self.assertEqual(encrypted_str, result)
self._client_repo.load.assert_called_once_with(client_id)
self._encryptor.encrypt_token.assert_called_once_with(token, token_iv, token_key)
def test_encrypt_invalidclient(self):
'''This test case ensures all exceptions occuring during client load are converted to oauth2 invalid client exceptions.'''
self._client_repo.load = Mock(side_effect=Exception("Unexpected exception."))
with self.assertRaises(OAuth2InvalidClientError):
self._tokens_service.encrypt(Token({}), "mock-client")
def test_encrypt_ex(self):
'''This test case ensures all encryption exceptions are bubbled up.'''
client_id = "mock client"
token_iv = "token iv".encode()
token_key = "token_key".encode()
token = Token({})
client = Client(token_iv=base64.b64encode(token_iv).decode(),
token_key=base64.b64encode(token_key).decode())
ex = Exception("Unexpected exception.")
self._client_repo.load = Mock(return_value=client)
self._encryptor.encrypt_token = Mock(side_effect=ex)
with self.assertRaises(Exception) as ctx:
self._tokens_service.encrypt(token, client_id)
self.assertEqual(ex, ctx.exception)
def test_decrypt_ok(self):
'''This test case ensures an encrypted string can be correctly decrypted.'''
encrypted_str = "abcd"
decrypted_str = "decryption succeeded."
self._encryptor.decrypt_token = Mock(return_value=decrypted_str)
result = self._tokens_service.decrypt(encrypted_str)
self.assertEqual(decrypted_str, result)
self._encryptor.decrypt_token.assert_called_once_with(encrypted_str, client_repo=self._client_repo)
def test_decrypt_ex(self):
'''This test case ensures all decrypt exceptions are bubbled up.'''
ex = Exception("Unexpected exception.")
self._encryptor.decrypt_token = Mock(side_effect=ex)
with self.assertRaises(Exception) as ctx:
self._tokens_service.decrypt("encrypted text.")
self.assertEqual(ex, ctx.exception)