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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
# This file is part of cloud-init. See LICENSE file for license information.
import os
from collections import namedtuple
import pytest
import cloudinit.settings
from cloudinit.cmd import clean
from cloudinit.config import cc_mounts
from cloudinit.distros import Distro
from cloudinit.sources import DataSource
from cloudinit.stages import Init
from cloudinit.util import del_file, ensure_dir, sym_link, write_file
from tests.unittests.helpers import mock, wrap_and_call
MyPaths = namedtuple("MyPaths", "cloud_dir")
CleanPaths = namedtuple(
"CleanPaths",
["tmpdir", "cloud_dir", "clean_dir", "log", "output_log"],
)
@pytest.fixture(scope="function")
def clean_paths(tmpdir):
return CleanPaths(
tmpdir=tmpdir,
cloud_dir=tmpdir.join("varlibcloud"),
clean_dir=tmpdir.join("clean.d"),
log=tmpdir.join("cloud-init.log"),
output_log=tmpdir.join("cloud-init-output.log"),
)
@pytest.fixture(scope="function")
def init_class(clean_paths):
init = mock.Mock(spec=Init)
init.paths = MyPaths(cloud_dir=f"{clean_paths.cloud_dir}/")
init.distro.shutdown_command = Distro.shutdown_command
init.cfg = {
"def_log_file": clean_paths.log,
"output": {"all": f"|tee -a {clean_paths.output_log}"},
}
return init
class TestClean:
def test_remove_artifacts_removes_logs(self, clean_paths, init_class):
"""remove_artifacts removes logs when remove_logs is True."""
clean_paths.log.write("cloud-init-log")
clean_paths.output_log.write("cloud-init-output-log")
assert (
os.path.exists(clean_paths.cloud_dir) is False
), "Unexpected cloud_dir"
retcode = clean.remove_artifacts(
init=init_class,
remove_logs=True,
)
assert (
clean_paths.log.exists() is False
), f"Unexpected file {clean_paths.log}"
assert (
clean_paths.output_log.exists() is False
), f"Unexpected file {clean_paths.output_log}"
assert 0 == retcode
def test_remove_net_conf(self, clean_paths, init_class):
"""remove_config removes config files when True."""
TEST_GEN_NET_CONFIG_FILES = [
clean_paths.tmpdir.join(conf_file)
for conf_file in clean.GEN_NET_CONFIG_FILES
]
for conf_path in TEST_GEN_NET_CONFIG_FILES:
assert conf_path.exists() is False, f"Unexpected {conf_path}"
ensure_dir(os.path.dirname(conf_path))
if "*" in conf_path.strpath:
# Expand glob path to interface-specific eth0 filename
eth0_path = conf_path.strpath.replace("*", "eth0")
write_file(
eth0_path, f"#generated by cloud-init test {eth0_path}"
)
else:
conf_path.write(f"#generated by cloud-init test {conf_path}")
with mock.patch(
"cloudinit.cmd.clean.GEN_NET_CONFIG_FILES",
[f.strpath for f in TEST_GEN_NET_CONFIG_FILES],
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["network"],
)
for conf_path in TEST_GEN_NET_CONFIG_FILES:
if "*" in conf_path.strpath:
# Expand glob path to interface-specific eth0 filename
assert (
os.path.exists(conf_path.strpath.replace("*", "eth0"))
is False
), f"Unexpected file {conf_path.strpath.replace('*', 'eth0')}"
else:
assert (
conf_path.exists() is False
), f"Unexpected file {conf_path}"
assert 0 == retcode
def test_remove_ssh_conf(self, clean_paths, init_class):
"""remove_config removes config files when True."""
TEST_GEN_SSH_CONFIG_FILES = [
clean_paths.tmpdir.join(conf_file)
for conf_file in clean.GEN_SSH_CONFIG_FILES
]
for conf_path in TEST_GEN_SSH_CONFIG_FILES:
assert conf_path.exists() is False, f"Unexpected {conf_path}"
ensure_dir(os.path.dirname(conf_path))
conf_path.write(f"#generated by cloud-init\ntouch {conf_path}\n")
with mock.patch(
"cloudinit.cmd.clean.GEN_SSH_CONFIG_FILES",
TEST_GEN_SSH_CONFIG_FILES,
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["ssh_config"],
)
for conf_path in TEST_GEN_SSH_CONFIG_FILES:
assert conf_path.exists() is False, f"Unexpected file {conf_path}"
assert 0 == retcode
def test_remove_all_conf(self, clean_paths, init_class):
"""remove_config removes config files when True."""
TEST_GEN_NET_CONFIG_FILES = [
clean_paths.tmpdir.join(conf_file)
for conf_file in clean.GEN_NET_CONFIG_FILES
]
for conf_path in TEST_GEN_NET_CONFIG_FILES:
assert conf_path.exists() is False, f"Unexpected {conf_path}"
ensure_dir(os.path.dirname(conf_path))
conf_path.write(f"#generated by cloud-init\ntouch {conf_path}\n")
TEST_GEN_SSH_CONFIG_FILES = [
clean_paths.tmpdir.join(conf_file)
for conf_file in clean.GEN_SSH_CONFIG_FILES
]
for conf_path in TEST_GEN_SSH_CONFIG_FILES:
assert conf_path.exists() is False, f"Unexpected {conf_path}"
ensure_dir(os.path.dirname(conf_path))
conf_path.write(f"#generated by cloud-init\ntouch {conf_path}\n")
with mock.patch(
"cloudinit.cmd.clean.GEN_NET_CONFIG_FILES",
[f.strpath for f in TEST_GEN_NET_CONFIG_FILES],
), mock.patch(
"cloudinit.cmd.clean.GEN_SSH_CONFIG_FILES",
TEST_GEN_SSH_CONFIG_FILES,
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["all"],
)
for conf_path in TEST_GEN_NET_CONFIG_FILES:
assert conf_path.exists() is False, f"file {conf_path} exists!"
for conf_path in TEST_GEN_SSH_CONFIG_FILES:
assert conf_path.exists() is False, f"file {conf_path} exists!"
assert 0 == retcode
def test_keep_net_conf(self, clean_paths, init_class):
"""remove_config removes config files when True."""
TEST_GEN_NET_CONFIG_FILES = [
clean_paths.tmpdir.join(conf_file)
for conf_file in clean.GEN_NET_CONFIG_FILES
]
for conf_path in TEST_GEN_NET_CONFIG_FILES:
assert conf_path.exists() is False, f"Unexpected {conf_path}"
ensure_dir(os.path.dirname(conf_path))
conf_path.write(f"#generated by cloud-init\ntouch {conf_path}\n")
with mock.patch(
"cloudinit.cmd.clean.GEN_NET_CONFIG_FILES",
TEST_GEN_NET_CONFIG_FILES,
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=[],
)
for conf_path in TEST_GEN_NET_CONFIG_FILES:
assert conf_path.exists() is True, f"file {conf_path} removed!"
assert 0 == retcode
@pytest.mark.usefixtures("fake_filesystem")
def test_clean_fstab(self, clean_paths, init_class):
"""remove_config removed added entries in fstab when
`cloud-init clean -c fstab` is used.
"""
fstab_original_content = (
"UUID=abc123 / ext4 defaults 0 0\n"
"/workspace /mnt "
"auto defaults,nofail,x-systemd.after="
"cloud-init.service,_netdev,comment=cloudconfig 0 2\n"
)
fstab_expected_content = "UUID=abc123 / ext4 defaults 0 0\n"
etc_path = "/etc"
if not os.path.exists(etc_path):
os.makedirs(etc_path)
fstab_path = cc_mounts.FSTAB_PATH
with open(fstab_path, "w") as fd:
fd.write(fstab_original_content)
clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["fstab"],
)
with open(fstab_path, "r") as fd:
fstab_new_content = fd.read()
assert fstab_expected_content == fstab_new_content
@pytest.mark.usefixtures("fake_filesystem")
def test_clean_fstab_for_all(self, clean_paths, init_class):
"""remove_config removed added entries in fstab when
`cloud-init clean -c all` is used.
"""
fstab_original_content = (
"UUID=abc123 / ext4 defaults 0 0\n"
"/workspace /mnt "
"auto defaults,nofail,x-systemd.after="
"cloud-init.service,_netdev,comment=cloudconfig 0 2\n"
)
fstab_expected_content = "UUID=abc123 / ext4 defaults 0 0\n"
TEST_GEN_SSH_CONFIG_FILES = [
clean_paths.tmpdir.join(conf_file)
for conf_file in clean.GEN_SSH_CONFIG_FILES
]
etc_path = "/etc"
if not os.path.exists(etc_path):
os.makedirs(etc_path)
fstab_path = cc_mounts.FSTAB_PATH
with open(fstab_path, "w") as fd:
fd.write(fstab_original_content)
with mock.patch(
"cloudinit.cmd.clean.GEN_SSH_CONFIG_FILES",
TEST_GEN_SSH_CONFIG_FILES,
):
clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["all"],
)
with open(fstab_path, "r") as fd:
fstab_new_content = fd.read()
assert fstab_expected_content == fstab_new_content
def test_clean_datasource_conf_without_cache(
self, clean_paths, init_class
):
"""remove_config does not remove datasource files when cache
is not present.
"""
ds_conf = clean_paths.tmpdir.join("/var/run/ds")
assert ds_conf.exists() is False, f"Unexpected {ds_conf}"
ensure_dir(os.path.dirname(ds_conf))
ds_conf.write("#generated by generic DataSource\nfoobar\n")
assert ds_conf.exists() is True, "{ds_conf} not written!"
assert (
clean_paths.cloud_dir.exists() is False
), "unexpected cloud_dir present!"
def ds_clean():
print("deleting {ds_conf}")
del_file(ds_conf)
ds = mock.Mock(spec=DataSource)
ds.clean = ds_clean
def ds_fetch():
return ds
init_class.fetch = ds_fetch
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["datasource"],
)
assert ds_conf.exists() is True, f"file {ds_conf} was removed!"
assert 0 == retcode
def test_clean_datasource_conf_with_cache(self, clean_paths, init_class):
"""remove_config removes datasource files when cache
is present.
"""
ensure_dir(clean_paths.cloud_dir)
ds_conf = clean_paths.tmpdir.join("/var/run/ds")
assert ds_conf.exists() is False, f"Unexpected {ds_conf}"
ensure_dir(os.path.dirname(ds_conf))
ds_conf.write("#generated by generic DataSource\nfoobar\n")
assert ds_conf.exists() is True, "{ds_conf} not written!"
cache = clean_paths.cloud_dir.join("instance")
assert cache.exists() is False, f"unexpected {cache} present!"
ensure_dir(cache)
assert cache.exists() is True, "{cache} not created!"
def ds_clean():
print("deleting {ds_conf}")
del_file(ds_conf)
ds = mock.Mock(spec=DataSource)
ds.clean = ds_clean
def ds_fetch():
return ds
init_class.fetch = ds_fetch
with mock.patch(
"cloudinit.cmd.clean.settings.CLEAN_RUNPARTS_DIR", os.devnull
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_config=["datasource"],
)
assert ds_conf.exists() is False, f"Unexpected file {ds_conf}"
assert 0 == retcode
@pytest.mark.allow_all_subp
def test_remove_artifacts_runparts_clean_d(self, clean_paths, init_class):
"""remove_artifacts performs runparts on CLEAN_RUNPARTS_DIR"""
ensure_dir(clean_paths.cloud_dir)
artifact_file = clean_paths.tmpdir.join("didit")
ensure_dir(clean_paths.clean_dir)
assert artifact_file.exists() is False, f"Unexpected {artifact_file}"
clean_script = clean_paths.clean_dir.join("1.sh")
clean_script.write(f"#!/bin/sh\ntouch {artifact_file}\n")
clean_script.chmod(mode=0o755)
with mock.patch.object(
cloudinit.settings, "CLEAN_RUNPARTS_DIR", clean_paths.clean_dir
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
)
assert (
artifact_file.exists() is True
), f"Missing expected {artifact_file}"
assert 0 == retcode
def test_remove_artifacts_preserves_logs(self, clean_paths, init_class):
"""remove_artifacts leaves logs when remove_logs is False."""
clean_paths.log.write("cloud-init-log")
clean_paths.output_log.write("cloud-init-output-log")
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
)
assert 0 == retcode
assert (
clean_paths.log.exists() is True
), f"Missing expected file {clean_paths.log}"
assert (
clean_paths.output_log.exists()
), f"Missing expected file {clean_paths.output_log}"
def test_remove_artifacts_removes_unlinks_symlinks(
self, clean_paths, init_class
):
"""remove_artifacts cleans artifacts dir unlinking any symlinks."""
dir1 = clean_paths.cloud_dir.join("dir1")
ensure_dir(dir1)
symlink = clean_paths.cloud_dir.join("mylink")
sym_link(dir1.strpath, symlink.strpath)
with mock.patch.object(
cloudinit.settings, "CLEAN_RUNPARTS_DIR", clean_paths.clean_dir
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
)
assert 0 == retcode
for path in (dir1, symlink):
assert path.exists() is False, f"Unexpected {path} found"
def test_remove_artifacts_removes_artifacts_skipping_seed(
self, clean_paths, init_class
):
"""remove_artifacts cleans artifacts dir with exception of seed dir."""
dirs = [
clean_paths.cloud_dir,
clean_paths.cloud_dir.join("seed"),
clean_paths.cloud_dir.join("dir1"),
clean_paths.cloud_dir.join("dir2"),
]
for _dir in dirs:
ensure_dir(_dir)
with mock.patch.object(
cloudinit.settings, "CLEAN_RUNPARTS_DIR", clean_paths.clean_dir
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
)
assert 0 == retcode
for expected_dir in dirs[:2]:
assert expected_dir.exists() is True, f"Missing {expected_dir}"
for deleted_dir in dirs[2:]:
assert deleted_dir.exists() is False, f"Unexpected {deleted_dir}"
def test_remove_artifacts_removes_artifacts_removes_seed(
self, clean_paths, init_class
):
"""remove_artifacts removes seed dir when remove_seed is True."""
dirs = [
clean_paths.cloud_dir,
clean_paths.cloud_dir.join("seed"),
clean_paths.cloud_dir.join("dir1"),
clean_paths.cloud_dir.join("dir2"),
]
for _dir in dirs:
ensure_dir(_dir)
with mock.patch.object(
cloudinit.settings, "CLEAN_RUNPARTS_DIR", clean_paths.clean_dir
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
remove_seed=True,
)
assert 0 == retcode
assert (
clean_paths.cloud_dir.exists() is True
), f"Missing dir {clean_paths.cloud_dir}"
for deleted_dir in dirs[1:]:
assert (
deleted_dir.exists() is False
), f"Unexpected {deleted_dir} dir"
def test_remove_artifacts_returns_one_on_errors(
self, clean_paths, init_class, capsys
):
"""remove_artifacts returns non-zero on failure and prints an error."""
ensure_dir(clean_paths.cloud_dir)
ensure_dir(clean_paths.cloud_dir.join("dir1"))
with mock.patch(
"cloudinit.cmd.clean.del_dir", side_effect=OSError("oops")
):
retcode = clean.remove_artifacts(
init_class,
remove_logs=False,
)
assert 1 == retcode
_out, err = capsys.readouterr()
assert (
f"Error:\nCould not remove {clean_paths.cloud_dir}/dir1: oops\n"
== err
)
def test_handle_clean_args_reboots(self, init_class):
"""handle_clean_args_reboots when reboot arg is provided."""
called_cmds = []
def fake_subp(cmd, capture):
called_cmds.append(cmd)
return "", ""
myargs = namedtuple(
"myargs", "remove_logs remove_seed remove_config reboot machine_id"
)
cmdargs = myargs(
remove_logs=False,
remove_seed=False,
remove_config=[],
reboot=True,
machine_id=False,
)
retcode = wrap_and_call(
"cloudinit.cmd.clean",
{
"subp": {"side_effect": fake_subp},
"Init": {"return_value": init_class},
},
clean.handle_clean_args,
name="does not matter",
args=cmdargs,
)
assert 0 == retcode
assert [["shutdown", "-r", "now"]] == called_cmds
@pytest.mark.parametrize(
"machine_id,systemd_val",
(
pytest.param(True, True, id="machine_id_on_systemd_uninitialized"),
pytest.param(
True, False, id="machine_id_non_systemd_removes_file"
),
pytest.param(False, False, id="no_machine_id_param_file_remains"),
),
)
@mock.patch("cloudinit.cmd.clean.uses_systemd")
def test_handle_clean_args_removed_machine_id(
self, uses_systemd, machine_id, systemd_val, clean_paths, init_class
):
"""handle_clean_args removes /etc/machine-id when arg is True."""
uses_systemd.return_value = systemd_val
myargs = namedtuple(
"myargs", "remove_logs remove_seed remove_config reboot machine_id"
)
cmdargs = myargs(
remove_logs=False,
remove_seed=False,
remove_config=[],
reboot=False,
machine_id=machine_id,
)
machine_id_path = clean_paths.tmpdir.join("machine-id")
machine_id_path.write("SOME-AMAZN-MACHINE-ID")
with mock.patch.object(
cloudinit.settings, "CLEAN_RUNPARTS_DIR", clean_paths.clean_dir
):
with mock.patch.object(
cloudinit.cmd.clean, "ETC_MACHINE_ID", machine_id_path.strpath
):
with mock.patch(
"cloudinit.cmd.clean.Init", return_value=init_class
):
assert 0 == clean.handle_clean_args(
name="does not matter",
args=cmdargs,
)
if systemd_val:
if machine_id:
assert "uninitialized\n" == machine_id_path.read()
else:
assert "SOME-AMAZN-MACHINE-ID" == machine_id_path.read()
else:
assert machine_id_path.exists() is bool(not machine_id)
def test_status_main(self, clean_paths, init_class):
"""clean.main can be run as a standalone script."""
clean_paths.log.write("cloud-init-log")
with pytest.raises(SystemExit) as context_manager:
wrap_and_call(
"cloudinit.cmd.clean",
{
"Init": {"return_value": init_class},
"sys.argv": {"new": ["clean", "--logs"]},
},
clean.main,
)
assert 0 == context_manager.value.code
assert (
clean_paths.log.exists() is False
), f"Unexpected log {clean_paths.log}"
|
