1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-18 01:41:35 +00:00

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
@ -12,25 +11,24 @@ from itertools import count
from unittest.mock import patch
from ansible_collections.community.general.plugins.modules import keycloak_realm_key
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_component
@contextmanager
def patch_keycloak_api(get_components=None, create_component=None, update_component=None, delete_component=None):
"""Mock context manager for patching the methods in KeycloakAPI
"""
"""Mock context manager for patching the methods in KeycloakAPI"""
obj = keycloak_realm_key.KeycloakAPI
with patch.object(obj, 'get_components', side_effect=get_components) \
as mock_get_components:
with patch.object(obj, 'create_component', side_effect=create_component) \
as mock_create_component:
with patch.object(obj, 'update_component', side_effect=update_component) \
as mock_update_component:
with patch.object(obj, 'delete_component', side_effect=delete_component) \
as mock_delete_component:
with patch.object(obj, "get_components", side_effect=get_components) as mock_get_components:
with patch.object(obj, "create_component", side_effect=create_component) as mock_create_component:
with patch.object(obj, "update_component", side_effect=update_component) as mock_update_component:
with patch.object(obj, "delete_component", side_effect=delete_component) as mock_delete_component:
yield mock_get_components, mock_create_component, mock_update_component, mock_delete_component
@ -38,19 +36,17 @@ 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)
@ -70,11 +66,14 @@ def create_wrapper(text_as_string):
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,
)
@ -87,18 +86,18 @@ class TestKeycloakComponent(ModuleTestCase):
"""Add a new realm key"""
module_args = {
'auth_keycloak_url': 'http://keycloak.url/auth',
'auth_realm': 'master',
'auth_username': 'admin',
'auth_password': 'admin',
'parent_id': 'realm-name',
'name': 'test-user-provider',
'state': 'present',
'provider_id': 'my-provider',
'provider_type': 'org.keycloak.storage.UserStorageProvider',
'config': {
'enabled': True,
'my_custom_config': 'foo',
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_realm": "master",
"auth_username": "admin",
"auth_password": "admin",
"parent_id": "realm-name",
"name": "test-user-provider",
"state": "present",
"provider_id": "my-provider",
"provider_type": "org.keycloak.storage.UserStorageProvider",
"config": {
"enabled": True,
"my_custom_config": "foo",
},
}
return_value_component_create = [
@ -111,24 +110,21 @@ class TestKeycloakComponent(ModuleTestCase):
"myCustomConfig": [
"foo",
],
"enabled": [
"true"
],
}
"enabled": ["true"],
},
}
]
# get before_comp, get default_mapper, get after_mapper
return_value_components_get = [
[], [], []
]
return_value_components_get = [[], [], []]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_components=return_value_components_get, create_component=return_value_component_create) \
as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with patch_keycloak_api(
get_components=return_value_components_get, create_component=return_value_component_create
) as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@ -138,35 +134,38 @@ class TestKeycloakComponent(ModuleTestCase):
self.assertEqual(len(mock_delete_component.mock_calls), 0)
# must not contain parent_id
mock_create_component.assert_called_once_with({
'name': 'test-user-provider',
'providerId': 'my-provider',
'providerType': 'org.keycloak.storage.UserStorageProvider',
'config': {
'enabled': ['true'],
'myCustomConfig': ['foo'],
mock_create_component.assert_called_once_with(
{
"name": "test-user-provider",
"providerId": "my-provider",
"providerType": "org.keycloak.storage.UserStorageProvider",
"config": {
"enabled": ["true"],
"myCustomConfig": ["foo"],
},
},
}, 'realm-name')
"realm-name",
)
# 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(self):
"""Update existing realm key"""
module_args = {
'auth_keycloak_url': 'http://keycloak.url/auth',
'auth_realm': 'master',
'auth_username': 'admin',
'auth_password': 'admin',
'parent_id': 'realm-name',
'name': 'test-user-provider',
'state': 'present',
'provider_id': 'my-provider',
'provider_type': 'org.keycloak.storage.UserStorageProvider',
'config': {
'enabled': True,
'my_custom_config': 'foo',
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_realm": "master",
"auth_username": "admin",
"auth_password": "admin",
"parent_id": "realm-name",
"name": "test-user-provider",
"state": "present",
"provider_id": "my-provider",
"provider_type": "org.keycloak.storage.UserStorageProvider",
"config": {
"enabled": True,
"my_custom_config": "foo",
},
}
return_value_components_get = [
@ -181,27 +180,23 @@ class TestKeycloakComponent(ModuleTestCase):
"myCustomConfig": [
"foo",
],
"enabled": [
"true"
],
}
"enabled": ["true"],
},
},
],
[],
[]
]
return_value_component_update = [
None
[],
]
return_value_component_update = [None]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_components=return_value_components_get,
update_component=return_value_component_update) \
as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with patch_keycloak_api(
get_components=return_value_components_get, update_component=return_value_component_update
) as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@ -211,37 +206,39 @@ class TestKeycloakComponent(ModuleTestCase):
self.assertEqual(len(mock_delete_component.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_absent(self):
"""Remove an absent realm key"""
module_args = {
'auth_keycloak_url': 'http://keycloak.url/auth',
'auth_realm': 'master',
'auth_username': 'admin',
'auth_password': 'admin',
'parent_id': 'realm-name',
'name': 'test-user-provider',
'state': 'absent',
'provider_id': 'my-provider',
'provider_type': 'org.keycloak.storage.UserStorageProvider',
'config': {
'enabled': True,
'my_custom_config': 'foo',
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_realm": "master",
"auth_username": "admin",
"auth_password": "admin",
"parent_id": "realm-name",
"name": "test-user-provider",
"state": "absent",
"provider_id": "my-provider",
"provider_type": "org.keycloak.storage.UserStorageProvider",
"config": {
"enabled": True,
"my_custom_config": "foo",
},
}
return_value_components_get = [
[]
]
return_value_components_get = [[]]
changed = False
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_components=return_value_components_get) \
as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with patch_keycloak_api(get_components=return_value_components_get) as (
mock_get_components,
mock_create_component,
mock_update_component,
mock_delete_component,
):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@ -251,24 +248,24 @@ class TestKeycloakComponent(ModuleTestCase):
self.assertEqual(len(mock_delete_component.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 an existing realm key"""
module_args = {
'auth_keycloak_url': 'http://keycloak.url/auth',
'auth_realm': 'master',
'auth_username': 'admin',
'auth_password': 'admin',
'parent_id': 'realm-name',
'name': 'test-user-provider',
'state': 'absent',
'provider_id': 'my-provider',
'provider_type': 'org.keycloak.storage.UserStorageProvider',
'config': {
'enabled': True,
'my_custom_config': 'foo',
"auth_keycloak_url": "http://keycloak.url/auth",
"auth_realm": "master",
"auth_username": "admin",
"auth_password": "admin",
"parent_id": "realm-name",
"name": "test-user-provider",
"state": "absent",
"provider_id": "my-provider",
"provider_type": "org.keycloak.storage.UserStorageProvider",
"config": {
"enabled": True,
"my_custom_config": "foo",
},
}
@ -284,26 +281,23 @@ class TestKeycloakComponent(ModuleTestCase):
"myCustomConfig": [
"foo",
],
"enabled": [
"true"
],
}
"enabled": ["true"],
},
},
],
[],
[]
]
return_value_component_delete = [
None
[],
]
return_value_component_delete = [None]
changed = True
# Run the module
with set_module_args(module_args):
with mock_good_connection():
with patch_keycloak_api(get_components=return_value_components_get, delete_component=return_value_component_delete) \
as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with patch_keycloak_api(
get_components=return_value_components_get, delete_component=return_value_component_delete
) as (mock_get_components, mock_create_component, mock_update_component, mock_delete_component):
with self.assertRaises(AnsibleExitJson) as exec_info:
self.module.main()
@ -313,8 +307,8 @@ class TestKeycloakComponent(ModuleTestCase):
self.assertEqual(len(mock_delete_component.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()