Files
ansible-middleware.keycloak/molecule/keycloak_modules/keycloak_user/verify.yml
T
Filipe Rosa Capela 07438ad4af keycloak_user: fix check mode reporting changed=True for every existing user
In check mode, the desired group memberships were built as a set and
compared with the stored memberships, a list, through is_struct_included().
It has no branch for sets and falls back to comparing their string forms,
which never match, so check mode reported a change for every existing user,
with or without groups.

Check mode now decides like normal mode: a group given by name or by path
counts as joined when the user is already a member. That rule moves from
update_user_groups_membership() into
filter_groups_to_add_to_and_remove_from_user(), which both modes use, and
the groups reported in check mode no longer list a group given by path
twice. Add check mode tests, including groups given by path.

Fixes #442

Signed-off-by: Filipe Rosa Capela <Filipe.Capela-CIC.Netherlands1@ibm.com>
2026-10-13 18:23:51 +02:00

348 lines
10 KiB
YAML

---
# Ported from community.general tests/integration/targets/keycloak_user
# Tests: user with groups+attributes, plus-addressed email, email_verified default reset,
# required_actions explicit reset to empty list.
- name: Load user test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new groups
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
state: present
loop: "{{ keycloak_user_groups }}"
- name: Create user
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
state: present
register: create_result
- name: Assert user is created
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.userProfileMetadata.attributes | length == 4
- create_result.end_state.groups | length == 2
- name: Delete User
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
state: absent
register: delete_result
- name: Assert user is deleted
ansible.builtin.assert:
that:
- delete_result.changed
- delete_result.end_state | length == 0
- name: Create user with plus-addressed email
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
first_name: Plus
last_name: User
email: "testuser+tag@example.org"
state: present
register: plus_create_result
- name: Assert plus-addressed user is created
ansible.builtin.assert:
that:
- plus_create_result.changed
- plus_create_result.end_state.username == 'testuser+tag'
- plus_create_result.end_state.email == 'testuser+tag@example.org'
- name: Re-run plus-addressed user creation (idempotency)
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
first_name: Plus
last_name: User
email: "testuser+tag@example.org"
state: present
register: plus_idempotent_result
- name: Assert plus-addressed user is idempotent
ansible.builtin.assert:
that:
- plus_idempotent_result is not changed
- name: Delete plus-addressed user
middleware_automation.keycloak.keycloak_user:
username: "testuser+tag"
realm: "{{ ephemeral_realm }}"
state: absent
register: plus_delete_result
- name: Assert plus-addressed user is deleted
ansible.builtin.assert:
that:
- plus_delete_result.changed
- name: Create user again
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
email_verified_behavior: no_defaults
register: create_result
- name: Assert user is created without email_verified
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.username == 'test'
- create_result.end_state.emailVerified == false
- name: Set email_verified
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
groups: "{{ keycloak_user_groups }}"
attributes: "{{ keycloak_user_attributes }}"
email_verified: true
state: present
register: create_result
- name: Assert email_verified is set
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.emailVerified == True
- name: Leave email_verified as it is
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
email_verified_behavior: no_defaults
register: create_result
- name: Assert email_verified is still set
ansible.builtin.assert:
that:
- not create_result.changed
- create_result.end_state.emailVerified == True
- name: Test old email_verified behavior
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
register: create_result
- name: Assert email_verified is reset
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.emailVerified == False
- name: Test setting required_actions
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
required_actions:
- UPDATE_PASSWORD
- VERIFY_EMAIL
state: present
register: create_result
- name: Assert required_actions are set
ansible.builtin.assert:
that:
- create_result.changed
- "'UPDATE_PASSWORD' in create_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in create_result.end_state.requiredActions"
- name: Test required_actions unchanged
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
register: create_result
- name: Assert required_actions are still set
ansible.builtin.assert:
that:
- not create_result.changed
- "'UPDATE_PASSWORD' in create_result.end_state.requiredActions"
- "'VERIFY_EMAIL' in create_result.end_state.requiredActions"
- name: Test required_actions reset
middleware_automation.keycloak.keycloak_user:
username: "{{ keycloak_username }}"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes
last_name: Untestes
email: ceciestuntestes@test.com
state: present
required_actions: []
register: create_result
- name: Assert required_actions are reset
ansible.builtin.assert:
that:
- create_result.changed
- create_result.end_state.requiredActions == []
- name: Create user for check mode tests
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
state: present
- name: Re-run with identical input in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports no change for identical input
ansible.builtin.assert:
that:
- check_mode_result is not changed
- name: Add the user to a group
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
state: present
- name: Re-run with identical groups in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports no change for identical groups
ansible.builtin.assert:
that:
- check_mode_result is not changed
- name: Join a second group in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: test2
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports joining a group as a change
ansible.builtin.assert:
that:
- check_mode_result is changed
- name: Create a parent group and a subgroup for check mode tests
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ item.name }}"
parents: "{{ item.parents | default(omit) }}"
state: present
loop:
- name: check-mode-parent
- name: check-mode-child
parents:
- name: check-mode-parent
- name: Add the user to the subgroup by path
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: /check-mode-parent/check-mode-child
state: present
- name: Re-run with identical groups given by path in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: /check-mode-parent/check-mode-child
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports no change for identical groups given by path
ansible.builtin.assert:
that:
- check_mode_result is not changed
- check_mode_result.end_state.groups | sort == ['check-mode-child', 'test']
- name: Leave the subgroup by path in check mode
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
groups:
- name: test
- name: /check-mode-parent/check-mode-child
state: absent
state: present
check_mode: true
register: check_mode_result
- name: Assert check mode reports leaving a group given by path as a change
ansible.builtin.assert:
that:
- check_mode_result is changed
- check_mode_result.end_state.groups == ['test']
- name: Delete user for check mode tests
middleware_automation.keycloak.keycloak_user:
username: check-mode-user
realm: "{{ ephemeral_realm }}"
state: absent
register: check_mode_delete_result
- name: Assert user for check mode tests is deleted
ansible.builtin.assert:
that:
- check_mode_delete_result.changed