community.general/plugins/doc_fragments
Mark Armstrong af0118278b
Keycloak modules retry request on authentication error, support refresh token parameter (#9494)
* feat: begin refactor to support refresh token in keycloak modules

* chore: add start of tests for shared token usage

* feat: progress towards supporting refresh token; token introspection not yet working [8857]

* chore: reset to main branch previous state; a different approach is needed [8857]

* feat: add request methods to keycloak class, which will be expanded with retry logic [8857]

* feat: all requests to keycloak use request methods instead of open_url [8857]

* fix: data argument is optional in keycloak request methods [8857]

* feat: add integration test for keycloak module authentication methods [8857]

* chore: refactor get token logic to separate logic using username/pass credentials [8857]

* chore: refactor token request logic further to isolate request logic [8857]

* chore: fix minor lint issues [8857]

* test: add (currently failing) test for request with invalid auth token, valid refresh token [8857]

* chore: allow realm to be provided to role module with refresh_token, without username/pass [8857]

* feat: add retry logic to requests in keycloak module utils [8857]

* chore: rename keycloak module fail_open_url method to fail_request [8857]

* chore: update all keycloak modules to support refresh token param [8857]

* chore: add refresh_token param to keycloak doc_fragments [8857]

* chore: restore dependency between auth_realm and auth_username,auth_password params [8857]

* chore: rearrange module param checks to reduce future pr size [8857]

* chore: remove extra comma [8857]

* chore: update version added for refresh token param [8857]

* chore: add changelog fragment [8857]

* chore: re-add fail_open_url to keycloak module utils for backward compatability [8857]

* fix: do not make a new request to keycloak without reauth when refresh token not provided (#8857)

* fix: only make final auth attempt if username/pass provided, and return exception on failure (#8857)

* fix: make re-auth and retry code more consistent, ensure final exceptions are thrown (#8857)

* test: fix arguments for invalid token, valid refresh token test (#8857)

* feat: catch invalid refresh token errors during re-auth attempt (#8857)

Add test to verify this behaviour works.

* test: improve test coverage, including some unhappy path tests for authentication failures (#8857)

* chore: store auth errors from token request in backwards compatible way (#8857)

* fix: ensure method is still specified for all requests (#8857)

* chore: simplify token request logic (#8857)

* chore: rename functions to request tokens using refresh token or username/password (#8857)

To emphasize their difference from the `get_token` function,
which either gets the token from the module params
*or* makes a request for it.

* doc: add docstrings for new or significantly modified functions (#8857)

* test: repair unit test following change to exception message upon key error during auth request (#8857)
2025-01-26 15:23:39 +01:00
..
alicloud.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
attributes.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
auth_basic.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
bitbucket.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
clc.py (abc*, doc frags): style adjustments (#9534) 2025-01-06 21:50:53 +01:00
consul.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
dimensiondata.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
dimensiondata_wait.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
django.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
emc.py remove extraneous doc fragments (#9433) 2024-12-28 00:03:25 +01:00
gitlab.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
hpe3par.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
hwc.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
ibm_storage.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
influxdb.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
ipa.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
keycloak.py Keycloak modules retry request on authentication error, support refresh token parameter (#9494) 2025-01-26 15:23:39 +01:00
ldap.py (abc*, doc frags): style adjustments (#9534) 2025-01-06 21:50:53 +01:00
lxca_common.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
manageiq.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
nomad.py [a-n]*.py: normalize doc_fragments (#9422) 2024-12-27 14:30:17 +01:00
onepassword.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
oneview.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
online.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
opennebula.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
openswitch.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
oracle.py (abc*, doc frags): style adjustments (#9534) 2025-01-06 21:50:53 +01:00
oracle_creatable_resource.py (abc*, doc frags): style adjustments (#9534) 2025-01-06 21:50:53 +01:00
oracle_display_name_option.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
oracle_name_option.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
oracle_tags.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
oracle_wait_options.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
pipx.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
pritunl.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
proxmox.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
purestorage.py remove extraneous doc fragments (#9433) 2024-12-28 00:03:25 +01:00
redis.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
rundeck.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
scaleway.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
scaleway_waitable_resource.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00
utm.py (abc*, doc frags): style adjustments (#9534) 2025-01-06 21:50:53 +01:00
vexata.py remove extraneous doc fragments (#9433) 2024-12-28 00:03:25 +01:00
xenserver.py [m-z]*.py: normalize doc_fragments (#9423) 2024-12-27 14:37:39 +01:00