-
Notifications
You must be signed in to change notification settings - Fork 654
/
_prerun.py
305 lines (265 loc) · 10.3 KB
/
_prerun.py
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
import logging
import os
import pathlib
import re
import subprocess
import sys
from functools import lru_cache
from typing import List, Optional, Tuple
from packaging import version
from ansiblelint.config import (
ansible_collections_path,
collection_list,
options,
parse_ansible_version,
)
from ansiblelint.constants import (
ANSIBLE_DEFAULT_ROLES_PATH,
ANSIBLE_MIN_VERSION,
ANSIBLE_MISSING_RC,
ANSIBLE_MOCKED_MODULE,
INVALID_CONFIG_RC,
INVALID_PREREQUISITES_RC,
)
from ansiblelint.loaders import yaml_from_file
_logger = logging.getLogger(__name__)
def check_ansible_presence(exit_on_error: bool = False) -> Tuple[str, str]:
"""Assures we stop execution if Ansible is missing or outdated.
Returne found version and an optional exception if something wrong
was detected.
"""
@lru_cache()
def _get_ver_err() -> Tuple[str, str]:
err = ""
failed = False
ver = ""
result = subprocess.run(
args=["ansible", "--version"],
stdout=subprocess.PIPE,
universal_newlines=True,
check=False,
)
if result.returncode != 0:
return (
ver,
"FATAL: Unable to retrieve ansible cli version: %s" % result.stdout,
)
ver, error = parse_ansible_version(result.stdout)
if error is not None:
return "", error
try:
# pylint: disable=import-outside-toplevel
from ansible.release import __version__ as ansible_module_version
if version.parse(ansible_module_version) < version.parse(
ANSIBLE_MIN_VERSION
):
failed = True
except (ImportError, ModuleNotFoundError) as e:
failed = True
ansible_module_version = "none"
err += f"{e}\n"
if failed:
err += (
"FATAL: ansible-lint requires a version of Ansible package"
" >= %s, but %s was found. "
"Please install a compatible version using the same python interpreter. See "
"https://docs.ansible.com/ansible/latest/installation_guide"
"/intro_installation.html#installing-ansible-with-pip"
% (ANSIBLE_MIN_VERSION, ansible_module_version)
)
elif ver != ansible_module_version:
err = (
f"FATAL: Ansible CLI ({ver}) and python module"
f" ({ansible_module_version}) versions do not match. This "
"indicates a broken execution environment."
)
return ver, err
ver, err = _get_ver_err()
if exit_on_error and err:
_logger.error(err)
sys.exit(ANSIBLE_MISSING_RC)
return ver, err
def prepare_environment() -> None:
"""Make dependencies available if needed."""
if not options.offline and os.path.exists("requirements.yml"):
cmd = [
"ansible-galaxy",
"role",
"install",
"--roles-path",
f"{options.project_dir}/.cache/roles",
"-vr",
"requirements.yml",
]
_logger.info("Running %s", " ".join(cmd))
run = subprocess.run(
cmd,
universal_newlines=True,
check=False,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
)
if run.returncode != 0:
_logger.error(run.stdout)
sys.exit(run.returncode)
# Run galaxy collection install works on v2 requirements.yml
if "collections" in yaml_from_file("requirements.yml"):
cmd = [
"ansible-galaxy",
"collection",
"install",
"-p",
f"{options.project_dir}/.cache/collections",
"-vr",
"requirements.yml",
]
_logger.info("Running %s", " ".join(cmd))
run = subprocess.run(
cmd,
universal_newlines=True,
check=False,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
)
if run.returncode != 0:
_logger.error(run.stdout)
sys.exit(run.returncode)
_install_galaxy_role()
_perform_mockings()
_prepare_ansible_paths()
def _install_galaxy_role() -> None:
"""Detect standalone galaxy role and installs it."""
if not os.path.exists("meta/main.yml"):
return
yaml = yaml_from_file("meta/main.yml")
if 'galaxy_info' not in yaml:
return
role_name = yaml['galaxy_info'].get('role_name', None)
role_namespace = yaml['galaxy_info'].get('namespace', None)
if not role_namespace:
role_namespace = yaml['galaxy_info'].get('author', None)
if not role_name:
role_name = pathlib.Path(".").absolute().name
role_name = re.sub(r'^{0}'.format(re.escape('ansible-role-')), '', role_name)
if 'role-name' not in options.skip_list:
fqrn = f"{role_namespace}.{role_name}"
if not re.match(r"[a-z0-9][a-z0-9_]+\.[a-z][a-z0-9_]+$", fqrn):
msg = (
"""\
Computed fully qualified role name of %s does not follow current galaxy requirements.
Please edit meta/main.yml and assure we can correctly determine full role name:
galaxy_info:
role_name: my_name # if absent directory name hosting role is used instead
namespace: my_galaxy_namespace # if absent, author is used instead
Namespace: https://galaxy.ansible.com/docs/contributing/namespaces.html#galaxy-namespace-limitations
Role: https://galaxy.ansible.com/docs/contributing/creating_role.html#role-names
As an alternative, you can add 'role-name' to either skip_list or warn_list.
""",
fqrn,
)
if 'role-name' in options.warn_list:
_logger.warning(msg)
else:
_logger.error(msg)
sys.exit(INVALID_PREREQUISITES_RC)
else:
# when 'role-name' is in skip_list, we stick to plain role names
fqrn = role_name
p = pathlib.Path(f"{options.project_dir}/.cache/roles")
p.mkdir(parents=True, exist_ok=True)
link_path = p / f"{role_namespace}.{role_name}"
# despite documentation stating that is_file() reports true for symlinks,
# it appears that is_dir() reports true instead, so we rely on exits().
if not link_path.exists():
link_path.symlink_to(pathlib.Path("../..", target_is_directory=True))
_logger.info(
"Using %s symlink to current repository in order to enable Ansible to find the role using its expected full name.",
link_path,
)
def _prepare_ansible_paths() -> None:
"""Configure Ansible environment variables."""
library_paths: List[str] = []
roles_path: List[str] = []
for path_list, path in (
(library_paths, "plugins/modules"),
(library_paths, f"{options.project_dir}/.cache/modules"),
(collection_list, f"{options.project_dir}/.cache/collections"),
(roles_path, "roles"),
(roles_path, f"{options.project_dir}/.cache/roles"),
):
if path not in path_list and os.path.exists(path):
path_list.append(path)
_update_env('ANSIBLE_LIBRARY', library_paths)
_update_env(ansible_collections_path(), collection_list)
_update_env('ANSIBLE_ROLES_PATH', roles_path, default=ANSIBLE_DEFAULT_ROLES_PATH)
def _make_module_stub(module_name: str) -> None:
# a.b.c is treated a collection
if re.match(r"\w+\.\w+\.\w+", module_name):
namespace, collection, module_file = module_name.split(".")
path = f"{ options.project_dir }/.cache/collections/ansible_collections/{ namespace }/{ collection }/plugins/modules"
os.makedirs(path, exist_ok=True)
_write_module_stub(
filename=f"{path}/{module_file}.py",
name=module_file,
namespace=namespace,
collection=collection,
)
elif "." in module_name:
_logger.error("Config error: %s is not a valid module name.", module_name)
sys.exit(INVALID_CONFIG_RC)
else:
os.makedirs(f"{options.project_dir}/.cache/modules", exist_ok=True)
_write_module_stub(
filename=f"{options.project_dir}/.cache/modules/{module_name}.py",
name=module_name,
)
def _write_module_stub(
filename: str,
name: str,
namespace: Optional[str] = None,
collection: Optional[str] = None,
) -> None:
"""Write module stub to disk."""
body = ANSIBLE_MOCKED_MODULE.format(
name=name, collection=collection, namespace=namespace
)
with open(filename, "w") as f:
f.write(body)
def _update_env(varname: str, value: List[str], default: str = "") -> None:
"""Update colon based environment variable if needed. by appending."""
if value:
value = [*os.environ.get(varname, default=default).split(':'), *value]
value_str = ":".join(value)
if value_str != os.environ.get(varname, ""):
os.environ[varname] = value_str
_logger.info("Added %s=%s", varname, value_str)
def _perform_mockings() -> None:
"""Mock modules and roles."""
for role_name in options.mock_roles:
if re.match(r"\w+\.\w+\.\w+$", role_name):
namespace, collection, role_dir = role_name.split(".")
path = f".cache/collections/ansible_collections/{ namespace }/{ collection }/roles/{ role_dir }/"
else:
path = f".cache/roles/{role_name}"
os.makedirs(path, exist_ok=True)
if options.mock_modules:
for module_name in options.mock_modules:
_make_module_stub(module_name)
# if inside a collection repo, symlink it to simulate its installed state
if not os.path.exists("galaxy.yml"):
return
yaml = yaml_from_file("galaxy.yml")
if not yaml:
# ignore empty galaxy.yml file
return
namespace = yaml.get('namespace', None)
collection = yaml.get('name', None)
if not namespace or not collection:
return
p = pathlib.Path(
f"{options.project_dir}/.cache/collections/ansible_collections/{ namespace }"
)
p.mkdir(parents=True, exist_ok=True)
link_path = p / collection
if not link_path.exists():
link_path.symlink_to(pathlib.Path("../../../..", target_is_directory=True))