Inspq keycloak user module #6476

elfelip · 2023-05-02T19:19:59Z

SUMMARY

This PR add a new Keycloak module to manage users.

ISSUE TYPE

New Module/Plugin Pull Request

COMPONENT NAME

keycloak_user

ADDITIONAL INFORMATION

This module include attributes and group membership management for users.

The alias username for the auth_username parameter have been removed because it conflicted with the username parameter of the Keycloak user representation

ansibullbot · 2023-05-02T19:20:56Z

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

elfelip · 2023-05-03T13:09:16Z

Hello @eikef @mattock @ndclt
Someone can do something about this problem?
.github/BOTMETA.yml:0:0: Author elfelip not mentioned as active or inactive maintainer for plugins/modules/keycloak_user.py (mentioned are: eikef, ndclt, mattock)
Thankyou

felixfontein · 2023-05-03T20:20:16Z

Someone can do something about this problem?
.github/BOTMETA.yml:0:0: Author elfelip not mentioned as active or inactive maintainer for plugins/modules/keycloak_user.py (mentioned are: eikef, ndclt, mattock)
Thankyou

Did you look at the part in CONTRIBUTING.md on adding new modules and plugins?

felixfontein

Thanks for your contribution! I've added some first comments. Please note that you need to add tests as well (that's a requirement for every new module and plugin).

changelogs/fragments/6476-new-keycloak-user.module.yml

plugins/module_utils/identity/keycloak/keycloak.py

plugins/modules/keycloak_user.py

changelogs/fragments/6476-new-keycloak-user.module.yml

plugins/modules/keycloak_user.py

felixfontein · 2023-06-04T20:16:35Z

plugins/modules/keycloak_user.py

+  returned: on success
+  type: dict
+msg:
+  description: Message if it is the case.


If what is the case?

I think this is the only comment left open. Can you please improve the description? Once that's fixed I'll merge.

Co-authored-by: Felix Fontein <felix@fontein.de>

.github/workflows/ansible-test.yml

felixfontein

I don't know Keycloak, but I think this looks good for a first release (at least the parts I can judge :) )! So if nobody objects, I'll merge this by the end of this week.

patchback · 2023-06-09T04:17:48Z

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/07a5f07eaa349dcc603f5fbe5599c154f3e948d3/pr-6476

Backported as #6645

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

* Add Keycloak User Module * keycloak_user refactoring * Add changelog fragment for breaking changes * Fix Copyright for keycloak_user module * Add keycloak_user module to BOTMETA * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Update plugins/modules/keycloak_user.py Updated short description Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Fix keycloak_user module description Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Dedent and use FQCN's for examples in keycloak_user module * Fix examples in keycloak_user module documentation * keycloak_user refactoring * Add changelog fragment for breaking changes * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Fix merge error on keycloak_user module changelogs fragment * Add integration test for keycloak_user module * Fix yamllint errors in keycloak_user integration tests * Add README.md and fix integration tests for keycloak_user module * Add Copyright and license in README.md integration tests keycloak_user module * Update changelogs/fragments/6476-new-keycloak-user.module.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Fix argument_spec auth_username aliases for keycloak_user module * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Add units tests for keycloak_user module * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Remove default value for keycloak_user enabled module parameter * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * keycloak_user refactoring * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Dedent and use FQCN's for examples in keycloak_user module * Fix examples in keycloak_user module documentation * keycloak_user refactoring * Add changelog fragment for breaking changes * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Fix merge error on keycloak_user module changelogs fragment * Update changelogs/fragments/6476-new-keycloak-user.module.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Fix argument_spec auth_username aliases for keycloak_user module * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Remove github Workflow * Remove bugfix from changelog fragment * Fix indentation in examples for keycloak_user module * Fix examples in documentation for keycloak_user module * Remove PR 6476 changelog fragment * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Restore ansible-test.yml * Add msg output and RETURN documentation for keycloak_user module * Fix RETURN documentation for keycloak_user module * Fix msg for keycloak_user module --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 07a5f07)

felixfontein · 2023-06-09T04:17:58Z

