Add keycloak_realm_rolemapping module to map realm roles to groups #7663

agross · 2023-12-02T01:19:56Z

SUMMARY

For my Keycloak setup I need to be able to map realm roles into groups. Until now this collection does not support this.

ISSUE TYPE

New Module/Plugin Pull Request

COMPONENT NAME

keycloak_realm_rolemapping

ADDITIONAL INFORMATION

This is a continuation of #5384 which unfortunately was not merged.

ansibullbot · 2023-12-02T01:23:33Z

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

felixfontein

Thanks for your contribution!

For the errors regarding authors, see https://github.com/ansible-collections/community.general/blob/main/CONTRIBUTING.md#creating-new-modules-or-plugins.

Also note that new modules must always come with tests (unit tests, integration tests, or both). Some existing keycloak_* modules have unit tests (tests/unit/plugins/modules/test_keycloak_*.py), some others have integration tests (tests/integration/targets/keycloak_*).

plugins/module_utils/identity/keycloak/keycloak.py

plugins/modules/keycloak_realm_rolemapping.py

agross · 2023-12-06T13:17:24Z

Hello @felixfontein,

Thank you for your feedback. I'll continue working on the issues mentioned. I just wanted to get this out the door before people start duplicating work. I was aware this PR isn't perfect yet.

* mhuysamen submitted #7645 * Gaetan2907 authored keycloak_client_rolemapping.py which I took as a basis

agross · 2023-12-06T15:42:35Z

@felixfontein

I'm not sure what to do about this error regarding ansible/third-party-check:

+ ARTIFACT=/home/zuul/downloads/community-general-8.2.0.tar.gz
++ python -m galaxy_importer.main /home/zuul/downloads/community-general-8.2.0.tar.gz
+ output='Importing with galaxy-importer 0.4.17
ERROR: The import failed for the following reason: Invalid link target detected.'

agross · 2023-12-06T17:40:23Z

Hello @felixfontein,

The integration tests are successful when I run them locally with docker. I think I'm ready for your review, apart from that failing "third-party check" above which seems to have an issue with "TASK [Confirm collection can be imported into galaxy]". I'm not aware of any reason why it would fail with regard to my changes.

felixfontein · 2023-12-08T17:15:19Z

The third-party check check fails from time to time, you can ignore it. (I would rather remove it, but it comes as part of the "collection releasing is managed by Zuul" package, so I'm afraid we cannot remove it so easily...)

felixfontein · 2023-12-08T17:16:15Z

I'm not sure what to do about this error regarding ansible/third-party-check:

+ ARTIFACT=/home/zuul/downloads/community-general-8.2.0.tar.gz
++ python -m galaxy_importer.main /home/zuul/downloads/community-general-8.2.0.tar.gz
+ output='Importing with galaxy-importer 0.4.17
ERROR: The import failed for the following reason: Invalid link target detected.'

That was a bug in galaxy-importer that got fixed in ansible/galaxy-importer#252.

plugins/modules/keycloak_realm_rolemapping.py

Co-authored-by: Felix Fontein <[email protected]>

felixfontein · 2023-12-23T12:47:35Z

If nobody objects, I'll merge this in ~a week.

patchback · 2023-12-28T17:11:35Z

Backport to stable-8: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-8/f7bc6964be2d052278bf291f689dc2b85c609013/pr-7663

Backported as #7785

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

…7663) * Add keycloak_realm_rolemapping module to map realm roles to groups * Whitespace * Description in plain English * Casing * Update error reporting as per #7645 * Add agross as maintainer of keycloak_realm_rolemapping module * cid and client_id are not used here * Credit other authors * mhuysamen submitted #7645 * Gaetan2907 authored keycloak_client_rolemapping.py which I took as a basis * Add integration tests * With Keycloak 23 realmRoles are only returned if assigned * Remove debug statement * Add test verifying that unmap works when no realm roles are assigned * Add license to readme * Change version number this module was added * Document which versions of the docker images have been tested * Downgrade version_added Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit f7bc696)

felixfontein · 2023-12-28T17:12:17Z

@agross thanks for your contribution!

