Files
ansible-middleware.keycloak/molecule/keycloak_modules/keycloak_realm/verify.yml
T
sarankumar1325 dc8a6cb02d keycloak_realm: fix check mode always reporting changed
Check mode compared the realm returned by Keycloak with a plain
dict.update() of the module parameters. Keycloak stores attributes,
browserSecurityHeaders and smtpServer as string maps, merges attributes
and browserSecurityHeaders into the existing values and masks the SMTP
password, so the comparison never matched and check mode always
reported a change while a live run reported ok.

Predict the realm Keycloak would return for those maps in check mode
and add molecule checks for unchanged and changed settings.

Fixes #447

Signed-off-by: sarankumar1325 <120080287+sarankumar1325@users.noreply.github.com>
2026-10-30 13:12:39 +00:00

211 lines
6.3 KiB
YAML

---
# Ported from community.general tests/integration/targets/keycloak_realm
# Tests session timeout and OAuth2 device settings on keycloak_realm module.
- name: Modify realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
client_session_idle_timeout: 240
client_session_max_lifespan: 21600
client_offline_session_idle_timeout: 100
client_offline_session_max_lifespan: 200
oauth2_device_code_lifespan: 700
oauth2_device_polling_interval: 800
state: present
register: result
- name: Assert result
ansible.builtin.assert:
that:
- result is changed
- result.end_state.clientSessionIdleTimeout == 240
- result.end_state.clientSessionMaxLifespan == 21600
- result.end_state.clientOfflineSessionIdleTimeout == 100
- result.end_state.clientOfflineSessionMaxLifespan == 200
- result.end_state.oauth2DeviceCodeLifespan == 700
- result.end_state.oauth2DevicePollingInterval == 800
- name: Delete realm
middleware_automation.keycloak.keycloak_realm:
realm: "{{ ephemeral_realm }}"
state: absent
- name: create realm
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
client_session_idle_timeout: 240
client_session_max_lifespan: 21600
client_offline_session_idle_timeout: 100
client_offline_session_max_lifespan: 200
oauth2_device_code_lifespan: 700
oauth2_device_polling_interval: 800
state: present
register: result
- name: Assert result
ansible.builtin.assert:
that:
- result is changed
- result.end_state.clientSessionIdleTimeout == 240
- result.end_state.clientSessionMaxLifespan == 21600
- result.end_state.clientOfflineSessionIdleTimeout == 100
- result.end_state.clientOfflineSessionMaxLifespan == 200
- result.end_state.oauth2DeviceCodeLifespan == 700
- result.end_state.oauth2DevicePollingInterval == 800
- name: Update realm default client scopes
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
default_default_client_scopes:
- acr
- email
- profile
- roles
default_optional_client_scopes:
- offline_access
- microprofile-jwt
state: present
register: result
- name: Assert default client scopes updated
ansible.builtin.assert:
that:
- result is changed
- "'acr' in result.end_state.defaultDefaultClientScopes"
- "'email' in result.end_state.defaultDefaultClientScopes"
- "'profile' in result.end_state.defaultDefaultClientScopes"
- "'roles' in result.end_state.defaultDefaultClientScopes"
- "result.end_state.defaultDefaultClientScopes | length == 4"
- "'offline_access' in result.end_state.defaultOptionalClientScopes"
- "'microprofile-jwt' in result.end_state.defaultOptionalClientScopes"
- "result.end_state.defaultOptionalClientScopes | length == 2"
- name: Update realm default client scopes again (idempotency)
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
default_default_client_scopes:
- acr
- email
- profile
- roles
default_optional_client_scopes:
- offline_access
- microprofile-jwt
state: present
register: result
- name: Assert no changes on idempotent run
ansible.builtin.assert:
that:
- result is not changed
- name: Fail when setting a non-existent client scope
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
default_default_client_scopes:
- nonexistent-scope
state: present
register: result
ignore_errors: true
- name: Assert failure for non-existent scope
ansible.builtin.assert:
that:
- result is failed
- "'nonexistent-scope' in result.msg"
- name: Configure realm attributes, SMTP server and browser security headers
middleware_automation.keycloak.keycloak_realm: &realm_map_settings
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
attributes:
molecule-number: 123
molecule-flag: true
smtp_server:
host: smtp.example.com
port: 587
from: noreply@example.com
auth: true
user: molecule
password: molecule-smtp-password
starttls: true
browser_security_headers:
xFrameOptions: DENY
state: present
register: result
- name: Assert realm map settings applied
ansible.builtin.assert:
that:
- result is changed
- result.end_state.attributes['molecule-number'] == '123'
- result.end_state.smtpServer.port == '587'
- result.end_state.browserSecurityHeaders.xFrameOptions == 'DENY'
- name: Re-apply realm map settings in check mode
middleware_automation.keycloak.keycloak_realm: *realm_map_settings
check_mode: true
register: result
- name: Assert check mode reports no change for unchanged map settings
ansible.builtin.assert:
that:
- result is not changed
- name: Change a realm attribute in check mode
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
attributes:
molecule-number: 456
molecule-flag: true
state: present
check_mode: true
register: result
- name: Assert check mode reports a changed realm attribute
ansible.builtin.assert:
that:
- result is changed
- name: Change the SMTP port in check mode
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
smtp_server:
host: smtp.example.com
port: 25
from: noreply@example.com
auth: true
user: molecule
password: molecule-smtp-password
starttls: true
state: present
check_mode: true
register: result
- name: Assert check mode reports a changed SMTP server
ansible.builtin.assert:
that:
- result is changed
- name: Change a browser security header in check mode
middleware_automation.keycloak.keycloak_realm:
id: "{{ ephemeral_realm }}"
realm: "{{ ephemeral_realm }}"
browser_security_headers:
xRobotsTag: all
state: present
check_mode: true
register: result
- name: Assert check mode reports a changed browser security header
ansible.builtin.assert:
that:
- result is changed