New Module: Keycloak User Rolemapping #4898

bratwurzt · 2022-06-28T12:15:36Z

SUMMARY

Add keycloak_user_rolemapping module to provide management of direct assignment of client/realm roles to users. Also provides user role mapping for service-account users.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

keycloak_user_rolemapping

ADDITIONAL INFORMATION

Example:

- name: Map a client role to a user, authentication with credentials
  community.general.keycloak_user_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: present
    client_id: client1
    user_id: user1Id
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Map a client role to a service account user for a client, authentication with credentials
  community.general.keycloak_user_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: present
    client_id: client1
    service_account_user_client_id: clientIdOfServiceAccount
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

ansibullbot · 2022-06-28T12:17:37Z

@bratwurzt this PR contains the following merge commits:

2b2ba7e

Please rebase your branch to remove these commits.

click here for bot help

felixfontein

Thanks for your contribution! I've added some very first comments.

Please note that every new module must come with tests (integration or unit tests). Since other keycloak modules have unit tests as well, adding similar tests is probably a good idea.

plugins/modules/identity/keycloak/keycloak_user_rolemapping.py

ansibullbot · 2022-06-29T12:32:23Z

cc @Gaetan2907 @eikef @ndclt
click here for bot help

plugins/modules/identity/keycloak/keycloak_user_rolemapping.py

tests/integration/targets/keycloak_user_rolemapping/aliases

tests/integration/targets/keycloak_user_rolemapping/tasks/main.yml

tests/integration/targets/keycloak_user_rolemapping/vars/main.yml

felixfontein