… module to map realm roles to groups (#7785) Add keycloak_realm_rolemapping module to map realm roles to groups (#7663) * Add keycloak_realm_rolemapping module to map realm roles to groups * Whitespace * Description in plain English * Casing * Update error reporting as per #7645 * Add agross as maintainer of keycloak_realm_rolemapping module * cid and client_id are not used here * Credit other authors * mhuysamen submitted #7645 * Gaetan2907 authored keycloak_client_rolemapping.py which I took as a basis * Add integration tests * With Keycloak 23 realmRoles are only returned if assigned * Remove debug statement * Add test verifying that unmap works when no realm roles are assigned * Add license to readme * Change version number this module was added * Document which versions of the docker images have been tested * Downgrade version_added Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit f7bc696) Co-authored-by: Alexander Groß <[email protected]>

agross changed the title ~~Add keycloak_realm_rolemapping module to map realm roles to groups~~ Add keycloak_realm_rolemapping module to map realm roles to groups (WIP) Dec 2, 2023

ansibullbot added identity module module module_utils module_utils new_contributor Help guide this first time contributor plugins plugin (any type) labels Dec 2, 2023

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 Dec 2, 2023

felixfontein reviewed Dec 2, 2023

View reviewed changes

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-8 Automatically create a backport for the stable-8 branch labels Dec 4, 2023

agross added 5 commits December 6, 2023 14:27

Add keycloak_realm_rolemapping module to map realm roles to groups

e73ba85

Whitespace

92d5ce6

Description in plain English

9d5717a

Casing

3c3fdbb

Update error reporting as per #7645

53ed242

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Dec 6, 2023

Add agross as maintainer of keycloak_realm_rolemapping module

775559d

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Dec 6, 2023

This comment was marked as outdated.

Sign in to view

cid and client_id are not used here

be6abcd

This comment was marked as outdated.

Sign in to view

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Dec 6, 2023

Credit other authors

bd6dfe1

* mhuysamen submitted #7645 * Gaetan2907 authored keycloak_client_rolemapping.py which I took as a basis

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Dec 6, 2023

Add integration tests

500f97f

agross added 4 commits December 6, 2023 18:17

With Keycloak 23 realmRoles are only returned if assigned

b23d8e5

Remove debug statement

df4188c

Add test verifying that unmap works when no realm roles are assigned

237f751

Add license to readme

6b5c51e

ansibullbot added integration tests/integration tests tests labels Dec 6, 2023

Change version number this module was added

4c35ab3

agross changed the title ~~Add keycloak_realm_rolemapping module to map realm roles to groups (WIP)~~ Add keycloak_realm_rolemapping module to map realm roles to groups Dec 6, 2023

Document which versions of the docker images have been tested

2bd99e7

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

felixfontein reviewed Dec 22, 2023

View reviewed changes

plugins/modules/keycloak_realm_rolemapping.py Outdated Show resolved Hide resolved

plugins/modules/keycloak_realm_rolemapping.py Show resolved Hide resolved

Downgrade version_added

c1a25ba

Co-authored-by: Felix Fontein <[email protected]>

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 28, 2023

felixfontein merged commit f7bc696 into ansible-collections:main Dec 28, 2023
121 checks passed

patchback bot mentioned this pull request Dec 28, 2023

[PR #7663/f7bc6964 backport][stable-8] Add keycloak_realm_rolemapping module to map realm roles to groups #7785

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add keycloak_realm_rolemapping module to map realm roles to groups #7663

Add keycloak_realm_rolemapping module to map realm roles to groups #7663

agross commented Dec 2, 2023

ansibullbot commented Dec 2, 2023

This comment was marked as outdated.

felixfontein left a comment

agross commented Dec 6, 2023

This comment was marked as outdated.

This comment was marked as outdated.

agross commented Dec 6, 2023

agross commented Dec 6, 2023

felixfontein commented Dec 8, 2023

felixfontein commented Dec 8, 2023

felixfontein commented Dec 23, 2023

patchback bot commented Dec 28, 2023 •

edited

Loading

felixfontein commented Dec 28, 2023

Add keycloak_realm_rolemapping module to map realm roles to groups #7663

Add keycloak_realm_rolemapping module to map realm roles to groups #7663

Conversation

agross commented Dec 2, 2023

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Dec 2, 2023

This comment was marked as outdated.

felixfontein left a comment

Choose a reason for hiding this comment

agross commented Dec 6, 2023

This comment was marked as outdated.

This comment was marked as outdated.

agross commented Dec 6, 2023

agross commented Dec 6, 2023

felixfontein commented Dec 8, 2023

felixfontein commented Dec 8, 2023

felixfontein commented Dec 23, 2023

patchback bot commented Dec 28, 2023 • edited Loading

Backport to stable-8: 💚 backport PR created

felixfontein commented Dec 28, 2023

patchback bot commented Dec 28, 2023 •

edited

Loading