summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/general/plugins/modules/cargo.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/community/general/plugins/modules/cargo.py')
-rw-r--r--ansible_collections/community/general/plugins/modules/cargo.py213
1 files changed, 213 insertions, 0 deletions
diff --git a/ansible_collections/community/general/plugins/modules/cargo.py b/ansible_collections/community/general/plugins/modules/cargo.py
new file mode 100644
index 000000000..24be43741
--- /dev/null
+++ b/ansible_collections/community/general/plugins/modules/cargo.py
@@ -0,0 +1,213 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright (c) 2021 Radek Sprta <mail@radeksprta.eu>
+# 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
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+
+DOCUMENTATION = r"""
+---
+module: cargo
+short_description: Manage Rust packages with cargo
+version_added: 4.3.0
+description:
+ - Manage Rust packages with cargo.
+author: "Radek Sprta (@radek-sprta)"
+extends_documentation_fragment:
+ - community.general.attributes
+attributes:
+ check_mode:
+ support: full
+ diff_mode:
+ support: none
+options:
+ name:
+ description:
+ - The name of a Rust package to install.
+ type: list
+ elements: str
+ required: true
+ path:
+ description:
+ ->
+ The base path where to install the Rust packages. Cargo automatically appends
+ C(/bin). In other words, C(/usr/local) will become C(/usr/local/bin).
+ type: path
+ version:
+ description:
+ ->
+ The version to install. If I(name) contains multiple values, the module will
+ try to install all of them in this version.
+ type: str
+ required: false
+ state:
+ description:
+ - The state of the Rust package.
+ required: false
+ type: str
+ default: present
+ choices: [ "present", "absent", "latest" ]
+requirements:
+ - cargo installed in bin path (recommended /usr/local/bin)
+"""
+
+EXAMPLES = r"""
+- name: Install "ludusavi" Rust package
+ community.general.cargo:
+ name: ludusavi
+
+- name: Install "ludusavi" Rust package in version 0.10.0
+ community.general.cargo:
+ name: ludusavi
+ version: '0.10.0'
+
+- name: Install "ludusavi" Rust package to global location
+ community.general.cargo:
+ name: ludusavi
+ path: /usr/local
+
+- name: Remove "ludusavi" Rust package
+ community.general.cargo:
+ name: ludusavi
+ state: absent
+
+- name: Update "ludusavi" Rust package its latest version
+ community.general.cargo:
+ name: ludusavi
+ state: latest
+"""
+
+import os
+import re
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+class Cargo(object):
+ def __init__(self, module, **kwargs):
+ self.module = module
+ self.name = kwargs["name"]
+ self.path = kwargs["path"]
+ self.state = kwargs["state"]
+ self.version = kwargs["version"]
+
+ self.executable = [module.get_bin_path("cargo", True)]
+
+ @property
+ def path(self):
+ return self._path
+
+ @path.setter
+ def path(self, path):
+ if path is not None and not os.path.isdir(path):
+ self.module.fail_json(msg="Path %s is not a directory" % path)
+ self._path = path
+
+ def _exec(
+ self, args, run_in_check_mode=False, check_rc=True, add_package_name=True
+ ):
+ if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):
+ cmd = self.executable + args
+ rc, out, err = self.module.run_command(cmd, check_rc=check_rc)
+ return out, err
+ return "", ""
+
+ def get_installed(self):
+ cmd = ["install", "--list"]
+ data, dummy = self._exec(cmd, True, False, False)
+
+ package_regex = re.compile(r"^([\w\-]+) v(.+):$")
+ installed = {}
+ for line in data.splitlines():
+ package_info = package_regex.match(line)
+ if package_info:
+ installed[package_info.group(1)] = package_info.group(2)
+
+ return installed
+
+ def install(self, packages=None):
+ cmd = ["install"]
+ cmd.extend(packages or self.name)
+ if self.path:
+ cmd.append("--root")
+ cmd.append(self.path)
+ if self.version:
+ cmd.append("--version")
+ cmd.append(self.version)
+ return self._exec(cmd)
+
+ def is_outdated(self, name):
+ installed_version = self.get_installed().get(name)
+
+ cmd = ["search", name, "--limit", "1"]
+ data, dummy = self._exec(cmd, True, False, False)
+
+ match = re.search(r'"(.+)"', data)
+ if match:
+ latest_version = match.group(1)
+
+ return installed_version != latest_version
+
+ def uninstall(self, packages=None):
+ cmd = ["uninstall"]
+ cmd.extend(packages or self.name)
+ return self._exec(cmd)
+
+
+def main():
+ arg_spec = dict(
+ name=dict(required=True, type="list", elements="str"),
+ path=dict(default=None, type="path"),
+ state=dict(default="present", choices=["present", "absent", "latest"]),
+ version=dict(default=None, type="str"),
+ )
+ 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"]
+
+ if not name:
+ module.fail_json(msg="Package name must be specified")
+
+ # Set LANG env since we parse stdout
+ module.run_command_environ_update = dict(
+ LANG="C", LC_ALL="C", LC_MESSAGES="C", LC_CTYPE="C"
+ )
+
+ cargo = Cargo(module, name=name, path=path, state=state, version=version)
+ changed, out, err = False, None, None
+ installed_packages = cargo.get_installed()
+ if state == "present":
+ to_install = [
+ n
+ for n in name
+ if (n not in installed_packages)
+ or (version and version != installed_packages[n])
+ ]
+ if to_install:
+ changed = True
+ out, err = cargo.install(to_install)
+ elif state == "latest":
+ to_update = [
+ n for n in name if n not in installed_packages or cargo.is_outdated(n)
+ ]
+ if to_update:
+ changed = True
+ out, err = cargo.install(to_update)
+ else: # absent
+ to_uninstall = [n for n in name if n in installed_packages]
+ if to_uninstall:
+ changed = True
+ out, err = cargo.uninstall(to_uninstall)
+
+ module.exit_json(changed=changed, stdout=out, stderr=err)
+
+
+if __name__ == "__main__":
+ main()