1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00
community.general/tests/unit/plugins/modules/test_keycloak_role.py
Felix Fontein 02b185932c
Remove unittest.main() calls (#11304)
Remove unittest.main() calls.
2025-12-22 15:47:42 +01:00

700 lines
28 KiB
Python

# Copyright (c) 2021, Ansible Project
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import annotations
from contextlib import contextmanager
from unittest.mock import patch
from ansible_collections.community.internal_test_tools.tests.unit.plugins.modules.utils import (
AnsibleExitJson,
ModuleTestCase,
set_module_args,
)
from ansible_collections.community.general.plugins.modules import keycloak_role
from io import StringIO
from itertools import count
@contextmanager
def patch_keycloak_api(
get_realm_role=None,
create_realm_role=None,
update_realm_role=None,
delete_realm_role=None,
get_client_role=None,
create_client_role=None,
update_client_role=None,
delete_client_role=None,
get_client_by_id=None,
get_role_composites=None,
):
"""Mock context manager for patching the methods in PwPolicyIPAClient that contact the IPA server
Patches the `login` and `_post_json` methods
Keyword arguments are passed to the mock object that patches `_post_json`
No arguments are passed to the mock object that patches `login` because no tests require it
Example::
with patch_ipa(return_value={}) as (mock_login, mock_post):
...
"""
obj = keycloak_role.KeycloakAPI
with patch.object(obj, "get_realm_role", side_effect=get_realm_role) as mock_get_realm_role:
with patch.object(obj, "create_realm_role", side_effect=create_realm_role) as mock_create_realm_role:
with patch.object(obj, "update_realm_role", side_effect=update_realm_role) as mock_update_realm_role:
with patch.object(obj, "delete_realm_role", side_effect=delete_realm_role) as mock_delete_realm_role:
with patch.object(obj, "get_client_role", side_effect=get_client_role) as mock_get_client_role:
with patch.object(
obj, "create_client_role", side_effect=create_client_role
) as mock_create_client_role:
with patch.object(
obj, "update_client_role", side_effect=update_client_role
) as mock_update_client_role:
with patch.object(
obj, "delete_client_role", side_effect=delete_client_role
) as mock_delete_client_role:
with patch.object(
obj, "get_client_by_id", side_effect=get_client_by_id
) as mock_get_client_by_id:
with patch.object(
obj, "get_role_composites", side_effect=get_role_composites
) as mock_get_role_composites:
yield (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_id,
mock_get_role_composites,
)
def get_response(object_with_future_response, method, get_id_call_count):
if callable(object_with_future_response):
return object_with_future_response()
if isinstance(object_with_future_response, dict):
return get_response(object_with_future_response[method], method, get_id_call_count)
if isinstance(object_with_future_response, list):
call_number = next(get_id_call_count)
return get_response(object_with_future_response[call_number], method, get_id_call_count)
return object_with_future_response
def build_mocked_request(get_id_user_count, response_dict):
def _mocked_requests(*args, **kwargs):
url = args[0]
method = kwargs["method"]
future_response = response_dict.get(url, None)
return get_response(future_response, method, get_id_user_count)
return _mocked_requests
def create_wrapper(text_as_string):
"""Allow to mock many times a call to one address.
Without this function, the StringIO is empty for the second call.
"""
def _create_wrapper():
return StringIO(text_as_string)
return _create_wrapper
def mock_good_connection():
token_response = {
"http://keycloak.url/auth/realms/master/protocol/openid-connect/token": create_wrapper(
'{"access_token": "alongtoken"}'
),
}
return patch(
"ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak.open_url",
side_effect=build_mocked_request(count(), token_response),
autospec=True,
)
class TestKeycloakRealmRole(ModuleTestCase):
def setUp(self):
super().setUp()
self.module = keycloak_role
def test_create_when_absent(self):
"""Add a new realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"name": "role-name",
"description": "role-description",
}
return_value_absent = [
None,
{
"attributes": {},
"clientRole": False,
"composite": False,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
]
return_value_created = [None]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_role=return_value_absent, create_realm_role=return_value_created) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 2)
self.assertEqual(len(mock_create_realm_role.mock_calls), 1)
self.assertEqual(len(mock_update_realm_role.mock_calls), 0)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_create_when_present_with_change(self):
"""Update with change a realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"name": "role-name",
"description": "new-role-description",
}
return_value_present = [
{
"attributes": {},
"clientRole": False,
"composite": False,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
{
"attributes": {},
"clientRole": False,
"composite": False,
"containerId": "realm-name",
"description": "new-role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
]
return_value_updated = [None]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(
get_realm_role=return_value_present, update_realm_role=return_value_updated
) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 2)
self.assertEqual(len(mock_create_realm_role.mock_calls), 0)
self.assertEqual(len(mock_update_realm_role.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_create_when_present_no_change(self):
"""Update without change a realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"name": "role-name",
"description": "role-description",
}
return_value_present = [
{
"attributes": {},
"clientRole": False,
"composite": False,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
{
"attributes": {},
"clientRole": False,
"composite": False,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
]
return_value_updated = [None]
changed = False
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(
get_realm_role=return_value_present, update_realm_role=return_value_updated
) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 1)
self.assertEqual(len(mock_create_realm_role.mock_calls), 0)
self.assertEqual(len(mock_update_realm_role.mock_calls), 0)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_create_with_composites_when_present_no_change(self):
"""Update without change a realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"name": "role-name",
"description": "role-description",
"composite": True,
"composites": [{"client_id": "client_1", "name": "client-role1"}, {"name": "realm-role-1"}],
}
return_value_present = [
{
"attributes": {},
"clientRole": False,
"composite": True,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
{
"attributes": {},
"clientRole": False,
"composite": True,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
]
return_value_updated = [None]
return_get_role_composites = [
[
{"clientRole": True, "containerId": "c4367fac-f427-11ed-8e2f-aff070d20f0e", "name": "client-role1"},
{"clientRole": False, "containerId": "realm-name", "name": "realm-role-1"},
]
]
return_get_client_by_client_id = [
{
"id": "de152444-f126-4a7a-8273-4ee1544133ad",
"clientId": "client_1",
"name": "client_1",
"description": "client_1",
"surrogateAuthRequired": False,
"enabled": True,
"alwaysDisplayInConsole": False,
"clientAuthenticatorType": "client-secret",
"redirectUris": [
"http://localhost:8080/*",
],
"webOrigins": ["*"],
"notBefore": 0,
"bearerOnly": False,
"consentRequired": False,
"standardFlowEnabled": True,
"implicitFlowEnabled": False,
"directAccessGrantsEnabled": False,
"serviceAccountsEnabled": False,
"publicClient": False,
"frontchannelLogout": False,
"protocol": "openid-connect",
"attributes": {
"backchannel.logout.session.required": "true",
"backchannel.logout.revoke.offline.tokens": "false",
},
"authenticationFlowBindingOverrides": {},
"fullScopeAllowed": True,
"nodeReRegistrationTimeout": -1,
"defaultClientScopes": ["web-origins", "acr", "profile", "roles", "email"],
"optionalClientScopes": ["address", "phone", "offline_access", "microprofile-jwt"],
}
]
changed = False
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(
get_realm_role=return_value_present,
update_realm_role=return_value_updated,
get_client_by_id=return_get_client_by_client_id,
get_role_composites=return_get_role_composites,
) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 1)
self.assertEqual(len(mock_create_realm_role.mock_calls), 0)
self.assertEqual(len(mock_update_realm_role.mock_calls), 0)
self.assertEqual(len(mock_get_client_by_client_id.mock_calls), 1)
self.assertEqual(len(mock_get_role_composites.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_delete_when_absent(self):
"""Remove an absent realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"name": "role-name",
"state": "absent",
}
return_value_absent = [None]
return_value_deleted = [None]
changed = False
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_role=return_value_absent, delete_realm_role=return_value_deleted) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 1)
self.assertEqual(len(mock_delete_realm_role.mock_calls), 0)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_delete_when_present(self):
"""Remove a present realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"name": "role-name",
"state": "absent",
}
return_value_absent = [
{
"attributes": {},
"clientRole": False,
"composite": False,
"containerId": "realm-name",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
}
]
return_value_deleted = [None]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_role=return_value_absent, delete_realm_role=return_value_deleted) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 1)
self.assertEqual(len(mock_delete_realm_role.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
class TestKeycloakClientRole(ModuleTestCase):
def setUp(self):
super().setUp()
self.module = keycloak_role
def test_create_client_role_with_composites_when_absent(self):
"""Update with change a realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"client_id": "client-name",
"name": "role-name",
"description": "role-description",
"composite": True,
"composites": [{"client_id": "client_1", "name": "client-role1"}, {"name": "realm-role-1"}],
}
return_get_client_role = [
None,
{
"attributes": {},
"clientRole": True,
"composite": True,
"composites": [{"client": {"client1": ["client-role1"]}}, {"realm": ["realm-role-1"]}],
"containerId": "9ae25ec2-f40a-11ed-9261-b3bacf720f69",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
},
]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_client_role=return_get_client_role) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 0)
self.assertEqual(len(mock_create_realm_role.mock_calls), 0)
self.assertEqual(len(mock_update_realm_role.mock_calls), 0)
self.assertEqual(len(mock_get_client_role.mock_calls), 2)
self.assertEqual(len(mock_create_client_role.mock_calls), 1)
self.assertEqual(len(mock_update_client_role.mock_calls), 0)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_create_client_role_with_composites_when_present_no_change(self):
"""Update with change a realm role"""
module_args = {
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"realm": "realm-name",
"client_id": "client-name",
"name": "role-name",
"description": "role-description",
"composite": True,
"composites": [{"client_id": "client_1", "name": "client-role1"}, {"name": "realm-role-1"}],
}
return_get_client_role = [
{
"attributes": {},
"clientRole": True,
"composite": True,
"containerId": "9ae25ec2-f40a-11ed-9261-b3bacf720f69",
"description": "role-description",
"id": "90f1cdb6-be88-496e-89c6-da1fb6bc6966",
"name": "role-name",
}
]
return_get_role_composites = [
[
{"clientRole": True, "containerId": "c4367fac-f427-11ed-8e2f-aff070d20f0e", "name": "client-role1"},
{"clientRole": False, "containerId": "realm-name", "name": "realm-role-1"},
]
]
return_get_client_by_client_id = [
{
"id": "de152444-f126-4a7a-8273-4ee1544133ad",
"clientId": "client_1",
"name": "client_1",
"description": "client_1",
"surrogateAuthRequired": False,
"enabled": True,
"alwaysDisplayInConsole": False,
"clientAuthenticatorType": "client-secret",
"redirectUris": [
"http://localhost:8080/*",
],
"webOrigins": ["*"],
"notBefore": 0,
"bearerOnly": False,
"consentRequired": False,
"standardFlowEnabled": True,
"implicitFlowEnabled": False,
"directAccessGrantsEnabled": False,
"serviceAccountsEnabled": False,
"publicClient": False,
"frontchannelLogout": False,
"protocol": "openid-connect",
"attributes": {
"backchannel.logout.session.required": "true",
"backchannel.logout.revoke.offline.tokens": "false",
},
"authenticationFlowBindingOverrides": {},
"fullScopeAllowed": True,
"nodeReRegistrationTimeout": -1,
"defaultClientScopes": ["web-origins", "acr", "profile", "roles", "email"],
"optionalClientScopes": ["address", "phone", "offline_access", "microprofile-jwt"],
}
]
changed = False
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(
get_client_role=return_get_client_role,
get_client_by_id=return_get_client_by_client_id,
get_role_composites=return_get_role_composites,
) as (
mock_get_realm_role,
mock_create_realm_role,
mock_update_realm_role,
mock_delete_realm_role,
mock_get_client_role,
mock_create_client_role,
mock_update_client_role,
mock_delete_client_role,
mock_get_client_by_client_id,
mock_get_role_composites,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
self.assertEqual(len(mock_get_realm_role.mock_calls), 0)
self.assertEqual(len(mock_create_realm_role.mock_calls), 0)
self.assertEqual(len(mock_update_realm_role.mock_calls), 0)
self.assertEqual(len(mock_get_client_role.mock_calls), 1)
self.assertEqual(len(mock_create_client_role.mock_calls), 0)
self.assertEqual(len(mock_update_client_role.mock_calls), 0)
self.assertEqual(len(mock_get_client_by_client_id.mock_calls), 1)
self.assertEqual(len(mock_get_role_composites.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]["changed"], changed)