Module: Adding OpenBSD sysupgrade support #341

precurse · 2020-05-14T20:47:19Z

SUMMARY

This module will let users use OpenBSD's sysupgrade functionality with Ansible. This command is similar to syspatch, which is already in this repo, but handles upgrades between releases and snapshots.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

sysupgrade

ADDITIONAL INFORMATION

This module doesn't currently allow for check_mode, as the script within OpenBSD doesn't currently allow support for checking if a version is available. This will likely be resolved in a future release.

- name: Upgrade to latest release
  sysupgrade:
  become: true
  register: sysupgrade

- name: Upgrade to latest snapshot
  sysupgrade:
    snapshot: true
  register: sysupgrade

- name: Have Ansible reboot if required
  reboot:
  when: sysupgrade.changed

# Note: Ansible will error when running this way due to how
#   the reboot is forcefully handled by sysupgrade:

- name: Have sysupgrade automatically reboot
  sysupgrade:
    fetch_only: false
  become: true
  register: sysupgrade
  ignore_errors: true

ansibullbot · 2020-05-14T20:48:04Z

cc @MorrisA @bcoca @d-little @flynn1973 @gforster @kairoaraujo @marvin-sinister @mator @molekuul @ramooncamacho @wtcross
click here for bot help

ansibullbot · 2020-05-14T20:54:28Z

The test ansible-test sanity --test validate-modules [explain] failed with 4 errors:

plugins/modules/system/sysupgrade.py:0:0: parameter-type-not-in-doc: Argument 'fetch_only' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/system/sysupgrade.py:0:0: parameter-type-not-in-doc: Argument 'force' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/system/sysupgrade.py:0:0: parameter-type-not-in-doc: Argument 'keep_files' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/system/sysupgrade.py:0:0: parameter-type-not-in-doc: Argument 'snapshot' in argument_spec defines type as 'bool' but documentation doesn't define type

click here for bot help

plugins/modules/system/sysupgrade.py

Akasurde · 2020-05-16T12:54:50Z

LGTM, @felixfontein @Andersson007 Could you please review this? Thanks in advance.

felixfontein

This needs some sort of tests (I guess unit tests would be best, since CI doesn't have OpenBSD support).

plugins/modules/system/sysupgrade.py

ansibullbot · 2020-05-17T04:42:15Z

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

plugins/modules/system/sysupgrade.py:0:0: parameter-type-not-in-doc: Argument 'installurl' in argument_spec defines type as 'str' but documentation doesn't define type

click here for bot help

precurse · 2020-08-16T17:44:41Z

Hey, sorry, I got caught up with some things and haven't been able to take a look at this for a while.

I see that @Akasurde made a commit in early-July for this module. Do you need any other modifications done to it?

Thanks!

felixfontein

I don't know sysupgrade, so only some general remarks from my side.

plugins/modules/system/sysupgrade.py

felixfontein · 2020-08-16T19:55:38Z

See also the failed sanity tests (https://app.shippable.com/github/ansible-collections/community.general/runs/3327/1/tests, https://app.shippable.com/github/ansible-collections/community.general/runs/3327/4/tests) and the failed unit tests (https://app.shippable.com/github/ansible-collections/community.general/runs/3327/19/tests for example).

ansibullbot · 2020-08-16T19:56:54Z

The test ansible-test sanity --test pylint [explain] failed with 1 error:

tests/unit/plugins/modules/system/test_sysupgrade.py:17:12: undefined-variable: Undefined variable 'fail_json'

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

tests/unit/plugins/modules/system/test_sysupgrade.py:11:1: E302: expected 2 blank lines, found 1
tests/unit/plugins/modules/system/test_sysupgrade.py:19:1: E302: expected 2 blank lines, found 1

The test ansible-test sanity --test pylint [explain] failed with 1 error:

tests/unit/plugins/modules/system/test_sysupgrade.py:17:12: undefined-variable: Undefined variable 'fail_json'

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

tests/unit/plugins/modules/system/test_sysupgrade.py:11:1: E302: expected 2 blank lines, found 1
tests/unit/plugins/modules/system/test_sysupgrade.py:19:1: E302: expected 2 blank lines, found 1

The test ansible-test sanity --test pylint [explain] failed with 1 error:

tests/unit/plugins/modules/system/test_sysupgrade.py:17:12: undefined-variable: Undefined variable 'fail_json'

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

tests/unit/plugins/modules/system/test_sysupgrade.py:11:1: E302: expected 2 blank lines, found 1
tests/unit/plugins/modules/system/test_sysupgrade.py:19:1: E302: expected 2 blank lines, found 1

click here for bot help

precurse

Adding version_added field.
Adding note to fetch_only that describes reboot behavior.

felixfontein · 2020-08-17T04:00:08Z

@precurse in case you added these changes, you didn't push them.

precurse · 2020-08-17T04:12:27Z

@felixfontein Odd.. I wonder if Github got mixed up with my force push and your suggestions.

Either way, I just added and pushed them properly now :)

ansibullbot · 2020-08-17T05:25:19Z

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/system/sysupgrade.py:37:161: E501: line too long (162 > 160 characters)

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/system/sysupgrade.py:37:161: E501: line too long (162 > 160 characters)

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/system/sysupgrade.py:37:161: E501: line too long (162 > 160 characters)

click here for bot help

* Adding types to sysupgrade documentation * Apply suggestions from code review * Adding installurl flag. Changing wording in example. * Use None for installurl by default * Changing word case in description * sysupgrade: use module structure recommended by Ansible unit test docs * Adding unit test for sysupgrade Signed-off-by: Andrew Klaus <andrew@aklaus.ca> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de>

felixfontein

LGTM

@Andersson007 @Akasurde any last comments? Otherwise I'll merge for the 1.1.0 release today.

Andersson007

LGTM
@felixfontein , no questions
@precurse thanks for the feature!

felixfontein · 2020-08-18T07:11:28Z

@precurse thanks a lot for doing this!
@Akasurde @Andersson007 thanks a lot for reviewing this!

* Adding types to sysupgrade documentation * Apply suggestions from code review * Adding installurl flag. Changing wording in example. * Use None for installurl by default * Changing word case in description * sysupgrade: use module structure recommended by Ansible unit test docs * Adding unit test for sysupgrade Signed-off-by: Andrew Klaus <andrew@aklaus.ca> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Andrew Klychkov <aaklychkov@mail.ru> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 2aabf5e)

