mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
a7dac117e5
Bugfix: keycloak_identity_provider does not handle mapper changes properly (#7418)
* fix keycloak_identity_provider ITs to actually pass
- wrong identityProviderAlias in mapper configuration
* kc_identity_provider: add mapper reconfiguration regression tests
* test for removing an existing mapper
* test for adding a new mapper when others already exist
* test for module idempotency when mappers not ordered by name in ascending order
* kc_identity_provider: add bugfixes for mapper reconfigurations
* removing an existing mapper
* adding a new mapper when others already exist
* module idempotency when mappers not ordered by name in ascending order
* add changelog fragment
* prevent unnecessary update_mapper calls when there is no change
* Update changelogs/fragments/7418-kc_identity_provider-mapper-reconfiguration-fixes.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update changelogs/fragments/7418-kc_identity_provider-mapper-reconfiguration-fixes.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update changelogs/fragments/7418-kc_identity_provider-mapper-reconfiguration-fixes.yml
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/keycloak_identity_provider.py
Co-authored-by: Felix Fontein <felix@fontein.de>
* kc_identity_provider: sort changeset mappers via name OR id to prevent potential failures in case name was not specified in playbook
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit fd0d05d6f2
)
Co-authored-by: Jakub Danek <danekja@users.noreply.github.com>
278 lines
7.6 KiB
YAML
278 lines
7.6 KiB
YAML
---
|
|
# 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: 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
|
|
|
|
- name: Create new identity provider
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
display_name: OpenID Connect IdP
|
|
enabled: true
|
|
provider_id: oidc
|
|
config:
|
|
issuer: https://idp.example.com
|
|
authorizationUrl: https://idp.example.com/auth
|
|
tokenUrl: https://idp.example.com/token
|
|
userInfoUrl: https://idp.example.com/userinfo
|
|
clientAuthMethod: client_secret_post
|
|
clientId: clientid
|
|
clientSecret: clientsecret
|
|
syncMode: FORCE
|
|
mappers:
|
|
- name: "first_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "first_name"
|
|
user.attribute: "first_name"
|
|
syncMode: "INHERIT"
|
|
- name: "last_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "last_name"
|
|
user.attribute: "last_name"
|
|
syncMode: "INHERIT"
|
|
state: present
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider created
|
|
assert:
|
|
that:
|
|
- result is changed
|
|
- result.existing == {}
|
|
- result.end_state.alias == "{{ idp }}"
|
|
- result.end_state.mappers != []
|
|
|
|
- name: Update existing identity provider (no change)
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
enabled: true
|
|
provider_id: oidc
|
|
config:
|
|
issuer: https://idp.example.com
|
|
authorizationUrl: https://idp.example.com/auth
|
|
tokenUrl: https://idp.example.com/token
|
|
userInfoUrl: https://idp.example.com/userinfo
|
|
clientAuthMethod: client_secret_post
|
|
clientId: clientid
|
|
clientSecret: "**********"
|
|
syncMode: FORCE
|
|
mappers:
|
|
- name: "first_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "first_name"
|
|
user.attribute: "first_name"
|
|
syncMode: "INHERIT"
|
|
- name: "last_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "last_name"
|
|
user.attribute: "last_name"
|
|
syncMode: "INHERIT"
|
|
state: present
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider unchanged
|
|
assert:
|
|
that:
|
|
- result is not changed
|
|
|
|
- name: Update existing identity provider (with change, no mapper change)
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
enabled: false
|
|
state: present
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider updated
|
|
assert:
|
|
that:
|
|
- result is changed
|
|
- result.existing.enabled == true
|
|
- result.end_state.enabled == false
|
|
|
|
- name: Update existing identity provider (delete mapper)
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
state: present
|
|
mappers:
|
|
- name: "first_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "first_name"
|
|
user.attribute: "first_name"
|
|
syncMode: "INHERIT"
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider updated
|
|
assert:
|
|
that:
|
|
- result is changed
|
|
- result.existing.mappers | length == 2
|
|
- result.end_state.mappers | length == 1
|
|
- result.end_state.mappers[0].name == "first_name"
|
|
|
|
- name: Update existing identity provider (add mapper)
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
state: present
|
|
mappers:
|
|
- name: "last_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "last_name"
|
|
user.attribute: "last_name"
|
|
syncMode: "INHERIT"
|
|
- name: "first_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "first_name"
|
|
user.attribute: "first_name"
|
|
syncMode: "INHERIT"
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider updated
|
|
assert:
|
|
that:
|
|
- result is changed
|
|
- result.existing.mappers | length == 1
|
|
- result.end_state.mappers | length == 2
|
|
|
|
- name: Update existing identity provider (no change, test mapper idempotency)
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
state: present
|
|
mappers:
|
|
- name: "last_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "last_name"
|
|
user.attribute: "last_name"
|
|
syncMode: "INHERIT"
|
|
- name: "first_name"
|
|
identityProviderAlias: "{{ idp }}"
|
|
identityProviderMapper: "oidc-user-attribute-idp-mapper"
|
|
config:
|
|
claim: "first_name"
|
|
user.attribute: "first_name"
|
|
syncMode: "INHERIT"
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider updated
|
|
assert:
|
|
that:
|
|
- result is not changed
|
|
|
|
- name: Delete existing identity provider
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
state: absent
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider deleted
|
|
assert:
|
|
that:
|
|
- result is changed
|
|
- result.end_state == {}
|
|
|
|
- name: Delete absent identity provider
|
|
community.general.keycloak_identity_provider:
|
|
auth_keycloak_url: "{{ url }}"
|
|
auth_realm: "{{ admin_realm }}"
|
|
auth_username: "{{ admin_user }}"
|
|
auth_password: "{{ admin_password }}"
|
|
realm: "{{ realm }}"
|
|
alias: "{{ idp }}"
|
|
state: absent
|
|
register: result
|
|
|
|
- name: Debug
|
|
debug:
|
|
var: result
|
|
|
|
- name: Assert identity provider unchanged
|
|
assert:
|
|
that:
|
|
- result is not changed
|
|
- result.end_state == {}
|