mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-21 14:48:50 +00:00
Port integration tests from community.general keycloak modules into the keycloak collection molecule test framework (keycloak_modules scenario), adapting for KC 26.x behavioral changes and middleware module differences. Ported modules: keycloak_authentication, keycloak_authz_authorization_scope, keycloak_authz_permission, keycloak_client, keycloak_client_rolescope, keycloak_client_scope_rolemappings, keycloak_client_scope_type, keycloak_clientsecret_info, keycloak_clientsecret_regenerate, keycloak_component_info, keycloak_group, keycloak_group_rolemapping, keycloak_identity_provider, keycloak_modules_authentication, keycloak_realm, keycloak_realm_key, keycloak_realm_users_info, keycloak_role, keycloak_user, keycloak_user_federation, keycloak_user_rolemapping, keycloak_userprofile. KC 26.x adaptations: - serviceAccountsEnabled defaults to true on new clients - Default Policy/Resource no longer auto-created for authz clients - Built-in admin role rejects PUT updates (403) - Invalid credentials return HTTP 400 instead of 401 - LDAP federation no longer auto-creates mappers Other fixes: - Variable collision avoidance (role/group/client register overwriting play-level vars via include_vars) - Ansible 2.19+ native Jinja dict handling (endpoint combine filter) - Jinja embedded template warnings in assert expressions - Auth fallback prevention in invalid-token tests
490 lines
15 KiB
YAML
490 lines
15 KiB
YAML
---
|
|
# Ported from community.general tests/integration/targets/keycloak_authz_permission
|
|
# Tests error paths, scope permission CRUD, resource permission CRUD, permission_info queries.
|
|
|
|
# KC 26.x no longer auto-creates "Default Policy" and "Default Resource"
|
|
# when authorization services are enabled via API.
|
|
|
|
- name: Obtain access token for policy setup
|
|
ansible.builtin.uri:
|
|
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
|
|
method: POST
|
|
body_format: form-urlencoded
|
|
body:
|
|
grant_type: password
|
|
client_id: admin-cli
|
|
username: "{{ auth_username }}"
|
|
password: "{{ auth_password }}"
|
|
validate_certs: false
|
|
register: authz_perm_token
|
|
|
|
- name: Look up client UUID
|
|
ansible.builtin.uri:
|
|
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients?clientId={{ client }}"
|
|
headers:
|
|
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
|
|
validate_certs: false
|
|
register: authz_perm_client
|
|
|
|
- name: Ensure Default Policy exists (role-based positive policy)
|
|
ansible.builtin.uri:
|
|
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients/{{ authz_perm_client.json[0].id }}/authz/resource-server/policy/role"
|
|
method: POST
|
|
headers:
|
|
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
|
|
Content-Type: application/json
|
|
body_format: json
|
|
body:
|
|
name: "Default Policy"
|
|
description: "A default policy"
|
|
logic: POSITIVE
|
|
roles: []
|
|
status_code: [201, 409]
|
|
validate_certs: false
|
|
|
|
- name: Ensure Default Resource exists
|
|
ansible.builtin.uri:
|
|
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/clients/{{ authz_perm_client.json[0].id }}/authz/resource-server/resource"
|
|
method: POST
|
|
headers:
|
|
Authorization: "Bearer {{ authz_perm_token.json.access_token }}"
|
|
Content-Type: application/json
|
|
body_format: json
|
|
body:
|
|
name: "Default Resource"
|
|
type: "urn:molecule-client:resources:default"
|
|
uris:
|
|
- "/*"
|
|
status_code: [201, 409]
|
|
validate_certs: false
|
|
|
|
- name: Create file:create authorization scope
|
|
middleware_automation.keycloak.keycloak_authz_authorization_scope:
|
|
state: present
|
|
name: "file:create"
|
|
display_name: "File create"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
|
|
- name: Create file:delete authorization scope
|
|
middleware_automation.keycloak.keycloak_authz_authorization_scope:
|
|
state: present
|
|
name: "file:delete"
|
|
display_name: "File delete"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
|
|
# --- Error paths ---
|
|
|
|
- name: Create permission without type (test for failure)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
failed_when: result.msg.find('missing required arguments') == -1
|
|
|
|
- name: Create scope permission without scopes (test for failure)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission"
|
|
permission_type: scope
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
failed_when: result.msg.find('Scopes need to defined when permission type is set to scope!') == -1
|
|
|
|
- name: Create scope permission with multiple resources (test for failure)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission"
|
|
resources:
|
|
- "Default Resource"
|
|
- "Other Resource"
|
|
permission_type: scope
|
|
scopes:
|
|
- "file:delete"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
failed_when: result.msg.find('Only one resource can be defined for a scope permission!') == -1
|
|
|
|
- name: Create scope permission with invalid policy name (test for failure)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission"
|
|
permission_type: scope
|
|
scopes:
|
|
- "file:delete"
|
|
policies:
|
|
- "Missing Policy"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
failed_when: result.msg.find('Unable to find authorization policy with name') == -1
|
|
|
|
# --- Scope permission CRUD ---
|
|
|
|
- name: Create scope permission
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission"
|
|
permission_type: scope
|
|
scopes:
|
|
- "file:delete"
|
|
policies:
|
|
- "Default Policy"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert scope permission was created
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result is changed
|
|
- result.end_state != {}
|
|
- result.end_state.name == "ScopePermission"
|
|
- result.end_state.description == "Scope permission"
|
|
- result.end_state.type == "scope"
|
|
- result.end_state.resources == []
|
|
- result.end_state.policies | length == 1
|
|
- result.end_state.scopes | length == 1
|
|
|
|
- name: Query scope permission state
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ScopePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried state matches
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ScopePermission"
|
|
- result.queried_state.description == "Scope permission"
|
|
|
|
- name: Create scope permission (idempotency)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission"
|
|
permission_type: scope
|
|
scopes:
|
|
- "file:delete"
|
|
policies:
|
|
- "Default Policy"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert scope permission unchanged
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.end_state != {}
|
|
- result.end_state.name == "ScopePermission"
|
|
- result.end_state.description == "Scope permission"
|
|
- result.end_state.type == "scope"
|
|
- result.end_state.resources == []
|
|
- result.end_state.policies | length == 1
|
|
- result.end_state.scopes | length == 1
|
|
|
|
- name: Query scope permission state after idempotency
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ScopePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried state matches after idempotency
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ScopePermission"
|
|
- result.queried_state.description == "Scope permission"
|
|
|
|
- name: Update scope permission
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission changed"
|
|
permission_type: scope
|
|
decision_strategy: 'AFFIRMATIVE'
|
|
scopes:
|
|
- "file:create"
|
|
- "file:delete"
|
|
policies: []
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert scope permission updated
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.changed == True
|
|
- result.end_state != {}
|
|
- result.end_state.scopes | length == 2
|
|
- result.end_state.policies == []
|
|
- result.end_state.resources == []
|
|
- result.end_state.name == "ScopePermission"
|
|
- result.end_state.description == "Scope permission changed"
|
|
|
|
- name: Query updated scope permission state
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ScopePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried state matches after update
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ScopePermission"
|
|
- result.queried_state.description == "Scope permission changed"
|
|
|
|
- name: Update scope permission (idempotency)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ScopePermission"
|
|
description: "Scope permission changed"
|
|
permission_type: scope
|
|
decision_strategy: 'AFFIRMATIVE'
|
|
scopes:
|
|
- "file:create"
|
|
- "file:delete"
|
|
policies: []
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert scope permission update idempotent
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.changed == True
|
|
- result.end_state != {}
|
|
- result.end_state.scopes | length == 2
|
|
- result.end_state.policies == []
|
|
- result.end_state.resources == []
|
|
- result.end_state.name == "ScopePermission"
|
|
- result.end_state.description == "Scope permission changed"
|
|
|
|
- name: Query scope permission state after update idempotency
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ScopePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried state matches after update idempotency
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ScopePermission"
|
|
- result.queried_state.description == "Scope permission changed"
|
|
|
|
- name: Remove scope permission
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: absent
|
|
name: "ScopePermission"
|
|
permission_type: scope
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert scope permission removed
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result is changed
|
|
- result.end_state == {}
|
|
|
|
- name: Remove scope permission (idempotency)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: absent
|
|
name: "ScopePermission"
|
|
permission_type: scope
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert scope permission already absent
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result is not changed
|
|
- result.end_state == {}
|
|
|
|
# --- Resource permission error paths ---
|
|
|
|
- name: Create resource permission without resources (test for failure)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ResourcePermission"
|
|
description: "Resource permission"
|
|
permission_type: resource
|
|
policies:
|
|
- "Default Policy"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
failed_when: result.msg.find('A resource need to defined when permission type is set to resource!') == -1
|
|
|
|
- name: Create resource permission with scopes (test for failure)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ResourcePermission"
|
|
description: "Resource permission"
|
|
permission_type: resource
|
|
resources:
|
|
- "Default Resource"
|
|
policies:
|
|
- "Default Policy"
|
|
scopes:
|
|
- "file:delete"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
failed_when: result.msg.find('Scopes cannot be defined when permission type is set to resource!') == -1
|
|
|
|
# --- Resource permission CRUD ---
|
|
|
|
- name: Create resource permission
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ResourcePermission"
|
|
description: "Resource permission"
|
|
resources:
|
|
- "Default Resource"
|
|
permission_type: resource
|
|
policies:
|
|
- "Default Policy"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert resource permission was created
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result is changed
|
|
- result.end_state != {}
|
|
- result.end_state.policies | length == 1
|
|
- result.end_state.resources | length == 1
|
|
- result.end_state.name == "ResourcePermission"
|
|
- result.end_state.description == "Resource permission"
|
|
|
|
- name: Query resource permission state
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ResourcePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried resource state matches
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ResourcePermission"
|
|
- result.queried_state.description == "Resource permission"
|
|
|
|
- name: Create resource permission (idempotency)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ResourcePermission"
|
|
description: "Resource permission"
|
|
resources:
|
|
- "Default Resource"
|
|
permission_type: resource
|
|
policies:
|
|
- "Default Policy"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert resource permission unchanged
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.end_state != {}
|
|
- result.end_state.policies | length == 1
|
|
- result.end_state.resources | length == 1
|
|
- result.end_state.name == "ResourcePermission"
|
|
- result.end_state.description == "Resource permission"
|
|
|
|
- name: Query resource permission state after idempotency
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ResourcePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried resource state matches after idempotency
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ResourcePermission"
|
|
- result.queried_state.description == "Resource permission"
|
|
|
|
- name: Update resource permission
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: present
|
|
name: "ResourcePermission"
|
|
description: "Resource permission changed"
|
|
resources:
|
|
- "Default Resource"
|
|
permission_type: resource
|
|
policies: []
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert resource permission updated
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.changed == True
|
|
- result.end_state != {}
|
|
- result.end_state.policies == []
|
|
- result.end_state.resources | length == 1
|
|
- result.end_state.name == "ResourcePermission"
|
|
- result.end_state.description == "Resource permission changed"
|
|
|
|
- name: Query updated resource permission state
|
|
middleware_automation.keycloak.keycloak_authz_permission_info:
|
|
name: "ResourcePermission"
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert queried resource state matches after update
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result.queried_state.name == "ResourcePermission"
|
|
- result.queried_state.description == "Resource permission changed"
|
|
|
|
- name: Remove resource permission
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: absent
|
|
name: "ResourcePermission"
|
|
permission_type: resource
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert resource permission removed
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result is changed
|
|
- result.end_state == {}
|
|
|
|
- name: Remove resource permission (idempotency)
|
|
middleware_automation.keycloak.keycloak_authz_permission:
|
|
state: absent
|
|
name: "ResourcePermission"
|
|
permission_type: resource
|
|
client_id: "{{ client }}"
|
|
realm: "{{ target_realm }}"
|
|
register: result
|
|
|
|
- name: Assert resource permission already absent
|
|
ansible.builtin.assert:
|
|
that:
|
|
- result is not changed
|
|
- result.end_state == {}
|