Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix KeycloakAPI's missing http_agent, timeout, and validate_certs open_url() parameters #7067

Merged
merged 3 commits into from
Aug 11, 2023

Conversation

loricvdt
Copy link
Contributor

@loricvdt loricvdt commented Aug 7, 2023

SUMMARY

Added http_agent, timeout, and validate_certs to open_url() calls where they were missing in the KeycloakAPI module util

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

keycloak API module util

ADDITIONAL INFORMATION

Copied the same argument structure as all other open_url() calls in the same Python file.

An example issue was using community.general.keycloak_user to create a user, which would complain about SSL verification eventhough validate_certs was set to false

@ansibullbot
Copy link
Collaborator

@ansibullbot ansibullbot added WIP Work in progress bug This issue/PR relates to a bug identity module_utils module_utils new_contributor Help guide this first time contributor plugins plugin (any type) labels Aug 7, 2023
@loricvdt loricvdt marked this pull request as ready for review August 7, 2023 19:48
@ansibullbot ansibullbot removed the WIP Work in progress label Aug 7, 2023
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-6 labels Aug 7, 2023
Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

I think this really needs to be refactored so that all the common parameters are passed in one place, instead of having them repeated again in every place... But that's something for another PR, not for this one!

Copy link
Collaborator

@felixfontein felixfontein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will merge this by the end of this week if nobody objects.

@felixfontein felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Aug 11, 2023
@felixfontein felixfontein merged commit e7a6412 into ansible-collections:main Aug 11, 2023
@patchback
Copy link

patchback bot commented Aug 11, 2023

Backport to stable-6: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply e7a6412 on top of patchback/backports/stable-6/e7a6412ec471d74e59ffb6e8dc1481805ebebfab/pr-7067

Backporting merged PR #7067 into main

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible-collections/community.general.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-6/e7a6412ec471d74e59ffb6e8dc1481805ebebfab/pr-7067 upstream/stable-6
  4. Now, cherry-pick PR Fix KeycloakAPI's missing http_agent, timeout, and validate_certs open_url() parameters #7067 contents into that branch:
    $ git cherry-pick -x e7a6412ec471d74e59ffb6e8dc1481805ebebfab
    If it'll yell at you with something like fatal: Commit e7a6412ec471d74e59ffb6e8dc1481805ebebfab is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x e7a6412ec471d74e59ffb6e8dc1481805ebebfab
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix KeycloakAPI's missing http_agent, timeout, and validate_certs open_url() parameters #7067 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-6/e7a6412ec471d74e59ffb6e8dc1481805ebebfab/pr-7067
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

@patchback
Copy link

patchback bot commented Aug 11, 2023

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/e7a6412ec471d74e59ffb6e8dc1481805ebebfab/pr-7067

Backported as #7088

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

patchback bot pushed a commit that referenced this pull request Aug 11, 2023
…n_url() parameters (#7067)

* Fix KeycloakAPI's missing http_agent, timeout, and validate_certs open_url() parameters

* Add changelog fragment

* Update changelogs/fragments/7067-keycloak-api-paramerter-fix.yml

Following suggestion

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

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit e7a6412)
@felixfontein
Copy link
Collaborator

@loricvdt thanks for your contribution

felixfontein pushed a commit that referenced this pull request Aug 11, 2023
…_agent, timeout, and validate_certs open_url() parameters (#7088)

Fix KeycloakAPI's missing http_agent, timeout, and validate_certs open_url() parameters (#7067)

* Fix KeycloakAPI's missing http_agent, timeout, and validate_certs open_url() parameters

* Add changelog fragment

* Update changelogs/fragments/7067-keycloak-api-paramerter-fix.yml

Following suggestion

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

---------

Co-authored-by: Felix Fontein <[email protected]>
(cherry picked from commit e7a6412)

Co-authored-by: Loric Vandentempel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue/PR relates to a bug identity module_utils module_utils new_contributor Help guide this first time contributor plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants