From 0ca07b0b0513c0e534233aa536a3bfa1d6563924 Mon Sep 17 00:00:00 2001 From: radek-sprta Date: Fri, 6 Oct 2023 07:41:02 +0200 Subject: [PATCH] Add `executable` option to cargo (#7352) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add `executable` option to cargo Add `executable` option to cargo to make the module easier to use with cargo installed by rustup. * Add changelog fragment * Add license to integration test * Do not test on CentOS 6 CentOS 6 cannot even validate the certificate in https://sh.rustup.rs. * Fix condition to skip tests on CentOS 6 * Add version_added to path Co-authored-by: Felix Fontein * Update plugins/modules/cargo.py Co-authored-by: Felix Fontein * shell → command --------- Co-authored-by: Felix Fontein --- .../7352-add-executable-option-for-cargo.yml | 2 ++ plugins/modules/cargo.py | 16 ++++++++----- .../integration/targets/cargo/tasks/main.yml | 2 ++ .../integration/targets/cargo/tasks/setup.yml | 14 +++++++++++ .../targets/cargo/tasks/test_rustup_cargo.yml | 23 +++++++++++++++++++ 5 files changed, 51 insertions(+), 6 deletions(-) create mode 100644 changelogs/fragments/7352-add-executable-option-for-cargo.yml create mode 100644 tests/integration/targets/cargo/tasks/test_rustup_cargo.yml diff --git a/changelogs/fragments/7352-add-executable-option-for-cargo.yml b/changelogs/fragments/7352-add-executable-option-for-cargo.yml new file mode 100644 index 0000000000..63cf47d8f8 --- /dev/null +++ b/changelogs/fragments/7352-add-executable-option-for-cargo.yml @@ -0,0 +1,2 @@ +minor_changes: + - "cargo - add option ``executable``, which allows user to specify path to the cargo binary (https://github.com/ansible-collections/community.general/pull/7352)." diff --git a/plugins/modules/cargo.py b/plugins/modules/cargo.py index f3109db844..b872361b30 100644 --- a/plugins/modules/cargo.py +++ b/plugins/modules/cargo.py @@ -25,6 +25,12 @@ attributes: diff_mode: support: none options: + executable: + description: + - Path to the C(cargo) installed in the system. + - If not specified, the module will look C(cargo) in E(PATH). + type: path + version_added: 7.5.0 name: description: - The name of a Rust package to install. @@ -60,7 +66,7 @@ options: default: present choices: [ "present", "absent", "latest" ] requirements: - - cargo installed in bin path (recommended /usr/local/bin) + - cargo installed """ EXAMPLES = r""" @@ -103,14 +109,13 @@ from ansible.module_utils.basic import AnsibleModule class Cargo(object): def __init__(self, module, **kwargs): self.module = module + self.executable = [kwargs["executable"] or module.get_bin_path("cargo", True)] self.name = kwargs["name"] self.path = kwargs["path"] self.state = kwargs["state"] self.version = kwargs["version"] self.locked = kwargs["locked"] - self.executable = [module.get_bin_path("cargo", True)] - @property def path(self): return self._path @@ -176,6 +181,7 @@ class Cargo(object): def main(): arg_spec = dict( + executable=dict(default=None, type="path"), name=dict(required=True, type="list", elements="str"), path=dict(default=None, type="path"), state=dict(default="present", choices=["present", "absent", "latest"]), @@ -185,10 +191,8 @@ def main(): module = AnsibleModule(argument_spec=arg_spec, supports_check_mode=True) name = module.params["name"] - path = module.params["path"] state = module.params["state"] version = module.params["version"] - locked = module.params["locked"] if not name: module.fail_json(msg="Package name must be specified") @@ -198,7 +202,7 @@ def main(): LANG="C", LC_ALL="C", LC_MESSAGES="C", LC_CTYPE="C" ) - cargo = Cargo(module, name=name, path=path, state=state, version=version, locked=locked) + cargo = Cargo(module, **module.params) changed, out, err = False, None, None installed_packages = cargo.get_installed() if state == "present": diff --git a/tests/integration/targets/cargo/tasks/main.yml b/tests/integration/targets/cargo/tasks/main.yml index bb22e27c07..29f27c3fda 100644 --- a/tests/integration/targets/cargo/tasks/main.yml +++ b/tests/integration/targets/cargo/tasks/main.yml @@ -18,3 +18,5 @@ - import_tasks: test_version.yml environment: "{{ cargo_environment }}" when: has_cargo | default(false) +- import_tasks: test_rustup_cargo.yml + when: rustup_cargo_bin | default(false) diff --git a/tests/integration/targets/cargo/tasks/setup.yml b/tests/integration/targets/cargo/tasks/setup.yml index 232658ab46..7eec97ac4c 100644 --- a/tests/integration/targets/cargo/tasks/setup.yml +++ b/tests/integration/targets/cargo/tasks/setup.yml @@ -26,3 +26,17 @@ has_cargo: true when: - ansible_system == 'FreeBSD' and ansible_distribution_version is version('13.0', '>') + +- block: + - name: Download rustup + get_url: + url: https://sh.rustup.rs + dest: /tmp/sh.rustup.rs + mode: "0750" + force: true + - name: Install rustup cargo + command: /tmp/sh.rustup.rs -y + - set_fact: + rustup_cargo_bin: "{{ lookup('env', 'HOME') }}/.cargo/bin/cargo" + when: + - ansible_distribution != 'CentOS' or ansible_distribution_version is version('7.0', '>=') diff --git a/tests/integration/targets/cargo/tasks/test_rustup_cargo.yml b/tests/integration/targets/cargo/tasks/test_rustup_cargo.yml new file mode 100644 index 0000000000..ec2cf6e6de --- /dev/null +++ b/tests/integration/targets/cargo/tasks/test_rustup_cargo.yml @@ -0,0 +1,23 @@ +--- +# Copyright (c) Ansible Project +# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later +# +- name: Install application helloworld + community.general.cargo: + executable: "{{ rustup_cargo_bin }}" + name: helloworld + register: rustup_install_absent_helloworld + +- name: Uninstall application helloworld + community.general.cargo: + executable: "{{ rustup_cargo_bin }}" + state: absent + name: helloworld + register: rustup_uninstall_present_helloworld + +- name: Check assertions helloworld + assert: + that: + - rustup_install_absent_helloworld is changed + - rustup_uninstall_present_helloworld is changed