-
Notifications
You must be signed in to change notification settings - Fork 344
/
test_interface.py
388 lines (315 loc) · 11.2 KB
/
test_interface.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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
import os
import pytest
from ansible_runner import defaults
from ansible_runner.interface import run, run_async, run_command, run_command_async, get_plugin_docs, \
get_plugin_docs_async, get_plugin_list, get_ansible_config, get_inventory
def test_run():
r = run(module='debug', host_pattern='localhost')
assert r.status == 'successful'
@pytest.mark.parametrize(
'playbook', (
[{'hosts': 'localhost', 'tasks': [{'ping': ''}]}],
{'hosts': 'localhost', 'tasks': [{'ping': ''}]},
)
)
def test_run_playbook_data(playbook, tmp_path):
r = run(private_data_dir=str(tmp_path), playbook=playbook)
assert r.status == 'successful'
def test_run_async(tmp_path):
thread, r = run_async(private_data_dir=str(tmp_path), module='debug', host_pattern='localhost')
thread.join()
assert r.status == 'successful'
def get_env_data(res):
for event in res.events:
found = bool(
event['event'] == 'runner_on_ok' and event.get(
'event_data', {}
).get('task_action', None) == 'look_at_environment'
)
if found:
return event['event_data']['res']
else:
print('output:')
print(res.stdout.read())
raise RuntimeError('Count not find look_at_environment task from playbook')
def test_env_accuracy(request, project_fixtures):
printenv_example = project_fixtures / 'printenv'
os.environ['SET_BEFORE_TEST'] = 'MADE_UP_VALUE'
# Remove the envvars file if it exists
try:
os.remove(printenv_example / "env/envvars")
except FileNotFoundError:
pass
def remove_test_env_var():
if 'SET_BEFORE_TEST' in os.environ:
del os.environ['SET_BEFORE_TEST']
request.addfinalizer(remove_test_env_var)
res = run(
private_data_dir=printenv_example,
playbook='get_environment.yml',
inventory=None,
envvars={'FROM_TEST': 'FOOBAR'},
)
assert res.rc == 0, res.stdout.read()
actual_env = get_env_data(res)['environment']
assert actual_env == res.config.env
# Assert that the env file was properly created
assert os.path.exists(printenv_example / "env/envvars") == 1
def test_no_env_files(request, project_fixtures):
printenv_example = project_fixtures / 'printenv'
os.environ['SET_BEFORE_TEST'] = 'MADE_UP_VALUE'
# Remove the envvars file if it exists
try:
os.remove(printenv_example / "env/envvars")
except FileNotFoundError:
pass
res = run(
private_data_dir=printenv_example,
playbook='get_environment.yml',
inventory=None,
envvars={'FROM_TEST': 'FOOBAR'},
suppress_env_files=True,
)
assert res.rc == 0, res.stdout.read()
# Assert that the env file was not created
assert os.path.exists(printenv_example / "env/envvars") == 0
@pytest.mark.test_all_runtimes
def test_env_accuracy_inside_container(request, project_fixtures, runtime):
printenv_example = project_fixtures / 'printenv'
os.environ['SET_BEFORE_TEST'] = 'MADE_UP_VALUE'
def remove_test_env_var():
if 'SET_BEFORE_TEST' in os.environ:
del os.environ['SET_BEFORE_TEST']
request.addfinalizer(remove_test_env_var)
res = run(
private_data_dir=printenv_example,
project_dir='/tmp',
playbook='get_environment.yml',
inventory=None,
envvars={'FROM_TEST': 'FOOBAR'},
settings={
'process_isolation_executable': runtime,
'process_isolation': True
}
)
assert res.rc == 0, res.stdout.read()
env_data = get_env_data(res)
actual_env = env_data['environment']
expected_env = res.config.env.copy()
# NOTE: the reported environment for containerized jobs will not account for
# all environment variables, particularly those set by the entrypoint script
for key, value in expected_env.items():
assert key in actual_env
assert actual_env[key] == value, 'Reported value wrong for {0} env var'.format(key)
assert env_data['cwd'] == res.config.cwd
def test_multiple_inventories(project_fixtures):
private_data_dir = project_fixtures / 'debug'
res = run(
private_data_dir=private_data_dir,
playbook='debug.yml',
)
stdout = res.stdout.read()
assert res.rc == 0, stdout
# providing no inventory should cause <private_data_dir>/inventory
# to be used, reading both inventories in the directory
assert 'host_1' in stdout
assert 'host_2' in stdout
def test_inventory_absolute_path(project_fixtures):
private_data_dir = project_fixtures / 'debug'
res = run(
private_data_dir=private_data_dir,
playbook='debug.yml',
inventory=[
str(private_data_dir / 'inventory' / 'inv_1'),
],
)
stdout = res.stdout.read()
assert res.rc == 0, stdout
# hosts can be down-selected to one inventory out of those available
assert 'host_1' in stdout
assert 'host_2' not in stdout
def test_run_command(project_fixtures):
private_data_dir = project_fixtures / 'debug'
inventory = private_data_dir / 'inventory' / 'inv_1'
playbook = private_data_dir / 'project' / 'debug.yml'
out, err, rc = run_command(
private_data_dir=private_data_dir,
executable_cmd='ansible-playbook',
cmdline_args=[str(playbook), '-i', str(inventory)]
)
assert "Hello world!" in out
assert rc == 0
assert err == ''
def test_run_command_injection_error():
out, err, rc = run_command(
executable_cmd='whoami',
cmdline_args=[';hostname'],
runner_mode='subprocess',
)
assert rc == 1
assert "usage: whoami" in err or "whoami: extra operand ‘;hostname’" in err
@pytest.mark.test_all_runtimes
def test_run_command_injection_error_within_container(runtime):
out, err, rc = run_command(
executable_cmd='whoami',
cmdline_args=[';hostname'],
runner_mode='subprocess',
process_isolation_executable=runtime,
process_isolation=True,
container_image=defaults.default_container_image,
)
assert rc == 1
assert "whoami: extra operand ';hostname'" in err
@pytest.mark.test_all_runtimes
def test_run_ansible_command_within_container(project_fixtures, runtime):
private_data_dir = project_fixtures / 'debug'
inventory = private_data_dir / 'inventory' / 'inv_1'
playbook = private_data_dir / 'project' / 'debug.yml'
container_kwargs = {
'process_isolation_executable': runtime,
'process_isolation': True,
'container_image': defaults.default_container_image
}
out, err, rc = run_command(
private_data_dir=private_data_dir,
executable_cmd='ansible-playbook',
cmdline_args=[str(playbook), '-i', str(inventory)],
**container_kwargs
)
assert "Hello world!" in out
assert rc == 0
assert err == ''
@pytest.mark.test_all_runtimes
def test_run_script_within_container(project_fixtures, runtime):
private_data_dir = project_fixtures / 'debug'
script_path = project_fixtures / 'files'
container_volume_mounts = ["{}:{}:Z".format(script_path, script_path)]
container_kwargs = {
'process_isolation_executable': runtime,
'process_isolation': True,
'container_image': defaults.default_container_image,
'container_volume_mounts': container_volume_mounts
}
out, _, rc = run_command(
private_data_dir=private_data_dir,
executable_cmd='python3',
cmdline_args=[str(script_path / 'test_ee.py')],
**container_kwargs
)
assert "os-release" in out
assert rc == 0
def test_run_command_async(project_fixtures):
private_data_dir = project_fixtures / 'debug'
inventory = private_data_dir / 'inventory' / 'inv_1'
playbook = private_data_dir / 'project' / 'debug.yml'
thread, r = run_command_async(
private_data_dir=private_data_dir,
executable_cmd='ansible-playbook',
cmdline_args=[str(playbook), '-i', str(inventory)]
)
thread.join()
out = r.stdout.read()
assert "Hello world!" in out
assert r.status == 'successful'
def test_get_plugin_docs():
out, _ = get_plugin_docs(
plugin_names=['file', 'copy'],
plugin_type='module',
quiet=True
)
assert 'copy' in out
assert 'file' in out
def test_get_plugin_docs_async():
thread, r = get_plugin_docs_async(
plugin_names=['file', 'copy'],
plugin_type='module',
quiet=True
)
thread.join()
out = r.stdout.read()
assert 'copy' in out
assert 'file' in out
assert r.status == 'successful'
@pytest.mark.test_all_runtimes
def test_get_plugin_docs_within_container(runtime):
container_kwargs = {
'process_isolation_executable': runtime,
'process_isolation': True,
'container_image': defaults.default_container_image
}
out, _ = get_plugin_docs(
plugin_names=['file', 'copy'],
plugin_type='module',
quiet=True,
**container_kwargs
)
assert 'copy' in out
assert 'file' in out
def test_get_plugin_docs_list():
out, _ = get_plugin_list(
list_files=True,
quiet=True
)
assert 'copy' in out
assert 'file' in out
@pytest.mark.test_all_runtimes
def test_get_plugin_docs_list_within_container(runtime):
container_kwargs = {
'process_isolation_executable': runtime,
'process_isolation': True,
'container_image': defaults.default_container_image
}
out, _ = get_plugin_list(
list_files=True,
quiet=True,
**container_kwargs
)
assert 'copy' in out
assert 'file' in out
def test_ansible_config():
out, _ = get_ansible_config(
action='list',
quiet=True
)
assert 'DEFAULT_VERBOSITY' in out
def test_get_inventory(project_fixtures):
private_data_dir = project_fixtures / 'debug'
inventory1 = private_data_dir / 'inventory' / 'inv_1'
inventory2 = private_data_dir / 'inventory' / 'inv_2'
out, _ = get_inventory(
action='list',
inventories=[str(inventory1), str(inventory2)],
response_format='json',
quiet=True
)
assert 'host_1' in out['ungrouped']['hosts']
assert 'host_2' in out['ungrouped']['hosts']
@pytest.mark.test_all_runtimes
def test_get_inventory_within_container(project_fixtures, runtime):
container_kwargs = {
'process_isolation_executable': runtime,
'process_isolation': True,
'container_image': defaults.default_container_image
}
private_data_dir = project_fixtures / 'debug'
inventory1 = private_data_dir / 'inventory' / 'inv_1'
inventory2 = private_data_dir / 'inventory' / 'inv_2'
out, _ = get_inventory(
action='list',
inventories=[str(inventory1), str(inventory2)],
response_format='json',
quiet=True,
**container_kwargs
)
assert 'host_1' in out['ungrouped']['hosts']
assert 'host_2' in out['ungrouped']['hosts']
def test_run_role(project_fixtures):
''' Test that we can run a role via the API. '''
private_data_dir = project_fixtures / 'debug'
res = run(
private_data_dir=private_data_dir,
role='hello_world',
)
stdout = res.stdout.read()
assert res.rc == 0, stdout
assert 'Hello World!' in stdout