Reformat everything.

This commit is contained in:
Felix Fontein
2025-11-01 12:08:41 +01:00
parent 3f2213791a
commit 340ff8586d
1008 changed files with 61301 additions and 58309 deletions

View File

@@ -1,4 +1,3 @@
# 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
@@ -9,7 +8,11 @@ import unittest
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.internal_test_tools.tests.unit.plugins.modules.utils import (
AnsibleExitJson,
ModuleTestCase,
set_module_args,
)
from ansible_collections.community.general.plugins.modules import keycloak_realm
@@ -34,10 +37,10 @@ def patch_keycloak_api(get_realm_by_id, create_realm=None, update_realm=None, de
"""
obj = keycloak_realm.KeycloakAPI
with patch.object(obj, 'get_realm_by_id', side_effect=get_realm_by_id) as mock_get_realm_by_id:
with patch.object(obj, 'create_realm', side_effect=create_realm) as mock_create_realm:
with patch.object(obj, 'update_realm', side_effect=update_realm) as mock_update_realm:
with patch.object(obj, 'delete_realm', side_effect=delete_realm) as mock_delete_realm:
with patch.object(obj, "get_realm_by_id", side_effect=get_realm_by_id) as mock_get_realm_by_id:
with patch.object(obj, "create_realm", side_effect=create_realm) as mock_create_realm:
with patch.object(obj, "update_realm", side_effect=update_realm) as mock_update_realm:
with patch.object(obj, "delete_realm", side_effect=delete_realm) as mock_delete_realm:
yield mock_get_realm_by_id, mock_create_realm, mock_update_realm, mock_delete_realm
@@ -45,21 +48,20 @@ 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)
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 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']
method = kwargs["method"]
future_response = response_dict.get(url, None)
return get_response(future_response, method, get_id_user_count)
return _mocked_requests
@@ -67,18 +69,23 @@ 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"}'), }
"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',
"ansible_collections.community.general.plugins.module_utils.identity.keycloak.keycloak.open_url",
side_effect=build_mocked_request(count(), token_response),
autospec=True
autospec=True,
)
@@ -91,31 +98,30 @@ class TestKeycloakRealm(ModuleTestCase):
"""Add a new realm"""
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,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"id": "realm-name",
"realm": "realm-name",
"enabled": True,
}
return_value_absent = [None, {'id': 'realm-name', 'realm': 'realm-name', 'enabled': True}]
return_value_created = [{
'code': 201,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
}]
return_value_absent = [None, {"id": "realm-name", "realm": "realm-name", "enabled": True}]
return_value_created = [{"code": 201, "id": "realm-name", "realm": "realm-name", "enabled": True}]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_by_id=return_value_absent, create_realm=return_value_created) \
as (mock_get_realm_by_id, mock_create_realm, mock_update_realm, mock_delete_realm):
with patch_keycloak_api(get_realm_by_id=return_value_absent, create_realm=return_value_created) as (
mock_get_realm_by_id,
mock_create_realm,
mock_update_realm,
mock_delete_realm,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@@ -124,48 +130,39 @@ class TestKeycloakRealm(ModuleTestCase):
self.assertEqual(len(mock_update_realm.mock_calls), 0)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]['changed'], changed)
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_create_when_present_with_change(self):
"""Update with change a realm"""
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,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': False
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"id": "realm-name",
"realm": "realm-name",
"enabled": False,
}
return_value_absent = [
{
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
},
{
'id': 'realm-name',
'realm': 'realm-name',
'enabled': False
}
{"id": "realm-name", "realm": "realm-name", "enabled": True},
{"id": "realm-name", "realm": "realm-name", "enabled": False},
]
return_value_updated = [{
'code': 201,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': False
}]
return_value_updated = [{"code": 201, "id": "realm-name", "realm": "realm-name", "enabled": False}]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_by_id=return_value_absent, update_realm=return_value_updated) \
as (mock_get_realm_by_id, mock_create_realm, mock_update_realm, mock_delete_realm):
with patch_keycloak_api(get_realm_by_id=return_value_absent, update_realm=return_value_updated) as (
mock_get_realm_by_id,
mock_create_realm,
mock_update_realm,
mock_delete_realm,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@@ -174,48 +171,39 @@ class TestKeycloakRealm(ModuleTestCase):
self.assertEqual(len(mock_update_realm.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]['changed'], changed)
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_create_when_present_no_change(self):
"""Update without change a realm"""
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,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"id": "realm-name",
"realm": "realm-name",
"enabled": True,
}
return_value_absent = [
{
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
},
{
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
}
{"id": "realm-name", "realm": "realm-name", "enabled": True},
{"id": "realm-name", "realm": "realm-name", "enabled": True},
]
return_value_updated = [{
'code': 201,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True
}]
return_value_updated = [{"code": 201, "id": "realm-name", "realm": "realm-name", "enabled": True}]
changed = False
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_by_id=return_value_absent, update_realm=return_value_updated) \
as (mock_get_realm_by_id, mock_create_realm, mock_update_realm, mock_delete_realm):
with patch_keycloak_api(get_realm_by_id=return_value_absent, update_realm=return_value_updated) as (
mock_get_realm_by_id,
mock_create_realm,
mock_update_realm,
mock_delete_realm,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@@ -224,22 +212,22 @@ class TestKeycloakRealm(ModuleTestCase):
self.assertEqual(len(mock_update_realm.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]['changed'], changed)
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_delete_when_absent(self):
"""Remove an absent realm"""
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,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True,
'state': 'absent'
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"id": "realm-name",
"realm": "realm-name",
"enabled": True,
"state": "absent",
}
return_value_absent = [None]
return_value_deleted = [None]
@@ -249,8 +237,12 @@ class TestKeycloakRealm(ModuleTestCase):
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_by_id=return_value_absent, delete_realm=return_value_deleted) \
as (mock_get_realm_by_id, mock_create_realm, mock_update_realm, mock_delete_realm):
with patch_keycloak_api(get_realm_by_id=return_value_absent, delete_realm=return_value_deleted) as (
mock_get_realm_by_id,
mock_create_realm,
mock_update_realm,
mock_delete_realm,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@@ -258,28 +250,24 @@ class TestKeycloakRealm(ModuleTestCase):
self.assertEqual(len(mock_delete_realm.mock_calls), 0)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]['changed'], changed)
self.assertIs(exec_info.exception.args[0]["changed"], changed)
def test_delete_when_present(self):
"""Remove a present realm"""
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,
'id': 'realm-name',
'realm': 'realm-name',
'enabled': True,
'state': 'absent'
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_password": "admin",
"auth_realm": "master",
"auth_username": "admin",
"auth_client_id": "admin-cli",
"validate_certs": True,
"id": "realm-name",
"realm": "realm-name",
"enabled": True,
"state": "absent",
}
return_value_absent = [
{
'id': 'realm-name',
'realm': 'realm-name'
}]
return_value_absent = [{"id": "realm-name", "realm": "realm-name"}]
return_value_deleted = [None]
changed = True
@@ -287,8 +275,12 @@ class TestKeycloakRealm(ModuleTestCase):
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_realm_by_id=return_value_absent, delete_realm=return_value_deleted) \
as (mock_get_realm_by_id, mock_create_realm, mock_update_realm, mock_delete_realm):
with patch_keycloak_api(get_realm_by_id=return_value_absent, delete_realm=return_value_deleted) as (
mock_get_realm_by_id,
mock_create_realm,
mock_update_realm,
mock_delete_realm,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@@ -296,8 +288,8 @@ class TestKeycloakRealm(ModuleTestCase):
self.assertEqual(len(mock_delete_realm.mock_calls), 1)
# Verify that the module's changed status matches what is expected
self.assertIs(exec_info.exception.args[0]['changed'], changed)
self.assertIs(exec_info.exception.args[0]["changed"], changed)
if __name__ == '__main__':
if __name__ == "__main__":
unittest.main()