Compare commits

..
344 Commits
Author SHA1 Message Date
Harsha CherukuriandGitHub 7793ecd381 Merge pull request #437 from ansible-middleware/changelog/3.1.2
Update changelog for release 3.1.2
2026-10-09 10:56:59 -04:00
ansible-middleware-core 5cd7f3d147 Update changelog for release 3.1.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-10-09 14:40:59 +00:00
Harsha CherukuriandGitHub 39721dff35 Merge pull request #436 from cihlamar/AMW-649
Add missing protocolMappers alias to keycloak_client_scope mo…
2026-10-09 10:39:29 -04:00
Harsha CherukuriandGitHub 6c2ab1e4b9 Merge pull request #409 from cihlamar/AMW-616
Port integration tests from community.general
2026-10-09 10:38:58 -04:00
Martin Cihlar 3218326ac3 AMW-649 Add missing protocolMappers alias to keycloak_client_scope module
The keycloak_client module accepts protocolMappers as an alias for
protocol_mappers, but keycloak_client_scope was missing it.

Fixes #435
2026-10-09 10:53:47 +02:00
Martin Cihlar c51f290d64 AMW-616 Port 24 community.general keycloak integration tests to molecule
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
2026-10-08 20:48:09 +02:00
Ranabir ChakrabortyandGitHub bcddd1b95b Merge pull request #434 from cihlamar/AMW-641 2026-10-06 16:58:52 +05:30
Martin Cihlar e43dcafa9d AMW-641 Clarify health_check_url_path description per review 2026-10-06 10:42:18 +02:00
Harsha CherukuriandGitHub 3f620aaeba Merge pull request #429 from cihlamar/AMW-641
Fix health check URL to use localhost with protocol and port
2026-10-05 19:22:06 -04:00
Harsha CherukuriandGitHub e070def764 Merge pull request #433 from RanabirChakraborty/AMW-644
AMW-644 keycloak_user_federation module always reports task as changed in check mode
2026-10-05 19:18:50 -04:00
Ranabir Chakraborty ed99d28b5d AMW-644 keycloak_user_federation module always reports task as changed in check mode 2026-10-05 19:40:06 +05:30
Martin Cihlar 3e82ac6461 AMW-641 Fix health check URL to use localhost instead of public hostname
Replace hostname-based health check URL with localhost. The health check
runs on the managed host itself, so it should always target localhost
rather than the public-facing keycloak_quarkus_hostname which can be
empty or a domain name behind a load balancer.

Compose the URL directly from existing production variables
(keycloak_quarkus_http_enabled, keycloak_quarkus_http_port,
keycloak_quarkus_https_port, keycloak_quarkus_http_relative_path)
without introducing intermediate variables.

Add .config/molecule/config.yml with shared molecule settings and a new
quarkus_nohost test scenario that verifies the role works when
keycloak_quarkus_hostname is left at its default empty value.

Fixes #428
2026-10-05 15:24:02 +02:00
Harsha CherukuriandGitHub 4b317c46de Merge pull request #430 from RanabirChakraborty/AMW-642
AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature
2026-10-01 06:41:16 -04:00
Ranabir Chakraborty bd2c01a588 AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature 2026-10-01 00:55:27 +05:30
Harsha CherukuriandGitHub 221b1a7667 Merge pull request #425 from hcherukuri/main
Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND
2026-09-21 08:15:22 -04:00
Harsha Cherukuri d4fea4a5be Fix quarkus molecule verify for JAVA_OPTS sysconfig 2026-09-18 09:30:58 -04:00
Harsha CherukuriandGitHub 8c8eef172d Merge pull request #427 from ansible-middleware/bump/3.1.2
Bump version to 3.1.2
2026-09-18 08:58:33 -04:00
ansible-middleware-core 3b89e5a154 Bump version to 3.1.2 2026-09-18 12:53:05 +00:00
Harsha CherukuriandGitHub a1ed36e919 Merge pull request #426 from ansible-middleware/changelog/3.1.1
Update changelog for release 3.1.1
2026-09-18 08:50:47 -04:00
ansible-middleware-core 37e96d9bc0 Update changelog for release 3.1.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-18 12:32:53 +00:00
Harsha Cherukuri 8a3ed80b04 Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND 2026-09-17 11:15:47 -04:00
Harsha CherukuriandGitHub d8d36a41a8 Merge pull request #422 from Maestro157/bump/keycloak-26.7.3
Bump Keycloak to 26.7.3 and RHBK to 26.4.15
2026-09-17 08:47:54 -04:00
Harsha CherukuriandGitHub e8031923af Merge pull request #424 from cihlamar/AMW-634
Fix keycloak_quarkus_health_check_url crash when hostname is unset
2026-09-17 08:44:23 -04:00
Harsha CherukuriandGitHub eee2472cd6 Merge pull request #419 from nwintering/main
Add support for the `description` attribute of keycloak groups
2026-09-17 08:43:33 -04:00
Martin Cihlar 45e91f4e3f Fix keycloak_quarkus_health_check_url crash when hostname is unset
Default keycloak_quarkus_hostname to empty string instead of null to
prevent AttributeError when .rstrip() is called on NoneType in the
health_check_url default expression.

Fixes #423
2026-09-17 11:58:29 +02:00
Stefan Krempel f3b484acdd Bump Keycloak to 26.7.3 and RHBK to 26.4.15
Update the keycloak_quarkus role defaults, argument specs, README and
molecule scenarios to the current upstream releases. Keycloak 26.7.2+
and RHBK 26.4.15 fix CVE-2026-18963 (GHSA-4gv3-mc9p-5wqc, CVSS 9.1).

- keycloak_quarkus_version: 26.6.2 -> 26.7.3
- rhbk_version: 26.4.11 -> 26.4.15
- molecule/quarkus: SPID provider 26.5.6 -> 26.7.1 (new sha256),
  keycloak-kerberos-federation 26.6.3 -> 26.7.3
- molecule/quarkus_upgrade: prepare on 26.6.2, converge to 26.7.3

JDBC driver defaults are left unchanged; they still match the versions
listed in Red Hat article 7033107 referenced from the defaults file.
2026-09-15 15:39:42 +02:00
nwintering 7d9e99b370 add missing dot to docu 2026-09-14 16:57:38 +02:00
nwinteringandGitHub 2b4ce2694c Merge branch 'ansible-middleware:main' into main 2026-09-14 16:49:19 +02:00
Harsha CherukuriandGitHub 44e3f0078f Merge pull request #418 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-5.0.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.1.0 to 5.0.0
2026-09-14 08:57:53 -04:00
dependabot[bot]andGitHub 034a3bac52 Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 4.1.0 to 5.0.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e...fefb6b967e99964b55665b66ef0d8e4148d84aca)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-09-14 12:46:56 +00:00
nwintering 2bb6946fb9 Add support for description attribute 2026-09-14 14:44:35 +02:00
Ranabir ChakrabortyandGitHub 48d014cb18 Merge pull request #417 from ansible-middleware/bump/3.1.1
Bump version to 3.1.1
2026-09-11 22:13:53 +05:30
ansible-middleware-core 0fb476c6a1 Bump version to 3.1.1 2026-09-11 15:08:05 +00:00
Ranabir ChakrabortyandGitHub a071cd1c2d Merge pull request #416 from RanabirChakraborty/changelog/3.1.0
Update changelog for release 3.1.0
2026-09-11 20:34:19 +05:30
ansible-middleware-coreandRanabir Chakraborty 6b2d4a8552 Update changelog for release 3.1.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-09-11 20:29:58 +05:30
Ranabir ChakrabortyandGitHub 08ee1c33bc Merge pull request #412 from cihlamar/AMW-628
Replace deprecated top-level fact variables with ansible_fact
2026-09-11 20:01:40 +05:30
Ranabir ChakrabortyandGitHub e103524781 Merge pull request #384 from NilsBergmann/feature/authv2-formaction
authentication_v2: Fix validation for FormActions
2026-09-11 20:00:09 +05:30
Ranabir ChakrabortyandGitHub 45863b3023 Merge pull request #414 from hcherukuri/main
Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in
2026-09-11 12:44:16 +05:30
Ranabir ChakrabortyandGitHub 9ac8274434 Merge pull request #413 from cihlamar/AMW-578
Replace deprecated community.general.yaml callback with result
2026-09-10 21:07:57 +05:30
Harsha Cherukuri 0716f622ad Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in 2026-09-10 09:03:29 -04:00
Harsha CherukuriandGitHub 14cba062b4 Merge pull request #411 from RanabirChakraborty/AMW-626
AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role
2026-09-10 08:57:52 -04:00
Martin Cihlar 9d56a54bd8 AMW-628 Replace deprecated top-level fact variables with ansible_facts syntax 2026-09-10 13:26:02 +02:00
Martin Cihlar 8c3c4d8cbc AMW-578 Replace deprecated community.general.yaml callback with result_format 2026-09-10 10:38:00 +02:00
Nils Bergmann 638f694120 authentication_v2: Fix validation for form-flows and client-flows 2026-09-09 10:36:56 +02:00
Ranabir Chakraborty 86bd6c77d6 AMW-626 keycloak_user_rolemapping raises 403 error code while listing asignable Roles if invoker lacks view-realm Role 2026-09-09 13:24:37 +05:30
Ranabir ChakrabortyandGitHub 6644207e5d Merge pull request #407 from Yabk/bugfix/keycloak_group_parents
keycloak_group: fix subgroup lookup on Keycloak older than 25
2026-09-09 12:40:51 +05:30
Ranabir ChakrabortyandGitHub 5ba8098c15 Merge pull request #408 from cihlamar/AMW-625
Add use_netrc option to prevent .netrc overriding bearer token
2026-09-09 12:33:09 +05:30
Martin Cihlar d6ceb63914 AMW-625 add use_netrc option to prevent .netrc overriding bearer token auth
When ~/.netrc contains an entry matching the Keycloak host, open_url()
silently replaces the OIDC Bearer header with Basic auth, causing 401
errors. Add use_netrc option (default false) to all keycloak modules
and pass it through to both open_url() call sites.

Includes molecule test scenario (netrc) that verifies both behaviors:
- default use_netrc=false ignores .netrc (fix works)
- use_netrc=true picks up .netrc and gets 401 (proves the bug)

Fixes: https://github.com/ansible-middleware/keycloak/issues/403
2026-09-07 09:09:39 +02:00
Yabk 529b667321 keycloak_group: fix subgroup lookup on Keycloak older than 25
The parents branch of get_group_by_name() queried
GET /admin/realms/{realm}/groups/{id}/children?search=&exact=true
unconditionally. That endpoint only accepts GET from Keycloak 23 on, so
older servers (RH-SSO 7.x included) failed with 405 Method Not Allowed,
and 23/24 ignore search/exact and return only the first 10 children, so
subgroups past the tenth were silently reported as absent.

