From a509c08b3ad324dd1f0b5e8f0a9dc379507234dd Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Thu, 18 Aug 2022 13:11:39 +0200 Subject: [PATCH] pipx: add state latest (#5105) (#5125) * pipx: add state latest * add changelog fragment * Update plugins/modules/packaging/language/pipx.py Co-authored-by: Felix Fontein Co-authored-by: Felix Fontein (cherry picked from commit 3c960ac6207acc30bea990cf95fdab7e226dba1f) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- .../fragments/5105-pipx-state-latest.yaml | 2 + plugins/modules/packaging/language/pipx.py | 18 +- tests/integration/targets/pipx/tasks/main.yml | 157 ++++++++++++------ 3 files changed, 128 insertions(+), 49 deletions(-) create mode 100644 changelogs/fragments/5105-pipx-state-latest.yaml diff --git a/changelogs/fragments/5105-pipx-state-latest.yaml b/changelogs/fragments/5105-pipx-state-latest.yaml new file mode 100644 index 0000000000..999e5c3748 --- /dev/null +++ b/changelogs/fragments/5105-pipx-state-latest.yaml @@ -0,0 +1,2 @@ +minor_changes: + - pipx - added state ``latest`` to the module (https://github.com/ansible-collections/community.general/pull/5105). diff --git a/plugins/modules/packaging/language/pipx.py b/plugins/modules/packaging/language/pipx.py index 36117bacea..a94b7d8d03 100644 --- a/plugins/modules/packaging/language/pipx.py +++ b/plugins/modules/packaging/language/pipx.py @@ -19,11 +19,13 @@ description: options: state: type: str - choices: [present, absent, install, uninstall, uninstall_all, inject, upgrade, upgrade_all, reinstall, reinstall_all] + choices: [present, absent, install, uninstall, uninstall_all, inject, upgrade, upgrade_all, reinstall, reinstall_all, latest] default: install description: - Desired state for the application. - The states C(present) and C(absent) are aliases to C(install) and C(uninstall), respectively. + - The state C(latest) is equivalent to executing the task twice, with state C(install) and then C(upgrade). + It was added in community.general 5.5.0. name: type: str description: @@ -146,7 +148,7 @@ class PipX(StateModuleHelper): argument_spec=dict( state=dict(type='str', default='install', choices=['present', 'absent', 'install', 'uninstall', 'uninstall_all', - 'inject', 'upgrade', 'upgrade_all', 'reinstall', 'reinstall_all']), + 'inject', 'upgrade', 'upgrade_all', 'reinstall', 'reinstall_all', 'latest']), name=dict(type='str'), source=dict(type='str'), install_deps=dict(type='bool', default=False), @@ -166,6 +168,7 @@ class PipX(StateModuleHelper): ('state', 'uninstall', ['name']), ('state', 'upgrade', ['name']), ('state', 'reinstall', ['name']), + ('state', 'latest', ['name']), ('state', 'inject', ['name', 'inject_packages']), ], supports_check_mode=True, @@ -279,6 +282,17 @@ class PipX(StateModuleHelper): ctx.run() self._capture_results(ctx) + def state_latest(self): + if not self.vars.application or self.vars.force: + self.changed = True + with self.runner('state index_url install_deps force python editable pip_args name_source', check_mode_skip=True) as ctx: + ctx.run(state='install', name_source=[self.vars.name, self.vars.source]) + self._capture_results(ctx) + + with self.runner('state index_url install_deps force editable pip_args name', check_mode_skip=True) as ctx: + ctx.run(state='upgrade') + self._capture_results(ctx) + def main(): PipX.execute() diff --git a/tests/integration/targets/pipx/tasks/main.yml b/tests/integration/targets/pipx/tasks/main.yml index 7013880ad4..2318a59ba4 100644 --- a/tests/integration/targets/pipx/tasks/main.yml +++ b/tests/integration/targets/pipx/tasks/main.yml @@ -20,6 +20,10 @@ name: tox register: install_tox +- name: set fact latest_tox_version + set_fact: + latest_tox_version: "{{ install_tox.application.tox.version }}" + - name: install application tox again community.general.pipx: name: tox @@ -40,12 +44,12 @@ - name: check assertions tox assert: that: - - install_tox is changed - - "'tox' in install_tox.application" - - install_tox_again is not changed - - install_tox_again_force is changed - - uninstall_tox is changed - - "'tox' not in uninstall_tox.application" + - install_tox is changed + - "'tox' in install_tox.application" + - install_tox_again is not changed + - install_tox_again_force is changed + - uninstall_tox is changed + - "'tox' not in uninstall_tox.application" ############################################################################## - name: install application tox 3.24.0 @@ -66,7 +70,7 @@ register: reinstall_noname ignore_errors: yes -- name: upgrade tox 3.24.0 +- name: upgrade tox from 3.24.0 community.general.pipx: name: tox state: upgrade @@ -94,19 +98,78 @@ - name: check assertions tox 3.24.0 assert: that: - - install_tox_324 is changed - - "'tox' in install_tox_324.application" - - install_tox_324.application.tox.version == '3.24.0' - - reinstall_tox_324 is changed - - reinstall_tox_324.application.tox.version == '3.24.0' - - upgrade_tox_324 is changed - - upgrade_tox_324.application.tox.version != '3.24.0' - - downgrade_tox_324 is changed - - downgrade_tox_324.application.tox.version == '3.24.0' - - uninstall_tox_324 is changed - - "'tox' not in uninstall_tox_324.application" - - upgrade_noname is failed - - reinstall_noname is failed + - install_tox_324 is changed + - "'tox' in install_tox_324.application" + - install_tox_324.application.tox.version == '3.24.0' + - reinstall_tox_324 is changed + - reinstall_tox_324.application.tox.version == '3.24.0' + - upgrade_tox_324 is changed + - upgrade_tox_324.application.tox.version != '3.24.0' + - downgrade_tox_324 is changed + - downgrade_tox_324.application.tox.version == '3.24.0' + - uninstall_tox_324 is changed + - "'tox' not in uninstall_tox_324.application" + - upgrade_noname is failed + - reinstall_noname is failed + +############################################################################## +- name: install application latest tox + community.general.pipx: + name: tox + state: latest + register: install_tox_latest + +- name: cleanup tox latest + community.general.pipx: + state: absent + name: tox + register: uninstall_tox_latest + +- name: install application tox 3.24.0 for latest + community.general.pipx: + name: tox + source: tox==3.24.0 + register: install_tox_324_for_latest + +- name: install application latest tox + community.general.pipx: + name: tox + state: latest + register: install_tox_latest_with_preinstall + +- name: install application latest tox again + community.general.pipx: + name: tox + state: latest + register: install_tox_latest_with_preinstall_again + +- name: install application latest tox + community.general.pipx: + name: tox + state: latest + force: true + register: install_tox_latest_with_preinstall_again_force + +- name: cleanup tox latest again + community.general.pipx: + state: absent + name: tox + register: uninstall_tox_latest_again + +- name: check assertions tox latest + assert: + that: + - install_tox_latest is changed + - uninstall_tox_latest is changed + - install_tox_324_for_latest is changed + - install_tox_324_for_latest.application.tox.version == '3.24.0' + - install_tox_latest_with_preinstall is changed + - install_tox_latest_with_preinstall.application.tox.version == latest_tox_version + - install_tox_latest_with_preinstall_again is not changed + - install_tox_latest_with_preinstall_again.application.tox.version == latest_tox_version + - install_tox_latest_with_preinstall_again_force is changed + - install_tox_latest_with_preinstall_again_force.application.tox.version == latest_tox_version + - uninstall_tox_latest_again is changed ############################################################################## - name: ensure application ansible-lint is uninstalled @@ -136,34 +199,34 @@ - name: check assertions inject_packages assert: that: - - install_ansible_lint is changed - - inject_pkgs_ansible_lint is changed - - '"ansible-lint" in inject_pkgs_ansible_lint.application' - - '"licenses" in inject_pkgs_ansible_lint.application["ansible-lint"]["injected"]' - - uninstall_ansible_lint is changed + - install_ansible_lint is changed + - inject_pkgs_ansible_lint is changed + - '"ansible-lint" in inject_pkgs_ansible_lint.application' + - '"licenses" in inject_pkgs_ansible_lint.application["ansible-lint"]["injected"]' + - uninstall_ansible_lint is changed ############################################################################## - name: install jupyter - not working smoothly in freebsd - block: - - name: ensure application jupyter is uninstalled - community.general.pipx: - name: jupyter - state: absent - - - name: install application jupyter - community.general.pipx: - name: jupyter - install_deps: true - register: install_jupyter - - - name: cleanup jupyter - community.general.pipx: - state: absent - name: jupyter - - - name: check assertions - assert: - that: - - install_jupyter is changed - - '"ipython" in install_jupyter.stdout' when: ansible_system != 'FreeBSD' + block: + - name: ensure application jupyter is uninstalled + community.general.pipx: + name: jupyter + state: absent + + - name: install application jupyter + community.general.pipx: + name: jupyter + install_deps: true + register: install_jupyter + + - name: cleanup jupyter + community.general.pipx: + state: absent + name: jupyter + + - name: check assertions + assert: + that: + - install_jupyter is changed + - '"ipython" in install_jupyter.stdout'