add module pacman_key #778

grawlinson · 2020-08-15T18:01:12Z

SUMMARY

Manage pacman's keyring of trusted keys with pacman-key. Similar to the apt_key & rpm_key modules. Useful when adding additional repositories that have signed packages/databases.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

pacman_key

EDIT: This is originally from this PR on ansible/ansible.

felixfontein

Please note that all new modules need to have tests. Since we do not have Arch Linux nodes in CI, unit tests are probably best in this case.

plugins/modules/packaging/os/pacman_key.py

grawlinson · 2020-08-16T00:19:31Z

@felixfontein Thanks for the exceptional feedback! I'll implement your suggestions when I have the time.

plugins/modules/packaging/os/pacman_key.py

grawlinson · 2020-08-22T23:53:24Z

I'm not having any luck implementing unit tests due to this occurring.

$ ansible-test
ERROR: The current working directory must be at or below:

 - an Ansible collection: {...}/ansible_collections/{namespace}/{collection}/

The documentation simply states to run the tests in docker containers with ansible-test --docker. Is there something in the documentation that I'm missing?

felixfontein · 2020-08-23T10:47:04Z

See the documentation here: https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections

Andersson007

@grawlinson thanks for the new module!
To have unit or integration tests would be good

plugins/modules/packaging/os/pacman_key.py

felixfontein · 2021-02-26T09:08:05Z

@grawlinson are you still working on this?

needs_info

grawlinson · 2021-02-26T19:21:45Z

Since the last few messages, I've got a new laptop so this hasn't been a pressing priority.

I'll hop on IRC and ask a few questions in the next week or so.

russoz · 2021-04-18T00:14:30Z

@grawlinson any updates on this?

russoz · 2021-04-18T00:15:37Z

-label needs_triage

tests/unit/plugins/modules/packaging/os/test_pacman_key.py

plugins/modules/packaging/os/pacman_key.py

felixfontein · 2021-06-03T19:50:29Z

Please note that community.general will be released next Tuesday. Would be great if we can get this PR merged for that :)

a full length (40 characters) key ID is equivalent to the fingerprint.

grawlinson · 2021-06-04T00:53:14Z

I think module test coverage is at ~90% at the moment. Is there a threshold that new modules need?

plugins/modules/packaging/os/pacman_key.py

russoz · 2021-06-04T03:12:36Z

I think module test coverage is at ~90% at the moment. Is there a threshold that new modules need?

Not that I am aware @grawlinson . (Maybe we should, but to establish any threshold without adding test coverage to all modules (many are at 0% today) wouldn't feel right, IMO).

russoz

Looking good to me! Thanks @grawlinson for your contribution! 😁

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

felixfontein

Something I missed before. Besides that, looks good!

plugins/modules/packaging/os/pacman_key.py

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

patchback · 2021-06-04T05:08:57Z

Backport to stable-3: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-3/5ddf0041ecc733ed6f1f6ab938af584683c6e862/pr-778

Backported as #2704

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

* add module pacman_key * add symlink and fix documentation for pacman_key * documentation fix for pacman_key * improve logic around user input * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve parameter checking required_one_of=[] is neat. Co-authored-by: Alexei Znamensky * Revert "Improve parameter checking" This reverts commit 044b0cb. * Simplify a bunch of code. * fix typos pointed out by yan12125 * replaced manual checks with required-if invocation * added default keyring to documentation * some initial tests * updated metadata * refactored to make sanity tests pass * refactor to make sanity tests pass ... part deux * refactor: simplify run_command invocations * test: cover check-mode and some normal operation * docs: fix grammatical errors * rip out fingerprint code a full length (40 characters) key ID is equivalent to the fingerprint. * refactor tests, add a couple more * test: added testcase for method: data * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * docs: correct yaml boolean type Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 5ddf004)

felixfontein · 2021-06-04T05:09:39Z

@grawlinson thanks a lot for your contribution!
@Andersson007 @russoz @yan12125 thanks for reviewing etc.!

* add module pacman_key * add symlink and fix documentation for pacman_key * documentation fix for pacman_key * improve logic around user input * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> * Improve parameter checking required_one_of=[] is neat. Co-authored-by: Alexei Znamensky * Revert "Improve parameter checking" This reverts commit 044b0cb. * Simplify a bunch of code. * fix typos pointed out by yan12125 * replaced manual checks with required-if invocation * added default keyring to documentation * some initial tests * updated metadata * refactored to make sanity tests pass * refactor to make sanity tests pass ... part deux * refactor: simplify run_command invocations * test: cover check-mode and some normal operation * docs: fix grammatical errors * rip out fingerprint code a full length (40 characters) key ID is equivalent to the fingerprint. * refactor tests, add a couple more * test: added testcase for method: data * Update plugins/modules/packaging/os/pacman_key.py Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> * docs: correct yaml boolean type Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 5ddf004) Co-authored-by: George Rawlinson <george@rawlinson.net.nz>

