From ed99d28b5d15578672697c72e66c6cdf484ff540 Mon Sep 17 00:00:00 2001 From: Ranabir Chakraborty Date: Mon, 5 Oct 2026 19:40:06 +0530 Subject: [PATCH] AMW-644 keycloak_user_federation module always reports task as changed in check mode --- molecule/keycloak_modules/verify.yml | 121 ++++++++++++++++++++ plugins/modules/keycloak_user_federation.py | 12 ++ 2 files changed, 133 insertions(+) diff --git a/molecule/keycloak_modules/verify.yml b/molecule/keycloak_modules/verify.yml index c141fc3..4d78b25 100644 --- a/molecule/keycloak_modules/verify.yml +++ b/molecule/keycloak_modules/verify.yml @@ -902,6 +902,127 @@ - "'Connection refused' in (execute_actions_email_result.msg | default(''))" - "'Failed to send' in (execute_actions_email_result.msg | default(''))" + - name: keycloak_user_federation — create LDAP federation + middleware_automation.keycloak.keycloak_user_federation: + realm: "{{ target_realm }}" + name: "{{ federation }}" + state: present + provider_id: ldap + provider_type: org.keycloak.storage.UserStorageProvider + config: + enabled: true + priority: 0 + editMode: READ_ONLY + syncRegistrations: false + vendor: other + usernameLDAPAttribute: uid + rdnLDAPAttribute: uid + uuidLDAPAttribute: entryUUID + userObjectClasses: inetOrgPerson, organizationalPerson + connectionUrl: ldap://ldap.example.com + usersDn: ou=users,dc=example,dc=com + authType: simple + bindDn: cn=admin,dc=example,dc=com + bindCredential: admin_password + searchScope: "1" + pagination: true + importEnabled: true + batchSizeForSync: 1000 + fullSyncPeriod: -1 + changedSyncPeriod: -1 + bind_credential_update_mode: only_indirect + register: federation_create_result + + - name: Assert federation was created + ansible.builtin.assert: + that: + - federation_create_result is changed + + - name: keycloak_user_federation — create LDAP federation (idempotency) + middleware_automation.keycloak.keycloak_user_federation: + realm: "{{ target_realm }}" + name: "{{ federation }}" + state: present + provider_id: ldap + provider_type: org.keycloak.storage.UserStorageProvider + config: + enabled: true + priority: 0 + editMode: READ_ONLY + syncRegistrations: false + vendor: other + usernameLDAPAttribute: uid + rdnLDAPAttribute: uid + uuidLDAPAttribute: entryUUID + userObjectClasses: inetOrgPerson, organizationalPerson + connectionUrl: ldap://ldap.example.com + usersDn: ou=users,dc=example,dc=com + authType: simple + bindDn: cn=admin,dc=example,dc=com + bindCredential: admin_password + searchScope: "1" + pagination: true + importEnabled: true + batchSizeForSync: 1000 + fullSyncPeriod: -1 + changedSyncPeriod: -1 + bind_credential_update_mode: only_indirect + register: federation_idempotent_result + + - name: Assert federation creation is idempotent + ansible.builtin.assert: + that: + - federation_idempotent_result is not changed + + - name: keycloak_user_federation — check mode reports no change when config matches + middleware_automation.keycloak.keycloak_user_federation: + realm: "{{ target_realm }}" + name: "{{ federation }}" + state: present + provider_id: ldap + provider_type: org.keycloak.storage.UserStorageProvider + config: + enabled: true + priority: 0 + editMode: READ_ONLY + syncRegistrations: false + vendor: other + usernameLDAPAttribute: uid + rdnLDAPAttribute: uid + uuidLDAPAttribute: entryUUID + userObjectClasses: inetOrgPerson, organizationalPerson + connectionUrl: ldap://ldap.example.com + usersDn: ou=users,dc=example,dc=com + authType: simple + bindDn: cn=admin,dc=example,dc=com + bindCredential: admin_password + searchScope: "1" + pagination: true + importEnabled: true + batchSizeForSync: 1000 + fullSyncPeriod: -1 + changedSyncPeriod: -1 + bind_credential_update_mode: only_indirect + check_mode: true + register: federation_check_mode_result + + - name: Assert check mode returns no change when config matches + ansible.builtin.assert: + that: + - federation_check_mode_result is not changed + + - name: keycloak_user_federation — remove federation + middleware_automation.keycloak.keycloak_user_federation: + realm: "{{ target_realm }}" + name: "{{ federation }}" + state: absent + register: federation_remove_result + + - name: Assert federation was removed + ansible.builtin.assert: + that: + - federation_remove_result is changed + - name: keycloak_user_federation — remove non-existent federation (module API test) middleware_automation.keycloak.keycloak_user_federation: realm: "{{ target_realm }}" diff --git a/plugins/modules/keycloak_user_federation.py b/plugins/modules/keycloak_user_federation.py index d3576fc..51055c6 100644 --- a/plugins/modules/keycloak_user_federation.py +++ b/plugins/modules/keycloak_user_federation.py @@ -989,7 +989,10 @@ def main(): else: old_mapper = {} new_mapper = old_mapper.copy() + old_mapper_config = old_mapper.get("config", {}) new_mapper.update(change) + if "config" in change and old_mapper_config: + new_mapper["config"] = {**old_mapper_config, **change["config"]} # changeset contains all desired mappers: those existing, to update or to create if changeset.get("mappers") is None: changeset["mappers"] = list() @@ -1009,6 +1012,12 @@ def main(): desired_comp = before_comp.copy() desired_comp.update(changeset) + # Merge config: preserve KC-internal config keys not managed by this module + if "config" in changeset and "config" in before_comp: + merged_config = deepcopy(before_comp["config"]) + merged_config.update(changeset["config"]) + desired_comp["config"] = merged_config + result["proposed"] = sanitize(changeset) result["existing"] = sanitize(before_comp) @@ -1052,7 +1061,10 @@ def main(): old_mapper = {} new_mapper = old_mapper.copy() + old_default_config = old_mapper.get("config", {}) new_mapper.update(desired_mapper) + if "config" in desired_mapper and old_default_config: + new_mapper["config"] = {**old_default_config, **desired_mapper["config"]} if new_mapper.get("id") is not None: kc.update_component(new_mapper, realm)