New Module: Keycloak ClientSecret with PR changes #5606

johncant · 2022-11-26T14:47:38Z

SUMMARY

Updated version of PR #3997 by @fynncfchen

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

keycloak_clientsecret

ADDITIONAL INFORMATION

I rebased the original PR and made all of the changes, plus one or two extra

Structure of plugins/modules changed since original PR. No symlinks present after rebase.
Added an entry in meta/runtime.yml to help anyone using keycloak_clientsecret in fynncfchen:keycloak-clientsecret (4.3.0) switching to the version that includes this PR, where the structure of plugins/modules has changed.
All suggested changes from @felixfontein and @russoz implemented
Changed version added from 4.4.0 to 6.1.0

Testing

I tested the following:

Built docs - they look OK
Used the module with the following args to retrieve my keycloak client secret as part of my home network setup: auth_client_id, auth_keycloak_url, auth_realm, auth_username, auth_password, state, realm, client_id - it worked first time with no code changes needed.
Nothing else tested by me

…ecret

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

ansibullbot · 2022-11-26T14:51:34Z

cc @eikef @ndclt
click here for bot help

github-actions · 2022-11-26T15:17:29Z

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

johncant · 2022-11-26T16:17:36Z

It looks like the test failures are due to a rate limit being exceeded and not as a result of the PR changes.

felixfontein

Thanks for reviving this PR! Please note that new modules must come with tests (unit and/or integration).

meta/runtime.yml

johncant · 2022-11-27T10:11:55Z

Happy to write some tests.

I'm doing this now and I found something that doesn't make a lot of sense:

https://github.com/ansible-collections/community.general/pull/5606/files#diff-0e3de7219d2d49b252059fc768951af14b1f81fc584ce34eede5675aaa9621aeR218-R226

state: absent creates a new client secret rather than deletes it (no endpoint for this). If I change the value of state for this case, what should it be?

- end_state used instead

plugins/modules/keycloak_clientsecret.py

johncant · 2022-11-28T19:06:43Z

Hi @felixfontein - all changes made. I'd be grateful if you could take another look.

felixfontein

Sorry for the late response!

plugins/module_utils/identity/keycloak/keycloak.py

plugins/modules/keycloak_clientsecret_info.py

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

plugins/modules/keycloak_clientsecret_info.py

plugins/modules/keycloak_clientsecret_regenerate.py

.github/BOTMETA.yml

felixfontein

Besides this, LGTM!

.github/BOTMETA.yml

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

johncant · 2022-12-04T11:57:59Z

Besides this, LGTM!

Awesome!

felixfontein

Will merge tomorrow if nobody objects.

patchback · 2022-12-05T05:22:17Z

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/7ea544a6244c7324e45c6972cdf0b6674797e0e9/pr-5606

Backported as #5654

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

* feat(plugins/keycloak): add get and create util function for client secret * feat(plugins/keycloak): add client secret module * chore: add maintainer in BOTMETA * Update plugins/modules/identity/keycloak/keycloak_clientsecret.py Co-authored-by: Felix Fontein <felix@fontein.de> * Make changes to keycloak_clientsecret from PR * Add SPDX identifier for keycloak_clientsecret * Add copyright in keycloak_clientsecret for REUSE * Add integration test for keycloak_clientsecret * rm clientsecret from keycloak_clientsecret result - end_state used instead * keycloak_clientsecret: Undo meta/runtime.yml change * Fix sanity tests for keycloak_clientsecret * New keycloak_clientsecret_info module - Replaces keycloak_clientsecret - Module definition and some common logic moved into module_utils - Update documentation, tests, etc. - Add myself as author * Misc fixes to keycloak_clientsecret_info * Add keycloak_clientsecret_regenerate module * keycloak_clientsecret* Update .github/BOTMETA.yml * keycloak_clientsecret_regenerate: Fix sanity tests * Fix README for keycloak_clientsecret integration test * Separate out keycloak_clientsecret module_utils * Keycloak_clientsecret module_utils: boilerplate * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * keycloak_clientsecret: Add no_log to examples and docs * keycloak_clientsecret: Update BOTMETA * Update .github/BOTMETA.yml Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: fynncfchen <fynn.cfchen@gmail.com> Co-authored-by: Fynnnnn <ethan.cfchen@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 7ea544a)

felixfontein · 2022-12-05T05:22:49Z

@johncant @fynncfchen thanks for your contribution!

