1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
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()
|