Besides the following point, this looks good to me. I cannot really test this, but the code changes look good to me (i.e. they don't seem to break something that already worked) and since none of the maintainers reacted so far, I guess nobody objects. I'll merge this in a couple of days (assuming the below modification has been done).

Hmm, I must have done something strange, this should have ended up with a comment in another PR... I'll look at this one later, please ignore this for now :)

plugins/modules/identity/keycloak/keycloak_user_rolemapping.py

tests/integration/targets/keycloak_user_rolemapping/tasks/main.yml

tests/integration/targets/keycloak_user_rolemapping/aliases

tests/integration/targets/keycloak_user_rolemapping/vars/main.yml

felixfontein

Since nobody else bothered to comment on this, and it looks good enough to me (I don't use keycloak so I cannot really comment on that aspect), I'm declaring this ready to merge and will merge it :)

patchback · 2022-10-01T16:16:51Z

Backport to stable-5: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-5/2cac3ae879172c59149637a80c4597b1a2e156de/pr-4898

Backported as #5324

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

* keycloak_user_rolemapping: implement user role mapping * keycloak_user_rolemapping: additional logging * keycloak_user_rolemapping: move to getters, use names parameters * keycloak_user_rolemapping: add service account user example * Add keyring and keyring_info modules (#4764) * keycloak_user_rolemapping: write tests, address ansibullbot concerns no.1 * keycloak_user_rolemapping: address felixfontein concerns no.1 * keycloak_user_rolemapping: remove rebase mistakes * keycloak_user_rolemapping: address felixfontein concerns no.2 * keycloak_user_rolemapping: refactor duplicate username usage example * keycloak_user_rolemapping: fix sanity check errors no.1 * keycloak_user_rolemapping: fix sanity check errors no.2 * keycloak_user_rolemapping: fix sanity check errors no.3 * keycloak_user_rolemapping: fix sanity check errors no.4 * keycloak_user_rolemapping: write tests, address ansibullbot concerns no.1 * keycloak_user_rolemapping: resolve rebase conflicts with origin/main branch # Conflicts: # plugins/module_utils/identity/keycloak/keycloak.py * keycloak_user_rolemapping: remove keycloak_role_composites from BOTMETA.yml * keycloak_user_rolemapping: fix sanity check errors no.5 * keycloak_user_rolemapping: address felixfontein reviews concerns no.1 * keycloak_user_rolemapping: address felixfontein reviews concerns no.2 Co-authored-by: Dušan Markovič <[email protected]> Co-authored-by: ahussey-redhat <[email protected]> (cherry picked from commit 2cac3ae)

felixfontein · 2022-10-01T16:17:09Z

@bratwurzt thanks a lot for your contribution, and sorry that it took so long to get it merged!

* keycloak_user_rolemapping: implement user role mapping * keycloak_user_rolemapping: additional logging * keycloak_user_rolemapping: move to getters, use names parameters * keycloak_user_rolemapping: add service account user example * Add keyring and keyring_info modules (#4764) * keycloak_user_rolemapping: write tests, address ansibullbot concerns no.1 * keycloak_user_rolemapping: address felixfontein concerns no.1 * keycloak_user_rolemapping: remove rebase mistakes * keycloak_user_rolemapping: address felixfontein concerns no.2 * keycloak_user_rolemapping: refactor duplicate username usage example * keycloak_user_rolemapping: fix sanity check errors no.1 * keycloak_user_rolemapping: fix sanity check errors no.2 * keycloak_user_rolemapping: fix sanity check errors no.3 * keycloak_user_rolemapping: fix sanity check errors no.4 * keycloak_user_rolemapping: write tests, address ansibullbot concerns no.1 * keycloak_user_rolemapping: resolve rebase conflicts with origin/main branch # Conflicts: # plugins/module_utils/identity/keycloak/keycloak.py * keycloak_user_rolemapping: remove keycloak_role_composites from BOTMETA.yml * keycloak_user_rolemapping: fix sanity check errors no.5 * keycloak_user_rolemapping: address felixfontein reviews concerns no.1 * keycloak_user_rolemapping: address felixfontein reviews concerns no.2 Co-authored-by: Dušan Markovič <[email protected]> Co-authored-by: ahussey-redhat <[email protected]> (cherry picked from commit 2cac3ae) Co-authored-by: bratwurzt <[email protected]>

* upstream/main: (203 commits) Make pfexec become usable for illumos (ansible-collections#3889) znode: add options for authentication (ansible-collections#5306) keycloak_user_federation: add explanation and example to vendor option (ansible-collections#4893) Next expected release is 5.8.0. Allow terraform module to specify complex variable structures (ansible-collections#4797) Fix ansible-collections#5313: redhat_subscription module is not idempotent when pool_ids (ansible-collections#5319) bitwarden: Add field to search for all item attributes, instead of on… (ansible-collections#5297) New Module: Keycloak User Rolemapping (ansible-collections#4898) chore: Update lxc_container to support py3 (ansible-collections#5304) terraform: run `init` with no-color, too (ansible-collections#5147) nmcli: fix error when setting previously unset mac address (ansible-collections#5291) [feat] proxmox_snap: snapshot containers with configured mountpoints (ansible-collections#5274) machinectl: include the success command (ansible-collections#5287) Add SetSessionService to redfish_config (ansible-collections#5009) locale_gen: fix UbuntuMode (ansible-collections#5282) ini_file: fix lint error (ansible-collections#5307) netcup_dnsapi: Add timeout paramter (ansible-collections#5301) stable-2.14 is now default. Add stable-2.14 to CI, adjust to devel version bump (ansible-collections#5298) Try to run reuse workflow without explicitly allowing it for new contributors. (ansible-collections#5296) ...

bratwurzt · 2022-10-28T11:31:46Z

@bratwurzt thanks a lot for your contribution, and sorry that it took so long to get it merged!

No worries, glad I could contribute.

* keycloak_user_rolemapping: implement user role mapping * keycloak_user_rolemapping: additional logging * keycloak_user_rolemapping: move to getters, use names parameters * keycloak_user_rolemapping: add service account user example * Add keyring and keyring_info modules (ansible-collections#4764) * keycloak_user_rolemapping: write tests, address ansibullbot concerns no.1 * keycloak_user_rolemapping: address felixfontein concerns no.1 * keycloak_user_rolemapping: remove rebase mistakes * keycloak_user_rolemapping: address felixfontein concerns no.2 * keycloak_user_rolemapping: refactor duplicate username usage example * keycloak_user_rolemapping: fix sanity check errors no.1 * keycloak_user_rolemapping: fix sanity check errors no.2 * keycloak_user_rolemapping: fix sanity check errors no.3 * keycloak_user_rolemapping: fix sanity check errors no.4 * keycloak_user_rolemapping: write tests, address ansibullbot concerns no.1 * keycloak_user_rolemapping: resolve rebase conflicts with origin/main branch * keycloak_user_rolemapping: remove keycloak_role_composites from BOTMETA.yml * keycloak_user_rolemapping: fix sanity check errors no.5 * keycloak_user_rolemapping: address felixfontein reviews concerns no.1 * keycloak_user_rolemapping: address felixfontein reviews concerns no.2 Co-authored-by: Dušan Markovič <[email protected]> Co-authored-by: ahussey-redhat <[email protected]>

ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! module module needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html new_contributor Help guide this first time contributor new_plugin New plugin labels Jun 28, 2022

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jun 28, 2022

felixfontein reviewed Jun 29, 2022

View reviewed changes

plugins/modules/identity/keycloak/keycloak_user_rolemapping.py Outdated Show resolved Hide resolved

plugins/modules/identity/keycloak/keycloak_user_rolemapping.py Outdated Show resolved Hide resolved

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-5 labels Jun 29, 2022

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Jun 29, 2022

bratwurzt force-pushed the keycloak_user_rolemapping branch from f0a30d2 to 9281495 Compare June 29, 2022 11:57

This comment was marked as outdated.

Sign in to view

ansibullbot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI and removed merge_commit This PR contains at least one merge commit. Please resolve! labels Jun 29, 2022

This comment was marked as outdated.

Sign in to view

ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI labels Jun 29, 2022

bratwurzt force-pushed the keycloak_user_rolemapping branch 2 times, most recently from 965e448 to ad510d4 Compare June 29, 2022 12:27

ansibullbot removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html stale_ci CI is older than 7 days, rerun before merging labels Aug 2, 2022

This comment was marked as outdated.

Sign in to view

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Aug 2, 2022

keycloak_user_rolemapping: fix sanity check errors no.5

b8d3b05

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Aug 2, 2022

felixfontein reviewed Aug 8, 2022

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Aug 16, 2022

keycloak_user_rolemapping: address felixfontein reviews concerns no.1

baa17df

ansibullbot removed the stale_ci CI is older than 7 days, rerun before merging label Sep 18, 2022

This comment was marked as outdated.

Sign in to view

felixfontein reviewed Sep 18, 2022

View reviewed changes

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Sep 26, 2022

keycloak_user_rolemapping: address felixfontein reviews concerns no.2

3c70524

ansibullbot removed stale_ci CI is older than 7 days, rerun before merging needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Sep 26, 2022

felixfontein approved these changes Oct 1, 2022

View reviewed changes

felixfontein merged commit 2cac3ae into ansible-collections:main Oct 1, 2022

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Oct 1, 2022

patchback bot mentioned this pull request Oct 1, 2022

[PR #4898/2cac3ae8 backport][stable-5] New Module: Keycloak User Rolemapping #5324

Merged

bratwurzt deleted the keycloak_user_rolemapping branch October 28, 2022 11:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Module: Keycloak User Rolemapping #4898

New Module: Keycloak User Rolemapping #4898

bratwurzt commented Jun 28, 2022

ansibullbot commented Jun 28, 2022

This comment was marked as outdated.

felixfontein left a comment

This comment was marked as outdated.

This comment was marked as outdated.

ansibullbot commented Jun 29, 2022

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein left a comment •

edited

Loading

felixfontein left a comment

patchback bot commented Oct 1, 2022 •

edited

Loading

felixfontein commented Oct 1, 2022

bratwurzt commented Oct 28, 2022

New Module: Keycloak User Rolemapping #4898

New Module: Keycloak User Rolemapping #4898

Conversation

bratwurzt commented Jun 28, 2022

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Jun 28, 2022

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

ansibullbot commented Jun 29, 2022

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein left a comment • edited Loading

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

patchback bot commented Oct 1, 2022 • edited Loading

Backport to stable-5: 💚 backport PR created

felixfontein commented Oct 1, 2022

bratwurzt commented Oct 28, 2022

felixfontein left a comment •

edited

Loading

patchback bot commented Oct 1, 2022 •

edited

Loading