Fix and rework gitlab_project_variable #4038

markuman · 2022-01-13T13:30:57Z

SUMMARY

Closes: #1952
Closes: #4074

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

gitlab_project_variable

ADDITIONAL INFORMATION

First tests looks promising.

    - name: previous way. still works
      community.general.gitlab_project_variable:
        api_url: https://gitlab.com
        api_token: "{{ some_token }}"
        project: markuman/dotfiles
        purge: false
        vars:
          ACCESS_KEY_ID: abc123
          SECRET_ACCESS_KEY:
            value: 3214cbad
            masked: true
            protected: true
            variable_type: env_var
            environment_scope: '*'

    - name: new way, works also
      community.general.gitlab_project_variable:
        api_url: https://gitlab.com
        api_token: "{{ some_token }}"
        project: markuman/dotfiles
        purge: false
        variables:
          - name: ACCESS_KEY_ID
            value: abc123
          - name: SECRET_ACCESS_KEY
            value: 3214cbad
            masked: true
            protected: true
            variable_type: env_var
            environment_scope: '*'

What's left is

append integration test
return_value[untouched] is not handled
changelog fragment

ansibullbot · 2022-01-13T13:35:49Z

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

plugins/modules/source_control/gitlab/gitlab_project_variable.py

markuman · 2022-01-13T21:46:45Z

Integration test pass for me

PLAY RECAP *********************************************************************
testhost                   : ok=70   changed=27   unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

felixfontein

Thanks for your contribution! Some first comments:

plugins/modules/source_control/gitlab/gitlab_project_variable.py

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

markuman · 2022-01-28T09:00:39Z

All integration tests still pass here

testhost                   : ok=70   changed=27   unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

plugins/modules/source_control/gitlab/gitlab_project_variable.py

markuman · 2022-01-31T07:49:17Z

Still no failures

testhost                   : ok=70   changed=26   unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

FYI, the changed count flipps between 26 and 27 because of the first task, which purges all variables from the test project. If it is already empty, it's one change less

markuman · 2022-01-31T07:50:04Z

hm codespace put the changes somewhere else ...

…compare, because values always exists (prebuild)

patchback · 2022-01-31T19:00:42Z

Backport to stable-4: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-4/33a65ae20f53ead447ca08d1c0c7244c067ec445/pr-4038

Backported as #4133

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

* rework-and-fix * fix delete bug and change report * delete the requested variables based on env scope * fix absent logic when not purge: remove what is requested * change code to current behaviour * complete implementation * fix delete * restore origin return structure * reorder * add test for origin bug * add changelog fragment * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * remove yaml * apply suggestions * readd accidental removed line * improve the truth of return value 'project_variable' in check mode * fix pep8, over-indented * fix typos and add subelement options * Update changelogs/fragments/4038-fix-and-rework-gitlb-project-variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/4038-fix-and-rework-gitlb-project-variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * remove diff feature * resolve all recommentdations * resolve change requests, improve doc and remove default value before compare, because values always exists (prebuild) Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 33a65ae)

felixfontein · 2022-01-31T19:00:51Z

@markuman thanks a lot for implementing this!
@sguarin thanks for reviewing!

* rework-and-fix * fix delete bug and change report * delete the requested variables based on env scope * fix absent logic when not purge: remove what is requested * change code to current behaviour * complete implementation * fix delete * restore origin return structure * reorder * add test for origin bug * add changelog fragment * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * remove yaml * apply suggestions * readd accidental removed line * improve the truth of return value 'project_variable' in check mode * fix pep8, over-indented * fix typos and add subelement options * Update changelogs/fragments/4038-fix-and-rework-gitlb-project-variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/4038-fix-and-rework-gitlb-project-variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/modules/source_control/gitlab/gitlab_project_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * remove diff feature * resolve all recommentdations * resolve change requests, improve doc and remove default value before compare, because values always exists (prebuild) Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 33a65ae) Co-authored-by: Markus Bergholz <git@osuv.de>

* Rework of gitlab_project_variable over gitlab_group_variable * Linting and removed unused example * Fix test 2 * Sync from review of gitlab_project_variable #4038 * Linting, default protected True, value optional * Next version is 4.5.0 * Roll back protected default true, and value not required * Apply suggestions from code review Missing check_mode Co-authored-by: Markus Bergholz <git@osuv.de> * Fix one unit test, comment test that requires premium gitlab * Add changelog * Update plugins/modules/source_control/gitlab/gitlab_group_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/4086-rework_of_gitlab_proyect_variable_over_gitlab_group_variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Added conditional gitlab_premium_tests variable when required * Allow delete without value * Fix variable name * Linting * Value should not be required in doc * Linting missing new-line * Update changelogs/fragments/4086-rework_of_gitlab_proyect_variable_over_gitlab_group_variable.yml Co-authored-by: Markus Bergholz <git@osuv.de> Co-authored-by: Markus Bergholz <git@osuv.de> Co-authored-by: Felix Fontein <felix@fontein.de>

* Rework of gitlab_project_variable over gitlab_group_variable * Linting and removed unused example * Fix test 2 * Sync from review of gitlab_project_variable #4038 * Linting, default protected True, value optional * Next version is 4.5.0 * Roll back protected default true, and value not required * Apply suggestions from code review Missing check_mode Co-authored-by: Markus Bergholz <git@osuv.de> * Fix one unit test, comment test that requires premium gitlab * Add changelog * Update plugins/modules/source_control/gitlab/gitlab_group_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/4086-rework_of_gitlab_proyect_variable_over_gitlab_group_variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Added conditional gitlab_premium_tests variable when required * Allow delete without value * Fix variable name * Linting * Value should not be required in doc * Linting missing new-line * Update changelogs/fragments/4086-rework_of_gitlab_proyect_variable_over_gitlab_group_variable.yml Co-authored-by: Markus Bergholz <git@osuv.de> Co-authored-by: Markus Bergholz <git@osuv.de> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 44f9bf5)

