gitlab_group => Make most options optional #6712

Intellium · 2023-06-15T19:02:25Z

SUMMARY

This PR changes the gitlab_group module to make most options optional, as they should be according to the gitlab API documentation. This PR also ensures compatibility with Gitlab v16 as current module behaviour is non-functional with Gitlab v16.

Closes #4577
Closes #5806

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

gitlab_group

ADDITIONAL INFORMATION

Current module behaviour is to include parameters in the API call to gitlab even if they're not set. This results in the API call including 'nil' values for these parameters. This still worked up until Gitlab v15.11.4.
Gitlab v16 currently breaks on this behaviour. This pull request ensures API parameters are only included when they're actually set, or if they are mandatory.

ansibullbot · 2023-06-15T19:06:43Z

cc @Lunik @Shaps @dj-wasabi @lgatellier @marwatk @metanovii @nejch @scodeman @sh0shin @suukit @waheedi @zanssa
click here for bot help

felixfontein

Thanks for your contribution! Can you please add a changelog fragment? Thanks.

Also, instead of having an if for every entry, why not modify create_group() to filter out all None values?

plugins/modules/gitlab_group.py

nejch · 2023-06-15T19:21:01Z

+1 for checking None values as there are a lot of other boolean values that could be added from https://docs.gitlab.com/ee/api/groups.html#new-group.

Btw, this closes #4577 and #5806.

(but as we discussed in #4577, since GitLab doesn't like receiving null attributes there will be another 15+ attributes from that API that would need to be added the same way eventually)

Intellium · 2023-06-15T20:23:48Z

I added a filter to the create_group function instead.

Intellium · 2023-06-15T20:51:31Z

@felixfontein @nejch : Are these changed good ?

changelogs/fragments/6712-gitlab_group-filtered-for-none-values.yml

plugins/modules/gitlab_group.py

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

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

Intellium · 2023-06-16T07:53:27Z

Committed the suggestions. Thanks @felixfontein !

nejch

LGTM

plugins/modules/gitlab_group.py

patchback · 2023-06-18T19:02:25Z

Backport to stable-6: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-6/e85b0080360100d34d0bd366b85a321743314440/pr-6712

Backported as #6724

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

* Make most options optional as they should be * Add filter to create_group instead * Remove whitespace * Add changelog fragment * Added description and extension to fragment * Update changelogs/fragments/6712-gitlab_group-filtered-for-none-values.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/gitlab_group.py Co-authored-by: Felix Fontein <felix@fontein.de> * Make Python 2.6 compatible. * Another shot at compatibility. --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit e85b008)

patchback · 2023-06-18T19:02:34Z

Backport to stable-7: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-7/e85b0080360100d34d0bd366b85a321743314440/pr-6712

Backported as #6725

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

felixfontein · 2023-06-18T19:02:39Z

@Intellium thanks for your contribution!
@nejch thanks for reviewing!

* Make most options optional as they should be * Add filter to create_group instead * Remove whitespace * Add changelog fragment * Added description and extension to fragment * Update changelogs/fragments/6712-gitlab_group-filtered-for-none-values.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/gitlab_group.py Co-authored-by: Felix Fontein <felix@fontein.de> * Make Python 2.6 compatible. * Another shot at compatibility. --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit e85b008)

…ons optional (#6725) gitlab_group => Make most options optional (#6712) * Make most options optional as they should be * Add filter to create_group instead * Remove whitespace * Add changelog fragment * Added description and extension to fragment * Update changelogs/fragments/6712-gitlab_group-filtered-for-none-values.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/gitlab_group.py Co-authored-by: Felix Fontein <felix@fontein.de> * Make Python 2.6 compatible. * Another shot at compatibility. --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit e85b008) Co-authored-by: Intellium <w.moeken@moeken.eu>

…ons optional (#6724) gitlab_group => Make most options optional (#6712) * Make most options optional as they should be * Add filter to create_group instead * Remove whitespace * Add changelog fragment * Added description and extension to fragment * Update changelogs/fragments/6712-gitlab_group-filtered-for-none-values.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/gitlab_group.py Co-authored-by: Felix Fontein <felix@fontein.de> * Make Python 2.6 compatible. * Another shot at compatibility. --------- Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit e85b008) Co-authored-by: Intellium <w.moeken@moeken.eu>

Make most options optional as they should be

69b58bf

ansibullbot added bug This issue/PR relates to a bug module module new_contributor Help guide this first time contributor plugins plugin (any type) labels Jun 15, 2023

felixfontein reviewed Jun 15, 2023

View reviewed changes

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

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

Add filter to create_group instead

e291364

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 Jun 15, 2023

Remove whitespace

3173e14

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 Jun 15, 2023

Add changelog fragment

97e6565

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 Jun 15, 2023

Added description and extension to fragment

06b0923

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 Jun 15, 2023

felixfontein reviewed Jun 16, 2023

View reviewed changes

changelogs/fragments/6712-gitlab_group-filtered-for-none-values.yml Outdated Show resolved Hide resolved

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

Intellium and others added 2 commits June 16, 2023 09:27

Update changelogs/fragments/6712-gitlab_group-filtered-for-none-value…

465408b

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

Update plugins/modules/gitlab_group.py

6e1cc59

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

nejch approved these changes Jun 16, 2023

View reviewed changes

felixfontein approved these changes Jun 18, 2023

View reviewed changes

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

felixfontein reviewed Jun 18, 2023

View reviewed changes

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

Make Python 2.6 compatible.

2a3602f

felixfontein reviewed Jun 18, 2023

View reviewed changes

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

Another shot at compatibility.

31105f1

felixfontein merged commit e85b008 into ansible-collections:main Jun 18, 2023
135 of 136 checks passed

patchback bot mentioned this pull request Jun 18, 2023

[PR #6712/e85b0080 backport][stable-6] gitlab_group => Make most options optional #6724

Merged

patchback bot mentioned this pull request Jun 18, 2023

[PR #6712/e85b0080 backport][stable-7] gitlab_group => Make most options optional #6725

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gitlab_group => Make most options optional #6712

gitlab_group => Make most options optional #6712

Intellium commented Jun 15, 2023 •

edited by felixfontein

Loading

ansibullbot commented Jun 15, 2023

felixfontein left a comment

nejch commented Jun 15, 2023

Intellium commented Jun 15, 2023

This comment was marked as outdated.

Intellium commented Jun 15, 2023

This comment was marked as outdated.

Intellium commented Jun 16, 2023

nejch left a comment

patchback bot commented Jun 18, 2023 •

edited

Loading

patchback bot commented Jun 18, 2023 •

edited

Loading

felixfontein commented Jun 18, 2023

gitlab_group => Make most options optional #6712

gitlab_group => Make most options optional #6712

Conversation

Intellium commented Jun 15, 2023 • edited by felixfontein Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Jun 15, 2023

felixfontein left a comment

Choose a reason for hiding this comment

nejch commented Jun 15, 2023

Intellium commented Jun 15, 2023

This comment was marked as outdated.

Intellium commented Jun 15, 2023

This comment was marked as outdated.

Intellium commented Jun 16, 2023

nejch left a comment

Choose a reason for hiding this comment

patchback bot commented Jun 18, 2023 • edited Loading

Backport to stable-6: 💚 backport PR created

patchback bot commented Jun 18, 2023 • edited Loading

Backport to stable-7: 💚 backport PR created

felixfontein commented Jun 18, 2023

Intellium commented Jun 15, 2023 •

edited by felixfontein

Loading

patchback bot commented Jun 18, 2023 •

edited

Loading

patchback bot commented Jun 18, 2023 •

edited

Loading