@elfelip thanks for your contribution!

) Inspq keycloak user module (#6476) * Add Keycloak User Module * keycloak_user refactoring * Add changelog fragment for breaking changes * Fix Copyright for keycloak_user module * Add keycloak_user module to BOTMETA * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Update plugins/modules/keycloak_user.py Updated short description Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Fix keycloak_user module description Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Dedent and use FQCN's for examples in keycloak_user module * Fix examples in keycloak_user module documentation * keycloak_user refactoring * Add changelog fragment for breaking changes * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Fix merge error on keycloak_user module changelogs fragment * Add integration test for keycloak_user module * Fix yamllint errors in keycloak_user integration tests * Add README.md and fix integration tests for keycloak_user module * Add Copyright and license in README.md integration tests keycloak_user module * Update changelogs/fragments/6476-new-keycloak-user.module.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Fix argument_spec auth_username aliases for keycloak_user module * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Add units tests for keycloak_user module * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Remove default value for keycloak_user enabled module parameter * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * keycloak_user refactoring * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Dedent and use FQCN's for examples in keycloak_user module * Fix examples in keycloak_user module documentation * keycloak_user refactoring * Add changelog fragment for breaking changes * Remove ANSIBLE_METADATA and override aliases for auth_username argument spec * Fix merge error on keycloak_user module changelogs fragment * Update changelogs/fragments/6476-new-keycloak-user.module.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Fix argument_spec auth_username aliases for keycloak_user module * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Remove github Workflow * Remove bugfix from changelog fragment * Fix indentation in examples for keycloak_user module * Fix examples in documentation for keycloak_user module * Remove PR 6476 changelog fragment * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_user.py Co-authored-by: Felix Fontein <felix@fontein.de> * Restore ansible-test.yml * Add msg output and RETURN documentation for keycloak_user module * Fix RETURN documentation for keycloak_user module * Fix msg for keycloak_user module --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 07a5f07) Co-authored-by: Philippe Gauthier <philippe.gauthier@inspq.qc.ca>

This comment was marked as outdated.

Sign in to view

ansibullbot added ci_verified Push fixes to PR branch to re-run CI and removed ci_verified Push fixes to PR branch to re-run CI labels May 2, 2023

felixfontein added the check-before-release PR will be looked at again shortly before release and merged if possible. label May 3, 2023

ansibullbot removed 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 May 3, 2023

felixfontein reviewed May 9, 2023

View reviewed changes

felixfontein added the backport-7 label May 10, 2023

This comment was marked as outdated.

Sign in to view

ansibullbot removed the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label May 10, 2023

This comment was marked as outdated.

Sign in to view

ansibullbot removed the merge_commit This PR contains at least one merge commit. Please resolve! label May 30, 2023

elfelip added 3 commits May 30, 2023 09:47

Remove bugfix from changelog fragment

f7661ee

Fix indentation in examples for keycloak_user module

f8c5f56

Fix examples in documentation for keycloak_user module

ece9f26

felixfontein reviewed Jun 4, 2023

View reviewed changes

elfelip and others added 8 commits June 5, 2023 07:56

Remove PR 6476 changelog fragment

5d510db

Update plugins/modules/keycloak_user.py

7c11d2c

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/keycloak_user.py

48f04e7

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/keycloak_user.py

9fc9305

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/keycloak_user.py

7fa9fa5

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/keycloak_user.py

7e96ec1

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/keycloak_user.py

02cb85f

Co-authored-by: Felix Fontein <felix@fontein.de>

Update plugins/modules/keycloak_user.py

d0488d1

Co-authored-by: Felix Fontein <felix@fontein.de>

ansibullbot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI labels Jun 5, 2023

felixfontein reviewed Jun 5, 2023

View reviewed changes

.github/workflows/ansible-test.yml Outdated Show resolved Hide resolved

elfelip added 4 commits June 5, 2023 16:33

Restore ansible-test.yml

3bd2d36

Add msg output and RETURN documentation for keycloak_user module

c89d34c

Fix RETURN documentation for keycloak_user module

f765b0a

Fix msg for keycloak_user module

838273d

felixfontein approved these changes Jun 6, 2023

View reviewed changes

ansibullbot added the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI label Jun 6, 2023

felixfontein mentioned this pull request Jun 6, 2023

Add keycloak_authz_permission module #6321

Merged

felixfontein merged commit 07a5f07 into ansible-collections:main Jun 9, 2023

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

patchback bot mentioned this pull request Jun 9, 2023

[PR #6476/07a5f07e backport][stable-7] Inspq keycloak user module #6645

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inspq keycloak user module #6476

Inspq keycloak user module #6476

elfelip commented May 2, 2023 •

edited

Loading

ansibullbot commented May 2, 2023

This comment was marked as outdated.

elfelip commented May 3, 2023

felixfontein commented May 3, 2023

felixfontein left a comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein Jun 4, 2023

felixfontein Jun 6, 2023

felixfontein left a comment

patchback bot commented Jun 9, 2023 •

edited

Loading

felixfontein commented Jun 9, 2023

Inspq keycloak user module #6476

Inspq keycloak user module #6476

Conversation

elfelip commented May 2, 2023 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented May 2, 2023

This comment was marked as outdated.

elfelip commented May 3, 2023

felixfontein commented May 3, 2023

felixfontein left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

felixfontein Jun 4, 2023

Choose a reason for hiding this comment

felixfontein Jun 6, 2023

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

patchback bot commented Jun 9, 2023 • edited Loading

Backport to stable-7: 💚 backport PR created

felixfontein commented Jun 9, 2023

elfelip commented May 2, 2023 •

edited

Loading

patchback bot commented Jun 9, 2023 •

edited

Loading