mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-04 13:14:24 -07:00
Keycloak realm add support for some missing options (#10538)
* First commit * fixe * changelog --------- Co-authored-by: Andre Desrosiers <andre.desrosiers@ssss.gouv.qc.ca>
This commit is contained in:
parent
40bcfd9646
commit
85f6a07b19
6 changed files with 183 additions and 0 deletions
|
@ -0,0 +1,2 @@
|
|||
minor_changes:
|
||||
- keycloak_realm - add support for client-related options and Oauth2 device (https://github.com/ansible-collections/community.general/pull/10538).
|
|
@ -510,6 +510,48 @@ options:
|
|||
aliases:
|
||||
- waitIncrementSeconds
|
||||
type: int
|
||||
client_session_idle_timeout:
|
||||
description:
|
||||
- All Clients will inherit from this setting, time a session is allowed to be idle before it expires.
|
||||
aliases:
|
||||
- clientSessionIdleTimeout
|
||||
type: int
|
||||
version_added: 11.2.0
|
||||
client_session_max_lifespan:
|
||||
description:
|
||||
- All Clients will inherit from this setting, max time before a session is expired.
|
||||
aliases:
|
||||
- clientSessionMaxLifespan
|
||||
type: int
|
||||
version_added: 11.2.0
|
||||
client_offline_session_idle_timeout:
|
||||
description:
|
||||
- All Clients will inherit from this setting, time an offline session is allowed to be idle before it expires.
|
||||
aliases:
|
||||
- clientOfflineSessionIdleTimeout
|
||||
type: int
|
||||
version_added: 11.2.0
|
||||
client_offline_session_max_lifespan:
|
||||
description:
|
||||
- All Clients will inherit from this setting, max time before an offline session is expired regardless of activity.
|
||||
aliases:
|
||||
- clientOfflineSessionMaxLifespan
|
||||
type: int
|
||||
version_added: 11.2.0
|
||||
oauth2_device_code_lifespan:
|
||||
description:
|
||||
- Max time before the device code and user code are expired.
|
||||
aliases:
|
||||
- oauth2DeviceCodeLifespan
|
||||
type: int
|
||||
version_added: 11.2.0
|
||||
oauth2_device_polling_interval:
|
||||
description:
|
||||
- The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint.
|
||||
aliases:
|
||||
- oauth2DevicePollingInterval
|
||||
type: int
|
||||
version_added: 11.2.0
|
||||
|
||||
extends_documentation_fragment:
|
||||
- community.general.keycloak
|
||||
|
@ -710,6 +752,12 @@ def main():
|
|||
user_managed_access_allowed=dict(type='bool', aliases=['userManagedAccessAllowed']),
|
||||
verify_email=dict(type='bool', aliases=['verifyEmail']),
|
||||
wait_increment_seconds=dict(type='int', aliases=['waitIncrementSeconds']),
|
||||
client_session_idle_timeout=dict(type='int', aliases=['clientSessionIdleTimeout']),
|
||||
client_session_max_lifespan=dict(type='int', aliases=['clientSessionMaxLifespan']),
|
||||
client_offline_session_idle_timeout=dict(type='int', aliases=['clientOfflineSessionIdleTimeout']),
|
||||
client_offline_session_max_lifespan=dict(type='int', aliases=['clientOfflineSessionMaxLifespan']),
|
||||
oauth2_device_code_lifespan=dict(type='int', aliases=['oauth2DeviceCodeLifespan']),
|
||||
oauth2_device_polling_interval=dict(type='int', aliases=['oauth2DevicePollingInterval']),
|
||||
)
|
||||
|
||||
argument_spec.update(meta_args)
|
||||
|
|
20
tests/integration/targets/keycloak_realm/README.md
Normal file
20
tests/integration/targets/keycloak_realm/README.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
<!--
|
||||
Copyright (c) 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
|
||||
-->
|
||||
# Running keycloak_realm module integration test
|
||||
|
||||
To run Keycloak component info module's integration test, start a keycloak server using Docker:
|
||||
|
||||
docker run -d --rm --name mykeycloak -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=password quay.io/keycloak/keycloak:latest start-dev --http-relative-path /auth
|
||||
|
||||
Run integration tests:
|
||||
|
||||
ansible-test integration -v keycloak_realm --allow-unsupported --docker fedora35 --docker-network host
|
||||
|
||||
Cleanup:
|
||||
|
||||
docker stop mykeycloak
|
||||
|
||||
|
5
tests/integration/targets/keycloak_realm/aliases
Normal file
5
tests/integration/targets/keycloak_realm/aliases
Normal file
|
@ -0,0 +1,5 @@
|
|||
# Copyright (c) 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
|
||||
|
||||
unsupported
|
98
tests/integration/targets/keycloak_realm/tasks/main.yml
Normal file
98
tests/integration/targets/keycloak_realm/tasks/main.yml
Normal file
|
@ -0,0 +1,98 @@
|
|||
---
|
||||
# Copyright (c) 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
|
||||
- name: Wait for Keycloak
|
||||
uri:
|
||||
url: "{{ url }}/admin/"
|
||||
status_code: 200
|
||||
validate_certs: false
|
||||
register: result
|
||||
until: result.status == 200
|
||||
retries: 10
|
||||
delay: 10
|
||||
|
||||
- name: Delete realm if exists
|
||||
community.general.keycloak_realm:
|
||||
auth_keycloak_url: "{{ url }}"
|
||||
auth_realm: "{{ admin_realm }}"
|
||||
auth_username: "{{ admin_user }}"
|
||||
auth_password: "{{ admin_password }}"
|
||||
realm: "{{ realm }}"
|
||||
state: absent
|
||||
|
||||
- name: Create realm
|
||||
community.general.keycloak_realm:
|
||||
auth_keycloak_url: "{{ url }}"
|
||||
auth_realm: "{{ admin_realm }}"
|
||||
auth_username: "{{ admin_user }}"
|
||||
auth_password: "{{ admin_password }}"
|
||||
id: "{{ realm }}"
|
||||
realm: "{{ realm }}"
|
||||
state: present
|
||||
register: result
|
||||
|
||||
- name: Modify realm
|
||||
community.general.keycloak_realm:
|
||||
auth_keycloak_url: "{{ url }}"
|
||||
auth_realm: "{{ admin_realm }}"
|
||||
auth_username: "{{ admin_user }}"
|
||||
auth_password: "{{ admin_password }}"
|
||||
id: "{{ realm }}"
|
||||
realm: "{{ 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
|
||||
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
|
||||
community.general.keycloak_realm:
|
||||
auth_keycloak_url: "{{ url }}"
|
||||
auth_realm: "{{ admin_realm }}"
|
||||
auth_username: "{{ admin_user }}"
|
||||
auth_password: "{{ admin_password }}"
|
||||
realm: "{{ realm }}"
|
||||
state: absent
|
||||
|
||||
- name: create realm
|
||||
community.general.keycloak_realm:
|
||||
auth_keycloak_url: "{{ url }}"
|
||||
auth_realm: "{{ admin_realm }}"
|
||||
auth_username: "{{ admin_user }}"
|
||||
auth_password: "{{ admin_password }}"
|
||||
id: "{{ realm }}"
|
||||
realm: "{{ 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
|
||||
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
|
10
tests/integration/targets/keycloak_realm/vars/main.yml
Normal file
10
tests/integration/targets/keycloak_realm/vars/main.yml
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
# Copyright (c) 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
|
||||
|
||||
url: http://localhost:8080/auth
|
||||
admin_realm: master
|
||||
admin_user: admin
|
||||
admin_password: password
|
||||
realm: myrealm
|
Loading…
Add table
Add a link
Reference in a new issue