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
|
# This file is part of cloud-init. See LICENSE file for license information.
import os
from datetime import datetime
from io import StringIO
from cloudinit.cmd.devel import logs
from cloudinit.sources import INSTANCE_JSON_SENSITIVE_FILE
from cloudinit.subp import subp
from cloudinit.util import ensure_dir, load_file, write_file
from tests.unittests.helpers import (
FilesystemMockingTestCase,
mock,
wrap_and_call,
)
@mock.patch("cloudinit.cmd.devel.logs.os.getuid")
class TestCollectLogs(FilesystemMockingTestCase):
def setUp(self):
super(TestCollectLogs, self).setUp()
self.new_root = self.tmp_dir()
self.run_dir = self.tmp_path("run", self.new_root)
def test_collect_logs_with_userdata_requires_root_user(self, m_getuid):
"""collect-logs errors when non-root user collects userdata ."""
m_getuid.return_value = 100 # non-root
output_tarfile = self.tmp_path("logs.tgz")
with mock.patch("sys.stderr", new_callable=StringIO) as m_stderr:
self.assertEqual(
1, logs.collect_logs(output_tarfile, include_userdata=True)
)
self.assertEqual(
"To include userdata, root user is required."
" Try sudo cloud-init collect-logs\n",
m_stderr.getvalue(),
)
def test_collect_logs_creates_tarfile(self, m_getuid):
"""collect-logs creates a tarfile with all related cloud-init info."""
m_getuid.return_value = 100
log1 = self.tmp_path("cloud-init.log", self.new_root)
write_file(log1, "cloud-init-log")
log2 = self.tmp_path("cloud-init-output.log", self.new_root)
write_file(log2, "cloud-init-output-log")
ensure_dir(self.run_dir)
write_file(self.tmp_path("results.json", self.run_dir), "results")
write_file(
self.tmp_path(INSTANCE_JSON_SENSITIVE_FILE, self.run_dir),
"sensitive",
)
output_tarfile = self.tmp_path("logs.tgz")
date = datetime.utcnow().date().strftime("%Y-%m-%d")
date_logdir = "cloud-init-logs-{0}".format(date)
version_out = "/usr/bin/cloud-init 18.2fake\n"
expected_subp = {
(
"dpkg-query",
"--show",
"-f=${Version}\n",
"cloud-init",
): "0.7fake\n",
("cloud-init", "--version"): version_out,
("dmesg",): "dmesg-out\n",
("journalctl", "--boot=0", "-o", "short-precise"): "journal-out\n",
("tar", "czvf", output_tarfile, date_logdir): "",
}
def fake_subp(cmd):
cmd_tuple = tuple(cmd)
if cmd_tuple not in expected_subp:
raise AssertionError(
"Unexpected command provided to subp: {0}".format(cmd)
)
if cmd == ["tar", "czvf", output_tarfile, date_logdir]:
subp(cmd) # Pass through tar cmd so we can check output
return expected_subp[cmd_tuple], ""
fake_stderr = mock.MagicMock()
wrap_and_call(
"cloudinit.cmd.devel.logs",
{
"subp": {"side_effect": fake_subp},
"sys.stderr": {"new": fake_stderr},
"CLOUDINIT_LOGS": {"new": [log1, log2]},
"CLOUDINIT_RUN_DIR": {"new": self.run_dir},
},
logs.collect_logs,
output_tarfile,
include_userdata=False,
)
# unpack the tarfile and check file contents
subp(["tar", "zxvf", output_tarfile, "-C", self.new_root])
out_logdir = self.tmp_path(date_logdir, self.new_root)
self.assertFalse(
os.path.exists(
os.path.join(
out_logdir,
"run",
"cloud-init",
INSTANCE_JSON_SENSITIVE_FILE,
)
),
"Unexpected file found: %s" % INSTANCE_JSON_SENSITIVE_FILE,
)
self.assertEqual(
"0.7fake\n", load_file(os.path.join(out_logdir, "dpkg-version"))
)
self.assertEqual(
version_out, load_file(os.path.join(out_logdir, "version"))
)
self.assertEqual(
"cloud-init-log",
load_file(os.path.join(out_logdir, "cloud-init.log")),
)
self.assertEqual(
"cloud-init-output-log",
load_file(os.path.join(out_logdir, "cloud-init-output.log")),
)
self.assertEqual(
"dmesg-out\n", load_file(os.path.join(out_logdir, "dmesg.txt"))
)
self.assertEqual(
"journal-out\n", load_file(os.path.join(out_logdir, "journal.txt"))
)
self.assertEqual(
"results",
load_file(
os.path.join(out_logdir, "run", "cloud-init", "results.json")
),
)
fake_stderr.write.assert_any_call("Wrote %s\n" % output_tarfile)
def test_collect_logs_includes_optional_userdata(self, m_getuid):
"""collect-logs include userdata when --include-userdata is set."""
m_getuid.return_value = 0
log1 = self.tmp_path("cloud-init.log", self.new_root)
write_file(log1, "cloud-init-log")
log2 = self.tmp_path("cloud-init-output.log", self.new_root)
write_file(log2, "cloud-init-output-log")
userdata = self.tmp_path("user-data.txt", self.new_root)
write_file(userdata, "user-data")
ensure_dir(self.run_dir)
write_file(self.tmp_path("results.json", self.run_dir), "results")
write_file(
self.tmp_path(INSTANCE_JSON_SENSITIVE_FILE, self.run_dir),
"sensitive",
)
output_tarfile = self.tmp_path("logs.tgz")
date = datetime.utcnow().date().strftime("%Y-%m-%d")
date_logdir = "cloud-init-logs-{0}".format(date)
version_out = "/usr/bin/cloud-init 18.2fake\n"
expected_subp = {
(
"dpkg-query",
"--show",
"-f=${Version}\n",
"cloud-init",
): "0.7fake",
("cloud-init", "--version"): version_out,
("dmesg",): "dmesg-out\n",
("journalctl", "--boot=0", "-o", "short-precise"): "journal-out\n",
("tar", "czvf", output_tarfile, date_logdir): "",
}
def fake_subp(cmd):
cmd_tuple = tuple(cmd)
if cmd_tuple not in expected_subp:
raise AssertionError(
"Unexpected command provided to subp: {0}".format(cmd)
)
if cmd == ["tar", "czvf", output_tarfile, date_logdir]:
subp(cmd) # Pass through tar cmd so we can check output
return expected_subp[cmd_tuple], ""
fake_stderr = mock.MagicMock()
wrap_and_call(
"cloudinit.cmd.devel.logs",
{
"subp": {"side_effect": fake_subp},
"sys.stderr": {"new": fake_stderr},
"CLOUDINIT_LOGS": {"new": [log1, log2]},
"CLOUDINIT_RUN_DIR": {"new": self.run_dir},
"USER_DATA_FILE": {"new": userdata},
},
logs.collect_logs,
output_tarfile,
include_userdata=True,
)
# unpack the tarfile and check file contents
subp(["tar", "zxvf", output_tarfile, "-C", self.new_root])
out_logdir = self.tmp_path(date_logdir, self.new_root)
self.assertEqual(
"user-data", load_file(os.path.join(out_logdir, "user-data.txt"))
)
self.assertEqual(
"sensitive",
load_file(
os.path.join(
out_logdir,
"run",
"cloud-init",
INSTANCE_JSON_SENSITIVE_FILE,
)
),
)
fake_stderr.write.assert_any_call("Wrote %s\n" % output_tarfile)
|