ansibullbot added affects_2.10 module module new_module New module new_plugin New plugin labels May 14, 2020

Akasurde requested changes May 15, 2020

View reviewed changes

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 May 15, 2020

precurse requested a review from Akasurde May 15, 2020 18:12

felixfontein mentioned this pull request May 16, 2020

ansible-test validate-modules: missing default in docs not detected if default=False in argspec ansible/ansible#69561

Closed

ansibullbot added the has_issue label May 16, 2020

felixfontein reviewed May 16, 2020

View reviewed changes

Andersson007 reviewed May 16, 2020

View reviewed changes

plugins/modules/system/sysupgrade.py Outdated Show resolved Hide resolved

plugins/modules/system/sysupgrade.py Show resolved Hide resolved

Andersson007 reviewed May 16, 2020

View reviewed changes

plugins/modules/system/sysupgrade.py Outdated Show resolved Hide resolved

plugins/modules/system/sysupgrade.py Outdated Show resolved Hide resolved

Andersson007 reviewed May 16, 2020

View reviewed changes

plugins/modules/system/sysupgrade.py Outdated Show resolved Hide resolved

Andersson007 requested changes May 16, 2020

View reviewed changes

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label May 17, 2020

Akasurde force-pushed the obsd_sysupgrade branch from 5669a6d to c70992c Compare July 3, 2020 06:40

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Jul 3, 2020

felixfontein changed the base branch from master to main July 6, 2020 07:56

ansibullbot added the new_contributor Help guide this first time contributor label Jul 6, 2020

ansibullbot added affects_1 stale_ci CI is older than 7 days, rerun before merging and removed stale_ci CI is older than 7 days, rerun before merging labels Aug 16, 2020

precurse force-pushed the obsd_sysupgrade branch from e555094 to 00e7482 Compare August 16, 2020 19:29

felixfontein reviewed Aug 16, 2020

View reviewed changes

plugins/modules/system/sysupgrade.py Show resolved Hide resolved

plugins/modules/system/sysupgrade.py Show resolved Hide resolved

precurse force-pushed the obsd_sysupgrade branch 2 times, most recently from 9ab776a to c70992c Compare August 16, 2020 20:55

precurse commented Aug 16, 2020

View reviewed changes

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Aug 17, 2020

precurse force-pushed the obsd_sysupgrade branch from 8eed190 to 035822a Compare August 17, 2020 14:50

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Aug 17, 2020

precurse requested review from felixfontein and Andersson007 August 17, 2020 16:16

felixfontein approved these changes Aug 18, 2020

View reviewed changes

Andersson007 approved these changes Aug 18, 2020

View reviewed changes

felixfontein merged commit 2aabf5e into ansible-collections:main Aug 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Module: Adding OpenBSD sysupgrade support #341

Module: Adding OpenBSD sysupgrade support #341

precurse commented May 14, 2020 •

edited

Loading

ansibullbot commented May 14, 2020

ansibullbot commented May 14, 2020

Akasurde commented May 16, 2020

felixfontein left a comment

ansibullbot commented May 17, 2020

precurse commented Aug 16, 2020

felixfontein left a comment

felixfontein commented Aug 16, 2020

ansibullbot commented Aug 16, 2020

precurse left a comment

felixfontein commented Aug 17, 2020

precurse commented Aug 17, 2020 •

edited

Loading

ansibullbot commented Aug 17, 2020

felixfontein left a comment

Andersson007 left a comment

felixfontein commented Aug 18, 2020

Module: Adding OpenBSD sysupgrade support #341

Module: Adding OpenBSD sysupgrade support #341

Conversation

precurse commented May 14, 2020 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented May 14, 2020

ansibullbot commented May 14, 2020

Akasurde commented May 16, 2020

felixfontein left a comment

Choose a reason for hiding this comment

ansibullbot commented May 17, 2020

precurse commented Aug 16, 2020

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein commented Aug 16, 2020

ansibullbot commented Aug 16, 2020

precurse left a comment

Choose a reason for hiding this comment

felixfontein commented Aug 17, 2020

precurse commented Aug 17, 2020 • edited Loading

ansibullbot commented Aug 17, 2020

felixfontein left a comment

Choose a reason for hiding this comment

Andersson007 left a comment

Choose a reason for hiding this comment

felixfontein commented Aug 18, 2020

precurse commented May 14, 2020 •

edited

Loading

precurse commented Aug 17, 2020 •

edited

Loading