djmattyg007 · 2021-06-04T09:27:54Z

Wow, nice work and thank you for persevering <3

add module pacman_key

45a00ee

ansibullbot added affects_2.10 community_review module module needs_triage new_contributor Help guide this first time contributor new_module New module new_plugin New plugin os packaging labels Aug 15, 2020

This comment has been minimized.

Sign in to view

felixfontein reviewed Aug 15, 2020

View reviewed changes

add symlink and fix documentation for pacman_key

5b5d99f

felixfontein reviewed Aug 16, 2020

View reviewed changes

plugins/modules/packaging/os/pacman_key.py Outdated Show resolved Hide resolved

grawlinson added 2 commits August 17, 2020 05:57

documentation fix for pacman_key

6c66cd1

improve logic around user input

34c3f97

ansibullbot added the stale_ci CI is older than 7 days, rerun before merging label Oct 21, 2020

Andersson007 reviewed Oct 21, 2020

View reviewed changes

ansibullbot added needs_info This issue requires further information. Please answer any outstanding questions and removed community_review labels Feb 26, 2021

ansibullbot added community_review and removed needs_info This issue requires further information. Please answer any outstanding questions labels Feb 26, 2021

ansibullbot removed the needs_triage label Apr 18, 2021

felixfontein reviewed Jun 1, 2021

View reviewed changes

docs: fix grammatical errors

edbae74

grawlinson added 2 commits June 3, 2021 23:39

rip out fingerprint code

99d3e49

a full length (40 characters) key ID is equivalent to the fingerprint.

refactor tests, add a couple more

65d98fc

ansibullbot added community_review and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jun 3, 2021

test: added testcase for method: data

1fca4d4

ansibullbot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR and removed community_review labels Jun 4, 2021

russoz reviewed Jun 4, 2021

View reviewed changes

plugins/modules/packaging/os/pacman_key.py Outdated Show resolved Hide resolved

russoz approved these changes Jun 4, 2021

View reviewed changes

ansibullbot added community_review and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Jun 4, 2021

Update plugins/modules/packaging/os/pacman_key.py

fb766e4

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

felixfontein reviewed Jun 4, 2021

View reviewed changes

plugins/modules/packaging/os/pacman_key.py Outdated Show resolved Hide resolved

plugins/modules/packaging/os/pacman_key.py Outdated Show resolved Hide resolved

plugins/modules/packaging/os/pacman_key.py Outdated Show resolved Hide resolved

docs: correct yaml boolean type

28daa44

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

felixfontein approved these changes Jun 4, 2021

View reviewed changes

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

felixfontein merged commit 5ddf004 into ansible-collections:main Jun 4, 2021

patchback bot mentioned this pull request Jun 4, 2021

[PR #778/5ddf0041 backport][stable-3] add module pacman_key #2704

Merged

felixfontein mentioned this pull request Jun 4, 2021

Add new module/plugin maintainers to BOTMETA #2708

Merged

patchback bot mentioned this pull request Jun 4, 2021

[PR #2708/d4978328 backport][stable-3] Add new module/plugin maintainers to BOTMETA #2712

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add module pacman_key #778

add module pacman_key #778

grawlinson commented Aug 15, 2020 •

edited

Loading

This comment has been minimized.

felixfontein left a comment

grawlinson commented Aug 16, 2020

grawlinson commented Aug 22, 2020

felixfontein commented Aug 23, 2020

Andersson007 left a comment

felixfontein commented Feb 26, 2021

grawlinson commented Feb 26, 2021

russoz commented Apr 18, 2021

russoz commented Apr 18, 2021

felixfontein commented Jun 3, 2021

grawlinson commented Jun 4, 2021

russoz commented Jun 4, 2021

russoz left a comment

felixfontein left a comment

patchback bot commented Jun 4, 2021 •

edited

Loading

felixfontein commented Jun 4, 2021

djmattyg007 commented Jun 4, 2021

add module pacman_key #778

add module pacman_key #778

Conversation

grawlinson commented Aug 15, 2020 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

This comment has been minimized.

felixfontein left a comment

Choose a reason for hiding this comment

grawlinson commented Aug 16, 2020

grawlinson commented Aug 22, 2020

felixfontein commented Aug 23, 2020

Andersson007 left a comment

Choose a reason for hiding this comment

felixfontein commented Feb 26, 2021

grawlinson commented Feb 26, 2021

russoz commented Apr 18, 2021

russoz commented Apr 18, 2021

felixfontein commented Jun 3, 2021

grawlinson commented Jun 4, 2021

russoz commented Jun 4, 2021

russoz left a comment

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

patchback bot commented Jun 4, 2021 • edited Loading

Backport to stable-3: 💚 backport PR created

felixfontein commented Jun 4, 2021

djmattyg007 commented Jun 4, 2021

grawlinson commented Aug 15, 2020 •

edited

Loading

patchback bot commented Jun 4, 2021 •

edited

Loading