The lookup now goes through get_subgroups(), which already detects the
server generation, and that helper takes an optional search argument so
the search optimization is kept where the server supports it.
2026-09-04 12:56:23 +02:00
Harsha CherukuriandGitHub 8d5526aeb6 Merge pull request #406 from RanabirChakraborty/AMW-622
AMW-622 keycloak collection spelling and grammar checking for PRs
2026-09-03 13:48:04 -04:00
Ranabir ChakrabortyandGitHub afc12b6ae2 Merge pull request #405 from hcherukuri/main
Fix issue #397 #398 crash on first role assignment
2026-09-03 22:34:37 +05:30
Ranabir Chakraborty 0868b58e90 AMW-622 keycloak collection spelling and grammar checking for PRs 2026-09-03 22:18:47 +05:30
Harsha Cherukuri 2ffe3a8f7b Fix keycloak_user_federation for issue #398 2026-09-03 10:02:35 -04:00
Harsha CherukuriandGitHub 6814939116 Merge pull request #402 from stblassitude/fix/keycloak_authentication_v2-subflow-keyerror
In a flow definition, handle non-existing keys correctly
2026-09-03 09:47:01 -04:00
Harsha Cherukuri 24350903ed Fix issue #397 crash on first role assignment 2026-09-03 09:43:17 -04:00
Harsha CherukuriandGitHub 89cb1691ae Merge pull request #404 from hcherukuri/main
Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
2026-09-03 09:38:14 -04:00
Harsha Cherukuri 79852e61fc Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter 2026-09-03 08:23:38 -04:00
Stefan Bethke 8007d8039a Handle non-existing keys correctly
See issue #401 for details.
2026-09-02 10:35:01 +02:00
Ranabir ChakrabortyandGitHub 85d494731a Merge pull request #399 from santanoce/bugfix/keycloak_user
keycloak_user: fix attributes always reporting changed=True
2026-09-01 18:43:41 +05:30
Ranabir ChakrabortyandGitHub d41fc161be Merge pull request #392 from cihlamar/AMW-612
Normalize hostname that includes http_relative_path suffix
2026-09-01 18:42:10 +05:30
Harsha CherukuriandGitHub 4e1d14c4a1 Merge pull request #400 from RanabirChakraborty/AMW-615
AMW-615 Inconsistent support of authentication via client credentials
2026-08-31 22:34:42 -04:00
Ranabir Chakraborty e9f74fa4a9 AMW-615 Inconsistent support of authentication via client credentials 2026-08-31 23:40:02 +05:30
santanoce 23d96186f5 keycloak_user: fix attributes always reporting changed=True 2026-08-30 12:44:17 +02:00
Martin Cihlar b48b0b7334 AMW-612 Fix health URL duplication when hostname includes http_relative_path
Use removesuffix to strip overlapping path from hostname before
re-appending http_relative_path, preventing /auth/auth/ duplication.
Add molecule test for the relative path scenario.
2026-08-27 13:14:28 +02:00
Martin CihlarandGitHub 9446e53b6e Merge pull request #393 from ansible-middleware/dependabot/github_actions/ansible-collections/partner-certification-checker/dot-github/workflows/certification-reusable.yml-4.1.0
Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml from 4.0.0 to 4.1.0
2026-08-27 11:50:45 +02:00
Ranabir ChakrabortyandGitHub a29e1a0c0e Merge pull request #387 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-11
Bump EndBug/add-and-commit from 10 to 11
2026-08-26 22:45:27 +05:30
Ranabir ChakrabortyandGitHub f082e8adb1 Merge pull request #374 from RISE-GmbH/369-add_integration_tests_for_keycloak_authentication_v2
369 add integration tests for keycloak_authentication_v2
2026-08-26 22:45:08 +05:30
Ranabir ChakrabortyandGitHub a4cdf1b154 Merge pull request #395 from ansible-middleware/bump/3.0.12
Bump version to 3.0.12
2026-08-24 22:40:30 +05:30
ansible-middleware-core 4112ac7d71 Bump version to 3.0.12 2026-08-24 17:08:25 +00:00
Ranabir ChakrabortyandGitHub a965f47fb8 Merge pull request #394 from ansible-middleware/changelog/3.0.11
Update changelog for release 3.0.11
2026-08-24 22:37:01 +05:30
ansible-middleware-core 15356606f3 Update changelog for release 3.0.11
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-08-24 17:05:40 +00:00
dependabot[bot]andGitHub 8021fd735d Bump ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
Bumps [ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml](https://github.com/ansible-collections/partner-certification-checker) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/ansible-collections/partner-certification-checker/releases)
- [Changelog](https://github.com/ansible-collections/partner-certification-checker/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/ansible-collections/partner-certification-checker/compare/f182febf0568baf1151f66549401167fd10b25d2...f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e)

---
updated-dependencies:
- dependency-name: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml
  dependency-version: 4.1.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-24 12:45:47 +00:00
Ranabir ChakrabortyandGitHub 412f3f405d Merge pull request #389 from hcherukuri/main
Fix cert workflow
2026-08-18 18:39:45 +05:30
Harsha Cherukuri e5f6f92c5d Fix cert workflow 2026-08-18 08:46:50 -04:00
dependabot[bot]andGitHub 3d9c71a2e6 Bump EndBug/add-and-commit from 10 to 11
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 10 to 11.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v10...v11)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '11'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-17 12:46:38 +00:00
Thomas Bargetz 742c44039c 369 add integration tests for keycloak_authentication_v2 2026-08-17 07:40:31 +02:00
Harsha CherukuriandGitHub 9c347d1bf0 Merge pull request #376 from RISE-GmbH/375-increase_number_of_subflow_levels
375 increase maximum of sub levels to 25
2026-08-14 11:28:40 -04:00
Harsha CherukuriandGitHub 6023cff8ca Merge pull request #381 from snecklifter/fix/changelog-sanity-dotfile
Remove changelogs/fragments/.gitignore to fix changelog sanity test
2026-08-13 13:56:27 -04:00
Harsha CherukuriandGitHub fd13175e45 Merge pull request #377 from snecklifter/feat/keycloak-organization-module
Add keycloak_organization and keycloak_organization_info modules
2026-08-13 13:55:33 -04:00
Harsha CherukuriandGitHub c831534a48 Merge pull request #379 from ansible-middleware/dependabot/github_actions/actions/checkout-7
Bump actions/checkout from 2 to 7
2026-08-12 17:53:24 -04:00
Chris BrownandClaude Opus 4.6 192061d1b5 Remove changelogs/fragments/.gitignore to fix changelog sanity test
The changelog sanity test rejects dotfiles in the fragments directory.
The .gitignore was only present to keep the empty directory tracked
by git. The directory is recreated by antsibull-changelog when
fragments are added, so it does not need to exist in the repo.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-12 21:43:02 +01:00
Ranabir ChakrabortyandGitHub bba9d8bb23 Merge pull request #380 from ansible-middleware/dependabot/github_actions/EndBug/add-and-commit-10
Bump EndBug/add-and-commit from 4 to 10
2026-08-12 21:01:55 +05:30
dependabot[bot]andGitHub 7a1dbad76f Bump EndBug/add-and-commit from 4 to 10
Bumps [EndBug/add-and-commit](https://github.com/endbug/add-and-commit) from 4 to 10.
- [Release notes](https://github.com/endbug/add-and-commit/releases)
- [Commits](https://github.com/endbug/add-and-commit/compare/v4...v10)

---
updated-dependencies:
- dependency-name: EndBug/add-and-commit
  dependency-version: '10'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-10 17:05:00 +00:00
dependabot[bot]andGitHub 50e1d93184 Bump actions/checkout from 2 to 7
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-08-10 17:04:56 +00:00
Ranabir ChakrabortyandGitHub 786ef844f8 Merge pull request #378 from hcherukuri/main
Add certification checks to the upstream repo
2026-08-10 22:31:41 +05:30
Harsha Cherukuri 8d44d73394 Add certification checks to the upstream repo
Declare module Python requirement for certification sanity
2026-08-10 10:11:24 -04:00
Chris BrownandClaude Opus 4.6 c8253fdbf8 Add keycloak_organization and keycloak_organization_info modules
Keycloak 26 introduced Organizations as a stable feature for B2B
multi-tenancy within a single realm. This adds declarative Ansible
module support so organizations can be managed like other Keycloak
resources instead of requiring direct REST API calls.

New modules:
- keycloak_organization: CRUD for organizations with full check_mode,
  diff_mode, and idempotency support. Manages name, alias, description,
  enabled state, domains, and attributes.
- keycloak_organization_info: read-only module to list/search
  organizations by name with exact or partial matching.

Also adds 6 API methods to the KeycloakAPI class and comprehensive
Molecule integration tests covering create, idempotency, update,
info queries, attributes, and delete flows.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-07 07:26:58 +01:00
Thomas Bargetz 9abf2e832b 375 increase maximum of sub levels to 10 2026-07-30 12:56:51 +02:00
Harsha CherukuriandGitHub 9e5946a2a4 Merge pull request #373 from RanabirChakraborty/AMW-594
AMW-594 Upstream release is failing due to recent rules change
2026-07-28 13:21:08 -04:00
Ranabir Chakraborty ef2f24e9fc AMW-594 Upstream release is failing due to recent rules change 2026-07-28 21:28:35 +05:30
Harsha CherukuriandGitHub 866c5e2255 Merge pull request #371 from RISE-GmbH/368-avoid_pruning_of_undefined_realm_attributes
368 keycloak_realm: Control whether undefined realm attributes are pruned
2026-07-28 09:10:49 -04:00
Harsha CherukuriandGitHub a0b924b593 Merge pull request #372 from hcherukuri/main
Add community.general.keycloak_realm_users_info into keycloak collection
2026-07-28 08:46:31 -04:00
Thomas Bargetz 95c6fe1b50 386 add integration tests 2026-07-27 11:01:35 +02:00
9bb680b8e6 Update plugins/modules/keycloak_realm_users_info.py
Co-authored-by: Felix Fontein <felix@fontein.de>
2026-07-26 21:02:08 -04:00
Thomas Bargetz 1f0a7c289f 368 introduce the parameter prune_undefined_realm_attributes to control whether undefined realm attributes are pruned 2026-07-24 10:20:17 +02:00
Harsha Cherukuri ff51c4098a Add community.general.keycloak_realm_users_info into keycloak collection 2026-07-23 22:31:32 -04:00
Ranabir ChakrabortyandGitHub f2792e32ba Merge pull request #364 from cihlamar/AMW-299
Fix health check URL to include HTTP relative path
2026-07-22 19:49:44 +05:30
Martin Cihlar 4f62617f2c Fix health check URL to include HTTP relative path
- Include keycloak_quarkus_http_relative_path in health_url construction
- Use rstrip('/') to handle both default '/' and custom paths like '/auth'
- Replace hardcoded 'master' realm with keycloak_quarkus_master_realm variable
- Add keycloak_quarkus_validate_certs option for SSL certificate validation
- Update documentation in meta and README

Fixes #299
2026-07-22 11:24:57 +02:00
Harsha CherukuriandGitHub edb38ebb3d Merge pull request #366 from RanabirChakraborty/AMW-592
AMW-592 AMW Github Actions are failing because of latest molecule
2026-07-20 15:38:03 -04:00
Ranabir Chakraborty d25bf46a6a AMW-592 AMW Github Actions are failing because of latest molecule 2026-07-21 00:27:35 +05:30
Helmut WolfandGitHub 74ca1e05ef Merge pull request #363 from world-direct/fix/no_log-provider-secrets
fix(keycloak_quarkus): avoid leaking maven provider password in logs
2026-07-01 09:38:16 +02:00
Helmut WolfandClaude Opus 4.8 b9181abb24 fix(keycloak_quarkus): avoid leaking maven provider password in logs
The Validate providers / Download custom providers via http / Copy local
providers tasks loop over all providers and print the item (including
maven.password) in cleartext, even for skipped iterations. Add the same
conditional no_log the maven download/copy tasks already use so entries
carrying a secret are censored while url/local providers stay visible.

Refs ansible-middleware/keycloak#362

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-01 09:23:48 +02:00
Helmut WolfandGitHub d4eafe1b30 Merge pull request #361 from world-direct/fix/360
fix: fact renaming regression (store_items), closes #360
2026-06-30 08:35:09 +02:00
Helmut Wolf 19bd41a86a fix: fact renaming regression (store_items), closes #360 2026-06-30 08:15:48 +02:00
ansible-middleware-core b44d754b8c Bump version to 3.0.11 2026-06-25 12:29:55 +00:00
ansible-middleware-core 404d2f6a1b Update changelog for release 3.0.10
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-25 12:29:32 +00:00
Ranabir ChakrabortyandGitHub bfcb125d87 Merge pull request #359 from RanabirChakraborty/vars_fix
Fixing vars naming issue
2026-06-25 13:38:46 +05:30
Ranabir Chakraborty 1164bf008d Fixing vars naming issue 2026-06-25 12:32:49 +05:30
Ranabir ChakrabortyandGitHub f3353d1686 Merge pull request #358 from hcherukuri/main
Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors
2026-06-25 10:38:20 +05:30
Harsha Cherukuri e4c3ec8046 Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors. 2026-06-24 23:19:59 -04:00
Harsha Cherukuri 82022b9031 Replace from __future__ import annotations with the required future-import. 2026-06-24 23:19:59 -04:00
Harsha CherukuriandGitHub 0307985282 Merge pull request #356 from RanabirChakraborty/AMW-571
AMW-571 keycloak_identity_provider hide_on_login_page not working
2026-06-24 23:19:24 -04:00
Harsha CherukuriandGitHub b0d1114684 Merge pull request #357 from RanabirChakraborty/lint_issue_fix
Fixing linting issues
2026-06-24 23:18:59 -04:00
Ranabir Chakraborty 728d5288ec Fixing linting issues 2026-06-25 03:22:25 +05:30
Ranabir Chakraborty eaeedd8d74 AMW-571 keycloak_identity_provider hide_on_login_page not working 2026-06-23 22:43:37 +05:30
Harsha CherukuriandGitHub 86a6bc63bb Merge pull request #354 from RanabirChakraborty/remove_deprecate
Remove deprecated ansible-basic-sphinx-ext
2026-06-23 08:26:40 -04:00
Ranabir Chakraborty d557665dc9 Remove deprecated ansible-basic-sphinx-ext 2026-06-23 14:52:59 +05:30
Harsha CherukuriandGitHub bd82a85dea Merge pull request #353 from RanabirChakraborty/AMW-568
Fix downstream SSO collection errors
2026-06-20 15:43:59 -04:00
Ranabir Chakraborty 1f82f50127 Fix downstream SSO collection errors 2026-06-20 21:14:34 +05:30
Ranabir ChakrabortyandGitHub adf0f7fc36 Merge pull request #352 from RanabirChakraborty/fix_password
Fixing password
2026-06-20 13:02:14 +05:30
Ranabir Chakraborty 0a9e6c66eb Fixing password 2026-06-20 13:01:44 +05:30
ansible-middleware-core da3d5e0ed6 Bump version to 3.0.10 2026-06-11 15:16:22 +00:00
ansible-middleware-core f172e019b4 Update changelog for release 3.0.9
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-11 15:16:05 +00:00
Harsha CherukuriandGitHub e764cfd6f1 Merge pull request #344 from RanabirChakraborty/rhbk_version_fix
AMW-551 Providing correct rhbk version
2026-06-11 09:48:33 -04:00
Ranabir Chakraborty 01b00dfb2e Providing correct rhbk version 2026-06-11 18:58:23 +05:30
Harsha CherukuriandGitHub 1908794569 Merge pull request #349 from felix-grzelka/consistent-naming-of-client-scope
Consistent naming of client scope
2026-06-10 09:07:00 -04:00
Harsha Cherukuri c8bcff39ef Fix keycloak client module 2026-06-10 08:22:52 -04:00
Felix Grzelka 0fad56294b fix typo 2026-06-10 11:14:23 +00:00
ansible-middleware-core b2b52ddfb5 Bump version to 3.0.9 2026-06-09 14:43:40 +00:00
ansible-middleware-core 7369a5724c Update changelog for release 3.0.8
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-09 14:43:23 +00:00
Felix Grzelka 942f0ae896 fix rename payload -> roles 2026-06-09 07:14:32 +00:00
Felix Grzelka 92d6dddd49 rename to role_owner_client_id 2026-06-08 13:21:27 +00:00
Felix Grzelka a1bb84ea5b fix some missed ones 2026-06-08 12:20:32 +00:00
Felix Grzelka 1ec94b961f rename files to match new convention 2026-06-08 12:00:52 +00:00
Felix Grzelka ba3f716e5c fix scope_id etc. 2026-06-08 12:00:52 +00:00
Felix Grzelka 808d137e4c s/clientscope/client_scope/ 2026-06-08 12:00:52 +00:00
Harsha CherukuriandGitHub 1794d4ff9b Merge pull request #348 from felix-grzelka/fix-normalize_keycloak_url
Remove normalize_keycloak_url
2026-06-05 07:40:20 -04:00
Felix Grzelka e898a2511a rm other use of normalize_keycloak_url 2026-06-05 07:29:53 +00:00
Felix Grzelka dd2cfaa87d remove normalize_keycloak_url 2026-06-04 13:20:03 +00:00
Harsha CherukuriandGitHub b114c7b252 Merge pull request #345 from cihlamar/standardize-readme-gitignore-lint
Standardize README and .ansible-lint configuration
2026-06-03 12:42:23 -04:00
Martin Cihlar 9920dc93c9 Standardize README and .ansible-lint configuration
- Update role links in README to full GitHub URLs
- Add profile: production to .ansible-lint for production-level linting
2026-06-03 17:11:56 +02:00
ansible-middleware-core 5cb555d6c2 Bump version to 3.0.8 2026-06-01 14:50:07 +00:00
ansible-middleware-core 3ab0f2b259 Update changelog for release 3.0.7
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-06-01 14:49:51 +00:00
Harsha CherukuriandGitHub 9394e2598f Merge pull request #341 from hcherukuri/main
Migrate Keycloak modules from the community.general collection to Keycloak collection.
2026-06-01 10:23:18 -04:00
Harsha Cherukuri 123906d739 Added PRs #11841 and #11749, and updated version references from community.general to Keycloak. 2026-05-30 09:29:04 -04:00
Harsha Cherukuri bdc090de64 Move community.general keycloak modules into keycloak collection 2026-05-28 13:14:54 -04:00
Ranabir ChakrabortyandGitHub d4a92c9f4f Merge pull request #343 from RanabirChakraborty/common_module_fix
Fixing common module usage
2026-05-28 20:55:21 +05:30
Ranabir Chakraborty 926ea0192d Fixing common module usgae 2026-05-28 20:13:34 +05:30
Ranabir ChakrabortyandGitHub 88c825c997 Merge pull request #342 from RanabirChakraborty/JN_to_UD
Jboss Network replace with Unified Downloads
2026-05-28 18:46:17 +05:30
Ranabir Chakraborty 0e3a9e3741 Jboss Network replace with Unified Downloads 2026-05-28 18:45:36 +05:30
Harsha CherukuriandGitHub 7495385ccb Merge pull request #338 from world-direct/fix/336_downloads
fix #336: https://github.com/ansible-middleware/common/pull/38
2026-05-27 14:44:14 -04:00
Helmut Wolf 494a522ab2 fix #336: https://github.com/ansible-middleware/common/pull/38 2026-05-27 20:03:36 +02:00
Ranabir ChakrabortyandGitHub 64e7fa3129 Merge pull request #339 from hcherukuri/main
Fix molecule tests
2026-05-27 21:06:37 +05:30
Harsha Cherukuri 15a0c6ee46 Fix molecule tests 2026-05-27 11:10:41 -04:00
ansible-middleware-core e4d1a79d1f Bump version to 3.0.7 2026-05-26 17:30:50 +00:00
ansible-middleware-core f4588dbbdf Update changelog for release 3.0.6
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-05-26 17:30:30 +00:00
Ranabir ChakrabortyandGitHub a9a771c6bc Merge pull request #337 from RanabirChakraborty/AMW-540
AMW-540 Fix the upstream collection requirements with common v1.2.4
2026-05-26 22:37:54 +05:30
Ranabir Chakraborty f00c714798 AMW-540 Fix the upstream collection requirements with common v1.2.4 2026-05-26 21:58:05 +05:30
Harsha CherukuriandGitHub 50750ef125 Update requirements.yml 2026-05-26 12:28:04 -04:00
ansible-middleware-core b631b07cae Bump version to 3.0.6 2026-05-20 18:44:49 +00:00
ansible-middleware-core 195e104f5e Update changelog for release 3.0.5
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-05-20 18:44:31 +00:00
Ranabir ChakrabortyandGitHub 047ddcaa92 Merge pull request #335 from RanabirChakraborty/AMW-528
AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables
2026-05-21 00:09:58 +05:30
Ranabir Chakraborty 0b2f2786dd AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables 2026-05-20 23:51:34 +05:30
ansible-middleware-core 4cc360052e Bump version to 3.0.5 2026-05-20 13:38:22 +00:00
ansible-middleware-core c6e3337778 Update changelog for release 3.0.4
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2026-05-20 13:38:01 +00:00
Harsha CherukuriandGitHub d1b295f551 Merge pull request #332 from cihlamar/AMW-522
Fix certification requirements for Keycloak
2026-05-20 09:36:11 -04:00
Martin Cihlar 5e13f4ea50 Fix certification requirements for Keycloak
- Add .ansible-lint, .DS_Store to build_ignore in galaxy.yml
- Add Release and Upgrade Notes section to README

[AMW-522](https://redhat.atlassian.net/browse/AMW-522)
2026-05-20 11:00:58 +02:00
Harsha CherukuriandGitHub 06cf664b08 Merge pull request #331 from RanabirChakraborty/SET-1341
SET-1341 Without ansible-core tag tests are failing in keycloak
2026-04-30 03:33:48 -04:00
Ranabir Chakraborty e5690d7513 SET-1341 Without ansible-core tag tests are failing in keycloak 2026-04-28 22:15:14 +05:30
Ranabir ChakrabortyandGitHub fb76736441 Merge pull request #330 from nwintering/main
Check that `data/tmp` directory has correct ownership
2026-04-28 18:24:19 +05:30
nwintering 6d00dcff48 check that tmp directory has correct permissions 2026-04-27 15:35:03 +02:00
Harsha Cherukuri eaf9964aab Fix docs pipeline 2026-04-24 10:50:10 -04:00
Harsha CherukuriandGitHub 180f075a9f Merge pull request #324 from RanabirChakraborty/AMW-518
AMW-518 Validating arguments against arg spec 'main' fails unexpectedly.
2026-04-24 10:34:55 -04:00
Harsha CherukuriandGitHub 1013a05f8c Merge pull request #328 from hcherukuri/main
Fix sanity and molecule tests
2026-04-24 10:26:26 -04:00
Harsha Cherukuri 22f1ce516d Fix sanity and molecule tests 2026-04-24 10:07:24 -04:00
Harsha CherukuriandGitHub 7be872cc48 Merge pull request #326 from paulomenon/add/example-playbooks-client-scope-auth-flow
Add/example playbooks client scope auth flow
2026-04-24 08:29:16 -04:00
Harsha CherukuriandGitHub 55248de9ae Merge pull request #325 from paulomenon/fix/keycloak-context-default
Fix keycloak_context default from /auth to empty string for Quarkus-based Keycloak
2026-04-24 08:29:00 -04:00
Harsha CherukuriandGitHub c6d4dfb8bb Merge pull request #327 from hcherukuri/main
Fix CI
2026-04-24 08:16:25 -04:00
Harsha Cherukuri c8f4065eb5 Fix CI 2026-04-24 08:00:45 -04:00
pamenon 06e096ac50 Add module documentation to collection and role READMEs
Document all six modules (including the two new ones) in the main
collection README under a new 'Included modules' section. Add the
three new example playbooks to the Config Playbooks section. Update
the keycloak_realm role README with a 'Related Modules' table and
inline examples for keycloak_client_scope and
keycloak_authentication_flow usage.

Made-with: Cursor
2026-04-23 12:54:22 +01:00
pamenon c6189bfc51 Add keycloak_client_scope and keycloak_authentication_flow modules with example playbooks
The collection was missing modules for managing client scopes and
authentication flows, forcing users to write raw uri calls against
the Keycloak Admin REST API. This adds two new modules that leverage
the existing KeycloakAPI helper methods:

- keycloak_client_scope: create/update/delete client scopes with
  protocol mappers (supports check_mode and diff)
- keycloak_authentication_flow: create/delete authentication flows
  with execution steps, or copy existing flows (supports check_mode
  and diff)

Also adds three example playbooks using the new modules:
- keycloak_client_scope.yml
- keycloak_authentication_flow.yml
- keycloak_realm_client.yml

Made-with: Cursor
2026-04-23 12:53:03 +01:00
pamenon 03fffaaf5f Fix keycloak_context default from /auth to empty string
The /auth context path was used by legacy WildFly-based Keycloak but
is no longer needed for Quarkus-based Keycloak (17+) or RHBK. The
current default of /auth forces users to explicitly pass an empty
keycloak_context to avoid broken API URLs.

This changes the default to an empty string, updates argument_specs
and README documentation, and removes the now-unnecessary
keycloak_context: '' overrides from all molecule converge files.

Users on legacy WildFly-based Keycloak can still set
keycloak_context: /auth explicitly.

Made-with: Cursor
2026-04-23 12:25:03 +01:00
Ranabir Chakraborty a337a1d70c AMW-518 Validating arguments against arg spec 'main' fails unexpectedly. 2026-04-17 19:24:46 +05:30
Ranabir ChakrabortyandGitHub 28168a9a4f Merge pull request #307 from sgoericke/fix-client-id
manage_client_roles.yml: use "client.id" instead of "client.name" to fix client role creation.
2026-04-09 23:37:31 +05:30
Helmut WolfandGitHub 64469b6fac Merge pull request #320 from world-direct/fix/ispn_config
fix: include ispn config file conditionally
2026-01-15 08:05:26 +01:00
Ranabir ChakrabortyandGitHub 75e308b710 Merge pull request #321 from RanabirChakraborty/AMW-467
AMW-467 Download keycloak binary from password protected HTTP location
2026-01-14 21:59:45 +05:30
Ranabir Chakraborty 9cdf24ce28 AMW-467 Download keycloak binary from password protected HTTP location 2026-01-13 23:48:01 +05:30
Helmut Wolf a00a602c3c fix: include ispn config file conditionally 2026-01-13 10:17:04 +01:00
Ranabir ChakrabortyandGitHub a5a75c6d46 Merge pull request #317 from SLedunois/main
v26.4.x compability
2026-01-12 23:34:28 +05:30
Helmut WolfandSimon Ledunois 7212e572cd chore(defaults): raise default keycloak/rhbk versions to 26.4.7 2026-01-12 10:28:47 +01:00
Helmut WolfandSimon Ledunois bc669ce0cd chore(deps): Update default SQL driver versions
As per https://access.redhat.com/articles/7027683
2026-01-12 10:28:47 +01:00
Simon LEDUNOIS 3c097ebf09 chore: add molecule test for quarkus ha 26.4- 2026-01-12 10:28:47 +01:00
Simon Ledunois 9562bf727e chore: manage infinispan configuration file 2026-01-12 10:28:47 +01:00
Simon Ledunois 6c3e327294 chore: upgrade to 26.4.7 2026-01-12 10:28:47 +01:00
Ranabir ChakrabortyandGitHub be0c8a4ae3 Merge pull request #319 from RanabirChakraborty/fixing-lint
Removing parseable from lint file as Additional properties are not allowed
2026-01-09 22:16:00 +05:30
Ranabir Chakraborty 6bf10cc3e9 Removing parseable from lint file as Additional properties are not allowed 2026-01-09 22:14:03 +05:30
ansible-middleware-core d0161dbeef Bump version to 3.0.4 2025-12-16 15:53:14 +00:00
ansible-middleware-core bf5c805fcd Update changelog for release 3.0.3
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-12-16 15:52:59 +00:00
Ranabir ChakrabortyandGitHub 2b1c07d87e Merge pull request #306 from fxwgr/patch0
Declared proxy_mode as deprecated, updated quarkus and realm readme
2025-12-16 20:08:58 +05:30
Andreas Wagner f1305e5aac Updated quarkus and realm readme, declared proxy_mode as deprecated
Updated argument_specs and declared keycloak_quarkus_proxy_mode as deprecated
2025-11-14 11:55:24 +01:00
Ranabir ChakrabortyandGitHub 412e17e9ea Merge pull request #312 from RanabirChakraborty/ci_label_fix
keycloak collection CI label is showing no status
2025-10-04 20:46:52 +05:30
Ranabir Chakraborty fa87c004e3 keycloak collection CI label is showing no status 2025-10-04 20:19:09 +05:30
Ranabir ChakrabortyandGitHub 6c9bddbd61 Merge pull request #308 from tinsjourney/fix_config_key_store_password
Fix config_key_store_file description to match variable name
2025-09-25 21:47:46 +05:30
Ranabir ChakrabortyandGitHub 4602d254cf Merge pull request #310 from world-direct/fix/309
ansible-core 2.19 compatibility
2025-09-18 18:58:54 +05:30
Helmut Wolf 8b2ef22023 fix ansible-core v2.19.0: initialize keycloak_quarkus_hostname_admin to an empty string 2025-07-22 12:11:09 +02:00
Helmut Wolf 66228c3a13 ansible 2.19.0: fix error
'item' is undefined error, https://github.com/ansible-middleware/keycloak/issues/309#issuecomment-3101960407
2025-07-22 12:09:14 +02:00
Stephane Vigan 556d155533 Fix config_key_store_file description to match variable name 2025-07-21 16:15:59 +02:00
Sven Goericke 07063353b8 fixed wrong variable lookup 2025-07-16 13:50:07 +02:00
Guido GrazioliandGitHub c1bf9727f9 Merge pull request #293 from world-direct/fix/292
Update to keycloak 26.3.0
2025-07-09 11:38:56 +02:00
Helmut Wolf f79fd227eb chore: bump KC/RHBK to v26.3.0/v26.2.5 2025-07-07 11:09:35 +02:00
Helmut Wolf 19564987ca fix(quarkus): update infinispan-client configuration to include port in server-list and hosts 2025-07-07 11:05:44 +02:00
Helmut Wolf 1ff25325a7 fix(ispn): use legacy JGroups stack configuration for < 26.2 only 2025-07-07 11:05:44 +02:00
Guido GrazioliandGitHub 0099f1cf07 Merge pull request #303 from fxwgr/main
Allow to install provider jars from remote paths
2025-07-04 12:47:10 +02:00
Guido GrazioliandGitHub 725ec8e37b Merge pull request #304 from SLedunois/client_secret
keycloak_realm: allow secret in keycloak_clients
2025-07-04 12:46:40 +02:00
Andreas Wagner bbe568baa5 Added support for copy remote_src function for providers 2025-07-02 16:39:49 +02:00
LEDUNOIS Simon dcd448443f feat: allow secret in keycloak_clients 2025-07-02 14:36:25 +00:00
ansible-middleware-core 3780a4e3c0 Bump version to 3.0.3 2025-07-01 16:56:26 +00:00
ansible-middleware-core e60a5b7cf6 Update changelog for release 3.0.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-07-01 16:56:10 +00:00
Guido GrazioliandGitHub 6143ae25e2 Merge pull request #296 from RanabirChakraborty/keycloak_force_install_quarkus_role
Fix `keycloak_quarkus_force_install` parameter being ignored by install
2025-07-01 18:45:34 +02:00
Ranabir Chakraborty ef6d8890fb keycloak_quarkus_force_install does not ignore bootstrapped 2025-07-01 21:55:39 +05:30
Guido GrazioliandGitHub 55185a1439 Merge pull request #302 from tinsjourney/fix_federation_provider_type
keycloak_realm: federation default provider type should be a string
2025-07-01 17:50:34 +02:00
Guido GrazioliandGitHub bb64b97e43 Merge pull request #298 from tinsjourney/alternate_download_fix
Fix alternate download location being ignored (JBossNeworkAPI always used)
2025-07-01 16:10:35 +02:00
Stephane Vigan a9c9e05569 Default provider type should be a string 2025-07-01 10:27:00 +02:00
Stephane Vigan 8b27cb0706 Fix case where archive is always downalod from JBoss Nework API
Even is we set keycloak_quarkus_alternate_download_url
previous block was run and we always try to download
archive from JBoss Network Api.
2025-06-26 10:42:25 +02:00
Guido GrazioliandGitHub 41127504dc Merge pull request #287 from guidograzioli/kc_26_caches
Session storage / distributed caches
2025-06-13 11:43:00 +02:00
Guido Grazioli bcc961999c implement Single site - Sessions stored in external Infinispan 2025-06-05 12:02:43 +02:00
Guido GrazioliandGitHub b8907d765d Merge pull request #289 from guidograzioli/288_jdk_21
Use jdk21 as default in debian
2025-06-05 09:30:26 +02:00
Guido Grazioli 5c5e84b63e Use jdk21 as default in debian 2025-06-04 20:53:28 +02:00
Guido Grazioli 3d4bd734f1 document new parameters 2025-05-29 22:20:08 +02:00
Guido Grazioli 3de96a6666 single site remote cache 2025-05-29 21:37:11 +02:00
Guido Grazioli de0ea02272 ci: move intermittent test back 2025-05-29 21:03:03 +02:00
Guido GrazioliandGitHub b6e585f503 Merge pull request #284 from guidograzioli/caches
Refactor test scenarios
2025-05-29 20:45:37 +02:00
Guido Grazioli 18de37706f tune Xmx Xms jvm args 2025-05-29 20:37:39 +02:00
Guido Grazioli b569e4e713 update remote cache test 2025-05-29 20:14:04 +02:00
Guido GrazioliandGitHub 919d55f806 Merge pull request #286 from RanabirChakraborty/AMW-398
Use tags to decorate the role workflow
2025-05-27 11:12:07 +02:00
Guido Grazioli 476bc0ec0b update test config 2025-05-23 14:59:50 +02:00
Helmut WolfandGitHub 2954bf81e8 Merge pull request #285 from world-direct/fix/keycloak_config_rebuild
Run config rebuild after SPI providers update
2025-05-21 09:26:07 +02:00
Ranabir Chakraborty 0403939c03 AMW-398 Use tags to decorate the role workflow 2025-05-20 21:40:32 +05:30
Helmut Wolf 88e4ea8d99 fix: MVN provider invokes KC config rebuild 2025-05-20 13:53:56 +02:00
Guido Grazioli 0a5fc3ae25 restructure molecule tests 2025-05-20 10:35:01 +02:00
Guido GrazioliandGitHub f4a1798f26 Merge pull request #283 from world-direct/feature/282
RHBK v26.2 (#282)
2025-05-19 18:37:01 +02:00
Helmut Wolf d23ae39c25 chore(molecule): RHBK v26.2 (#282) 2025-05-19 14:44:34 +02:00
Helmut Wolf 8f95bcb9e6 feat(HA): Change default ispn discovery mechanism to JDBCPING as per v26.2.* (#282) 2025-05-19 14:44:34 +02:00
Helmut Wolf f8c75de5d5 chore: RHBK v26.2: Bump KC version to v26.2.4 2025-05-19 14:44:34 +02:00
Helmut Wolf 8093b1af2a chore: RHBK v26.2: Bump RHBK version to v26.2.4 2025-05-19 14:12:22 +02:00
Helmut Wolf a70aece0d9 chore: RHBK v26.2: Update recommended JDBC driver versions 2025-05-19 14:12:22 +02:00
Guido GrazioliandGitHub d427a6b721 Merge pull request #281 from jonathanspw/keycloak_quarkus_jgroups_ip
New parameter to set the jgroups host IP address
2025-05-13 19:04:56 +02:00
Jonathan Wright c614af127e Add var to set the jgroups IP per host
This is useful if the default route does not
represent the network you want/need to use for
cluster communication.
2025-05-13 09:48:46 -05:00
Guido Grazioli 0936d415c7 ci: update test linking removed url 2025-05-09 15:20:57 +02:00
Guido GrazioliandGitHub a120b1c9b5 Merge pull request #280 from world-direct/feature/279_provider_checksums
New `checksum` property for keycloak_quarkus_providers
2025-05-06 17:49:41 +02:00
Helmut Wolf 5cd400b053 feat: introduce checksum for keycloak_quarkus_providers (#279) 2025-05-06 15:16:50 +02:00
ansible-middleware-core e0c4b1e1ff Bump version to 3.0.2 2025-05-02 09:49:08 +00:00
ansible-middleware-core 88be789260 Update changelog for release 3.0.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-05-02 09:48:54 +00:00
Guido GrazioliandGitHub 868dac4f72 Merge pull request #277 from guidograzioli/26_0_11_update
Version update to 26.0.8 / rhbk 26.0.11
2025-05-02 11:42:01 +02:00
Guido Grazioli c45f7c0d60 Update remote cache default 2025-05-02 11:33:28 +02:00
Guido GrazioliandGitHub 77c5b893b1 Merge pull request #276 from guidograzioli/275_envvars_handler
Trigger rebuild handler on envvars file change
2025-05-02 11:25:27 +02:00
Guido Grazioli 9974ab2ee1 update molecule scenario 2025-05-02 11:18:57 +02:00
Guido Grazioli b8a2ebc699 update keycloak version 2025-05-02 10:55:17 +02:00
Guido Grazioli 5beb5dcda4 Add trigger on envvars file change 2025-05-02 10:50:01 +02:00
ansible-middleware-core d97044523d Bump version to 3.0.1 2025-04-23 11:47:54 +00:00
ansible-middleware-core 2abc580041 Update changelog for release 3.0.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2025-04-23 11:47:38 +00:00
Guido GrazioliandGitHub 2379e10091 Merge pull request #274 from guidograzioli/273_extra_envvars_rebuild
Load environment vars during kc rebuild
2025-04-23 10:47:36 +02:00
Guido Grazioli c86dff66ba double quote sysconfig envvars 2025-04-22 20:18:48 +02:00
Guido Grazioli f750e93d02 Add bash to preinstalled packages 2025-04-22 14:51:15 +02:00
Guido Grazioli 1a4590b0b8 Load envvars in kc rebuild 2025-04-18 17:59:16 +02:00
Guido GrazioliandGitHub 5e9535c866 Merge pull request #271 from guidograzioli/honor_http_host_setting
Rename and honour parameter `keycloak_quarkus_http_host`
2025-04-18 09:11:11 +02:00
Guido Grazioli b8028d376a Rename and honor parameter keycloak_quarkus_http_host 2025-04-16 14:16:07 +02:00
Guido GrazioliandGitHub 20797e4cad Merge pull request #270 from guidograzioli/jdbc_params_rename
Rename parameters to follow upstream
2025-04-16 13:55:19 +02:00
Guido Grazioli 70d61ce8de rename ispn parameters 2025-04-16 11:58:04 +02:00
Guido Grazioli 69a947c0b6 rename _admin to _hostname_admin 2025-04-16 11:34:12 +02:00
Guido Grazioli c7ce7be6c4 drop ajp port parameter 2025-04-16 10:42:07 +02:00
Guido Grazioli e9061b29ef Rename parameters from jdbc to db 2025-04-16 10:31:48 +02:00
Guido GrazioliandGitHub c92bf19720 Merge pull request #269 from Preskton/patch-1
Update example playbooks to use new `bootstrap` var
2025-04-14 12:52:51 +02:00
Guido GrazioliandGitHub 1ca0b30a81 Merge pull request #268 from RanabirChakraborty/AMW-384
keycloak_realm: change url variables to defaults
2025-04-14 10:49:01 +02:00
Preston DosterandGitHub 7738e0feb1 Update keycloak_quarkus_dev.yml 2025-04-13 10:18:27 -05:00
Preston DosterandGitHub 671cf4eb53 Updating example playbooks to use bootstrap admin password
It looks like the underlying `quarkus` provider has changed to use `keycloak_quarkus_bootstrap_admin_password`.
2025-04-13 10:17:22 -05:00
Ranabir Chakraborty f146eb5fda AMW-384 Keycloak realm variable keycloak_url with hard-coded http 2025-04-11 21:49:01 +05:30
Guido GrazioliandGitHub a10bc95bfc Merge pull request #266 from guidograzioli/major_bump_3
Bump major and ansible-core versions
2025-04-09 20:28:52 +02:00
Guido Grazioli 314e2f26b2 Fix spell in parameter name 2025-04-09 18:08:18 +02:00
Guido Grazioli f628b84fb0 disable restart health check because of selfsigned cert 2025-04-09 17:21:49 +02:00
Guido Grazioli ac0ceca35f Update to ubi9 2025-04-09 09:45:22 +02:00
Guido Grazioli 744766fe3b update doc generation to 2.16 2025-04-08 15:36:38 +02:00
Guido Grazioli 7f980c44d2 Bump major and ansible-core versions 2025-04-08 11:58:47 +02:00
Guido GrazioliandGitHub 532dc12a60 Merge pull request #254 from world-direct/feature/253_rhbk_v26
Role support for keycloak/RHBK v26
2025-04-08 11:47:35 +02:00
Guido GrazioliandGitHub 173a85638f Merge pull request #257 from NilsDeckert/main
Skip certificate checking
2025-04-01 15:27:39 +02:00
Guido GrazioliandGitHub 81f019f8b5 Merge pull request #264 from guidograzioli/linter_reserved_words
Variables names must not be Ansible reserved names
2025-04-01 15:25:10 +02:00
Guido Grazioli 5db96afa56 Variables names must not be Ansible reserved names 2025-04-01 15:20:37 +02:00
Helmut Wolf fa36721207 Improve string interpolation 2025-01-20 09:44:27 +01:00
Helmut Wolf 86284b12c2 Fix molecule tests 2025-01-09 12:17:07 +01:00
Nils Deckert b3e93dd89b Skip certificate checking 2024-12-20 17:21:49 +01:00
Helmut Wolf e029e1c2fd keycloak_quarkus: Introduce keycloak_quarkus_health_check_url 2024-12-13 12:12:02 +01:00
Helmut Wolf d0f19b59dc keycloak_quarkus: Add http_management_port and http_management_relative_path options
RHBK v26 exposes health endpoints and metrics on this port moving forward.
Note that the scheme of the MGMT interface is defined by the overall keycloak configuration: if https is enabled and configured, th MGMT interface is exposed via https and NOT via http; this might be breaking some configured load balancer health checks
2024-12-13 12:11:35 +01:00
Helmut Wolf 213449ec58 RHBK v26: Add hostname v2 (KC/RHBK v26 Support #253)
Cf. https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/upgrading_guide/index#new_hostname_options - especially the removed options
2024-12-13 12:11:35 +01:00
Helmut Wolf 277e1336ee RHBK v26: Migrate to keycloak_quarkus_bootstrap_admin_user[_password] (Process for creation of admin account changed #248) 2024-12-13 12:11:35 +01:00
Helmut Wolf 58233549a7 keycloak.conf: Remove config-keystore-type (KC/RHBK v26 Support #253)
Cf. <https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/upgrading_guide/index#keystore_and_trust_store_default_format_change>
2024-12-13 12:11:35 +01:00
Helmut Wolf 0c58ae48ff RHBK v26: Update ispn session usages (KC/RHBK v26 Support #253)
Cf. <https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/upgrading_guide/index#restricting_the_size_of_session_caches>
2024-12-13 12:11:35 +01:00
Helmut Wolf bf0bd9e1da RHBK v26: Update mssqj jdbc driver (KC/RHBK v26 Support #253)
As per <https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/26.0/html-single/server_configuration_guide/index#db-installing-the-microsoft-sql-server-driver>
2024-12-13 12:11:35 +01:00
Helmut Wolf 5d15d37890 RHBK v26: Raise default KC+RHBK versions to v26.x (#253) 2024-12-13 12:11:35 +01:00
Guido GrazioliandGitHub 910a2aa5d4 Merge pull request #252 from world-direct/feature/cache_buster
Add theme cache invalidation handler
2024-12-12 09:36:18 +01:00
Helmut Wolf 5f534ca566 keycloak_quarkus: Add theme cache invalidation handler 2024-12-12 09:05:09 +01:00
Guido GrazioliandGitHub 692fb59797 Merge pull request #251 from RanabirChakraborty/increase_access_token_lifespan
Access token lifespan is too short for ansible run
2024-12-11 16:19:13 +01:00
Ranabir Chakraborty d1859aaff2 Access token lifespan is too short for ansible run 2024-12-03 22:40:25 +05:30
Guido GrazioliandGitHub 0d0e52f9ff Merge pull request #250 from world-direct/feature/249
Rebuild config and restart service for local providers
2024-11-25 08:40:54 +01:00
Helmut Wolf 68a0f88423 keycloak_quarkus: Rebuild config and restart service for local providers (#249) 2024-11-22 08:08:09 +01:00
ansible-middleware-core 333d55ad73 Bump version to 2.4.4 2024-10-16 07:24:57 +00:00
ansible-middleware-core f6fdae4aa8 Update changelog for release 2.4.3
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-10-16 07:24:42 +00:00
Guido GrazioliandGitHub b8c11f3ca8 Merge pull request #241 from guidograzioli/update_24_0_5
Update keycloak to 24.0.5
2024-10-16 09:02:43 +02:00
Guido Grazioli 1279937bb0 Update keycloak to 24.0.5 2024-10-16 08:56:53 +02:00
Guido GrazioliandGitHub c57753f608 Merge pull request #240 from guidograzioli/update_modules
update keycloak modules
2024-10-14 15:12:44 +02:00
Guido Grazioli be19ec1289 update tests 2024-10-14 14:36:58 +02:00
Guido Grazioli 5f1b43f37b update docs 2024-10-14 10:34:20 +02:00
Guido Grazioli c6bb815979 update keycloak modules 2024-10-14 10:22:10 +02:00
ansible-middleware-core ac4511bea9 Bump version to 2.4.3 2024-09-26 08:52:17 +00:00
ansible-middleware-core c8021f3102 Update changelog for release 2.4.2
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-09-26 08:52:04 +00:00
Guido GrazioliandGitHub 0386254073 Merge pull request #239 from guidograzioli/238_controller_download_path
New parameter `keycloak_quarkus_download_path`
2024-09-26 10:35:18 +02:00
Guido Grazioli b2edea8777 linter 2024-09-26 10:22:54 +02:00
Guido Grazioli fc0ee5a896 refactor default test for keycloak-quarkus offline 2024-09-26 10:22:42 +02:00
Guido Grazioli eb66d4a412 update prereqs validation 2024-09-26 10:22:28 +02:00
Guido Grazioli f170257205 Add local download path 2024-09-24 09:21:10 +02:00
Guido GrazioliandGitHub 3f4617c32c Merge pull request #237 from guidograzioli/236_waitfor_port_number
Add wait_for_port number parameter
2024-07-31 17:30:35 +02:00
Guido Grazioli 34caf6a490 add wait_for_port number parameter 2024-07-31 17:18:30 +02:00
Guido GrazioliandGitHub fa6ac99b34 Merge pull request #235 from guidograzioli/keycloak_realm_test
add verify steps for quarkus/keycloak_realm
2024-07-31 15:04:35 +02:00
Guido Grazioli a35c963a65 add verify steps for quarkus/keycloak_realm 2024-07-18 13:01:01 +02:00
Guido Grazioli 11aab0f5e2 add verify steps for quarkus/keycloak_realm 2024-07-18 12:53:49 +02:00
ansible-middleware-core fa2319d5da Bump version to 2.4.2 2024-07-02 14:23:53 +00:00
ansible-middleware-core 7c520dcdd2 Update changelog for release 2.4.1
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-07-02 14:23:37 +00:00
Guido Grazioli 35b3b090f6 ci: update READMEs 2024-07-02 15:59:16 +02:00
Guido Grazioli 94f1b8b355 ci: update README 2024-07-02 15:46:05 +02:00
Guido Grazioli e40f554936 ci: add traffic wf 2024-06-27 11:02:32 +02:00
Guido Grazioli 64e2a95685 ci: add traffic wf 2024-06-27 11:01:38 +02:00
Guido Grazioli c6fac7bb70 ci: add traffic wf 2024-06-27 11:00:29 +02:00
ansible-middleware-core 5f059e8d63 Bump version to 2.4.1 2024-06-04 15:44:35 +00:00
ansible-middleware-core e927ddbb6c Update changelog for release 2.4.0
Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
2024-06-04 15:44:20 +00:00
Guido Grazioli a82bdfbbb6 Bump to 2.4.0 2024-06-04 17:36:20 +02:00
Guido GrazioliandGitHub c850484e67 Merge pull request #234 from gionn/fix-restart-health-check-default
Enable by default health check on restart
2024-06-04 17:25:52 +02:00
Giovanni Toraldo a4deaa005a Enable by default health check on restart 2024-06-04 17:00:11 +02:00
Guido Grazioli 4fb44091d6 ci: fix missing symlink 2024-05-30 08:44:04 +02:00
Guido GrazioliandGitHub 883127d280 Merge pull request #232 from guidograzioli/linter_ansible_215
Update minimum ansible-core version > 2.15
2024-05-22 10:04:41 +02:00
Guido Grazioli e69e5b7ba4 readme 2024-05-21 12:41:31 +02:00
Guido Grazioli bf1871182b linter 2024-05-21 12:35:33 +02:00
Guido Grazioli adfee5f6e1 ci 2024-05-21 12:34:11 +02:00
Guido Grazioli ef53ca545a update yamllint 2024-05-21 12:31:40 +02:00
Guido Grazioli 2092c2d23a Update minimum ansible-core version > 2.15 2024-05-21 12:27:45 +02:00
ansible-middleware-core 8ca73364e9 Bump version to 2.3.1 2024-05-20 10:22:09 +00:00
274 changed files with 32620 additions and 3728 deletions
+4 -3
View File
@@ -1,4 +1,6 @@
# .ansible-lint
profile: production
exclude_paths:
- .cache/
- .github/
@@ -30,12 +32,11 @@ warn_list:
- schema[meta]
- key-order[task]
- blocked_modules
- run-once[task]
skip_list:
- vars_should_not_be_used
- file_is_small_enough
- name[template]
- var-naming[no-role-prefix]
- file_has_valid_name
use_default_rules: true
parseable: true
+104
View File
@@ -0,0 +1,104 @@
# Keycloak / Ansible domain-specific words
# Only terms NOT covered by built-in dictionaries
# Product names and projects
Infinispan
infinispan
Wildfly
wildfly
keycloak
# Red Hat product names
RHBK
rhbk
rhsso
# Java / JBoss terms
Djboss
Djgroups
Dsun
ispn
ISPN
jaegertracing
jaxrs
jberet
JDBCPING
jgroups
JGROUPSPING
jndi
keytool
MPING
NAKACK
passivation
passivating
slsb
sfsb
TCPPING
tcpping
jdbcx
cacerts
changeit
# Systemd directives
restartsec
runas
startlimitburst
systemdunit
# Ansible terms
fqcn
FQCN
# WildFly / JBoss terms
jbcs
modcluster
# Linux / System terms
firewalld
cgroupns
zgrep
# Configuration terms
xforwarded
PYTHONHTTPSVERIFY
# Keycloak-specific
ciba
clusterless
eddsa
multivalued
remembertochangeme
subcomponent
subcomponents
# Molecule / Testing
hspaans
# CI / DevOps
sangonzal
rootperm
# RST / Sphinx directives
toctree
# Task names / verbs
Reown
decomment
# British spellings (from upstream Keycloak docs)
recognises
# Integration test container/variable names
Ceciestes
myidpfromurl
myidprealm
myfed
myldap
rootgrp
subgrp
subsubgrp
subsubsubgrp
Untestes
# Other
rmaster
+8
View File
@@ -0,0 +1,8 @@
---
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
# Weekly keeps Actions dependency PRs current without daily CI load.
interval: weekly
+25
View File
@@ -0,0 +1,25 @@
---
# Partner Certification Checker workflow for Automation Hub requirements.
# See: https://github.com/ansible-collections/partner-certification-checker
name: Run collection certification checks
permissions:
contents: read
on:
pull_request:
branches: [main]
concurrency:
group: cert-ver-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
# Files that are not related to the core functionality of your collection can
# cause Ansible Lint to fail. If this happens, add an .ansible-lint file that
# excludes those paths. See .ansible-lint in this repository.
#
# If there are sanity test failures that cannot be fixed, create a sanity ignore
# file for each affected ansible-core version (for example, tests/sanity/ignore-2.18.txt).
jobs:
call:
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@fefb6b967e99964b55665b66ef0d8e4148d84aca # v5.0.0
+21 -2
View File
@@ -5,14 +5,33 @@ on:
branches:
- main
pull_request:
workflow_dispatch:
inputs:
debug_verbosity:
description: 'ANSIBLE_VERBOSITY envvar value'
required: false
schedule:
- cron: '15 6 * * *'
jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v7
- name: Run cspell
uses: streetsidesoftware/cspell-action@v9
with:
incremental_files_only: false
use_cspell_files: true
ci:
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@main
uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
secrets: inherit
with:
fqcn: 'middleware_automation/keycloak'
root_permission_varname: 'keycloak_install_requires_become'
debug_verbosity: "${{ github.event.inputs.debug_verbosity }}"
molecule_tests: >-
[ "default", "overridexml", "https_revproxy", "quarkus", "quarkus-devmode", "quarkus_upgrade", "debian", "quarkus_ha" ]
[ "debian", "sso_test", "quarkus", "quarkus_ha", "quarkus_ha_remote", "quarkus_ha_26.4_below", "default", "quarkus_devmode", "quarkus_upgrade", "keycloak_modules", "quarkus_relpath", "quarkus_nohost" ]
+31
View File
@@ -0,0 +1,31 @@
---
name: Publish collection
on:
workflow_dispatch:
jobs:
publish:
uses: ansible-middleware/github-actions/.github/workflows/publish.yml@main
with:
collection_fqcn: 'middleware_automation.keycloak'
downstream_name: 'rhbk'
secrets:
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
push_token: ${{ secrets.TRIGGERING_PAT }}
dispatch:
needs: publish
if: needs.publish.result == 'success'
strategy:
matrix:
repo: ['ansible-middleware/ansible-middleware-ee']
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@v4
with:
token: ${{ secrets.TRIGGERING_PAT }}
repository: ${{ matrix.repo }}
event-type: "Dependency released - Keycloak v${{ needs.publish.outputs.tag_version }}"
client-payload: '{ "github": ${{toJson(github)}} }'
+1 -15
View File
@@ -17,18 +17,4 @@ jobs:
secrets:
galaxy_token: ${{ secrets.ANSIBLE_GALAXY_API_KEY }}
jira_webhook: ${{ secrets.JIRA_WEBHOOK_CREATE_VERSION }}
dispatch:
needs: release
strategy:
matrix:
repo: ['ansible-middleware/ansible-middleware-ee']
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.TRIGGERING_PAT }}
repository: ${{ matrix.repo }}
event-type: "Dependency released - Keycloak v${{ needs.release.outputs.tag_version }}"
client-payload: '{ "github": ${{toJson(github)}} }'
push_token: ${{ secrets.TRIGGERING_PAT }}
+26
View File
@@ -0,0 +1,26 @@
name: Collect traffic stats
on:
schedule:
- cron: "51 23 * * 0"
workflow_dispatch:
jobs:
traffic:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
ref: "gh-pages"
- name: GitHub traffic
uses: sangonzal/repository-traffic-action@v.0.1.6
env:
TRAFFIC_ACTION_TOKEN: ${{ secrets.TRIGGERING_PAT }}
- name: Commit changes
uses: EndBug/add-and-commit@v11
with:
author_name: Ansible Middleware
message: "GitHub traffic"
add: "./traffic/*"
ref: "gh-pages"
+5
View File
@@ -11,5 +11,10 @@ docs/_build/
.mypy_cache/
*.retry
changelogs/.plugin-cache.yaml
changelogs/fragments/*.yaml
changelogs/fragments/*.yml
*.pem
*.key
*.p12
.ansible/
+7 -2
View File
@@ -15,7 +15,8 @@ rules:
commas:
max-spaces-after: -1
level: error
comments: disable
comments:
min-spaces-from-content: 1
comments-indentation: disable
document-start: disable
empty-lines:
@@ -30,4 +31,8 @@ rules:
new-lines:
type: unix
trailing-spaces: disable
truthy: disable
truthy: disable
octal-values:
forbid-implicit-octal: true
forbid-explicit-octal: true
+275
View File
@@ -6,6 +6,281 @@ middleware\_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general `#409 <https://github.com/ansible-middleware/keycloak/pull/409>`_
Minor Changes
-------------
- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature `#430 <https://github.com/ansible-middleware/keycloak/pull/430>`_
- AMW-644 keycloak_user_federation module always reports task as changed in check mode `#433 <https://github.com/ansible-middleware/keycloak/pull/433>`_
Bugfixes
--------
- Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
v3.1.1
======
Minor Changes
-------------
- Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
- Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
Bugfixes
--------
- Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424 <https://github.com/ansible-middleware/keycloak/pull/424>`_
v3.1.0
======
Minor Changes
-------------
- 369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
- AMW-578 Replace deprecated community.general.yaml callback with result `#413 <https://github.com/ansible-middleware/keycloak/pull/413>`_
- AMW-615 Inconsistent support of authentication via client credentials `#400 <https://github.com/ansible-middleware/keycloak/pull/400>`_
- AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
- AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
- Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
- Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter `#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
- Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
- Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
- In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
- Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
- Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
- authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
- keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
- keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
v3.0.11
=======
Minor Changes
-------------
- Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
- Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
- Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
- fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363 <https://github.com/ansible-middleware/keycloak/pull/363>`_
Bugfixes
--------
- AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
- AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
v3.0.10
=======
Major Changes
-------------
- Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
Minor Changes
-------------
- AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
- Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
- Removing from __future__ import annotations broke runtime type hints using Sequence and union syntax, causing sanity import failures and molecule module errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
v3.0.9
======
Bugfixes
--------
- AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
v3.0.8
======
v3.0.7
======
Major Changes
-------------
- Migrate Keycloak modules from the community.general collection to Keycloak collection. `#341 <https://github.com/ansible-middleware/keycloak/pull/341>`_
Minor Changes
-------------
- Fixing common module usage `#343 <https://github.com/ansible-middleware/keycloak/pull/343>`_
- fix #336: https://github.com/ansible-middleware/common/pull/38 `#338 <https://github.com/ansible-middleware/keycloak/pull/338>`_
Bugfixes
--------
- Fix molecule tests `#339 <https://github.com/ansible-middleware/keycloak/pull/339>`_
v3.0.6
======
Major Changes
-------------
- AMW-540 Fix the upstream collection requirements with common v1.2.4 `#337 <https://github.com/ansible-middleware/keycloak/pull/337>`_
v3.0.5
======
Minor Changes
-------------
- AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables `#335 <https://github.com/ansible-middleware/keycloak/pull/335>`_
v3.0.4
======
Major Changes
-------------
- AMW-467 Download keycloak binary from password protected HTTP location `#321 <https://github.com/ansible-middleware/keycloak/pull/321>`_
- v26.4.x compability `#317 <https://github.com/ansible-middleware/keycloak/pull/317>`_
Minor Changes
-------------
- AMW-518 Validating arguments against arg spec 'main' fails unexpectedly. `#324 <https://github.com/ansible-middleware/keycloak/pull/324>`_
Bugfixes
--------
- Removing parseable from lint file as Additional properties are not allowed `#319 <https://github.com/ansible-middleware/keycloak/pull/319>`_
v3.0.3
======
Major Changes
-------------
- Update to keycloak 26.3.0 `#293 <https://github.com/ansible-middleware/keycloak/pull/293>`_
- ansible-core 2.19 compatibility `#310 <https://github.com/ansible-middleware/keycloak/pull/310>`_
Minor Changes
-------------
- Allow to install provider jars from remote paths `#303 <https://github.com/ansible-middleware/keycloak/pull/303>`_
- Declared proxy_mode as deprecated, updated quarkus and realm readme `#306 <https://github.com/ansible-middleware/keycloak/pull/306>`_
- Fix config_key_store_file description to match variable name `#308 <https://github.com/ansible-middleware/keycloak/pull/308>`_
Bugfixes
--------
- keycloak collection CI label is showing no status `#312 <https://github.com/ansible-middleware/keycloak/pull/312>`_
- keycloak_realm: allow secret in keycloak_clients `#304 <https://github.com/ansible-middleware/keycloak/pull/304>`_
v3.0.2
======
Minor Changes
-------------
- New ``checksum`` property for keycloak_quarkus_providers `#280 <https://github.com/ansible-middleware/keycloak/pull/280>`_
- New parameter to set the jgroups host IP address `#281 <https://github.com/ansible-middleware/keycloak/pull/281>`_
- Session storage / distributed caches `#287 <https://github.com/ansible-middleware/keycloak/pull/287>`_
- Update keycloak/RHBK to v26.2.4 `#283 <https://github.com/ansible-middleware/keycloak/pull/283>`_
Bugfixes
--------
- Fix ``keycloak_quarkus_force_install`` parameter being ignored by install `#296 <https://github.com/ansible-middleware/keycloak/pull/296>`_
- Fix alternate download location being ignored (JBossNeworkAPI always used) `#298 <https://github.com/ansible-middleware/keycloak/pull/298>`_
- Run config rebuild after SPI providers update `#285 <https://github.com/ansible-middleware/keycloak/pull/285>`_
- Use jdk21 as default in debian `#289 <https://github.com/ansible-middleware/keycloak/pull/289>`_
- keycloak_realm: federation default provider type should be a string `#302 <https://github.com/ansible-middleware/keycloak/pull/302>`_
v3.0.1
======
Minor Changes
-------------
- Version update to 26.0.8 / rhbk 26.0.11 `#277 <https://github.com/ansible-middleware/keycloak/pull/277>`_
Bugfixes
--------
- Trigger rebuild handler on envvars file change `#276 <https://github.com/ansible-middleware/keycloak/pull/276>`_
v3.0.0
======
Minor Changes
-------------
- Add theme cache invalidation handler `#252 <https://github.com/ansible-middleware/keycloak/pull/252>`_
- keycloak_realm: change url variables to defaults `#268 <https://github.com/ansible-middleware/keycloak/pull/268>`_
Breaking Changes / Porting Guide
--------------------------------
- Bump major and ansible-core versions `#266 <https://github.com/ansible-middleware/keycloak/pull/266>`_
- Rename parameters to follow upstream `#270 <https://github.com/ansible-middleware/keycloak/pull/270>`_
- Update for keycloak v26 `#254 <https://github.com/ansible-middleware/keycloak/pull/254>`_
Bugfixes
--------
- Access token lifespan is too short for ansible run `#251 <https://github.com/ansible-middleware/keycloak/pull/251>`_
- Load environment vars during kc rebuild `#274 <https://github.com/ansible-middleware/keycloak/pull/274>`_
- Rebuild config and restart service for local providers `#250 <https://github.com/ansible-middleware/keycloak/pull/250>`_
- Rename and honour parameter ``keycloak_quarkus_http_host`` `#271 <https://github.com/ansible-middleware/keycloak/pull/271>`_
New Modules
-----------
- middleware_automation.keycloak.keycloak_realm - Allows administration of Keycloak realm via Keycloak API
v2.4.3
======
Minor Changes
-------------
- Update keycloak to 24.0.5 `#241 <https://github.com/ansible-middleware/keycloak/pull/241>`_
v2.4.2
======
Minor Changes
-------------
- New parameter ``keycloak_quarkus_download_path`` `#239 <https://github.com/ansible-middleware/keycloak/pull/239>`_
Bugfixes
--------
- Add wait_for_port number parameter `#237 <https://github.com/ansible-middleware/keycloak/pull/237>`_
v2.4.1
======
Release Summary
---------------
Internal release, documentation or test changes only.
v2.4.0
======
Major Changes
-------------
- Enable by default health check on restart `#234 <https://github.com/ansible-middleware/keycloak/pull/234>`_
- Update minimum ansible-core version > 2.15 `#232 <https://github.com/ansible-middleware/keycloak/pull/232>`_
v2.3.0
======
+34
View File
@@ -1,3 +1,37 @@
## Developing
### Build and install locally
Clone the repository, checkout the tag you want to build, or pick the main branch for the development version; then:
ansible-galaxy collection build .
ansible-galaxy collection install middleware_automation-keycloak-*.tar.gz
### Development environment
Make sure your development machine has available:
* python 3.11+
* virtualenv
* docker (or podman)
In order to run setup the development environment and run the molecule tests locally, after cloning the repository:
```
# create new virtualenv using python 3
virtualenv $PATH_TO_DEV_VIRTUALENV
# activate the virtual env
source $PATH_TO_DEV_VIRTUALENV/bin/activate
# install ansible and tools onto the virtualenv
pip install yamllint 'molecule>=6.0' 'molecule-plugins[docker]' 'ansible-core>=2.16' ansible-lint
# install collection dependencies
ansible-galaxy collection install -r requirements.yml
# install python dependencies
pip install -r requirements.txt molecule/requirements.txt
# execute the tests (replace --all with -s subdirectory to run a single test)
molecule test --all
```
## Contributor's Guidelines
+112 -31
View File
@@ -1,17 +1,18 @@
# Ansible Collection - middleware_automation.keycloak
<!--start build_status -->
[![Build Status](https://github.com/ansible-middleware/keycloak/workflows/CI/badge.svg?branch=main)](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml)
[![Build Status](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ansible-middleware/keycloak/actions/workflows/ci.yml)
> **_NOTE:_ If you are Red Hat customer, install `redhat.sso` (for Red Hat Single Sign-On) or `redhat.rhbk` (for Red Hat Build of Keycloak) from [Automation Hub](https://console.redhat.com/ansible/ansible-dashboard) as the certified version of this collection.**
> **_NOTE:_ If you are Red Hat customer, install `redhat.rhbk` (for Red Hat Build of Keycloak) or `redhat.sso` (for Red Hat Single Sign-On) from [Automation Hub](https://console.redhat.com/ansible/ansible-dashboard) as the certified version of this collection.**
<!--end build_status -->
<!--start description -->
Collection to install and configure [Keycloak](https://www.keycloak.org/) or [Red Hat Single Sign-On](https://access.redhat.com/products/red-hat-single-sign-on) / [Red Hat Build of Keycloak](https://access.redhat.com/products/red-hat-build-of-keycloak).
<!--end description -->
<!--start requires_ansible-->
## Ansible version compatibility
This collection has been tested against following Ansible versions: **>=2.14.0**.
This collection has been tested against following Ansible versions: **>=2.16.0**.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.
<!--end requires_ansible-->
@@ -39,6 +40,7 @@ collections:
The keycloak collection also depends on the following python packages to be present on the controller host:
* netaddr
* lxml
A requirement file is provided to install:
@@ -47,23 +49,62 @@ A requirement file is provided to install:
<!--start roles_paths -->
### Included roles
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing the service (keycloak <= 19.0).
* [`keycloak_quarkus`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md): role for installing keycloak (>= 19.0.0, quarkus based).
* [`keycloak_realm`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md): role for configuring a realm, user federation(s), clients and users, in an installed service.
* [`keycloak_quarkus`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md): role for installing the quarkus variant of keycloak (>= 17.0.0).
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing legacy keycloak (<= 19.0, wildfly based).
<!--end roles_paths -->
### Included modules
All Keycloak administration modules from `community.general` are provided in this collection for Keycloak 17+ (Quarkus). Use `auth_keycloak_url` without the legacy `/auth` context path (for example `http://localhost:8080`). Set `keycloak_context` to `/auth` only when automating WildFly-based Keycloak with the `keycloak` role.
* `keycloak_authentication`: manage authentication flows and executions using Keycloak Admin REST API.
* `keycloak_authentication_flow`: manage custom authentication flows and flow executions.
* `keycloak_authentication_required_actions`: manage required actions available in realm authentication.
* `keycloak_authentication_v2`: manage authentication flows with newer Keycloak API handling.
* `keycloak_authz_authorization_scope`: manage authorization scopes for a client resource server.
* `keycloak_authz_custom_policy`: manage custom authorization policies for a client resource server.
* `keycloak_authz_permission`: manage authorization permissions for a client resource server.
* `keycloak_authz_permission_info`: retrieve authorization permission information for a client resource server.
* `keycloak_client`: manage Keycloak clients (create/update/delete).
* `keycloak_client_rolemapping`: manage client role mappings for users and groups.
* `keycloak_client_rolescope`: manage client role scope mappings.
* `keycloak_client_scope`: manage client scopes and protocol mappers (replaces `community.general.keycloak_clientscope`).
* `keycloak_client_scope_type`: manage default and optional client scope assignments.
* `keycloak_clientsecret_info`: retrieve client secret information.
* `keycloak_clientsecret_regenerate`: regenerate a client secret.
* `keycloak_clienttemplate`: manage legacy client templates.
* `keycloak_component`: manage realm components.
* `keycloak_component_info`: retrieve realm component information.
* `keycloak_group`: manage realm groups and subgroups.
* `keycloak_identity_provider`: manage identity provider instances and configuration.
* `keycloak_realm`: manage realms (create/update/delete).
* `keycloak_realm_info`: retrieve realm information.
* `keycloak_realm_key`: manage realm key providers.
* `keycloak_realm_keys_metadata_info`: retrieve realm keys metadata.
* `keycloak_realm_localization`: manage realm localization texts.
* `keycloak_realm_rolemapping`: manage realm role mappings for users and groups.
* `keycloak_realm_users_info`: retrieve users from a realm.
* `keycloak_role`: manage realm and client roles.
* `keycloak_user`: manage users (create/update/delete).
* `keycloak_user_execute_actions_email`: trigger execute-actions emails for users.
* `keycloak_user_federation`: manage user federation providers (for example LDAP/AD).
* `keycloak_user_rolemapping`: manage user role mappings.
* `keycloak_userprofile`: manage user profile configuration.
## Usage
The collection provides roles to install Keycloak and modules to manage realms, clients, users, and related settings via the [Keycloak Admin REST API](https://www.keycloak.org/docs-api/latest/rest-api/index.html).
### Install Playbook
<!--start rhbk_playbook -->
* [`playbooks/keycloak.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak.yml) installs keycloak legacy based on the defined variables (using most defaults).
* [`playbooks/keycloak_quarkus.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_quarkus.yml) installs keycloak >= 17 based on the defined variables (using most defaults).
Both playbooks include the `keycloak` role, with different settings, as described in the following sections.
For Quarkus-based Keycloak (17+), set `auth_keycloak_url` to the server root URL without the legacy `/auth` path, for example `http://localhost:8080`. When using the legacy `keycloak` role with WildFly-based Keycloak, set `keycloak_context` to `/auth` in the `keycloak_realm` role.
For full service configuration details, refer to the [keycloak role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md).
<!--end rhbk_playbook -->
### Install Keycloak
* [`playbooks/keycloak_quarkus.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_quarkus.yml) installs Keycloak >= 17 using the `keycloak_quarkus` role.
* [`playbooks/keycloak.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak.yml) installs legacy Keycloak (<= 19) using the `keycloak` role.
For full service configuration details, refer to the [keycloak_quarkus role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_quarkus/README.md) or the [keycloak role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md).
#### Install from controller node (offline)
@@ -84,15 +125,15 @@ keycloak_offline_install: true
It is possible to perform downloads from alternate sources, using the `keycloak_download_url` variable; make sure the final downloaded filename matches with the source filename (ie. keycloak-legacy-x.y.zip or rh-sso-x.y.z-server-dist.zip).
### Example installation command
#### Example installation command
Execute the following command from the source root directory
Execute the following command from the source root directory:
```bash
ansible-playbook -i <ansible_hosts> playbooks/keycloak_quarkus.yml -e keycloak_quarkus_bootstrap_admin_password=<changeme>
```
ansible-playbook -i <ansible_hosts> -e @rhn-creds.yml playbooks/keycloak.yml -e keycloak_admin_password=<changeme>
```
- `keycloak_admin_password` Password for the administration console user account.
- `keycloak_quarkus_bootstrap_admin_password` password for the administration console user account.
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
```
@@ -100,27 +141,26 @@ ansible-playbook -i <ansible_hosts> -e @rhn-creds.yml playbooks/keycloak.yml -e
localhost ansible_connection=local
```
Note: when deploying clustered configurations, all hosts belonging to the cluster must be present in ansible_play_batch; ie. they must be targeted by the same ansible-playbook execution.
Note: when deploying clustered configurations, all hosts belonging to the cluster must be present in `ansible_play_batch`; ie. they must be targeted by the same ansible-playbook execution.
### Configure with roles
## Configuration
### Config Playbook
<!--start rhbk_realm_playbook -->
[`playbooks/keycloak_realm.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm.yml) creates or updates provided realm, user federation(s), client(s), client role(s) and client user(s).
* [`playbooks/keycloak_realm.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm.yml) creates or updates provided realm, user federation(s), client(s), client role(s) and client user(s).
<!--end rhbk_realm_playbook -->
* [`playbooks/keycloak_realm_client.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_realm_client.yml) creates a realm with clients, roles and users using the `keycloak_realm` role.
* [`playbooks/keycloak_federation.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_federation.yml) configures user federation providers.
### Example configuration command
#### Example configuration command
Execute the following command from the source root directory:
```bash
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_admin_password=<changeme> -e keycloak_realm=test
ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_realm_admin_password=<changeme> -e keycloak_realm_realm=test
```
- `keycloak_admin_password` password for the administration console user account.
- `keycloak_realm` name of the realm to be created/used.
- `keycloak_realm_admin_password` password for the administration console user account.
- `keycloak_realm_realm` name of the realm to be created/used.
- `ansible_hosts` is the inventory, below is an example inventory for deploying to localhost
```
@@ -131,14 +171,55 @@ ansible-playbook -i <ansible_hosts> playbooks/keycloak_realm.yml -e keycloak_adm
For full configuration details, refer to the [keycloak_realm role README](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md).
<!--end rhbk_realm_readme -->
### Configure with modules
Module playbooks target an already running Keycloak instance. All modules use the `middleware_automation.keycloak` collection namespace.
* [`playbooks/keycloak_client_scope.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_client_scope.yml) creates a client scope with protocol mappers using the `keycloak_client_scope` module.
* [`playbooks/keycloak_authentication_flow.yml`](https://github.com/ansible-middleware/keycloak/blob/main/playbooks/keycloak_authentication_flow.yml) creates a custom authentication flow with execution steps using the `keycloak_authentication_flow` module.
Example task using shared authentication defaults:
```yaml
- hosts: localhost
module_defaults:
group/middleware_automation.keycloak.keycloak:
auth_keycloak_url: http://localhost:8080
auth_realm: master
auth_username: admin
auth_password: "{{ keycloak_admin_password }}"
tasks:
- name: Create a user in a realm
middleware_automation.keycloak.keycloak_user:
realm: TestRealm
username: testuser
first_name: Test
last_name: User
email: testuser@example.com
enabled: true
state: present
```
When migrating from `community.general`, replace the collection prefix in playbooks (for example `community.general.keycloak_user` becomes `middleware_automation.keycloak.keycloak_user`) and use `keycloak_client_scope` instead of `keycloak_clientscope`.
## Support
<!--start support -->
For bug reports and feature requests, use [GitHub Issues](https://github.com/ansible-middleware/keycloak/issues).
<!--end support -->
## Release and Upgrade Notes
For details on changes between versions, please see the [CHANGELOG](https://github.com/ansible-middleware/keycloak/blob/main/CHANGELOG.rst) for this collection.
## License
Apache License v2.0 or later
<!--start license -->
See [LICENSE](LICENSE) to view the full text.
See [LICENSE](https://github.com/ansible-middleware/keycloak/blob/main/LICENSE) to view the full text.
<!--end license -->
+1
View File
@@ -6,4 +6,5 @@ python3-netaddr [platform:rpm platform:dpkg]
python3-lxml [platform:rpm platform:dpkg]
python3-jmespath [platform:rpm platform:dpkg]
python3-requests [platform:rpm platform:dpkg]
podman [platform:rpm platform:dpkg]
+439
View File
@@ -571,3 +571,442 @@ releases:
- 229.yaml
- 231.yaml
release_date: '2024-05-20'
2.4.0:
changes:
major_changes:
- 'Enable by default health check on restart `#234 <https://github.com/ansible-middleware/keycloak/pull/234>`_
'
- 'Update minimum ansible-core version > 2.15 `#232 <https://github.com/ansible-middleware/keycloak/pull/232>`_
'
fragments:
- 232.yaml
- 234.yaml
release_date: '2024-06-04'
2.4.1:
changes:
release_summary: Internal release, documentation or test changes only.
fragments:
- v2.4.1-devel_summary.yaml
release_date: '2024-07-02'
2.4.2:
changes:
bugfixes:
- 'Add wait_for_port number parameter `#237 <https://github.com/ansible-middleware/keycloak/pull/237>`_
'
minor_changes:
- 'New parameter ``keycloak_quarkus_download_path`` `#239 <https://github.com/ansible-middleware/keycloak/pull/239>`_
'
fragments:
- 237.yaml
- 239.yaml
release_date: '2024-09-26'
2.4.3:
changes:
minor_changes:
- 'Update keycloak to 24.0.5 `#241 <https://github.com/ansible-middleware/keycloak/pull/241>`_
'
fragments:
- 241.yaml
release_date: '2024-10-16'
3.0.0:
changes:
breaking_changes:
- 'Bump major and ansible-core versions `#266 <https://github.com/ansible-middleware/keycloak/pull/266>`_
'
- 'Rename parameters to follow upstream `#270 <https://github.com/ansible-middleware/keycloak/pull/270>`_
'
- 'Update for keycloak v26 `#254 <https://github.com/ansible-middleware/keycloak/pull/254>`_
'
bugfixes:
- 'Access token lifespan is too short for ansible run `#251 <https://github.com/ansible-middleware/keycloak/pull/251>`_
'
- 'Load environment vars during kc rebuild `#274 <https://github.com/ansible-middleware/keycloak/pull/274>`_
'
- 'Rebuild config and restart service for local providers `#250 <https://github.com/ansible-middleware/keycloak/pull/250>`_
'
- 'Rename and honour parameter ``keycloak_quarkus_http_host`` `#271 <https://github.com/ansible-middleware/keycloak/pull/271>`_
'
minor_changes:
- 'Add theme cache invalidation handler `#252 <https://github.com/ansible-middleware/keycloak/pull/252>`_
'
- 'keycloak_realm: change url variables to defaults `#268 <https://github.com/ansible-middleware/keycloak/pull/268>`_
'
fragments:
- 250.yaml
- 251.yaml
- 252.yaml
- 254.yaml
- 266.yaml
- 268.yaml
- 270.yaml
- 271.yaml
- 274.yaml
modules:
- description: Allows administration of Keycloak realm via Keycloak API
name: keycloak_realm
namespace: ''
release_date: '2025-04-23'
3.0.1:
changes:
bugfixes:
- 'Trigger rebuild handler on envvars file change `#276 <https://github.com/ansible-middleware/keycloak/pull/276>`_
'
minor_changes:
- 'Version update to 26.0.8 / rhbk 26.0.11 `#277 <https://github.com/ansible-middleware/keycloak/pull/277>`_
'
fragments:
- 276.yaml
- 277.yaml
release_date: '2025-05-02'
3.0.10:
changes:
major_changes:
- 'Fixing linting issues `#357 <https://github.com/ansible-middleware/keycloak/pull/357>`_
'
minor_changes:
- 'AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 <https://github.com/ansible-middleware/keycloak/pull/356>`_
'
- 'Fixing vars naming issue `#359 <https://github.com/ansible-middleware/keycloak/pull/359>`_
'
- 'Removing from __future__ import annotations broke runtime type hints using
Sequence and union syntax, causing sanity import failures and molecule module
errors `#358 <https://github.com/ansible-middleware/keycloak/pull/358>`_
'
fragments:
- 356.yaml
- 357.yaml
- 358.yaml
- 359.yaml
release_date: '2026-06-25'
3.0.11:
changes:
bugfixes:
- 'AMW-592 AMW Github Actions are failing because of latest molecule `#366 <https://github.com/ansible-middleware/keycloak/pull/366>`_
'
- 'AMW-594 Upstream release is failing due to recent rules change `#373 <https://github.com/ansible-middleware/keycloak/pull/373>`_
'
minor_changes:
- 'Add certification checks to the upstream repo `#378 <https://github.com/ansible-middleware/keycloak/pull/378>`_
'
- 'Fix cert workflow `#389 <https://github.com/ansible-middleware/keycloak/pull/389>`_
'
- 'Fix health check URL to include HTTP relative path `#364 <https://github.com/ansible-middleware/keycloak/pull/364>`_
'
- 'fix(keycloak_quarkus): avoid leaking maven provider password in logs `#363
<https://github.com/ansible-middleware/keycloak/pull/363>`_
'
fragments:
- 363.yaml
- 364.yaml
- 366.yaml
- 373.yaml
- 378.yaml
- 389.yaml
release_date: '2026-08-24'
3.0.2:
changes:
bugfixes:
- 'Fix ``keycloak_quarkus_force_install`` parameter being ignored by install
`#296 <https://github.com/ansible-middleware/keycloak/pull/296>`_
'
- 'Fix alternate download location being ignored (JBossNeworkAPI always used)
`#298 <https://github.com/ansible-middleware/keycloak/pull/298>`_
'
- 'Run config rebuild after SPI providers update `#285 <https://github.com/ansible-middleware/keycloak/pull/285>`_
'
- 'Use jdk21 as default in debian `#289 <https://github.com/ansible-middleware/keycloak/pull/289>`_
'
- 'keycloak_realm: federation default provider type should be a string `#302
<https://github.com/ansible-middleware/keycloak/pull/302>`_
'
minor_changes:
- 'New ``checksum`` property for keycloak_quarkus_providers `#280 <https://github.com/ansible-middleware/keycloak/pull/280>`_
'
- 'New parameter to set the jgroups host IP address `#281 <https://github.com/ansible-middleware/keycloak/pull/281>`_
'
- 'Session storage / distributed caches `#287 <https://github.com/ansible-middleware/keycloak/pull/287>`_
'
- 'Update keycloak/RHBK to v26.2.4 `#283 <https://github.com/ansible-middleware/keycloak/pull/283>`_
'
fragments:
- 280.yaml
- 281.yaml
- 283.yaml
- 285.yaml
- 287.yaml
- 289.yaml
- 296.yaml
- 298.yaml
- 302.yaml
release_date: '2025-07-01'
3.0.3:
changes:
bugfixes:
- 'keycloak collection CI label is showing no status `#312 <https://github.com/ansible-middleware/keycloak/pull/312>`_
'
- 'keycloak_realm: allow secret in keycloak_clients `#304 <https://github.com/ansible-middleware/keycloak/pull/304>`_
'
major_changes:
- 'Update to keycloak 26.3.0 `#293 <https://github.com/ansible-middleware/keycloak/pull/293>`_
'
- 'ansible-core 2.19 compatibility `#310 <https://github.com/ansible-middleware/keycloak/pull/310>`_
'
minor_changes:
- 'Allow to install provider jars from remote paths `#303 <https://github.com/ansible-middleware/keycloak/pull/303>`_
'
- 'Declared proxy_mode as deprecated, updated quarkus and realm readme `#306
<https://github.com/ansible-middleware/keycloak/pull/306>`_
'
- 'Fix config_key_store_file description to match variable name `#308 <https://github.com/ansible-middleware/keycloak/pull/308>`_
'
fragments:
- 293.yaml
- 303.yaml
- 304.yaml
- 306.yaml
- 308.yaml
- 310.yaml
- 312.yaml
release_date: '2025-12-16'
3.0.4:
changes:
bugfixes:
- 'Removing parseable from lint file as Additional properties are not allowed
`#319 <https://github.com/ansible-middleware/keycloak/pull/319>`_
'
major_changes:
- 'AMW-467 Download keycloak binary from password protected HTTP location `#321
<https://github.com/ansible-middleware/keycloak/pull/321>`_
'
- 'v26.4.x compability `#317 <https://github.com/ansible-middleware/keycloak/pull/317>`_
'
minor_changes:
- 'AMW-518 Validating arguments against arg spec ''main'' fails unexpectedly.
`#324 <https://github.com/ansible-middleware/keycloak/pull/324>`_
'
fragments:
- 317.yaml
- 319.yaml
- 321.yaml
- 324.yaml
release_date: '2026-05-20'
3.0.5:
changes:
minor_changes:
- 'AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables
`#335 <https://github.com/ansible-middleware/keycloak/pull/335>`_
'
fragments:
- 335.yaml
release_date: '2026-05-20'
3.0.6:
changes:
major_changes:
- 'AMW-540 Fix the upstream collection requirements with common v1.2.4 `#337
<https://github.com/ansible-middleware/keycloak/pull/337>`_
'
fragments:
- 337.yaml
release_date: '2026-05-26'
3.0.7:
changes:
bugfixes:
- 'Fix molecule tests `#339 <https://github.com/ansible-middleware/keycloak/pull/339>`_
'
major_changes:
- 'Migrate Keycloak modules from the community.general collection to Keycloak
collection. `#341 <https://github.com/ansible-middleware/keycloak/pull/341>`_
'
minor_changes:
- 'Fixing common module usage `#343 <https://github.com/ansible-middleware/keycloak/pull/343>`_
'
- 'fix #336: https://github.com/ansible-middleware/common/pull/38 `#338 <https://github.com/ansible-middleware/keycloak/pull/338>`_
'
fragments:
- 338.yaml
- 339.yaml
- 341.yaml
- 343.yaml
release_date: '2026-06-01'
3.0.8:
release_date: '2026-06-09'
3.0.9:
changes:
bugfixes:
- 'AMW-551 Providing correct rhbk version `#344 <https://github.com/ansible-middleware/keycloak/pull/344>`_
'
fragments:
- 344.yaml
release_date: '2026-06-11'
3.1.0:
changes:
minor_changes:
- '369 add integration tests for keycloak_authentication_v2 `#374 <https://github.com/ansible-middleware/keycloak/pull/374>`_
'
- 'AMW-578 Replace deprecated community.general.yaml callback with result `#413
<https://github.com/ansible-middleware/keycloak/pull/413>`_
'
- 'AMW-615 Inconsistent support of authentication via client credentials `#400
<https://github.com/ansible-middleware/keycloak/pull/400>`_
'
- 'AMW-622 keycloak collection spelling and grammar checking for PRs `#406 <https://github.com/ansible-middleware/keycloak/pull/406>`_
'
- 'AMW-626 keycloak_user_rolemapping raises 403 error code while listing assignable
Roles if invoker lacks view-realm Role `#411 <https://github.com/ansible-middleware/keycloak/pull/411>`_
'
- 'Add use_netrc option to prevent .netrc overriding bearer token `#408 <https://github.com/ansible-middleware/keycloak/pull/408>`_
'
- 'Address issue #370, add keycloak_realm: max_secondary_auth_failures parameter
`#404 <https://github.com/ansible-middleware/keycloak/pull/404>`_
'
- 'Fix #396 keycloak_user_federation.py mapper sorting now happens after unspecified
mappers are merged in `#414 <https://github.com/ansible-middleware/keycloak/pull/414>`_
'
- 'Fix issue #397 #398 crash on first role assignment `#405 <https://github.com/ansible-middleware/keycloak/pull/405>`_
'
- 'In a flow definition, handle non-existing keys correctly `#402 <https://github.com/ansible-middleware/keycloak/pull/402>`_
'
- 'Normalize hostname that includes http_relative_path suffix `#392 <https://github.com/ansible-middleware/keycloak/pull/392>`_
'
- 'Replace deprecated top-level fact variables with ansible_fact `#412 <https://github.com/ansible-middleware/keycloak/pull/412>`_
'
- 'authentication_v2: Fix validation for FormActions `#384 <https://github.com/ansible-middleware/keycloak/pull/384>`_
'
- 'keycloak_group: fix subgroup lookup on Keycloak older than 25 `#407 <https://github.com/ansible-middleware/keycloak/pull/407>`_
'
- 'keycloak_user: fix attributes always reporting changed=True `#399 <https://github.com/ansible-middleware/keycloak/pull/399>`_
'
fragments:
- 374.yaml
- 384.yaml
- 392.yaml
- 399.yaml
- 400.yaml
- 402.yaml
- 404.yaml
- 405.yaml
- 406.yaml
- 407.yaml
- 408.yaml
- 411.yaml
- 412.yaml
- 413.yaml
- 414.yaml
release_date: '2026-09-11'
3.1.1:
changes:
bugfixes:
- 'Fix keycloak_quarkus_health_check_url crash when hostname is unset `#424
<https://github.com/ansible-middleware/keycloak/pull/424>`_
'
minor_changes:
- 'Add support for the ``description`` attribute of keycloak groups `#419 <https://github.com/ansible-middleware/keycloak/pull/419>`_
'
- 'Bump Keycloak to 26.7.3 and RHBK to 26.4.15 `#422 <https://github.com/ansible-middleware/keycloak/pull/422>`_
'
fragments:
- 419.yaml
- 422.yaml
- 424.yaml
release_date: '2026-09-18'
3.1.2:
changes:
bugfixes:
- 'Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
'
- 'Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP
and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
'
major_changes:
- 'Port integration tests from community.general `#409 <https://github.com/ansible-middleware/keycloak/pull/409>`_
'
minor_changes:
- 'AMW-642 keycloak_identity_provider: add support for Do not store users from
transient-users feature `#430 <https://github.com/ansible-middleware/keycloak/pull/430>`_
'
- 'AMW-644 keycloak_user_federation module always reports task as changed in
check mode `#433 <https://github.com/ansible-middleware/keycloak/pull/433>`_
'
fragments:
- 409.yaml
- 425.yaml
- 429.yaml
- 430.yaml
- 433.yaml
release_date: '2026-10-09'
-2
View File
@@ -1,2 +0,0 @@
*
!.gitignore
+59
View File
@@ -0,0 +1,59 @@
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
"version": "0.2",
"language": "en",
"ignorePaths": ["changelogs/**", "CHANGELOG.rst"],
"files": [
"**/*.md",
"**/*.rst",
"roles/*/meta/argument_specs.yml",
"roles/*/meta/main.yml",
"roles/*/tasks/**/*.yml",
"roles/*/defaults/*.yml",
"roles/*/handlers/*.yml",
"roles/*/templates/*.j2",
"molecule/**/*.yml",
"molecule/**/*.j2",
"playbooks/**/*.yml",
"meta/runtime.yml",
"meta/execution-environment.yml",
".github/workflows/*.yml",
".github/ISSUE_TEMPLATE/*.md",
"galaxy.yml"
],
"dictionaries": [
"custom-keycloak",
"java",
"bash",
"shellscript",
"fullstack",
"softwareTerms",
"software-tools",
"cpp-compound-words",
"python",
"docker",
"k8s",
"html",
"css",
"git",
"networking-terms",
"node",
"npm"
],
"dictionaryDefinitions": [
{
"name": "custom-keycloak",
"path": ".cspell/custom-dictionary.txt",
"addWords": true
}
],
"ignoreRegExpList": [
"/\\{\\{.*?\\}\\}/g",
"/`[^`]+`/g",
"/(https?:\\/\\/[^\\s)]+)/g",
"/\\|`?[a-z_]+`?\\|/g",
"/\\[.*?\\]\\(.*?\\)/g",
"/^\\s*authors?:.*$/gm",
"/^\\s*-\\s+.*<[^>]+>.*$/gm"
]
}
+2 -2
View File
@@ -7,7 +7,7 @@
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2022, Red Hat, Inc.</p>
<p>&#169; Copyright 2024, Red Hat, Inc.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
@@ -18,4 +18,4 @@
</section>
</div>
</body>
</html>
</html>
+1 -2
View File
@@ -44,7 +44,6 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx_antsibull_ext',
'ansible_basic_sphinx_ext',
]
# Add any paths that contain templates here, relative to this directory.
@@ -64,7 +63,7 @@ master_doc = 'index'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
+5 -11
View File
@@ -10,31 +10,25 @@ Welcome to Keycloak Collection documentation
README
plugins/index
roles/index
Changelog <CHANGELOG>
.. toctree::
:maxdepth: 2
:caption: Developer documentation
testing
developing
releasing
.. toctree::
:maxdepth: 2
:caption: General
Changelog <CHANGELOG>
Developing <developing>
Testing <testing>
Releasing <releasing>
.. toctree::
:maxdepth: 2
:caption: Middleware collections
Infinispan / Red Hat Data Grid <https://ansible-middleware.github.io/infinispan/main/>
Keycloak / Red Hat Single Sign-On <https://ansible-middleware.github.io/keycloak/main/>
Infinispan / Red Hat Data Grid <https://ansible-middleware.github.io/infinispan/main/>
Wildfly / Red Hat JBoss EAP <https://ansible-middleware.github.io/wildfly/main/>
Tomcat / Red Hat JWS <https://ansible-middleware.github.io/jws/main/>
ActiveMQ / Red Hat AMQ Broker <https://ansible-middleware.github.io/amq/main/>
Kafka / Red Hat AMQ Streams <https://ansible-middleware.github.io/amq_streams/main/>
Ansible Middleware utilities <https://ansible-middleware.github.io/common/main/>
Red Hat CSP Download <https://ansible-middleware.github.io/redhat-csp-download/main/>
JCliff <https://ansible-middleware.github.io/ansible_collections_jcliff/main/>
+1 -2
View File
@@ -1,8 +1,7 @@
antsibull>=0.17.0
antsibull-docs
antsibull-changelog
ansible-core>=2.14.1
ansible-core>=2.16.0
ansible-pygments
sphinx-rtd-theme
git+https://github.com/felixfontein/ansible-basic-sphinx-ext
myst-parser
+2 -27
View File
@@ -4,24 +4,7 @@
The collection is tested with a [molecule](https://github.com/ansible-community/molecule) setup covering the included roles and verifying correct installation and idempotency.
In order to run the molecule tests locally with python 3.9 available, after cloning the repository:
```
pip install yamllint 'molecule[docker]~=3.5.2' ansible-core flake8 ansible-lint voluptuous
molecule test --all
```
## Integration testing
Demo repositories which depend on the collection, and aggregate functionality with other middleware_automation collections, are automatically rebuilt
at every collection release to ensure non-breaking changes and consistent behaviour.
The repository are:
- [Flange demo](https://github.com/ansible-middleware/flange-demo)
A deployment of Wildfly cluster integrated with keycloak and infinispan.
- [CrossDC keycloak demo](https://github.com/ansible-middleware/cross-dc-rhsso-demo)
A clustered multi-regional installation of keycloak with infinispan remote caches.
The test scenarios are available on the source code repository each on his own subdirectory under [molecule/](https://github.com/ansible-middleware/keycloak/molecule).
## Test playbooks
@@ -29,15 +12,7 @@ The repository are:
Sample playbooks are provided in the `playbooks/` directory; to run the playbooks locally (requires a rhel system with python 3.9+, ansible, and systemd) the steps are as follows:
```
# setup environment
pip install ansible-core
# clone the repository
git clone https://github.com/ansible-middleware/keycloak
cd keycloak
# install collection dependencies
ansible-galaxy collection install -r requirements.yml
# install collection python deps
pip install -r requirements.txt
# setup environment as in developing
# create inventory for localhost
cat << EOF > inventory
[keycloak]
+5 -1
View File
@@ -1,13 +1,15 @@
---
namespace: middleware_automation
name: keycloak
version: "2.3.0"
version: "3.1.2"
readme: README.md
authors:
- Romain Pelisse <rpelisse@redhat.com>
- Guido Grazioli <ggraziol@redhat.com>
- Ranabir Chakraborty <ranabir@ibm.com>
- Pavan Kumar Motaparthi <pmotapar@redhat.com>
- Helmut Wolf <hwo@world-direct.at>
- Harsha Cherukuri <hcheruku@redhat.com>
description: Install and configure a keycloak, or Red Hat Single Sign-on, service.
license_file: "LICENSE"
tags:
@@ -35,7 +37,9 @@ issues: https://github.com/ansible-middleware/keycloak/issues
build_ignore:
- .gitignore
- .github
- .ansible-lint
- .yamllint
- .DS_Store
- '*.tar.gz'
- '*.zip'
- molecule
+20
View File
@@ -0,0 +1,20 @@
v3.1.2
======
Major Changes
-------------
- Port integration tests from community.general #409
Minor Changes
-------------
- AMW-642 keycloak_identity_provider: add support for Do not store users from transient-users feature #430
- AMW-644 keycloak_user_federation module always reports task as changed in check mode #433
Bugfixes
--------
- Fix health check URL to use localhost with protocol and port #429
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND #425
+64 -1
View File
@@ -1,2 +1,65 @@
---
requires_ansible: ">=2.14.0"
requires_ansible: ">=2.16.0"
action_groups:
keycloak:
- keycloak_authentication
- keycloak_authentication_flow
- keycloak_authentication_required_actions
- keycloak_authentication_v2
- keycloak_authz_authorization_scope
- keycloak_authz_custom_policy
- keycloak_authz_permission
- keycloak_authz_permission_info
- keycloak_client
- keycloak_client_rolemapping
- keycloak_client_rolescope
- keycloak_client_scope
- keycloak_client_scope_type
- keycloak_client_scope_rolemappings
- keycloak_clientsecret_info
- keycloak_clientsecret_regenerate
- keycloak_clienttemplate
- keycloak_component
- keycloak_component_info
- keycloak_group
- keycloak_identity_provider
- keycloak_organization
- keycloak_organization_info
- keycloak_realm
- keycloak_realm_info
- keycloak_realm_key
- keycloak_realm_keys_metadata_info
- keycloak_realm_localization
- keycloak_realm_rolemapping
- keycloak_realm_users_info
- keycloak_role
- keycloak_user
- keycloak_user_federation
- keycloak_user_rolemapping
- keycloak_userprofile
- keycloak_user_execute_actions_email
plugin_routing:
modules:
keycloak_clientscope:
redirect: middleware_automation.keycloak.keycloak_client_scope
deprecation:
removal_version: 5.0.0
warning_text: >-
The module has been renamed to keycloak_client_scope for Keycloak 17+ (Quarkus).
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope.
keycloak_clientscope_type:
redirect: middleware_automation.keycloak.keycloak_client_scope_type
deprecation:
removal_version: 5.0.0
warning_text: >-
The module has been renamed to keycloak_client_scope_type for Keycloak 17+ (Quarkus).
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_type.
keycloak_clientscope_rolemappings:
redirect: middleware_automation.keycloak.keycloak_client_scope_rolemappings
deprecation:
removal_version: 5.0.0
warning_text: >-
The module has been renamed to keycloak_client_scope_rolemappings for Keycloak 17+ (Quarkus).
Update playbooks to use middleware_automation.keycloak.keycloak_client_scope_rolemappings.
+35 -32
View File
@@ -1,42 +1,45 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_admin_pass: "remembertochangeme"
keycloak_realm: TestRealm
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_hostname: http://instance:8080
keycloak_quarkus_log: file
keycloak_quarkus_frontend_url: 'http://localhost:8080/'
keycloak_quarkus_start_dev: True
keycloak_quarkus_start_dev: true
keycloak_quarkus_proxy_mode: none
keycloak_client_default_roles:
- TestRoleAdmin
- TestRoleUser
keycloak_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
- client: TestClient
role: TestRoleAdmin
keycloak_clients:
- name: TestClient
roles: "{{ keycloak_client_default_roles }}"
public_client: "{{ keycloak_client_public }}"
web_origins: "{{ keycloak_client_web_origins }}"
users: "{{ keycloak_client_users }}"
client_id: TestClient
attributes:
post.logout.redirect.uris: '/public/logout'
roles:
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_realm: TestRealm
keycloak_admin_password: "remembertochangeme"
keycloak_context: ''
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm_realm }}"
public_client: "{{ keycloak_realm_client_public }}"
web_origins: "{{ keycloak_realm_client_web_origins }}"
users: "{{ keycloak_realm_client_users }}"
client_id: TestClient
attributes:
post.logout.redirect.uris: '/public/logout'
+2 -2
View File
@@ -3,10 +3,10 @@ driver:
name: docker
platforms:
- name: instance
image: ghcr.io/hspaans/molecule-containers:debian-11
image: ghcr.io/hspaans/molecule-containers:debian-13
pre_build_image: true
privileged: true
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
+4 -2
View File
@@ -1,11 +1,13 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
tasks:
- name: Install sudo
ansible.builtin.apt:
name:
- sudo
- openjdk-17-jdk-headless
state: present
- openjdk-21-jdk-headless
- iproute2
+1 -1
View File
@@ -2,7 +2,7 @@
- name: Verify
hosts: all
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_uri: "http://localhost:{{ 8080 + ( keycloak_jboss_port_offset | default(0) ) }}"
keycloak_management_port: "http://localhost:{{ 9990 + ( keycloak_jboss_port_offset | default(0) ) }}"
keycloak_jboss_port_offset: 10
+43 -57
View File
@@ -1,62 +1,48 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_jvm_package: java-11-openjdk-headless
keycloak_modcluster_enabled: True
keycloak_modcluster_urls:
- host: myhost1
port: 16667
- host: myhost2
port: 16668
keycloak_jboss_port_offset: 10
keycloak_log_target: /tmp/keycloak
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_hostname: http://instance:8080
keycloak_quarkus_log: file
keycloak_quarkus_log_level: debug
keycloak_quarkus_log_target: /tmp/keycloak
keycloak_quarkus_start_dev: true
keycloak_quarkus_proxy_mode: none
keycloak_quarkus_offline_install: true
keycloak_quarkus_download_path: /tmp/keycloak/
keycloak_quarkus_java_heap_opts: "-Xms640m -Xmx640m "
roles:
- role: keycloak
tasks:
- name: Keycloak Realm Role
ansible.builtin.include_role:
name: keycloak_realm
vars:
keycloak_client_default_roles:
- TestRoleAdmin
- TestRoleUser
keycloak_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm }}"
keycloak_realm: TestRealm
keycloak_clients:
- name: TestClient
roles: "{{ keycloak_client_default_roles }}"
realm: "{{ keycloak_realm }}"
public_client: "{{ keycloak_client_public }}"
web_origins: "{{ keycloak_client_web_origins }}"
users: "{{ keycloak_client_users }}"
client_id: TestClient
attributes:
post.logout.redirect.uris: '/public/logout'
pre_tasks:
- name: "Retrieve assets server from env"
ansible.builtin.set_fact:
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
- name: "Set offline when assets server from env is defined"
ansible.builtin.set_fact:
sso_offline_install: True
when:
- assets_server is defined
- assets_server | length > 0
- role: keycloak_quarkus
- role: keycloak_realm
keycloak_realm_url: "{{ keycloak_quarkus_hostname }}"
keycloak_realm_admin_user: "{{ keycloak_quarkus_bootstrap_admin_user }}"
keycloak_realm_admin_password: "{{ keycloak_quarkus_bootstrap_admin_password }}"
keycloak_realm_client_users:
- username: TestUser
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- username: TestAdmin
password: password
client_roles:
- client: TestClient
role: TestRoleUser
realm: "{{ keycloak_realm_realm }}"
- client: TestClient
role: TestRoleAdmin
realm: "{{ keycloak_realm_realm }}"
keycloak_realm_realm: TestRealm
keycloak_realm_clients:
- name: TestClient
realm: "{{ keycloak_realm_realm }}"
public_client: "{{ keycloak_realm_client_public }}"
web_origins: "{{ keycloak_realm_client_web_origins }}"
users: "{{ keycloak_realm_client_users }}"
client_id: TestClient
+8 -2
View File
@@ -3,14 +3,15 @@ driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi8/ubi-init:latest
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
@@ -23,11 +24,16 @@ provisioner:
converge: converge.yml
verify: verify.yml
inventory:
group_vars:
all:
keycloak_install_requires_become: true
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
+59 -18
View File
@@ -1,29 +1,70 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
vars:
sudo_pkg_name: sudo
tasks:
- name: "Run preparation common to all scenario"
ansible.builtin.include_tasks: ../prepare.yml
vars:
assets:
- "{{ assets_server }}/sso/7.6.0/rh-sso-7.6.0-server-dist.zip"
- "{{ assets_server }}/sso/7.6.1/rh-sso-7.6.1-patch.zip"
- name: Install JDK8
become: yes
ansible.builtin.yum:
name:
- java-1.8.0-openjdk
state: present
when: ansible_facts['os_family'] == "RedHat"
- name: Create controller directory for downloads
ansible.builtin.file: # noqa risky-file-permissions delegated, uses controller host user
path: /tmp/keycloak
state: directory
mode: '0750'
delegate_to: localhost
run_once: true
- name: Install JDK8
become: yes
ansible.builtin.apt:
name:
- openjdk-8-jdk
state: present
when: ansible_facts['os_family'] == "Debian"
- name: Download keycloak archive to controller directory
ansible.builtin.get_url: # noqa risky-file-permissions delegated, uses controller host user
url: https://github.com/keycloak/keycloak/releases/download/26.7.3/keycloak-26.7.3.zip
dest: /tmp/keycloak
mode: '0640'
validate_certs: false
delegate_to: localhost
run_once: true
ignore_errors: true
- name: Attempt RHBK download using redhat.runtimes_common collection
when:
- rhn_username is defined
- rhn_username | length > 0
block:
- name: Retrieve RHBK product download using Unified Downloads API
middleware_automation.common.product_search:
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_type: DISTRIBUTION
product_version: "{{ keycloak_quarkus_version | default('26.7.3') }}"
product_category: "RHBK"
register: rhn_products
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
ignore_errors: true
- name: Determine install zipfile from search results
ansible.builtin.set_fact:
rhn_matched_products: "{{ rhn_products.results | selectattr('file_name', 'match', '.*keycloak-' + (keycloak_quarkus_version | default('26.7.3')) + '.zip$') }}"
delegate_to: localhost
run_once: true
when:
- rhn_products is defined
- rhn_products.results is defined
- name: Download Red Hat Build of Keycloak
middleware_automation.common.product_download:
client_id: "{{ rhn_username }}"
client_secret: "{{ rhn_password }}"
product_id: "{{ (rhn_matched_products | first).id }}"
dest: "/tmp/keycloak/keycloak-{{ keycloak_quarkus_version | default('26.7.3') }}.zip"
no_log: "{{ omit_rhn_output | default(true) }}"
delegate_to: localhost
run_once: true
when:
- rhn_matched_products is defined
- rhn_matched_products | length > 0
ignore_errors: true
+5 -69
View File
@@ -2,11 +2,9 @@
- name: Verify
hosts: all
vars:
keycloak_admin_password: "remembertochangeme"
keycloak_jvm_package: java-11-openjdk-headless
keycloak_uri: "http://localhost:{{ 8080 + ( keycloak_jboss_port_offset | default(0) ) }}"
keycloak_management_port: "http://localhost:{{ 9990 + ( keycloak_jboss_port_offset | default(0) ) }}"
keycloak_jboss_port_offset: 10
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_uri: "http://localhost:8080"
tasks:
- name: Populate service facts
ansible.builtin.service_facts:
@@ -15,75 +13,13 @@
that:
- ansible_facts.services["keycloak.service"]["state"] == "running"
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
- name: Verify we are running on requested jvm # noqa blocked_modules command-instead-of-module
ansible.builtin.shell: |
set -o pipefail
ps -ef | grep '/etc/alternatives/jre_11/' | grep -v grep
args:
executable: /bin/bash
changed_when: no
- name: Verify token api call
ansible.builtin.uri:
url: "{{ keycloak_uri }}/auth/realms/master/protocol/openid-connect/token"
url: "{{ keycloak_uri }}/realms/master/protocol/openid-connect/token"
method: POST
body: "client_id=admin-cli&username=admin&password={{ keycloak_admin_password }}&grant_type=password"
body: "client_id=admin-cli&username={{ keycloak_quarkus_bootstrap_admin_user }}&password={{ keycloak_quarkus_bootstrap_admin_user }}&grant_type=password"
validate_certs: no
register: keycloak_auth_response
until: keycloak_auth_response.status == 200
retries: 2
delay: 2
- name: Fetch openid-connect config
ansible.builtin.uri:
url: "{{ keycloak_uri }}/auth/realms/TestRealm/.well-known/openid-configuration"
method: GET
validate_certs: no
status_code: 200
register: keycloak_openid_config
- name: Verify expected config
ansible.builtin.assert:
that:
- keycloak_openid_config.json.registration_endpoint == 'http://localhost:8080/auth/realms/TestRealm/clients-registrations/openid-connect'
- name: Get test realm clients
ansible.builtin.uri:
url: "{{ keycloak_uri }}/auth/admin/realms/TestRealm/clients"
method: GET
validate_certs: no
status_code: 200
headers:
Authorization: "Bearer {{ keycloak_auth_response.json.access_token }}"
register: keycloak_query_clients
- name: Verify expected config
ansible.builtin.assert:
that:
- (keycloak_query_clients.json | selectattr('clientId','equalto','TestClient') | first)["attributes"]["post.logout.redirect.uris"] == '/public/logout'
- name: "Privilege escalation as some files/folders may requires it"
become: yes
block:
- name: Check log folder
ansible.builtin.stat:
path: "/tmp/keycloak"
register: keycloak_log_folder
- name: Check that keycloak log folder exists and is a link
ansible.builtin.assert:
that:
- keycloak_log_folder.stat.exists
- not keycloak_log_folder.stat.isdir
- keycloak_log_folder.stat.islnk
- name: Check log file
ansible.builtin.stat:
path: "/tmp/keycloak/server.log"
register: keycloak_log_file
- name: Check if keycloak file exists
ansible.builtin.assert:
that:
- keycloak_log_file.stat.exists
- not keycloak_log_file.stat.isdir
- name: Check default log folder
ansible.builtin.stat:
path: "/var/log/keycloak"
register: keycloak_default_log_folder
failed_when: false
- name: Check that default keycloak log folder doesn't exist
ansible.builtin.assert:
that:
- not keycloak_default_log_folder.stat.exists
+31
View File
@@ -0,0 +1,31 @@
---
keycloak_download_validate_certs: false
keycloak_validate_certs: false
keycloak_quarkus_download_validate_certs: false
keycloak_quarkus_validate_certs: false
keycloak_realm_validate_certs: false
keycloak_quarkus_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_firewalld_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_iptables_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_jdbc_driver_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_config_store_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_restart_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_start_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_rebuild_config_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_fastpackages_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_bootstrapped_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_quarkus_invalidate_theme_cache_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_systemd_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_install_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_firewalld_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_iptables_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_jdbc_driver_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_restart_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_start_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_stop_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_fastpackages_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
keycloak_rhsso_patch_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
molecule_prepare_require_privilege_escalation: "{{ keycloak_install_requires_become | default(true) }}"
+5 -5
View File
@@ -1,17 +1,17 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_show_deprecation_warnings: false
keycloak_quarkus_admin_pass: "remembertochangeme"
keycloak_admin_password: "remembertochangeme"
keycloak_realm: TestRealm
keycloak_quarkus_host: instance
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_quarkus_bootstrap_admin_user: "remembertochangeme"
keycloak_quarkus_hostname: "http://proxy:{{ keycloak_quarkus_http_port }}"
keycloak_quarkus_log: file
keycloak_quarkus_http_enabled: True
keycloak_quarkus_http_port: 8080
keycloak_quarkus_proxy_mode: edge
keycloak_quarkus_http_relative_path: /
keycloak_quarkus_frontend_url: https://proxy/
roles:
- role: keycloak_quarkus
+4 -4
View File
@@ -3,24 +3,24 @@ driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi8/ubi-init:latest
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
networks:
- name: keycloak
port_bindings:
exposed_ports:
- "8080/tcp"
published_ports:
- 0.0.0.0:8080:8080/tcp
- name: proxy
image: registry.access.redhat.com/ubi8/ubi-init:latest
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
networks:
- name: keycloak
port_bindings:
exposed_ports:
- "443/tcp"
published_ports:
- 0.0.0.0:443:443/tcp
+6 -2
View File
@@ -1,6 +1,8 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
tasks:
- name: Install sudo
ansible.builtin.dnf:
@@ -27,6 +29,8 @@
pre_tasks:
- name: Create certificate request
ansible.builtin.command: openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 365 -nodes -subj '/CN=proxy'
args:
chdir: "{{ playbook_dir }}"
delegate_to: localhost
changed_when: false
- name: Make certificate directory
@@ -39,11 +43,11 @@
src: "{{ item.name }}"
dest: "{{ item.dest }}"
mode: 0444
become: true
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
loop:
- { name: 'cert.pem', dest: '/etc/nginx/tls/certificate.crt' }
- { name: 'key.pem', dest: '/etc/nginx/tls/certificate.key' }
- name: Update CA trust
ansible.builtin.command: update-ca-trust
changed_when: false
become: true
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
+2
View File
@@ -0,0 +1,2 @@
---
- import_playbook: ../default/converge.yml
@@ -0,0 +1,131 @@
---
# Ported from community.general tests/integration/targets/keycloak_authentication
# Tests authentication flow CRUD: create from copy, create with conditional OTP,
# update config, verify config uniqueness via realm export, and delete.
- name: Set auth flow test variables
ansible.builtin.set_fact:
keycloak_no_otp_required_pattern_original: 'X-Forwarded-For: 10\.[0-9\.:]+'
keycloak_no_otp_required_pattern_modified: 'X-Original-Forwarded-For: 10\.[0-9\.:]+'
- name: Create auth flow from first broker login copy
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "Test first broker login"
copyFrom: "first broker login"
authenticationExecutions:
- providerId: "idp-review-profile"
requirement: "REQUIRED"
authenticationConfig:
alias: "Test review profile config"
config:
update.profile.on.first.login: "missing"
- name: Create conditional OTP auth flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
description: "browser based authentication with otp"
providerId: "basic-flow"
authenticationExecutions:
- displayName: Cookie
providerId: auth-cookie
requirement: ALTERNATIVE
- displayName: Kerberos
providerId: auth-spnego
requirement: DISABLED
- displayName: Identity Provider Redirector
providerId: identity-provider-redirector
requirement: ALTERNATIVE
- displayName: My browser otp forms
requirement: ALTERNATIVE
- displayName: Username Password Form
flowAlias: My browser otp forms
providerId: auth-username-password-form
requirement: REQUIRED
- displayName: My browser otp Browser - Conditional OTP
flowAlias: My browser otp forms
requirement: REQUIRED
providerId: "auth-conditional-otp-form"
authenticationConfig:
alias: my-conditional-otp-config
config:
defaultOtpOutcome: "force"
noOtpRequiredForHeaderPattern: "{{ keycloak_no_otp_required_pattern_original }}"
state: present
- name: Update conditional OTP auth flow config
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
description: "browser based authentication with otp"
providerId: "basic-flow"
authenticationExecutions:
- displayName: Cookie
providerId: auth-cookie
requirement: ALTERNATIVE
- displayName: Kerberos
providerId: auth-spnego
requirement: DISABLED
- displayName: Identity Provider Redirector
providerId: identity-provider-redirector
requirement: ALTERNATIVE
- displayName: My browser otp forms
requirement: ALTERNATIVE
- displayName: Username Password Form
flowAlias: My browser otp forms
providerId: auth-username-password-form
requirement: REQUIRED
- displayName: My browser otp Browser - Conditional OTP
flowAlias: My browser otp forms
requirement: REQUIRED
providerId: "auth-conditional-otp-form"
authenticationConfig:
alias: my-conditional-otp-config
config:
defaultOtpOutcome: "force"
noOtpRequiredForHeaderPattern: "{{ keycloak_no_otp_required_pattern_modified }}"
state: present
register: result
- name: Get access token for realm export
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
status_code: 200
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
- name: Extract access token
ansible.builtin.set_fact:
access_token: "{{ token_response.json.access_token }}"
- name: Export ephemeral realm
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ ephemeral_realm }}/partial-export?exportClients=false&exportGroupsAndRoles=false"
method: POST
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
body_format: form-urlencoded
body: {}
register: exported_realm
no_log: true
- name: Assert my-conditional-otp-config exists only once
ansible.builtin.assert:
that:
- exported_realm.json.authenticatorConfig | selectattr('alias', 'equalto', 'my-conditional-otp-config') | list | length == 1
- name: Delete conditional OTP auth flow
middleware_automation.keycloak.keycloak_authentication:
realm: "{{ ephemeral_realm }}"
alias: "My conditional browser otp"
state: absent
register: result
@@ -0,0 +1,24 @@
# 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: Get access token
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/{{ auth_realm }}/protocol/openid-connect/token"
method: POST
status_code: 200
headers:
Accept: application/json
User-agent: Ansible
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
no_log: true
- name: Extract access token
ansible.builtin.set_fact:
access_token: "{{ token_response.json['access_token'] }}"
no_log: true
@@ -0,0 +1,37 @@
# 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: Flow Creation/Update <Integration Test Flow> Version 1
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: idp-create-user-if-unique
requirement: ALTERNATIVE
authenticationConfig:
alias: Integration Test Flow - create unique user config
config:
require.password.update.after.registration: "false"
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: idp-confirm-link
requirement: REQUIRED
- providerId: auth-cookie
requirement: REQUIRED
register: flow_v1_result
- name: Expose flow_v1_result to parent scope
ansible.builtin.set_fact:
flow_v1_result: "{{ flow_v1_result }}"
no_log: true
@@ -0,0 +1,43 @@
# 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
# - adding a new execution inside the sub flow 'Integration Test Flow - User creation or linking' after the execution 'idp-create-user-if-unique'
# - disable auth-cookie at the end of the flow
# - change the config require.password.update.after.registration to "true"
- name: Flow Creation/Update <Integration Test Flow> Version 2
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: idp-create-user-if-unique
requirement: ALTERNATIVE
authenticationConfig:
alias: Integration Test Flow - create unique user config
config:
require.password.update.after.registration: "true"
- providerId: auth-cookie
requirement: REQUIRED
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: idp-confirm-link
requirement: REQUIRED
- providerId: auth-cookie
requirement: DISABLED
register: flow_v2_result
- name: Expose flow_v2_result to parent scope
ansible.builtin.set_fact:
flow_v2_result: "{{ flow_v2_result }}"
no_log: true
@@ -0,0 +1,28 @@
# 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
# Rebuilds Keycloak's own built-in "clients" flow structure as of 26.7.1.
# validate_executions() used to raise a KeyError for client-flow parents, since only
# basic-flow and form-flow provider sets were known.
- name: Flow Creation/Update <Integration Test Flow - Client Flow>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Client Flow
providerId: client-flow
state: present
authenticationExecutions:
- providerId: client-secret
requirement: ALTERNATIVE
- providerId: client-jwt
requirement: ALTERNATIVE
- providerId: client-secret-jwt
requirement: ALTERNATIVE
- providerId: client-x509
requirement: ALTERNATIVE
register: flow_v2_client_flow_result
- name: Expose flow_v2_client_flow_result to parent scope
ansible.builtin.set_fact:
flow_v2_client_flow_result: "{{ flow_v2_client_flow_result }}"
no_log: true
@@ -0,0 +1,31 @@
# 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
# Rebuilds Keycloak's own built-in "registration" flow structure as of 26.7.1.
# validate_executions() used to only check authenticator-providers and falsely flagged form actions as invalid
# See https://github.com/ansible-middleware/keycloak/issues/382
- name: Flow Creation/Update <Integration Test Flow - Form Actions>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Form Actions
state: present
authenticationExecutions:
- subFlow: Integration Test Flow - Form Actions - registration form
subFlowType: form-flow
requirement: REQUIRED
authenticationExecutions:
- providerId: registration-user-creation
requirement: REQUIRED
- providerId: registration-password-action
requirement: REQUIRED
- providerId: registration-recaptcha-action
requirement: DISABLED
- providerId: registration-terms-and-conditions
requirement: DISABLED
register: flow_v2_form_action_result
- name: Expose flow_v2_form_action_result to parent scope
ansible.builtin.set_fact:
flow_v2_form_action_result: "{{ flow_v2_form_action_result }}"
no_log: true
@@ -0,0 +1,144 @@
# 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: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 6
- test_flow_executions.json[0].providerId == "idp-review-profile"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].priority == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationConfig is not none
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].priority == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[1]['authenticationConfig'] is not defined
- test_flow_executions.json[1].authenticationFlow == true
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 0
- test_flow_executions.json[2].priority == 0
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[2].authenticationConfig is not none
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
- test_flow_executions.json[3].displayName == "Integration Test Flow - Handle Existing Account"
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
- test_flow_executions.json[3].index == 1
- test_flow_executions.json[3].priority == 1
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[3]['authenticationConfig'] is not defined
- test_flow_executions.json[3].authenticationFlow == true
- test_flow_executions.json[4].providerId == "idp-confirm-link"
- test_flow_executions.json[4].requirement == "REQUIRED"
- test_flow_executions.json[4].index == 0
- test_flow_executions.json[4].priority == 0
- test_flow_executions.json[4].level == 2
- test_flow_executions.json[4]['authenticationConfig'] is not defined
- test_flow_executions.json[4]['authenticationFlow'] is not defined or test_flow_executions.json[4].authenticationFlow == false
- test_flow_executions.json[5].providerId == "auth-cookie"
- test_flow_executions.json[5].requirement == "REQUIRED"
- test_flow_executions.json[5].index == 2
- test_flow_executions.json[5].priority == 2
- test_flow_executions.json[5].level == 0
- test_flow_executions.json[5]['authenticationConfig'] is not defined
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
- name: Fetch flow execution config for 'idp-review-profile'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_review_profile_config
no_log: true
- name: Assert flow execution config for 'idp-review-profile'
ansible.builtin.assert:
that:
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
- test_flow_execution_idp_review_profile_config.json.config is not none
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
- name: Fetch flow execution config for 'idp-create-user-if-unique'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_create_user_if_unique
no_log: true
- name: Assert flow execution config for 'idp-create-user-if-unique'
ansible.builtin.assert:
that:
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
- test_flow_execution_idp_create_user_if_unique.json.config is not none
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "false"
@@ -0,0 +1,151 @@
# 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: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 7
- test_flow_executions.json[0].providerId == "idp-review-profile"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].priority == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationConfig is not none
- test_flow_executions.json[0]['authenticationFlow'] is not defined or test_flow_executions.json[0].authenticationFlow == false
- test_flow_executions.json[1].displayName == "Integration Test Flow - User creation or linking"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].priority == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[1]['authenticationConfig'] is not defined
- test_flow_executions.json[1].authenticationFlow == true
- test_flow_executions.json[2].providerId == "idp-create-user-if-unique"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 0
- test_flow_executions.json[2].priority == 0
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[2].authenticationConfig is not none
- test_flow_executions.json[2]['authenticationFlow'] is not defined or test_flow_executions.json[2].authenticationFlow == false
- test_flow_executions.json[3].providerId == "auth-cookie"
- test_flow_executions.json[3].requirement == "REQUIRED"
- test_flow_executions.json[3].index == 1
- test_flow_executions.json[3].priority == 1
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[3]['authenticationConfig'] is not defined
- test_flow_executions.json[3]['authenticationFlow'] is not defined or test_flow_executions.json[3].authenticationFlow == false
- test_flow_executions.json[4].displayName == "Integration Test Flow - Handle Existing Account"
- test_flow_executions.json[4].requirement == "ALTERNATIVE"
- test_flow_executions.json[4].index == 2
- test_flow_executions.json[4].priority == 2
- test_flow_executions.json[4].level == 1
- test_flow_executions.json[4]['authenticationConfig'] is not defined
- test_flow_executions.json[4].authenticationFlow == true
- test_flow_executions.json[5].providerId == "idp-confirm-link"
- test_flow_executions.json[5].requirement == "REQUIRED"
- test_flow_executions.json[5].index == 0
- test_flow_executions.json[5].priority == 0
- test_flow_executions.json[5].level == 2
- test_flow_executions.json[5]['authenticationConfig'] is not defined
- test_flow_executions.json[5]['authenticationFlow'] is not defined or test_flow_executions.json[5].authenticationFlow == false
- test_flow_executions.json[6].providerId == "auth-cookie"
- test_flow_executions.json[6].requirement == "DISABLED"
- test_flow_executions.json[6].index == 2
- test_flow_executions.json[6].priority == 2
- test_flow_executions.json[6].level == 0
- test_flow_executions.json[6]['authenticationConfig'] is not defined
- test_flow_executions.json[6]['authenticationFlow'] is not defined or test_flow_executions.json[6].authenticationFlow == false
- name: Fetch flow execution config for 'idp-review-profile'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[0].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_review_profile_config
no_log: true
- name: Assert flow execution config for 'idp-review-profile'
ansible.builtin.assert:
that:
- test_flow_execution_idp_review_profile_config.json.alias == "Integration Test Flow - review profile config"
- test_flow_execution_idp_review_profile_config.json.config is not none
- test_flow_execution_idp_review_profile_config.json.config['update.profile.on.first.login'] == "missing"
- name: Fetch flow execution config for 'idp-create-user-if-unique'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/config/{{ test_flow_executions.json[2].authenticationConfig }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_execution_idp_create_user_if_unique
no_log: true
- name: Assert flow execution config for 'idp-create-user-if-unique'
ansible.builtin.assert:
that:
- test_flow_execution_idp_create_user_if_unique.json.alias == "Integration Test Flow - create unique user config"
- test_flow_execution_idp_create_user_if_unique.json.config is not none
- test_flow_execution_idp_create_user_if_unique.json.config['require.password.update.after.registration'] == "true"
@@ -0,0 +1,80 @@
# 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: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow - Client Flow'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow - Client Flow')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow - Client Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow - Client Flow"
- test_flow_top_level_data.json.providerId == "client-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow - Client Flow'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Client%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 4
- test_flow_executions.json[0].providerId == "client-secret"
- test_flow_executions.json[0].requirement == "ALTERNATIVE"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[1].providerId == "client-jwt"
- test_flow_executions.json[1].requirement == "ALTERNATIVE"
- test_flow_executions.json[1].index == 1
- test_flow_executions.json[1].level == 0
- test_flow_executions.json[2].providerId == "client-secret-jwt"
- test_flow_executions.json[2].requirement == "ALTERNATIVE"
- test_flow_executions.json[2].index == 2
- test_flow_executions.json[2].level == 0
- test_flow_executions.json[3].providerId == "client-x509"
- test_flow_executions.json[3].requirement == "ALTERNATIVE"
- test_flow_executions.json[3].index == 3
- test_flow_executions.json[3].level == 0
@@ -0,0 +1,86 @@
# 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: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch all authentication flows
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: keycloak_flows_response
no_log: true
- name: Extract flow id for alias 'Integration Test Flow - Form Actions'
ansible.builtin.set_fact:
test_flow_id: >-
{{ keycloak_flows_response.json
| selectattr('alias', 'equalto', 'Integration Test Flow - Form Actions')
| map(attribute='id')
| first }}
no_log: true
- name: Fetch basic flow data for 'Integration Test Flow - Form Actions'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ test_flow_id }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_top_level_data
no_log: true
- name: Assert flow attributes
ansible.builtin.assert:
that:
- test_flow_top_level_data.json.alias == "Integration Test Flow - Form Actions"
- test_flow_top_level_data.json.providerId == "basic-flow"
- test_flow_top_level_data.json.topLevel == true
- test_flow_top_level_data.json.builtIn == false
- name: Fetch flow executions for 'Integration Test Flow - Form Actions'
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Form%20Actions/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: test_flow_executions
no_log: true
- name: Assert flow executions
ansible.builtin.assert:
that:
- test_flow_executions.json | length == 5
- test_flow_executions.json[0].displayName == "Integration Test Flow - Form Actions - registration form"
- test_flow_executions.json[0].requirement == "REQUIRED"
- test_flow_executions.json[0].index == 0
- test_flow_executions.json[0].level == 0
- test_flow_executions.json[0].authenticationFlow == true
- test_flow_executions.json[1].providerId == "registration-user-creation"
- test_flow_executions.json[1].requirement == "REQUIRED"
- test_flow_executions.json[1].index == 0
- test_flow_executions.json[1].level == 1
- test_flow_executions.json[1]['authenticationFlow'] is not defined or test_flow_executions.json[1].authenticationFlow == false
- test_flow_executions.json[2].providerId == "registration-password-action"
- test_flow_executions.json[2].requirement == "REQUIRED"
- test_flow_executions.json[2].index == 1
- test_flow_executions.json[2].level == 1
- test_flow_executions.json[3].providerId == "registration-recaptcha-action"
- test_flow_executions.json[3].requirement == "DISABLED"
- test_flow_executions.json[3].index == 2
- test_flow_executions.json[3].level == 1
- test_flow_executions.json[4].providerId == "registration-terms-and-conditions"
- test_flow_executions.json[4].requirement == "DISABLED"
- test_flow_executions.json[4].index == 3
- test_flow_executions.json[4].level == 1
@@ -0,0 +1,33 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow - Client Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v2_client_flow.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v2_client_flow_result is changed
- flow_v2_client_flow_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow - Client Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2_client_flow.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow - Client Flow> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v2_client_flow.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v2_client_flow_result is not changed
- flow_v2_client_flow_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v2_client_flow_result.changed }}, diff={{ flow_v2_client_flow_result.get('diff') }}"
@@ -0,0 +1,61 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Create a client with browser override <Integration Test Flow>
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: present
authentication_flow_binding_overrides:
browser_name: "Integration Test Flow"
- name: Modify the flow <Integration Test Flow> although it is bound as client override flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch client data
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: present
register: client_result
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Fetch authentication flow (browser override={{ client_result.end_state.authenticationFlowBindingOverrides.browser }})
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/{{ client_result.end_state.authenticationFlowBindingOverrides.browser }}"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
register: flow_response
- name: Assert client flow override binding
ansible.builtin.assert:
that:
- flow_response.json is defined
- flow_response.json.alias == "Integration Test Flow"
@@ -0,0 +1,33 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v1_result is changed
- flow_v1_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v1.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v1_result is not changed
- flow_v1_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
@@ -0,0 +1,40 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Delete the flow <Integration Test Flow>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: absent
register: flow_deletion_result
- name: Assert that the flow deletion result
ansible.builtin.assert:
that:
- flow_deletion_result is changed
- flow_deletion_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_deletion_result.changed }}, diff={{ flow_deletion_result.get('diff') }}"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow does not exist anymore
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,33 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow - Form Actions>
ansible.builtin.include_tasks:
file: ../actions/flow_v2_form_action.yml
- name: Assert the flow creation result
ansible.builtin.assert:
that:
- flow_v2_form_action_result is changed
- flow_v2_form_action_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
- name: Assert the created flow <Integration Test Flow - Form Actions>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2_form_action.yml
# Check idempotency, by trying to create the existing flow again
- name: Trying to create the <Integration Test Flow - Form Actions> again, although nothing changed
ansible.builtin.include_tasks:
file: ../actions/flow_v2_form_action.yml
- name: Assert that the task didn't re-create the flow, because the flow didn't change
ansible.builtin.assert:
that:
- flow_v2_form_action_result is not changed
- flow_v2_form_action_result.diff is not defined
msg: "Expected no changes and no diff but got: changed={{ flow_v2_form_action_result.changed }}, diff={{ flow_v2_form_action_result.get('diff') }}"
@@ -0,0 +1,58 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Create an identity-provider with first and post login flow override <Integration Test Flow>
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: present
display_name: OpenID Connect IdP - Integration Test
enabled: true
provider_id: oidc
first_broker_login_flow_alias: Integration Test Flow
post_broker_login_flow_alias: Integration Test Flow
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: my-client
clientSecret: secret
syncMode: FORCE
- name: Modify the flow <Integration Test Flow> although it is bound as identity-provider first and post login flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch identity-provider data
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: present
register: identity_provider_result
- name: Assert identity-provider first and post flow binding
ansible.builtin.assert:
that:
- identity_provider_result.end_state.firstBrokerLoginFlowAlias == "Integration Test Flow"
- identity_provider_result.end_state.postBrokerLoginFlowAlias == "Integration Test Flow"
@@ -0,0 +1,58 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Flow Creation/Update <Integration Test Flow with invalid providerid in execution>
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow with invalid providerid in execution
state: present
authenticationExecutions:
- providerId: idp-review-profile
requirement: REQUIRED
authenticationConfig:
alias: Integration Test Flow - review profile config
config:
update.profile.on.first.login: "missing"
- subFlow: Integration Test Flow - User creation or linking
requirement: REQUIRED
authenticationExecutions:
- providerId: invalid-providerid
requirement: ALTERNATIVE
- subFlow: Integration Test Flow - Handle Existing Account
requirement: ALTERNATIVE
authenticationExecutions:
- providerId: another-invalid-providerid
requirement: REQUIRED
- providerId: auth-cookie
requirement: REQUIRED
ignore_errors: true
register: invalid_providerid_in_flow_result
- name: Verify that invalid providerId causes failure
ansible.builtin.assert:
that:
- invalid_providerid_in_flow_result is failed
- invalid_providerid_in_flow_result is not changed
- >-
invalid_providerid_in_flow_result.msg == "Validation of executions failed: Error(s) while validating flow: Unknown providerId 'invalid-providerid', Unknown providerId 'another-invalid-providerid'"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow did not get created
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20with%20invalid%20providerid%20in%20execution/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,50 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
# form-action providers are valid for form-flow, but not for basic-flow.
# This test ensures that validate_executions() correctly rejects them when used in a basic-flow context.
# Same for authentication providers (e.g auth-cookie) in a form-flow context.
- name: Flow Creation/Update <Integration Test Flow - Mismatched Flow Type> with providerIds mismatched to their parent flow type
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Mismatched Flow Type
state: present
authenticationExecutions:
- providerId: registration-user-creation
requirement: REQUIRED
- subFlow: Integration Test Flow - Mismatched Flow Type - form
subFlowType: form-flow
requirement: REQUIRED
authenticationExecutions:
- providerId: auth-cookie
requirement: REQUIRED
ignore_errors: true
register: mismatched_flow_type_result
- name: Assert providerIds mismatched with their parent flow type are rejected
ansible.builtin.assert:
that:
- mismatched_flow_type_result is failed
- mismatched_flow_type_result is not changed
- "'registration-user-creation' in mismatched_flow_type_result.msg"
- "'auth-cookie' in mismatched_flow_type_result.msg"
- name: Retrieve access token
ansible.builtin.include_tasks:
file: ../actions/fetch_access_token.yml
- name: Assert that the flow did not get created
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/admin/realms/{{ target_realm }}/authentication/flows/Integration%20Test%20Flow%20-%20Mismatched%20Flow%20Type/executions"
method: GET
headers:
Accept: application/json
User-agent: Ansible
Authorization: "Bearer {{ access_token }}"
return_content: true
status_code: 404
register: flow_response
@@ -0,0 +1,45 @@
# 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: Delete identity-provider <oidc-idp-integration-test> if it exists
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ target_realm }}"
alias: oidc-idp-integration-test
state: absent
- name: Delete client <test_client> if it exists
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "test_client"
state: absent
- name: Unassign the flow <Integration Test Flow> as default browser flow
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
browser_flow: browser
- name: Delete <Integration Test Flow> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow
state: absent
- name: Delete <Integration Test Flow - Form Actions> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Form Actions
state: absent
- name: Delete <Integration Test Flow - Mismatched Flow Type> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Mismatched Flow Type
state: absent
- name: Delete <Integration Test Flow - Client Flow> flow if it exists
middleware_automation.keycloak.keycloak_authentication_v2:
realm: "{{ target_realm }}"
alias: Integration Test Flow - Client Flow
state: absent
@@ -0,0 +1,41 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Modify the flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow creation modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the modified flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
# Revert the modifications from the previous step
- name: Revert the modifications the flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v1_result is changed
- flow_v1_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v1_result.changed }}, diff={{ flow_v1_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after reverting the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v1.yml
@@ -0,0 +1,44 @@
# 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: Setup Test
ansible.builtin.include_tasks:
file: test_setup.yml
- name: Create the new flow <Integration Test Flow>
ansible.builtin.include_tasks:
file: ../actions/flow_v1.yml
- name: Assign the flow <Integration Test Flow> as default browser flow
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
browser_flow: Integration Test Flow
- name: Modify the flow <Integration Test Flow> although it is bound as realm browser flow
ansible.builtin.include_tasks:
file: ../actions/flow_v2.yml
- name: Assert the flow modification result
ansible.builtin.assert:
that:
- flow_v2_result is changed
- flow_v2_result.diff is defined
msg: "Expected changes and a diff but got: changed={{ flow_v2_result.changed }}, diff={{ flow_v2_result.get('diff') }}"
- name: Assert the flow <Integration Test Flow> after the modifications
ansible.builtin.include_tasks:
file: ../assertions/assertion_flow_v2.yml
- name: Fetch realm data to validate if the browser flow is still set to <Integration Test Flow>
middleware_automation.keycloak.keycloak_realm:
id: "{{ target_realm }}"
realm: "{{ target_realm }}"
state: present
register: realm_result
- name: Assert realm browser flow binding
ansible.builtin.assert:
that:
- realm_result.end_state.browserFlow == "Integration Test Flow"
@@ -0,0 +1,39 @@
- name: Executing flow creation tests
ansible.builtin.include_tasks:
file: tests/test_flow_creation.yml
- name: Executing unused flow modification tests
ansible.builtin.include_tasks:
file: tests/test_unused_flow_modification.yml
- name: Executing used default browser flow modification tests
ansible.builtin.include_tasks:
file: tests/test_used_default_browser_flow_modification.yml
- name: Executing client flow override flow modification tests
ansible.builtin.include_tasks:
file: tests/test_client_flow_override_flow_modification.yml
- name: Executing identity provider first and post flow override flow modification tests
ansible.builtin.include_tasks:
file: tests/test_identity_provider_flow_overrides_flow_modification.yml
- name: Executing flow deletion tests
ansible.builtin.include_tasks:
file: tests/test_flow_deletion.yml
- name: Invalid providerIds in execution tests
ansible.builtin.include_tasks:
file: tests/test_invalid_providerid_flow_creation.yml
- name: Executing form action flow creation tests
ansible.builtin.include_tasks:
file: tests/test_form_action_flow_creation.yml
- name: Mismatched flow type providerIds in execution tests
ansible.builtin.include_tasks:
file: tests/test_mismatched_flow_type_flow_creation.yml
- name: Executing client flow creation tests
ansible.builtin.include_tasks:
file: tests/test_client_flow_creation.yml
@@ -0,0 +1,164 @@
---
# Ported from community.general tests/integration/targets/keycloak_authz_authorization_scope
# Tests full CRUD lifecycle with check_mode, diff, and idempotency.
- name: Create authorization scope (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
check_mode: true
diff: true
register: result
- name: Assert scope not created in check mode
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == 'Authorization scope would be created'
- result.diff.before == {}
- result.diff.after.name == 'file:delete'
- result.diff.after.displayName == 'File delete'
- result.diff.after.iconUri == 'http://localhost/icon.png'
- name: Create authorization scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == "http://localhost/icon.png"
- result.end_state.displayName == "File delete"
- name: Create authorization scope (idempotency)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
display_name: "File delete"
icon_uri: "http://localhost/icon.png"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == "http://localhost/icon.png"
- result.end_state.displayName == "File delete"
- name: Update scope - remove optional params (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
diff: true
check_mode: true
register: result
- name: Assert scope not updated in check mode
ansible.builtin.assert:
that:
- result is changed
- result.msg == 'Authorization scope would be updated'
- result.diff.before.displayName == 'File delete'
- result.diff.before.iconUri == 'http://localhost/icon.png'
- result.diff.after.displayName == ''
- result.diff.after.iconUri == ''
- name: Update scope - remove optional params
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert optional params removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == ""
- result.end_state.displayName == ""
- name: Update scope - idempotency after removal
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: present
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope unchanged after update
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "file:delete"
- result.end_state.iconUri == ""
- result.end_state.displayName == ""
- name: Remove scope (check mode)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
diff: true
check_mode: true
register: result
- name: Assert scope not removed in check mode
ansible.builtin.assert:
that:
- result is changed
- result.msg == 'Authorization scope would be removed'
- result.diff.before.name == 'file:delete'
- result.diff.after == {}
- name: Remove scope
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Remove scope (idempotency)
middleware_automation.keycloak.keycloak_authz_authorization_scope:
state: absent
name: "file:delete"
client_id: "{{ client }}"
realm: "{{ target_realm }}"
register: result
- name: Assert scope already absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,489 @@
---
# 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 == {}
@@ -0,0 +1,84 @@
---
client_id: myclient
client_id_2: mynewclient
post_logout_redirect_uris:
- "https://example.com/logout-callback"
- "https://example.com/signout"
backchannel_logout_url: "https://example.com/backchannel-logout"
redirect_uris1:
- "http://example.c.com/"
- "http://example.b.com/"
- "http://example.a.com/"
client_attributes1: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "oauth2.device.authorization.grant.enabled": true, "client.secret.creation.time": 0}
client_attributes2: {"backchannel.logout.session.required": false, "oauth2.device.authorization.grant.enabled": false, "client.secret.creation.time": 0}
protocol_mappers1:
- name: 'email'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email"
"user.attribute": "email"
"jsonType.label": "String"
"id.token.claim": true
"access.token.claim": true
"userinfo.token.claim": true
- name: 'email_verified'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email_verified"
"user.attribute": "emailVerified"
"jsonType.label": "boolean"
"id.token.claim": true
"access.token.claim": true
"userinfo.token.claim": true
- name: 'family_name'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "family_name"
"user.attribute": "lastName"
"jsonType.label": "String"
"id.token.claim": "true"
"access.token.claim": "true"
"userinfo.token.claim": "true"
protocol_mappers2_unordered:
- "{{ protocol_mappers1[2] }}"
- "{{ protocol_mappers1[1] }}"
- "{{ protocol_mappers1[0] }}"
protocol_mappers3_modifed:
- "{{ protocol_mappers1[2] }}"
- name: address
protocol: openid-connect
protocolMapper: oidc-address-mapper
consentRequired: false
config:
user.attribute.formatted: formatted
user.attribute.country: country
introspection.token.claim: 'true'
user.attribute.postal_code: postal_code
userinfo.token.claim: 'true'
user.attribute.street: street
id.token.claim: 'true'
user.attribute.region: region
access.token.claim: 'true'
user.attribute.locality: locality
- name: 'email'
protocol: 'openid-connect'
protocolMapper: 'oidc-usermodel-property-mapper'
config:
"claim.name": "email"
"user.attribute": "email"
"jsonType.label": "String"
"id.token.claim": true
"access.token.claim": false
"userinfo.token.claim": true
@@ -0,0 +1,409 @@
---
# Ported from community.general tests/integration/targets/keycloak_client
# Tests protocol_mapper CRUD, flow binding overrides, client_scopes_behavior,
# attribute updates, and post-logout redirect URIs / backchannel logout URL.
- name: Load client test variables
ansible.builtin.include_vars:
file: vars.yml
# --- Protocol mapper create, idempotency, and modification ---
- name: Desire client
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
register: desire_client_not_present
- name: Desire client again with same props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
register: desire_client_when_present_and_same
- name: Check client again with same props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers2_unordered }}"
authorization_services_enabled: false
check_mode: true
register: check_client_when_present_and_same
- name: Assert changes not detected in last two tasks (desire when same, and check)
ansible.builtin.assert:
that:
- desire_client_when_present_and_same is not changed
- check_client_when_present_and_same is not changed
- name: Check client again with changed props
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authorization_services_enabled: false
service_accounts_enabled: false
check_mode: true
register: check_client_when_present_and_changed
- name: Assert changes detected in last tasks
ansible.builtin.assert:
that:
- check_client_when_present_and_changed is changed
- name: Check client with modified protocol_mappers idempotence
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers3_modifed }}"
authorization_services_enabled: false
service_accounts_enabled: true
register: check_client_protocol_mappers_idempotence
- name: Assert idempotence changes to protocol_mappers
ansible.builtin.assert:
that:
- check_client_protocol_mappers_idempotence is changed
- end_state.protocolMappers | length == 3
- end_state.protocolMappers | selectattr('name', 'equalto', 'email_verified') | list | length == 0
- end_state.protocolMappers | selectattr('name', 'equalto', 'address') | list | length == 1
- end_state.protocolMappers | selectattr('name', 'equalto', 'email') | list | length == 1
- end_state.protocolMappers | selectattr('name', 'equalto', 'family_name') | list | length == 1
- email.config is defined
- email.config['access.token.claim'] == "false"
vars:
end_state: "{{ check_client_protocol_mappers_idempotence.end_state }}"
email: "{{ end_state.protocolMappers | selectattr('name', 'equalto', 'email') | first | default({}) }}"
# --- Flow binding overrides ---
- name: Desire client with flow binding overrides
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser_name: browser
direct_grant_name: direct grant
register: desire_client_with_flow_binding_overrides
- name: Assert flows are set
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser | length > 0
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant | length > 0
- name: Backup flow UUIDs
ansible.builtin.set_fact:
flow_browser_uuid: "{{ desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser }}"
flow_direct_grant_uuid: "{{ desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant }}"
- name: Desire client with flow binding overrides remove direct_grant_name
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser_name: browser
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser | length > 0
- "'direct_grant' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- name: Desire client with flow binding overrides remove browser add direct_grant
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
direct_grant_name: direct grant
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- "'browser' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant | length > 0
- name: Desire client with flow binding overrides with UUIDs
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser: "{{ flow_browser_uuid }}"
direct_grant: "{{ flow_direct_grant_uuid }}"
register: desire_client_with_flow_binding_overrides
- name: Assert flows are updated
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.browser == flow_browser_uuid
- desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides.direct_grant == flow_direct_grant_uuid
- name: Unset flow binding overrides
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
state: present
redirect_uris: "{{ redirect_uris1 }}"
attributes: "{{ client_attributes1 }}"
protocol_mappers: "{{ protocol_mappers1 }}"
authentication_flow_binding_overrides:
browser: "{{ None }}"
direct_grant: null
register: desire_client_with_flow_binding_overrides
- name: Assert flows are removed
ansible.builtin.assert:
that:
- desire_client_with_flow_binding_overrides is changed
- "'authenticationFlowBindingOverrides' in desire_client_with_flow_binding_overrides.end_state"
- "'browser' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
- "'direct_grant' not in desire_client_with_flow_binding_overrides.end_state.authenticationFlowBindingOverrides"
# --- Client scopes behavior ---
- name: Create a scope1 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope1
description: "test 1"
protocol: openid-connect
- name: Create a scope2 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope2
description: "test 2"
protocol: openid-connect
- name: Create a scope3 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope3
description: "test 3"
protocol: openid-connect
- name: Create Keycloak client with default_client_scopes (idempotent behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: idempotent
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert default_client_scopes and optional_client_scopes are set correctly
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- '"scope1" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
- end_state.defaultClientScopes | length == 1
- end_state.optionalClientScopes | length == 1
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with new scopes (ignore behavior, check mode)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope3']
optional_client_scopes: ['scope3']
client_id: testSD-bug
state: present
check_mode: true
register: desire_client_with_default_client_scopes
- name: Assert client scopes remain unchanged with ignore behavior
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is not changed
- end_state.defaultClientScopes | length == 1
- end_state.optionalClientScopes | length == 1
- '"scope1" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with conflicting scopes (patch behavior, should fail)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: patch
default_client_scopes: ['scope3']
optional_client_scopes: ['scope1', 'scope2', 'scope3']
client_id: testSD-bug
state: present
ignore_errors: true
register: desire_client_with_default_client_scopes
- name: Assert patch behavior fails when scope is both default and optional
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is failed
- "'scope3' in desire_client_with_default_client_scopes.msg"
- name: Update Keycloak client with new scopes (patch behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: patch
default_client_scopes: ['scope1', 'scope3']
optional_client_scopes: []
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert client scopes are patched correctly
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- end_state.defaultClientScopes | length == 2
- end_state.optionalClientScopes | length == 1
- '"scope1" in end_state.defaultClientScopes'
- '"scope3" in end_state.defaultClientScopes'
- '"scope2" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
- name: Update Keycloak client with empty default_client_scopes (idempotent behavior)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_scopes_behavior: idempotent
default_client_scopes: []
optional_client_scopes: ['scope3']
client_id: testSD-bug
state: present
register: desire_client_with_default_client_scopes
- name: Assert idempotent behavior with empty default_client_scopes
ansible.builtin.assert:
that:
- desire_client_with_default_client_scopes is changed
- end_state.defaultClientScopes | length == 0
- end_state.optionalClientScopes | length == 1
- '"scope3" in end_state.optionalClientScopes'
vars:
end_state: "{{ desire_client_with_default_client_scopes.end_state }}"
# --- Attribute updates ---
- name: Create client with initial attributes
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
state: present
attributes: "{{ client_attributes1 }}"
register: check_client_when_present_and_attributes_modified
- name: Update client attributes
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
state: present
attributes: "{{ client_attributes2 }}"
register: check_client_when_present_and_attributes_modified
- name: Assert client attributes are updated
ansible.builtin.assert:
that:
- check_client_when_present_and_attributes_modified is changed
- end_state.attributes["backchannel.logout.revoke.offline.tokens"] == 'false'
- end_state.attributes["backchannel.logout.session.required"] == 'false'
- end_state.attributes["oauth2.device.authorization.grant.enabled"] == 'false'
vars:
end_state: "{{ check_client_when_present_and_attributes_modified.end_state }}"
# --- Post-logout redirect URIs and backchannel logout URL ---
- name: Create client with post logout redirect URIs and backchannel logout URL
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris: "{{ post_logout_redirect_uris }}"
backchannel_logout_url: "{{ backchannel_logout_url }}"
state: present
register: result_create_logout_client
- name: Assert logout client is created with correct attributes
ansible.builtin.assert:
that:
- result_create_logout_client is changed
- result_create_logout_client.end_state.attributes["post.logout.redirect.uris"] is defined
- result_create_logout_client.end_state.attributes["backchannel.logout.url"] == backchannel_logout_url
- name: Re-create client with same logout fields (idempotency)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris: "{{ post_logout_redirect_uris }}"
backchannel_logout_url: "{{ backchannel_logout_url }}"
state: present
register: result_idempotent_logout_client
- name: Assert logout client is idempotent
ansible.builtin.assert:
that:
- result_idempotent_logout_client is not changed
- name: Update client logout fields
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
valid_post_logout_redirect_uris:
- "https://example.com/new-logout"
backchannel_logout_url: "https://example.com/new-backchannel"
state: present
register: result_update_logout_client
- name: Assert logout client fields are updated
ansible.builtin.assert:
that:
- result_update_logout_client is changed
- result_update_logout_client.end_state.attributes["backchannel.logout.url"] == "https://example.com/new-backchannel"
- name: Delete logout test client
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: logout-test-client
state: absent
@@ -0,0 +1,242 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_rolescope
# Tests multi-role mapping, remap idempotency, partial removal, error handling,
# duplicate roles, realm role operations, full-scope client rejection, and check_mode.
# --- Fixtures ---
- name: Create realm roles for rolescope test
middleware_automation.keycloak.keycloak_role:
name: "{{ item }}"
realm: "{{ ephemeral_realm }}"
state: present
loop:
- realm-role-admin
- realm-role-user
- name: Create private client (full_scope_allowed)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: backend-client-private
state: present
redirect_uris:
- "https://my-backend-api.c.org/"
full_scope_allowed: true
attributes: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "client.secret.creation.time": 0}
public_client: false
- name: Create client roles on private client
middleware_automation.keycloak.keycloak_role:
name: "{{ item }}"
realm: "{{ ephemeral_realm }}"
client_id: backend-client-private
state: present
loop:
- client-role-admin
- client-role-user
- name: Create public client (full_scope_allowed false)
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: frontend-client-public
redirect_uris:
- "https://my-onepage-app-frontend.c.org/"
attributes: {"backchannel.logout.session.required": true, "backchannel.logout.revoke.offline.tokens": false, "client.secret.creation.time": 0}
full_scope_allowed: false
public_client: true
# --- Client role scope mapping ---
- name: Map two client roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-user
register: result
- name: Assert both client roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Remap single role (additive idempotency)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-user
register: result
- name: Assert no change - both still mapped
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 2
- name: Remove admin role from public client scope
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
state: absent
register: result
- name: Assert admin removed, user remains
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- result.end_state[0].name == "client-role-user"
# --- Error: missing role ---
- name: Map non-existent client role (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-missing
ignore_errors: true
register: result
- name: Assert failure on missing client role
ansible.builtin.assert:
that:
- result is failed
# --- Duplicate role names ---
- name: Map duplicate role names
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_owner_client_id: backend-client-private
role_names:
- client-role-admin
- client-role-admin
register: result
- name: Assert duplicate handled - both roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
# --- Error: full-scope client ---
- name: Map realm role to full-scope private client (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: backend-client-private
role_names:
- realm-role-admin
ignore_errors: true
register: result
- name: Assert failure on full-scope client
ansible.builtin.assert:
that:
- result is failed
# --- Realm role scope mapping ---
- name: Map one realm role to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
register: result
- name: Assert realm role mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- name: Map two realm roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
register: result
- name: Assert both realm roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Unmap all realm roles from public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
state: absent
register: result
- name: Assert all realm roles unmapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 0
# --- Error: missing realm role ---
- name: Map non-existent realm role (expect failure)
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- client-role-missing
ignore_errors: true
register: result
- name: Assert failure on missing realm role
ansible.builtin.assert:
that:
- result is failed
# --- Check mode ---
- name: Check-mode map realm roles to public client
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names:
- realm-role-admin
- realm-role-user
check_mode: true
register: result
- name: Assert check-mode reports changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Verify check-mode did not actually apply changes
middleware_automation.keycloak.keycloak_client_rolescope:
realm: "{{ ephemeral_realm }}"
target_client_id: frontend-client-public
role_names: []
register: result
- name: Assert no roles present after check-mode
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 0
@@ -0,0 +1,247 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_scope_rolemappings
# Tests multi-role mapping, error paths, check_mode, partial removal, and full-scope rejection.
# --- Fixtures ---
- name: Create client for scope rolemapping tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
state: present
public_client: true
full_scope_allowed: false
- name: Create full-scope client for rejection test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: full-scope-client
state: present
public_client: true
full_scope_allowed: true
- name: Create realm roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ item }}"
loop:
- realm-role-admin
- realm-role-user
- name: Create client roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
name: "{{ item }}"
loop:
- client-role-admin
- client-role-user
- name: Create client roles in full-scope client
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: full-scope-client
name: "{{ item }}"
loop:
- client-role-admin
- client-role-user
- name: Create client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: client-scope
description: ""
protocol: openid-connect
state: present
# --- Client role mapping tests ---
- name: Map two client roles to scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-user
register: result
- name: Assert both client roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Remap one existing client role (idempotency - additive)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-user
register: result
- name: Assert no change and both still mapped
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 2
- name: Remove admin client role from scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
state: absent
register: result
- name: Assert admin role removed and user role remains
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- result.end_state[0].name == "client-role-user"
- name: Map non-existent client role
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-missing
ignore_errors: true
register: result
- name: Assert failed for missing client role
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"Failed to retrieve role '\" ~ ephemeral_realm ~ \".backend-client.client-role-missing'\""
- name: Map duplicate client roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_id: backend-client
client_scope_id: client-scope
role_names:
- client-role-admin
- client-role-admin
register: result
- name: Assert duplicate handled and both roles present
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Map role to full-scope client (should fail)
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
client_id: full-scope-client
role_names:
- client-role-admin
ignore_errors: true
register: result
- name: Assert full-scope client rejected
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"FullScopeAllowed is active for Client '\" ~ ephemeral_realm ~ \".full-scope-client'\""
# --- Realm role mapping tests ---
- name: Map one realm role to scope
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
register: result
- name: Assert realm role mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 1
- name: Map two realm roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
register: result
- name: Assert both realm roles mapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Unmap all realm roles
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
state: absent
register: result
- name: Assert all realm roles unmapped
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 0
- name: Map non-existent realm role
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- client-role-missing
ignore_errors: true
register: result
- name: Assert failed for missing realm role
ansible.builtin.assert:
that:
- result is failed
- "result.msg == \"Failed to retrieve role '\" ~ ephemeral_realm ~ \".client-role-missing'\""
# --- Check-mode test ---
- name: Map realm roles in check mode
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names:
- realm-role-admin
- realm-role-user
check_mode: true
register: result
- name: Assert check mode reports change
ansible.builtin.assert:
that:
- result is changed
- result.end_state | length == 2
- name: Verify check mode did not persist changes
middleware_automation.keycloak.keycloak_client_scope_rolemappings:
realm: "{{ ephemeral_realm }}"
client_scope_id: client-scope
role_names: []
register: result
- name: Assert no roles actually mapped after check mode
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | length == 0
@@ -0,0 +1,115 @@
---
# Ported from community.general tests/integration/targets/keycloak_client_scope_type
# Tests full realm-level and client-level scope type management with idempotency.
- name: Create client for scope type tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
state: present
enabled: true
- name: Create scope1 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope1
description: "test 1"
protocol: openid-connect
- name: Create scope2 client scope
middleware_automation.keycloak.keycloak_client_scope:
realm: "{{ ephemeral_realm }}"
name: scope2
description: "test 2"
protocol: openid-connect
# --- Realm level ---
- name: Set both scopes as realm defaults
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
- name: Assert realm default scopes are set
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.default_client_scopes'
- result.end_state.default_client_scopes | length == 2
- result.end_state.optional_client_scopes | length == 0
- name: Set same realm defaults (idempotency)
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
failed_when: result is changed
- name: Move scope2 to optional at realm level
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
register: result
- name: Assert scope2 moved to optional
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.optional_client_scopes'
- result.end_state.default_client_scopes | length == 1
- result.end_state.optional_client_scopes | length == 1
# --- Client level ---
- name: Set both scopes as client defaults
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
- name: Assert client default scopes are set
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.default_client_scopes'
- result.end_state.default_client_scopes | length == 2
- result.end_state.optional_client_scopes | length == 0
- name: Set same client defaults (idempotency)
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1', 'scope2']
optional_client_scopes: []
register: result
failed_when: result is changed
- name: Move scope2 to optional at client level
middleware_automation.keycloak.keycloak_client_scope_type:
realm: "{{ ephemeral_realm }}"
client_id: clientscope-type-client
default_client_scopes: ['scope1']
optional_client_scopes: ['scope2']
register: result
- name: Assert scope2 moved to optional on client
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- '"scope1" in result.end_state.default_client_scopes'
- '"scope2" in result.end_state.optional_client_scopes'
- result.end_state.default_client_scopes | length == 1
- result.end_state.optional_client_scopes | length == 1
@@ -0,0 +1,33 @@
---
# Ported from community.general tests/integration/targets/keycloak_clientsecret_info
# Tests fetch-by-client_id vs fetch-by-id and value assertions.
- name: Look up test client to get internal id
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: present
register: client_lookup
- name: Fetch client secret by client_id
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
register: fetch_by_client_id_result
- name: Assert client secret retrieved by client_id
ansible.builtin.assert:
that:
- fetch_by_client_id_result.clientsecret_info.type == "secret"
- fetch_by_client_id_result.clientsecret_info.value | length >= 32
- name: Fetch client secret by internal id
middleware_automation.keycloak.keycloak_clientsecret_info:
realm: "{{ target_realm }}"
id: "{{ client_lookup.end_state.id }}"
register: fetch_by_id_result
- name: Assert both fetch methods return the same secret value
ansible.builtin.assert:
that:
- fetch_by_id_result.clientsecret_info.value == fetch_by_client_id_result.clientsecret_info.value
@@ -0,0 +1,34 @@
---
# Ported from community.general tests/integration/targets/keycloak_clientsecret_regenerate
# Tests regenerate-by-client_id vs regenerate-by-id and rotation contract.
- name: Look up test client to get internal id
middleware_automation.keycloak.keycloak_client:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
state: present
register: client_lookup
- name: Regenerate client secret by client_id
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
client_id: "{{ client }}"
register: regenerate_by_client_id
- name: Assert regenerated secret is valid
ansible.builtin.assert:
that:
- regenerate_by_client_id.end_state.type == "secret"
- regenerate_by_client_id.end_state.value | length >= 32
- name: Regenerate client secret by internal id
middleware_automation.keycloak.keycloak_clientsecret_regenerate:
realm: "{{ target_realm }}"
id: "{{ client_lookup.end_state.id }}"
register: regenerate_by_id
- name: Assert secret value changed after second regeneration
ansible.builtin.assert:
that:
- regenerate_by_id.end_state.value | length >= 32
- regenerate_by_id.end_state.value != regenerate_by_client_id.end_state.value
@@ -0,0 +1,218 @@
---
# Ported from community.general tests/integration/targets/keycloak_component_info
# Tests querying components by name, provider_type, parent_id, and combined filters.
- name: Query LDAP federation when absent
middleware_automation.keycloak.keycloak_component_info:
name: myldap
provider_type: "org.keycloak.storage.UserStorageProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert LDAP federation is absent
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 0
- name: Create LDAP federation for component_info tests
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: myldap
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldap://ldap.example.com"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
mappers:
- name: "email"
providerId: "user-attribute-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.attribute: mail
user.model.attribute: email
is.mandatory.in.ldap: "false"
read.only: "true"
- name: "username"
providerId: "user-attribute-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.attribute: uid
user.model.attribute: username
is.mandatory.in.ldap: "true"
read.only: "true"
state: present
- name: Query LDAP federation by name and type
middleware_automation.keycloak.keycloak_component_info:
name: myldap
provider_type: "org.keycloak.storage.UserStorageProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert LDAP federation found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].name == "myldap"
- name: Save LDAP federation id
ansible.builtin.set_fact:
ci_ldap_id: "{{ result.components[0].id }}"
- name: Query LDAP subcomponents by parent_id
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
register: result
- name: Assert subcomponents exist
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- name: Query LDAP subcomponents filter by name
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
name: "email"
register: result
- name: Assert subcomponent with name email exists
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].name == "email"
- name: Query LDAP subcomponents filter by type
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
parent_id: "{{ ci_ldap_id }}"
provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
register: result
- name: Assert LDAP mapper subcomponents found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- result.components[0].providerType == "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
- name: Query key info when absent
middleware_automation.keycloak.keycloak_component_info:
name: testkey
provider_type: "org.keycloak.keys.KeyProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert key is missing
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 0
- name: Create AES realm key for component query test
middleware_automation.keycloak.keycloak_realm_key:
name: testkey
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
priority: 150
enabled: true
active: true
- name: Query key component by name and type
middleware_automation.keycloak.keycloak_component_info:
name: testkey
provider_type: "org.keycloak.keys.KeyProvider"
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert key component found
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- name: Query all realm components
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
register: result
- name: Assert realm has components
ansible.builtin.assert:
that:
- result is not changed
- result.components | length > 0
- name: Query all UserStorageProviders in realm
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
provider_type: "org.keycloak.storage.UserStorageProvider"
register: result
- name: Assert only the LDAP federation is returned
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].providerType == "org.keycloak.storage.UserStorageProvider"
- result.components[0].name == "myldap"
- name: Query component by name only
middleware_automation.keycloak.keycloak_component_info:
realm: "{{ ephemeral_realm }}"
name: testkey
register: result
- name: Assert key found by name only
ansible.builtin.assert:
that:
- result is not changed
- result.components | length == 1
- result.components[0].providerType == "org.keycloak.keys.KeyProvider"
- result.components[0].name == "testkey"
- name: Clean up - remove AES key
middleware_automation.keycloak.keycloak_realm_key:
name: testkey
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
state: absent
- name: Clean up - remove LDAP federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: myldap
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
state: absent
@@ -0,0 +1,412 @@
---
# Ported from community.general tests/integration/targets/keycloak_group
# Tests group CRUD, custom attributes, subgroups, deep chains, and deletion patterns.
# --- Group CRUD ---
- name: Create a group
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: test-group
state: present
register: result
- name: Assert group was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "test-group"
- result.end_state.path == "/test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Save group id
ansible.builtin.set_fact:
molecule_grp_test_id: "{{ result.end_state.id }}"
- name: Create group again (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: test-group
state: present
register: result
- name: Assert group unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "test-group"
- result.end_state.path == "/test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Rename group by id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
name: new-test-group
state: present
register: result
- name: Assert group was renamed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "new-test-group"
- result.end_state.path == "/new-test-group"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Delete group by id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
state: absent
register: result
- name: Assert group was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete group by id again (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ molecule_grp_test_id }}"
state: absent
register: result
- name: Assert no change on absent group
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Custom attributes ---
- name: Create group with custom attributes
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: my-new_group
attributes:
attrib1: value1
attrib2: value2
attrib3:
- item1
- item2
register: result
- name: Assert group created with attributes
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "my-new_group"
- result.end_state.path == "/my-new_group"
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- result.end_state.attributes != {}
- result.end_state.attributes.attrib1 == ["value1"]
- result.end_state.attributes.attrib2 == ["value2"]
- result.end_state.attributes.attrib3 == ["item1", "item2"]
- name: Delete group with attributes by name
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: my-new_group
state: absent
register: result
- name: Assert group with attributes was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
# --- Subgroup tests ---
- name: Create base group for subgroup testing
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
register: grp_root_result
- name: Create subgroup using parent id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup created by parent id
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subgrp1"
- result.end_state.path == "/rootgrp/subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate subgroup using parent id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "subgrp1"
- result.end_state.path == "/rootgrp/subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Rename subgroup
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result.end_state.id }}"
name: new-subgrp1
parents:
- id: "{{ grp_root_result.end_state.id }}"
register: result
- name: Assert subgroup renamed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "new-subgrp1"
- result.end_state.path == "/rootgrp/new-subgrp1"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Create subgroup using parent name
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp2
parents:
- name: rootgrp
register: result
- name: Assert subgroup created by parent name
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subgrp2"
- result.end_state.path == "/rootgrp/subgrp2"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate subgroup using parent name (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subgrp2
parents:
- name: rootgrp
register: result
- name: Assert subgroup unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.name == "subgrp2"
- result.end_state.path == "/rootgrp/subgrp2"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
# --- Sub-subgroup (deep chain) ---
- name: Create sub-subgroup using parent name chain
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubgrp
parents:
- name: rootgrp
- name: subgrp2
register: result
- name: Assert sub-subgroup created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subsubgrp"
- result.end_state.path == "/rootgrp/subgrp2/subsubgrp"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate sub-subgroup using parent names (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubgrp
parents:
- name: rootgrp
- name: subgrp2
register: result_subsub
- name: Assert sub-subgroup unchanged
ansible.builtin.assert:
that:
- result_subsub is not changed
- result_subsub.end_state != {}
- result_subsub.end_state.name == "subsubgrp"
- result_subsub.end_state.path == "/rootgrp/subgrp2/subsubgrp"
- result_subsub.end_state.attributes == {}
- result_subsub.end_state.clientRoles == {}
- result_subsub.end_state.realmRoles == []
- result_subsub.end_state.subGroups == []
- name: Create sub-sub-subgroup using direct parent id
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubsubgrp
parents:
- id: "{{ result_subsub.end_state.id }}"
register: result
- name: Assert sub-sub-subgroup created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "subsubsubgrp"
- result.end_state.path == "/rootgrp/subgrp2/subsubgrp/subsubsubgrp"
- result.end_state.attributes == {}
- result.end_state.clientRoles == {}
- result.end_state.realmRoles == []
- result.end_state.subGroups == []
- name: Recreate sub-sub-subgroup using direct parent id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: subsubsubgrp
parents:
- id: "{{ result_subsub.end_state.id }}"
register: result_subsubsub
- name: Assert sub-sub-subgroup unchanged
ansible.builtin.assert:
that:
- result_subsubsub is not changed
- result_subsubsub.end_state != {}
- result_subsubsub.end_state.name == "subsubsubgrp"
- result_subsubsub.end_state.path == "/rootgrp/subgrp2/subsubgrp/subsubsubgrp"
- result_subsubsub.end_state.attributes == {}
- result_subsubsub.end_state.clientRoles == {}
- result_subsubsub.end_state.realmRoles == []
- result_subsubsub.end_state.subGroups == []
# --- Subgroup deletion ---
- name: Delete subgroup by id (no parents needed)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result_subsubsub.end_state.id }}"
state: absent
register: result
- name: Assert subgroup deleted by id
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo subgroup deletion by id (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
id: "{{ result_subsubsub.end_state.id }}"
state: absent
register: result
- name: Assert subgroup deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Delete subgroup by name with parents
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: new-subgrp1
parents:
- name: rootgrp
state: absent
register: result
- name: Assert subgroup deleted by name
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo subgroup deletion by name (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: new-subgrp1
parents:
- name: rootgrp
state: absent
register: result
- name: Assert subgroup name deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Delete group that has subgroups (cascade)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
state: absent
register: result
- name: Assert group with subgroups deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Redo delete group with subgroups (idempotency)
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: rootgrp
state: absent
register: result
- name: Assert group deletion idempotent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,4 @@
---
role_1: myrole-1
role_2: myrole-2
test_group: mygroup
@@ -0,0 +1,113 @@
---
# Ported from community.general tests/integration/targets/keycloak_group_rolemapping
# Tests full map/unmap lifecycle with idempotency for realm role mappings on groups.
- name: Load group rolemapping test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create realm roles
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ item }}"
state: present
loop:
- "{{ role_1 }}"
- "{{ role_2 }}"
- name: Create group
middleware_automation.keycloak.keycloak_group:
realm: "{{ ephemeral_realm }}"
name: "{{ test_group }}"
state: present
- name: Map realm roles to group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
- name: "{{ role_2 }}"
state: present
register: result
- name: Assert realm roles are assigned to group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 2
- name: Map realm roles to group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
- name: "{{ role_2 }}"
state: present
register: result
- name: Assert realm roles stay assigned to group
ansible.builtin.assert:
that:
- result is not changed
- name: Unmap realm role 1 from group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
state: absent
register: result
- name: Assert realm role 1 is unassigned from group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 1
- result.end_state[0] == role_2
- name: Unmap realm role 1 from group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_1 }}"
state: absent
register: result
- name: Assert realm role 1 stays unassigned from group
ansible.builtin.assert:
that:
- result is not changed
- name: Unmap realm role 2 from group
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_2 }}"
state: absent
register: result
- name: Assert no realm roles are assigned to group
ansible.builtin.assert:
that:
- result is changed
- result.end_state | count == 0
- name: Unmap realm role 2 from group again (idempotency)
middleware_automation.keycloak.keycloak_realm_rolemapping:
realm: "{{ ephemeral_realm }}"
group_name: "{{ test_group }}"
roles:
- name: "{{ role_2 }}"
state: absent
register: result
- name: Assert no realm roles are assigned to group
ansible.builtin.assert:
that:
- result is not changed
- result.end_state | count == 0
@@ -0,0 +1,264 @@
---
# Ported from community.general tests/integration/targets/keycloak_identity_provider
# Tests create with mappers, mapper CRUD, update, clientSecret masking, delete idempotency, fromUrl discovery.
- name: Create new identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
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: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
state: present
register: result
- name: Assert identity provider created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.alias == "myidp"
- result.end_state.mappers != []
- result.end_state.config.clientSecret == "**********"
- name: Update existing identity provider (no change)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
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: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
state: present
register: result
- name: Assert identity provider unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update existing identity provider (with change, no mapper change)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
enabled: false
state: present
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.enabled == true
- result.end_state.enabled == false
- name: Update existing identity provider (delete mapper)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.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)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.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)
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: present
mappers:
- name: "last_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "last_name"
user.attribute: "last_name"
syncMode: "INHERIT"
- name: "first_name"
identityProviderAlias: myidp
identityProviderMapper: "oidc-user-attribute-idp-mapper"
config:
claim: "first_name"
user.attribute: "first_name"
syncMode: "INHERIT"
register: result
- name: Assert identity provider updated
ansible.builtin.assert:
that:
- result is not changed
- name: Delete existing identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: absent
register: result
- name: Assert identity provider deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent identity provider
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidp
state: absent
register: result
- name: Assert identity provider unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- name: Create IDP realm
middleware_automation.keycloak.keycloak_realm:
id: myidprealm
realm: myidprealm
state: present
- name: Create new identity provider with fromUrl
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: myidpfromurl
display_name: OpenID Connect IdP from url
enabled: true
provider_id: oidc
config:
fromUrl: "{{ auth_keycloak_url }}/realms/myidprealm/.well-known/openid-configuration"
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
syncMode: FORCE
state: present
register: result
- name: Assert identity provider created with IDP endpoints
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.authorizationUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/auth"
- result.end_state.config.issuer == auth_keycloak_url ~ "/realms/myidprealm"
- result.end_state.config.jwksUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/certs"
- result.end_state.config.logoutUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/logout"
- result.end_state.config.tokenUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/token"
- result.end_state.config.userInfoUrl == auth_keycloak_url ~ "/realms/myidprealm/protocol/openid-connect/userinfo"
- name: Create new identity provider with fromUrl and exclusion should fail
middleware_automation.keycloak.keycloak_identity_provider:
realm: "{{ ephemeral_realm }}"
alias: "mustfail"
display_name: Failed OpenID Connect IdP from url
enabled: true
provider_id: oidc
config: "{{ config | combine(endpoint) }}"
state: present
vars:
config:
fromUrl: "{{ auth_keycloak_url }}/realms/myidprealm/.well-known/openid-configuration"
clientAuthMethod: client_secret_post
clientId: clientid
clientSecret: clientsecret
endpoint: "{{ { item: auth_keycloak_url ~ '/realms/myidprealm/protocol/openid-connect/' ~ item } }}"
with_items: ['userInfoUrl', 'authorizationUrl', 'tokenUrl', 'logoutUrl', 'issuer', 'jwksUrl']
register: result
ignore_errors: true
- name: Check failure of identity provider creation with fromUrl and userInfoUrl
ansible.builtin.assert:
that:
- result is not changed
- result is failed
- result.results | selectattr('failed', 'equalto', false) | list | length == 0
@@ -0,0 +1,4 @@
---
client_secret: myclientsecret
auth_test_role: myrole
keycloak_role_description: test
@@ -0,0 +1,281 @@
---
# Ported from community.general tests/integration/targets/keycloak_modules_authentication
# Tests the authentication layer shared by all keycloak modules:
# token auth, refresh token fallback, auth fallback chains, client_credentials, and 401 errors.
- name: Load authentication test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Reset public login in master admin-cli (if potentially previous test failed)
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: true
state: present
- name: Create new realm role with username/password authentication
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert username/password authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Get Keycloak token
ansible.builtin.uri:
url: "{{ auth_keycloak_url }}/realms/master/protocol/openid-connect/token"
method: POST
return_content: true
status_code: 200
body_format: form-urlencoded
body:
grant_type: "password"
client_id: "admin-cli"
username: "{{ auth_username }}"
password: "{{ auth_password }}"
register: token_response
- name: Extract tokens
ansible.builtin.set_fact:
access_token: "{{ token_response.json.access_token }}"
refresh_token: "{{ token_response.json.refresh_token }}"
- name: Create new realm role with provided token authentication
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
token: "{{ access_token }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert token authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token and valid refresh token
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
refresh_token: "{{ refresh_token }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert refresh token fallback authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token and valid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert username/password fallback authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Create new realm role with invalid auth token, invalid refresh token, and valid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
token: "invalidtoken!!!"
refresh_token: "invalidrefreshtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert full fallback chain authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
- name: Test client_credentials authentication
block:
- name: PREPARE - Temporarily disable public login in master admin-cli
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: false
service_accounts_enabled: true
client_authenticator_type: client-secret
state: present
- name: PREPARE - Assign admin role to admin-cli in master
middleware_automation.keycloak.keycloak_user_rolemapping:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
realm: master
roles:
- name: admin
service_account_user_client_id: admin-cli
- name: Create new realm role with valid client_id and client_secret
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
- name: Assert client_credentials authentication succeeded
ansible.builtin.assert:
that:
- result is changed
- result is not failed
always:
- name: Reset temporarily disabled public login in master admin-cli
middleware_automation.keycloak.keycloak_client:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
auth_client_id: admin-cli
auth_client_secret: "{{ client_secret }}"
client_id: admin-cli
secret: "{{ client_secret }}"
public_client: true
state: present
- name: Remove created realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
state: absent
register: result
### Unhappy path tests
- name: Fail to create new realm role with invalid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "invalid_password"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
- name: Fail to create new realm role with invalid auth token
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_username: ""
auth_password: ""
token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
- name: Fail to create new realm role with invalid auth and refresh tokens, and invalid username/password
middleware_automation.keycloak.keycloak_role:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: master
auth_username: "{{ auth_username }}"
auth_password: "invalid_password"
token: "invalidtoken!!!"
refresh_token: "invalidtoken!!!"
realm: "{{ ephemeral_realm }}"
name: "{{ auth_test_role }}"
description: "{{ keycloak_role_description }}"
state: present
register: result
failed_when: >
("HTTP Error 401: Unauthorized" not in result.msg) and
("HTTP Error 400: Bad Request" not in result.msg)
@@ -0,0 +1,56 @@
---
# 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
@@ -0,0 +1,526 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm_key
# Tests auto-generated key providers: HMAC, AES, ECDSA, RSA, RSA-ENC, ECDH, EdDSA.
# Skips RSA with private key (needs external key material) and Java Keystore (needs keystore file).
# --- HMAC generated key ---
- name: Create HMAC key (check mode)
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
check_mode: true
register: result
- name: Assert HMAC key would be created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "hmac-test-key"
- result.end_state.providerId == "hmac-generated"
- result.end_state.config.algorithm == ["HS256"]
- result.end_state.config.secretSize == ["64"]
- result.msg == "Realm key hmac-test-key would be created"
- name: Create HMAC key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "hmac-test-key"
- result.end_state.providerId == "hmac-generated"
- result.end_state.providerType == "org.keycloak.keys.KeyProvider"
- result.end_state.config.algorithm == ["HS256"]
- result.end_state.config.secretSize == ["64"]
- result.msg == "Realm key hmac-test-key created"
- name: Create HMAC key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 100
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key hmac-test-key was in sync"
- name: Update HMAC key priority
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 110
algorithm: HS256
secret_size: 64
register: result
- name: Assert HMAC key was updated
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.priority == ["110"]
- "'config.priority' in result.msg"
- name: Remove HMAC key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
priority: 110
register: result
- name: Assert HMAC key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Realm key hmac-test-key deleted"
# --- AES generated key ---
- name: Create AES key
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
enabled: true
active: true
priority: 100
secret_size: 32
register: result
- name: Assert AES key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "aes-test-key"
- result.end_state.providerId == "aes-generated"
- result.end_state.config.secretSize == ["32"]
- result.msg == "Realm key aes-test-key created"
- name: Create AES key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
enabled: true
active: true
priority: 100
secret_size: 32
register: result
- name: Assert AES key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key aes-test-key was in sync"
- name: Remove AES key
middleware_automation.keycloak.keycloak_realm_key:
name: aes-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: aes-generated
config:
priority: 100
register: result
- name: Assert AES key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key aes-test-key deleted"
# --- ECDSA generated key ---
- name: Create ECDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: ES256
elliptic_curve: P-256
register: result
- name: Assert ECDSA key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ecdsa-test-key"
- result.end_state.providerId == "ecdsa-generated"
- result.end_state.config.algorithm == ["ES256"]
- result.end_state.config.ecdsaEllipticCurveKey == ["P-256"]
- result.msg == "Realm key ecdsa-test-key created"
- name: Create ECDSA key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: ES256
elliptic_curve: P-256
register: result
- name: Assert ECDSA key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key ecdsa-test-key was in sync"
- name: Remove ECDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdsa-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdsa-generated
config:
priority: 100
register: result
- name: Assert ECDSA key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key ecdsa-test-key deleted"
# --- RSA generated key ---
- name: Create RSA generated key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: RS256
key_size: 2048
register: result
- name: Assert RSA generated key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "rsa-gen-test-key"
- result.end_state.providerId == "rsa-generated"
- result.end_state.config.algorithm == ["RS256"]
- result.end_state.config.keySize == ["2048"]
- result.msg == "Realm key rsa-gen-test-key created"
- name: Create RSA generated key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
enabled: true
active: true
priority: 100
algorithm: RS256
key_size: 2048
register: result
- name: Assert RSA generated key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key rsa-gen-test-key was in sync"
- name: Remove RSA generated key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-gen-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-generated
config:
priority: 100
register: result
- name: Assert RSA generated key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key rsa-gen-test-key deleted"
# --- Default realm key management ---
- name: Update priority of default hmac-generated key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-generated
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
enabled: true
active: true
priority: 150
algorithm: HS256
register: result
- name: Assert default hmac-generated key was updated
ansible.builtin.assert:
that:
- result is changed
- result.end_state.config.priority == ["150"]
- name: Remove default hmac-generated key
middleware_automation.keycloak.keycloak_realm_key:
name: hmac-generated
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: hmac-generated
config:
priority: 150
register: result
- name: Assert default hmac-generated key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Realm key hmac-generated deleted"
# --- RSA encryption generated key ---
- name: Create RSA encryption key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
enabled: true
active: true
priority: 100
algorithm: RSA-OAEP
key_size: 2048
register: result
- name: Assert RSA encryption key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "rsa-enc-gen-test-key"
- result.end_state.providerId == "rsa-enc-generated"
- result.end_state.config.algorithm == ["RSA-OAEP"]
- result.end_state.config.keySize == ["2048"]
- result.msg == "Realm key rsa-enc-gen-test-key created"
- name: Create RSA encryption key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
enabled: true
active: true
priority: 100
algorithm: RSA-OAEP
key_size: 2048
register: result
- name: Assert RSA encryption key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key rsa-enc-gen-test-key was in sync"
- name: Remove RSA encryption key
middleware_automation.keycloak.keycloak_realm_key:
name: rsa-enc-gen-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: rsa-enc-generated
config:
priority: 100
register: result
- name: Assert RSA encryption key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key rsa-enc-gen-test-key deleted"
# --- ECDH generated key ---
- name: Create ECDH key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
enabled: true
active: true
priority: 100
algorithm: ECDH_ES
elliptic_curve: P-256
register: result
- name: Assert ECDH key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "ecdh-test-key"
- result.end_state.providerId == "ecdh-generated"
- result.end_state.config.algorithm == ["ECDH_ES"]
- result.end_state.config.ecdhEllipticCurveKey == ["P-256"]
- result.msg == "Realm key ecdh-test-key created"
- name: Create ECDH key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
enabled: true
active: true
priority: 100
algorithm: ECDH_ES
elliptic_curve: P-256
register: result
- name: Assert ECDH key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key ecdh-test-key was in sync"
- name: Remove ECDH key
middleware_automation.keycloak.keycloak_realm_key:
name: ecdh-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: ecdh-generated
config:
priority: 100
register: result
- name: Assert ECDH key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key ecdh-test-key deleted"
# --- EdDSA generated key ---
- name: Create EdDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
enabled: true
active: true
priority: 100
elliptic_curve: Ed25519
register: result
- name: Assert EdDSA key was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.name == "eddsa-test-key"
- result.end_state.providerId == "eddsa-generated"
- result.end_state.config.eddsaEllipticCurveKey == ["Ed25519"]
- result.msg == "Realm key eddsa-test-key created"
- name: Create EdDSA key (idempotency)
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: present
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
enabled: true
active: true
priority: 100
elliptic_curve: Ed25519
register: result
- name: Assert EdDSA key is in sync
ansible.builtin.assert:
that:
- result is not changed
- result.msg == "Realm key eddsa-test-key was in sync"
- name: Remove EdDSA key
middleware_automation.keycloak.keycloak_realm_key:
name: eddsa-test-key
state: absent
parent_id: "{{ ephemeral_realm }}"
provider_id: eddsa-generated
config:
priority: 100
register: result
- name: Assert EdDSA key was deleted
ansible.builtin.assert:
that:
- result is changed
- result.msg == "Realm key eddsa-test-key deleted"
@@ -0,0 +1,6 @@
---
keycloak_username: test
keycloak_user_groups:
- name: test
state: present
- name: test2
@@ -0,0 +1,57 @@
---
# Ported from community.general tests/integration/targets/keycloak_realm_users_info
# Tests multi-user listing and group membership in realm users info response.
- name: Load realm users info 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 }}"
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.groups | length == 2
- name: Create another user
middleware_automation.keycloak.keycloak_user:
username: "testuser2"
realm: "{{ ephemeral_realm }}"
first_name: Ceciestes2
last_name: Untestes2
email: ceciestuntestes2@test.com
state: present
register: create_result2
- name: Get user info
middleware_automation.keycloak.keycloak_realm_users_info:
realm: "{{ ephemeral_realm }}"
register: user_infos
- name: Add missing group info for comparison
ansible.builtin.set_fact:
user_info_with_groups: "{{ [user_infos.users[0] | combine({'groups': ['test', 'test2']}), user_infos.users[1] | combine({'groups': []}) ] }}"
- name: Assert user info is returned correctly
ansible.builtin.assert:
that:
- not user_infos.changed
- "user_info_with_groups == [create_result.end_state, create_result2.end_state]"
@@ -0,0 +1,32 @@
---
description_1: role test desc 1
description_2: role test desc 2
keycloak_role_description: composite role test
keycloak_role_composites:
- name: view-clients
client_id: "realm-management"
state: present
- name: query-clients
client_id: "realm-management"
state: present
- name: offline_access
state: present
keycloak_role_composites_with_aliases:
- name: view-clients
clientId: "realm-management"
state: present
- name: query-clients
clientId: "realm-management"
state: present
- name: offline_access
state: present
keycloak_role_composites_with_absent:
- name: view-clients
client_id: "realm-management"
state: present
- name: query-clients
client_id: "realm-management"
state: present
- name: offline_access
state: absent
@@ -0,0 +1,335 @@
---
# Ported from community.general tests/integration/targets/keycloak_role
# Tests full CRUD lifecycle for realm/client roles and composite role management.
- name: Load role test variables
ansible.builtin.include_vars:
file: vars.yml
# --- Realm role CRUD ---
- name: Create realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert realm role created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == "myrole-test"
- result.end_state.containerId == ephemeral_realm
- name: Create realm role again (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert realm role unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update realm role description
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
description: "{{ description_2 }}"
state: present
register: result
- name: Assert realm role updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.description == description_1
- result.end_state.description == description_2
- name: Delete realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
state: absent
register: result
- name: Assert realm role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent realm role (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: myrole-test
state: absent
register: result
- name: Assert no change on absent realm role
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Client role CRUD ---
- name: Create client for role tests
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: myclient
state: present
register: role_test_client
- name: Create client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert client role created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == "client-role-test"
- result.end_state.containerId == role_test_client.end_state.id
- name: Create client role again (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_1 }}"
state: present
register: result
- name: Assert client role unchanged
ansible.builtin.assert:
that:
- result is not changed
- name: Update client role description
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
description: "{{ description_2 }}"
state: present
register: result
- name: Assert client role updated
ansible.builtin.assert:
that:
- result is changed
- result.existing.description == description_1
- result.end_state.description == description_2
- name: Delete client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
state: absent
register: result
- name: Assert client role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent client role (idempotency)
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: myclient
name: client-role-test
state: absent
register: result
- name: Assert no change on absent client role
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Composite realm roles ---
- name: Create realm role with composites
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert realm role created with composites
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 3
- name: Realm role with composites (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert composites unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state.composites | length == 3
- name: Realm composites with aliases (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_aliases }}"
state: present
register: result
- name: Assert composites unchanged with aliases
ansible.builtin.assert:
that:
- result is not changed
- name: Remove one composite from realm role
middleware_automation.keycloak.keycloak_role:
name: composite-role
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_absent }}"
state: present
register: result
- name: Assert composite removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 2
- name: Delete composite realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-role
state: absent
register: result
- name: Assert composite role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent realm role with composites
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-role
state: absent
register: result
- name: Assert not changed and realm role absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
# --- Composite client roles ---
- name: Create client role with composites
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert client role created with composites
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 3
- name: Client role with composites (idempotency)
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites }}"
state: present
register: result
- name: Assert client composites unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.end_state.composites | length == 3
- name: Remove one composite from client role
middleware_automation.keycloak.keycloak_role:
name: composite-client-role
client_id: myclient
realm: "{{ ephemeral_realm }}"
description: "{{ keycloak_role_description }}"
composite: true
composites: "{{ keycloak_role_composites_with_absent }}"
state: present
register: result
- name: Assert composite removed from client role
ansible.builtin.assert:
that:
- result is changed
- result.end_state.composites | length == 2
- name: Delete composite client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-client-role
client_id: myclient
state: absent
register: result
- name: Assert composite client role deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- name: Delete absent client role with composites
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: composite-client-role
client_id: myclient
state: absent
register: result
- name: Assert not changed and client role absent
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
@@ -0,0 +1,19 @@
---
keycloak_username: test
keycloak_user_attributes:
- name: attr1
values:
- value1s
state: present
- name: attr2
values:
- value2s
state: present
- name: attr3
values:
- value3s
state: present
keycloak_user_groups:
- name: test
state: present
- name: test2
@@ -0,0 +1,221 @@
---
# 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 == []
@@ -0,0 +1,2 @@
---
federation: myfed
@@ -0,0 +1,352 @@
---
# Ported from community.general tests/integration/targets/keycloak_user_federation
# Tests full LDAP user federation lifecycle: create, idempotency (with masked credentials),
# update with mappers, delete, delete-absent, and create-with-mappers-in-one-step.
- name: Load user federation test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create new user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Create new user federation in admin realm
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation created (admin realm)
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Update existing user federation (no change)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Update existing user federation (no change, admin realm)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
register: result
- name: Assert user federation unchanged (admin realm)
ansible.builtin.assert:
that:
- result is not changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Update existing user federation (with change)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: "**********"
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
mappers:
- name: "username"
providerId: "user-attribute-ldap-mapper"
config:
ldap.attribute: ldap_user
user.model.attribute: usr
read.only: true
- name: "full name"
providerId: "full-name-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.full.name.attribute: cn
read.only: true
write.only: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing != {}
- result.existing.name == federation
- result.end_state != {}
- result.end_state.name == federation
- name: Delete existing user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
register: result
- name: Assert user federation deleted
ansible.builtin.assert:
that:
- result is changed
- result.existing != {}
- result.end_state == {}
- name: Delete absent user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
register: result
- name: Assert user federation unchanged
ansible.builtin.assert:
that:
- result is not changed
- result.existing == {}
- result.end_state == {}
- name: Create new user federation together with mappers
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: present
provider_id: ldap
provider_type: org.keycloak.storage.UserStorageProvider
config:
enabled: true
priority: 0
fullSyncPeriod: -1
changedSyncPeriod: -1
cachePolicy: DEFAULT
batchSizeForSync: 1000
editMode: READ_ONLY
importEnabled: true
syncRegistrations: false
vendor: other
usernameLDAPAttribute: uid
rdnLDAPAttribute: uid
uuidLDAPAttribute: entryUUID
userObjectClasses: "inetOrgPerson, organizationalPerson"
connectionUrl: "ldaps://ldap.example.com:636"
usersDn: "ou=Users,dc=example,dc=com"
authType: simple
bindDn: cn=directory reader
bindCredential: secret
searchScope: 1
validatePasswordPolicy: false
trustEmail: false
useTruststoreSpi: "ldapsOnly"
connectionPooling: true
pagination: true
allowKerberosAuthentication: false
useKerberosForPasswordAuthentication: false
debug: false
mappers:
- name: "username"
providerId: "user-attribute-ldap-mapper"
config:
ldap.attribute: ldap_user
user.model.attribute: usr
read.only: true
- name: "full name"
providerId: "full-name-ldap-mapper"
providerType: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
config:
ldap.full.name.attribute: cn
read.only: true
write.only: false
register: result
- name: Assert user federation created
ansible.builtin.assert:
that:
- result is changed
- result.existing == {}
- result.end_state.name == federation
- name: Clean up - delete user federation
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ ephemeral_realm }}"
name: "{{ federation }}"
state: absent
- name: Clean up - delete user federation (admin realm)
middleware_automation.keycloak.keycloak_user_federation:
realm: "{{ auth_realm }}"
name: "{{ federation }}"
state: absent
@@ -0,0 +1,5 @@
---
client_id: myclient
client_id_2: myotherclient
test_role: myrole
description_1: desc 1
@@ -0,0 +1,141 @@
---
# Ported from community.general tests/integration/targets/keycloak_user_rolemapping
# Tests service account role mapping (realm and client roles) and cross-client mapping.
- name: Load user rolemapping test variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create client with service account for rolemapping test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_accounts_enabled: true
state: present
register: rolemapping_client
- name: Create realm role for service account mapping
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ test_role }}"
description: "{{ description_1 }}"
state: present
- name: Map realm role to client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert realm role is assigned to service account
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap realm role from client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert realm role is unassigned from service account
ansible.builtin.assert:
that:
- result is changed
- (result.end_state | length) == (result.existing | length) - 1
- result.existing | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count > 0
- result.end_state | selectattr("clientRole", "eq", false) | selectattr("name", "eq", test_role) | list | count == 0
- name: Delete existing realm role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
name: "{{ test_role }}"
state: absent
- name: Create second client for cross-client role mapping test
middleware_automation.keycloak.keycloak_client:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id_2 }}"
service_accounts_enabled: true
state: present
register: client_2
- name: Create new client role
middleware_automation.keycloak.keycloak_role:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
name: "{{ test_role }}"
description: "{{ description_1 }}"
state: present
- name: Map client role to user with no existing roles for that client
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id_2 }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert client role is assigned to user with no prior roles
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap the cross-client role mapping
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id_2 }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert cross-client role mapping is removed
ansible.builtin.assert:
that:
- result is changed
- result.end_state == []
- name: Map client role to client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: present
register: result
- name: Assert client role is assigned
ansible.builtin.assert:
that:
- result is changed
- result.end_state | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
- name: Unmap client role from client service account
middleware_automation.keycloak.keycloak_user_rolemapping:
realm: "{{ ephemeral_realm }}"
client_id: "{{ client_id }}"
service_account_user_client_id: "{{ client_id }}"
roles:
- name: "{{ test_role }}"
state: absent
register: result
- name: Assert client role is unassigned
ansible.builtin.assert:
that:
- result is changed
- result.end_state == []
- result.existing | selectattr("clientRole", "eq", true) | selectattr("name", "eq", test_role) | list | count > 0
@@ -0,0 +1,109 @@
---
attributes_default:
- name: username
displayName: "${username}"
validations:
length:
min: 3
max: 255
usernameProhibitedCharacters: {}
up_username_not_idn_homograph: {}
annotations: {}
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: email
displayName: "${email}"
validations:
email: {}
length:
max: 255
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: firstName
displayName: "${firstName}"
validations:
length:
max: 255
personNameProhibitedCharacters: {}
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
- name: lastName
displayName: "${lastName}"
validations:
length:
max: 255
person_name_prohibited_characters: {}
annotations: {}
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
attributes_additional:
- name: additionalAttribute
displayName: additionalAttribute
group: user-metadata
required:
roles:
- user
permissions:
view:
- admin
- user
edit: []
multivalued: false
groups_default:
- name: user-metadata
displayHeader: User metadata
displayDescription: Attributes, which refer to user metadata
config_default:
kc_user_profile_config:
- attributes: "{{ attributes_default }}"
groups: "{{ groups_default }}"
config_updated:
kc_user_profile_config:
- attributes: "{{ attributes_default + attributes_additional }}"
groups: "{{ groups_default }}"
config_unmanaged_attributes_enabled:
kc_user_profile_config:
- unmanagedAttributePolicy: ENABLED
attributes: "{{ attributes_default }}"
config_unmanaged_attributes_admin_edit:
kc_user_profile_config:
- unmanagedAttributePolicy: ADMIN_EDIT
attributes: "{{ attributes_default }}"
config_unmanaged_attributes_admin_view:
kc_user_profile_config:
- unmanagedAttributePolicy: ADMIN_VIEW
attributes: "{{ attributes_default }}"
@@ -0,0 +1,187 @@
---
# Ported from community.general tests/integration/targets/keycloak_userprofile
# Tests full CRUD cycle with check_mode for user profile config,
# switching between unmanaged attribute policies (ENABLED, ADMIN_EDIT, ADMIN_VIEW).
- name: Load user profile config variables
ansible.builtin.include_vars:
file: vars.yml
- name: Create default User Profile (check mode)
middleware_automation.keycloak.keycloak_userprofile:
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
check_mode: true
register: result
- name: Assert User Profile would be created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile would be created"
- name: Create default User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
diff: true
register: result
- name: Assert User Profile was created
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile created"
- name: Create default User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
register: result
- name: Assert User Profile was in sync
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile was in sync"
- name: Update User Profile (check mode)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
check_mode: true
register: result
- name: Assert User Profile would be changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile would be changed:")
- name: Update User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
diff: true
register: result
- name: Assert User Profile changed
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Update User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_updated }}"
register: result
- name: Assert User Profile still in sync
ansible.builtin.assert:
that:
- result is not changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile was in sync"
- name: Remove User Profile
middleware_automation.keycloak.keycloak_userprofile:
state: absent
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
diff: true
register: result
- name: Assert User Profile was deleted
ansible.builtin.assert:
that:
- result is changed
- result.end_state == {}
- result.msg == "Userprofile declarative-user-profile deleted"
- name: Remove User Profile (idempotency)
middleware_automation.keycloak.keycloak_userprofile:
state: absent
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_default }}"
register: result
- name: Assert User Profile not present
ansible.builtin.assert:
that:
- result is not changed
- result.end_state == {}
- result.msg == "Userprofile declarative-user-profile not present"
- name: Create User Profile with unmanaged attributes ENABLED
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_enabled }}"
diff: true
register: result
- name: Assert User Profile created with ENABLED policy
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg == "Userprofile declarative-user-profile created"
- name: Change User Profile to unmanaged ADMIN_EDIT
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_admin_edit }}"
diff: true
register: result
- name: Assert User Profile changed to ADMIN_EDIT
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
- name: Change User Profile to unmanaged ADMIN_VIEW
middleware_automation.keycloak.keycloak_userprofile:
state: present
parent_id: "{{ ephemeral_realm }}"
config: "{{ config_unmanaged_attributes_admin_view }}"
diff: true
register: result
- name: Assert User Profile changed to ADMIN_VIEW
ansible.builtin.assert:
that:
- result is changed
- result.end_state != {}
- result.end_state.providerId == "declarative-user-profile"
- result.end_state.providerType == "org.keycloak.userprofile.UserProfileProvider"
- result.msg.startswith("Userprofile declarative-user-profile changed:")
+51
View File
@@ -0,0 +1,51 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
roles_path: ../../roles
ssh_connection:
pipelining: false
playbooks:
prepare: prepare.yml
converge: converge.yml
verify: verify.yml
inventory:
group_vars:
all:
keycloak_install_requires_become: true
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- idempotence
- side_effect
- verify
- cleanup
- destroy
+2
View File
@@ -0,0 +1,2 @@
---
- import_playbook: ../default/prepare.yml
File diff suppressed because it is too large Load Diff
+49
View File
@@ -0,0 +1,49 @@
---
driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
defaults:
interpreter_python: auto_silent
roles_path: ../../roles
ssh_connection:
pipelining: false
playbooks:
prepare: ../default/prepare.yml
converge: ../default/converge.yml
verify: verify.yml
inventory:
group_vars:
all:
keycloak_install_requires_become: true
host_vars:
localhost:
ansible_python_interpreter: "{{ ansible_playbook_python }}"
env:
ANSIBLE_FORCE_COLOR: "true"
PROXY: "${PROXY}"
NO_PROXY: "${NO_PROXY}"
verifier:
name: ansible
scenario:
test_sequence:
- cleanup
- destroy
- create
- prepare
- converge
- verify
- cleanup
- destroy
+64
View File
@@ -0,0 +1,64 @@
---
- name: Verify use_netrc option prevents .netrc from overriding bearer token (issue 403)
hosts: all
vars:
auth_keycloak_url: http://instance:8080
auth_realm: master
auth_username: remembertochangeme
auth_password: remembertochangeme
target_realm: TestRealm
module_defaults:
group/middleware_automation.keycloak.keycloak:
auth_keycloak_url: "{{ auth_keycloak_url }}"
auth_realm: "{{ auth_realm }}"
auth_username: "{{ auth_username }}"
auth_password: "{{ auth_password }}"
validate_certs: false
tasks:
- name: Populate service facts
ansible.builtin.service_facts:
- name: Check if keycloak service started
ansible.builtin.assert:
that:
- ansible_facts.services["keycloak.service"]["state"] == "running"
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
fail_msg: Keycloak service is not running
- name: Verify netrc handling
block:
- name: Create .netrc with bogus credentials matching the Keycloak host
ansible.builtin.copy:
dest: ~/.netrc
mode: "0600"
content: |
machine instance
login netrc_user
password netrc_password
- name: API call with default use_netrc (false) ignores .netrc
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
realm: "{{ target_realm }}"
register: netrc_default_result
- name: Assert API call succeeds with default use_netrc despite .netrc
ansible.builtin.assert:
that:
- netrc_default_result is not failed
- name: API call with use_netrc true picks up .netrc credentials
middleware_automation.keycloak.keycloak_realm_keys_metadata_info:
realm: "{{ target_realm }}"
use_netrc: true
register: netrc_true_result
ignore_errors: true
- name: Assert API call fails when use_netrc is true and .netrc has credentials
ansible.builtin.assert:
that:
- netrc_true_result is failed
always:
- name: Remove .netrc test file
ansible.builtin.file:
path: ~/.netrc
state: absent
+4
View File
@@ -1,8 +1,12 @@
---
- name: Converge
hosts: all
vars_files:
- ../group_vars/all/vars.yml
vars:
keycloak_quarkus_bootstrap_admin_password: "remembertochangeme"
keycloak_admin_password: "remembertochangeme"
keycloak_quarkus_hostname: "http://instance:8080"
keycloak_config_override_template: custom.xml.j2
keycloak_http_port: 8081
keycloak_management_http_port: 19990
+3 -2
View File
@@ -3,14 +3,15 @@ driver:
name: docker
platforms:
- name: instance
image: registry.access.redhat.com/ubi8/ubi-init:latest
image: registry.access.redhat.com/ubi9/ubi-init:latest
pre_build_image: true
privileged: true
command: "/usr/sbin/init"
port_bindings:
exposed_ports:
- "8080/tcp"
- "8443/tcp"
- "8009/tcp"
- "9000/tcp"
provisioner:
name: ansible
config_options:
+2
View File
@@ -1,6 +1,8 @@
---
- name: Prepare
hosts: all
vars_files:
- ../group_vars/all/vars.yml
gather_facts: yes
vars:
sudo_pkg_name: sudo
+3 -2
View File
@@ -25,17 +25,18 @@
fail_msg: "sudo is not installed on target system"
- name: "Install iproute"
become: true
ansible.builtin.yum:
name:
- iproute
state: present
when:
- ansible_user_id == 'root'
- name: "Retrieve assets server from env"
ansible.builtin.set_fact:
assets_server: "{{ lookup('env', 'MIDDLEWARE_DOWNLOAD_RELEASE_SERVER_URL') }}"
- name: "Download artefacts only if assets_server is set"
- name: "Download artifacts only if assets_server is set"
when:
- assets_server is defined
- assets_server | length > 0

Some files were not shown because too many files have changed in this diff Show More