…4226) * Rework of gitlab_project_variable over gitlab_group_variable * Linting and removed unused example * Fix test 2 * Sync from review of gitlab_project_variable #4038 * Linting, default protected True, value optional * Next version is 4.5.0 * Roll back protected default true, and value not required * Apply suggestions from code review Missing check_mode Co-authored-by: Markus Bergholz <git@osuv.de> * Fix one unit test, comment test that requires premium gitlab * Add changelog * Update plugins/modules/source_control/gitlab/gitlab_group_variable.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/4086-rework_of_gitlab_proyect_variable_over_gitlab_group_variable.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Added conditional gitlab_premium_tests variable when required * Allow delete without value * Fix variable name * Linting * Value should not be required in doc * Linting missing new-line * Update changelogs/fragments/4086-rework_of_gitlab_proyect_variable_over_gitlab_group_variable.yml Co-authored-by: Markus Bergholz <git@osuv.de> Co-authored-by: Markus Bergholz <git@osuv.de> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 44f9bf5) Co-authored-by: Sebastian Guarino <sebastian.guarino@gmail.com>

markuman added 2 commits January 13, 2022 14:22

rework-and-fix

0a36d1f

fix delete bug and change report

93a4085

ansibullbot added bug This issue/PR relates to a bug gitlab module module plugins plugin (any type) source_control labels Jan 13, 2022

delete the requested variables based on env scope

5a9566b

fix absent logic when not purge: remove what is requested

e85a481

markuman commented Jan 13, 2022

View reviewed changes

plugins/modules/source_control/gitlab/gitlab_project_variable.py Show resolved Hide resolved

change code to current behaviour

34d1767

markuman marked this pull request as draft January 13, 2022 19:10

ansibullbot added the WIP Work in progress label Jan 13, 2022

markuman added 6 commits January 13, 2022 22:03

complete implementation

dd55c36

fix delete

76dc123

restore origin return structure

8814510

reorder

9417554

add test for origin bug

53cdbde

add changelog fragment

3c3165c

markuman marked this pull request as ready for review January 13, 2022 21:46

ansibullbot added integration tests/integration tests tests and removed WIP Work in progress labels Jan 13, 2022

felixfontein reviewed Jan 16, 2022

View reviewed changes

plugins/modules/source_control/gitlab/gitlab_project_variable.py Outdated Show resolved Hide resolved

plugins/modules/source_control/gitlab/gitlab_project_variable.py Outdated Show resolved Hide resolved

markuman and others added 2 commits January 27, 2022 08:56

Update plugins/modules/source_control/gitlab/gitlab_project_variable.py

6808a45

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

Update plugins/modules/source_control/gitlab/gitlab_project_variable.py

936c316

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

ansibullbot removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jan 27, 2022

markuman added 2 commits January 28, 2022 09:25

remove diff feature

1bec811

resolve all recommentdations

bb2aa49

markuman requested a review from felixfontein January 28, 2022 09:00

felixfontein reviewed Jan 30, 2022

View reviewed changes

resolve change requests, improve doc and remove default value before …

af06da0

…compare, because values always exists (prebuild)

markuman requested a review from felixfontein January 31, 2022 07:52

felixfontein approved these changes Jan 31, 2022

View reviewed changes

felixfontein merged commit 33a65ae into ansible-collections:main Jan 31, 2022

patchback bot mentioned this pull request Jan 31, 2022

[PR #4038/33a65ae2 backport][stable-4] Fix and rework gitlab_project_variable #4133

Merged

3 tasks

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

sguarin added a commit to sguarin/community.general that referenced this pull request Feb 2, 2022

Sync from review of gitlab_project_variable ansible-collections#4038

c23a03c

patchback bot mentioned this pull request Feb 18, 2022

[PR #4086/44f9bf54 backport][stable-4] Rework of gitlab_project_variable over gitlab_group_variable #4226

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix and rework gitlab_project_variable #4038

Fix and rework gitlab_project_variable #4038

markuman commented Jan 13, 2022 •

edited by felixfontein

Loading

ansibullbot commented Jan 13, 2022

markuman commented Jan 13, 2022

felixfontein left a comment

markuman commented Jan 28, 2022

markuman commented Jan 31, 2022

markuman commented Jan 31, 2022

patchback bot commented Jan 31, 2022 •

edited

Loading

felixfontein commented Jan 31, 2022

Fix and rework gitlab_project_variable #4038

Fix and rework gitlab_project_variable #4038

Conversation

markuman commented Jan 13, 2022 • edited by felixfontein Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Jan 13, 2022

markuman commented Jan 13, 2022

felixfontein left a comment

Choose a reason for hiding this comment

markuman commented Jan 28, 2022

markuman commented Jan 31, 2022

markuman commented Jan 31, 2022

patchback bot commented Jan 31, 2022 • edited Loading

Backport to stable-4: 💚 backport PR created

felixfontein commented Jan 31, 2022

markuman commented Jan 13, 2022 •

edited by felixfontein

Loading

patchback bot commented Jan 31, 2022 •

edited

Loading