…ret with PR changes (#5654) New Module: Keycloak ClientSecret with PR changes (#5606) * feat(plugins/keycloak): add get and create util function for client secret * feat(plugins/keycloak): add client secret module * chore: add maintainer in BOTMETA * Update plugins/modules/identity/keycloak/keycloak_clientsecret.py Co-authored-by: Felix Fontein <felix@fontein.de> * Make changes to keycloak_clientsecret from PR * Add SPDX identifier for keycloak_clientsecret * Add copyright in keycloak_clientsecret for REUSE * Add integration test for keycloak_clientsecret * rm clientsecret from keycloak_clientsecret result - end_state used instead * keycloak_clientsecret: Undo meta/runtime.yml change * Fix sanity tests for keycloak_clientsecret * New keycloak_clientsecret_info module - Replaces keycloak_clientsecret - Module definition and some common logic moved into module_utils - Update documentation, tests, etc. - Add myself as author * Misc fixes to keycloak_clientsecret_info * Add keycloak_clientsecret_regenerate module * keycloak_clientsecret* Update .github/BOTMETA.yml * keycloak_clientsecret_regenerate: Fix sanity tests * Fix README for keycloak_clientsecret integration test * Separate out keycloak_clientsecret module_utils * Keycloak_clientsecret module_utils: boilerplate * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/keycloak_clientsecret_info.py Co-authored-by: Felix Fontein <felix@fontein.de> * keycloak_clientsecret: Add no_log to examples and docs * keycloak_clientsecret: Update BOTMETA * Update .github/BOTMETA.yml Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: fynncfchen <fynn.cfchen@gmail.com> Co-authored-by: Fynnnnn <ethan.cfchen@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 7ea544a) Co-authored-by: John Cant <a.johncant@gmail.com>

johncant · 2022-12-05T16:16:58Z

@felixfontein thankyou for your time reviewing the PRs!

fynncfchen and others added 5 commits November 26, 2022 09:34

feat(plugins/keycloak): add get and create util function for client s…

9549602

…ecret

feat(plugins/keycloak): add client secret module

8fbea99

chore: add maintainer in BOTMETA

337a1d6

Update plugins/modules/identity/keycloak/keycloak_clientsecret.py

b6379f1

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

Make changes to keycloak_clientsecret from PR

7a00262

ansibullbot added identity module module module_utils module_utils new_contributor Help guide this first time contributor new_plugin New plugin plugins plugin (any type) labels Nov 26, 2022

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-6 labels Nov 26, 2022

johncant added 2 commits November 26, 2022 14:56

Add SPDX identifier for keycloak_clientsecret

7af5090

Add copyright in keycloak_clientsecret for REUSE

c7c588c

ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Nov 26, 2022

felixfontein mentioned this pull request Nov 26, 2022

ansible-test: do not trigger all tests when .github/BOTMETA.yml is changed ansible/ansible#79472

Closed

ansibullbot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Nov 26, 2022

felixfontein reviewed Nov 26, 2022

View reviewed changes

meta/runtime.yml Outdated Show resolved Hide resolved

johncant added 3 commits November 27, 2022 11:40

Add integration test for keycloak_clientsecret

c9898d1

rm clientsecret from keycloak_clientsecret result

af561a5

- end_state used instead

keycloak_clientsecret: Undo meta/runtime.yml change

7e1ebe1

ansibullbot added integration tests/integration tests tests labels Nov 27, 2022

Fix sanity tests for keycloak_clientsecret

223904b

felixfontein reviewed Nov 27, 2022

View reviewed changes

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

keycloak_clientsecret_regenerate: Fix sanity tests

1e15865

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 Nov 28, 2022

Fix README for keycloak_clientsecret integration test

9ae4b15

felixfontein reviewed Dec 3, 2022

View reviewed changes

johncant and others added 8 commits December 4, 2022 11:13

Separate out keycloak_clientsecret module_utils

a6f5187

Keycloak_clientsecret module_utils: boilerplate

9851ea9

Update plugins/modules/keycloak_clientsecret_info.py

e5fa20f

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

Update plugins/modules/keycloak_clientsecret_info.py

1e961c0

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

Update plugins/modules/keycloak_clientsecret_info.py

3bb03f7

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

Update plugins/modules/keycloak_clientsecret_info.py

9b71671

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

Update plugins/modules/keycloak_clientsecret_info.py

67fa614

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

Update plugins/modules/keycloak_clientsecret_info.py

09b8e59

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

felixfontein reviewed Dec 4, 2022

View reviewed changes

plugins/modules/keycloak_clientsecret_info.py Show resolved Hide resolved

plugins/modules/keycloak_clientsecret_regenerate.py Show resolved Hide resolved

plugins/modules/keycloak_clientsecret_regenerate.py Show resolved Hide resolved

.github/BOTMETA.yml Show resolved Hide resolved

johncant added 2 commits December 4, 2022 11:41

keycloak_clientsecret: Add no_log to examples and docs

fce5bfa

keycloak_clientsecret: Update BOTMETA

490e775

felixfontein reviewed Dec 4, 2022

View reviewed changes

.github/BOTMETA.yml Outdated Show resolved Hide resolved

Update .github/BOTMETA.yml

0dd4be2

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

felixfontein approved these changes Dec 4, 2022

View reviewed changes

felixfontein merged commit 7ea544a into ansible-collections:main Dec 5, 2022

patchback bot mentioned this pull request Dec 5, 2022

[PR #5606/7ea544a6 backport][stable-6] New Module: Keycloak ClientSecret with PR changes #5654

Merged

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

johncant deleted the keycloak-clientsecret-rebased-with-pr-changes branch December 19, 2022 20:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

New Module: Keycloak ClientSecret with PR changes #5606

New Module: Keycloak ClientSecret with PR changes #5606

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

New Module: Keycloak ClientSecret with PR changes #5606

New Module: Keycloak ClientSecret with PR changes #5606

Uh oh!

Conversation

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Testing

Uh oh!

Uh oh!

Uh oh!

Docs Build 📝

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Backport to stable-6: 💚 backport PR created

Uh oh!

Uh oh!

Uh oh!

Uh oh!