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
|
# This file is part of cloud-init. See LICENSE file for license information.
from logging import Logger
from unittest import mock
import pytest
from cloudinit.config.cc_grub_dpkg import fetch_idevs, handle
from cloudinit.config.schema import (
SchemaValidationError,
get_schema,
validate_cloudconfig_schema,
)
from cloudinit.subp import ProcessExecutionError, SubpResult
from tests.unittests.helpers import does_not_raise, skipUnlessJsonSchema
class TestFetchIdevs:
"""Tests cc_grub_dpkg.fetch_idevs()"""
# Note: udevadm info returns devices in a large single line string
@pytest.mark.parametrize(
"grub_output,path_exists,expected_log_call,udevadm_output"
",expected_idevs,is_efi_boot",
[
# Inside a container, grub not installed
(
ProcessExecutionError(reason=FileNotFoundError()),
False,
mock.call("'grub-probe' not found in $PATH"),
"",
"",
False,
),
# Inside a container, grub installed
(
ProcessExecutionError(stderr="failed to get canonical path"),
False,
mock.call("grub-probe 'failed to get canonical path'"),
"",
"",
False,
),
# KVM Instance
(
SubpResult("/dev/vda", ""),
True,
None,
(
"/dev/disk/by-path/pci-0000:00:00.0 ",
"/dev/disk/by-path/virtio-pci-0000:00:00.0 ",
),
"/dev/vda",
False,
),
# Xen Instance
(
SubpResult("/dev/xvda", ""),
True,
None,
"",
"/dev/xvda",
False,
),
# NVMe Hardware Instance
(
SubpResult("/dev/nvme1n1", ""),
True,
None,
(
"/dev/disk/by-id/nvme-Company_hash000 ",
"/dev/disk/by-id/nvme-nvme.000-000-000-000-000 ",
"/dev/disk/by-path/pci-0000:00:00.0-nvme-0 ",
),
"/dev/disk/by-id/nvme-Company_hash000",
False,
),
# SCSI Hardware Instance
(
SubpResult("/dev/sda", ""),
True,
None,
(
"/dev/disk/by-id/company-user-1 ",
"/dev/disk/by-id/scsi-0Company_user-1 ",
"/dev/disk/by-path/pci-0000:00:00.0-scsi-0:0:0:0 ",
),
"/dev/disk/by-id/company-user-1",
False,
),
# UEFI Hardware Instance
(
SubpResult("/dev/sda2", ""),
True,
None,
(
"/dev/disk/by-id/scsi-3500a075116e6875a "
"/dev/disk/by-id/scsi-SATA_Crucial_CT525MX3_171816E6875A "
"/dev/disk/by-id/scsi-0ATA_Crucial_CT525MX3_171816E6875A "
"/dev/disk/by-path/pci-0000:00:17.0-ata-1 "
"/dev/disk/by-id/wwn-0x500a075116e6875a "
"/dev/disk/by-id/ata-Crucial_CT525MX300SSD1_171816E6875A"
),
"/dev/disk/by-id/ata-Crucial_CT525MX300SSD1_171816E6875A-"
"part1",
True,
),
],
)
@mock.patch("cloudinit.config.cc_grub_dpkg.is_efi_booted")
@mock.patch("cloudinit.config.cc_grub_dpkg.util.logexc")
@mock.patch("cloudinit.config.cc_grub_dpkg.os.path.exists")
@mock.patch("cloudinit.config.cc_grub_dpkg.subp.subp")
def test_fetch_idevs(
self,
m_subp,
m_exists,
m_logexc,
m_efi_booted,
grub_output,
path_exists,
expected_log_call,
udevadm_output,
expected_idevs,
is_efi_boot,
):
"""Tests outputs from grub-probe and udevadm info against grub_dpkg"""
m_subp.side_effect = [
grub_output,
SubpResult("".join(udevadm_output), ""),
]
m_exists.return_value = path_exists
m_efi_booted.return_value = is_efi_boot
log = mock.Mock(spec=Logger)
idevs = fetch_idevs(log)
if is_efi_boot:
assert expected_idevs.startswith(idevs) is True
else:
assert idevs == expected_idevs
if expected_log_call is not None:
assert expected_log_call in log.debug.call_args_list
class TestHandle:
"""Tests cc_grub_dpkg.handle()"""
@pytest.mark.parametrize(
"cfg_idevs,cfg_idevs_empty,fetch_idevs_output,"
"expected_log_output,is_uefi",
[
(
# No configuration
None,
None,
"/dev/disk/by-id/nvme-Company_hash000",
(
"Setting grub debconf-set-selections with ",
"'grub-pc grub-pc/install_devices string "
"/dev/disk/by-id/nvme-Company_hash000\n",
"grub-pc grub-pc/install_devices_empty boolean false\n'",
),
False,
),
(
# idevs set, idevs_empty unset
"/dev/sda",
None,
"/dev/sda",
(
"Setting grub debconf-set-selections with ",
"'grub-pc grub-pc/install_devices string /dev/sda\n",
"grub-pc grub-pc/install_devices_empty boolean false\n'",
),
False,
),
(
# idevs unset, idevs_empty set
None,
"true",
"/dev/xvda",
(
"Setting grub debconf-set-selections with ",
"'grub-pc grub-pc/install_devices string /dev/xvda\n",
"grub-pc grub-pc/install_devices_empty boolean true\n'",
),
False,
),
(
# idevs set, idevs_empty set
"/dev/vda",
False,
"/dev/disk/by-id/company-user-1",
(
"Setting grub debconf-set-selections with ",
"'grub-pc grub-pc/install_devices string /dev/vda\n",
"grub-pc grub-pc/install_devices_empty boolean false\n'",
),
False,
),
(
# idevs set, idevs_empty set
# Respect what the user defines, even if its logically wrong
"/dev/nvme0n1",
True,
"",
(
"Setting grub debconf-set-selections with ",
"'grub-pc grub-pc/install_devices string /dev/nvme0n1\n",
"grub-pc grub-pc/install_devices_empty boolean true\n'",
),
False,
),
(
# uefi active, idevs set
"/dev/sda1",
False,
"/dev/sda1",
(
"Setting grub debconf-set-selections with ",
"'grub-pc grub-efi/install_devices string /dev/sda1\n'",
),
True,
),
],
)
@mock.patch("cloudinit.config.cc_grub_dpkg.fetch_idevs")
@mock.patch("cloudinit.config.cc_grub_dpkg.util.logexc")
@mock.patch("cloudinit.config.cc_grub_dpkg.subp.subp")
@mock.patch("cloudinit.config.cc_grub_dpkg.is_efi_booted")
def test_handle(
self,
m_is_efi_booted,
m_subp,
m_logexc,
m_fetch_idevs,
cfg_idevs,
cfg_idevs_empty,
fetch_idevs_output,
expected_log_output,
is_uefi,
):
"""Test setting of correct debconf database entries"""
m_is_efi_booted.return_value = is_uefi
m_fetch_idevs.return_value = fetch_idevs_output
log = mock.Mock(spec=Logger)
cfg = {"grub_dpkg": {}}
if cfg_idevs is not None:
cfg["grub_dpkg"]["grub-pc/install_devices"] = cfg_idevs
if cfg_idevs_empty is not None:
cfg["grub_dpkg"]["grub-pc/install_devices_empty"] = cfg_idevs_empty
handle(mock.Mock(), cfg, mock.Mock(), log, mock.Mock())
log.debug.assert_called_with("".join(expected_log_output))
class TestGrubDpkgSchema:
@pytest.mark.parametrize(
"config, expectation, has_errors",
(
(
{"grub_dpkg": {"grub-pc/install_devices_empty": False}},
does_not_raise(),
None,
),
(
{"grub_dpkg": {"grub-pc/install_devices_empty": "off"}},
pytest.raises(
SchemaValidationError,
match=(
"Cloud config schema deprecations: "
"grub_dpkg.grub-pc/install_devices_empty: "
"Changed in version 22.3. Use a boolean value "
"instead."
),
),
False,
),
(
{"grub_dpkg": {"enabled": "yes"}},
pytest.raises(
SchemaValidationError,
match="'yes' is not of type 'boolean'",
),
True,
),
(
{"grub_dpkg": {"grub-pc/install_devices": ["/dev/sda"]}},
pytest.raises(
SchemaValidationError,
match=r"\['/dev/sda'\] is not of type 'string'",
),
True,
),
(
{"grub-dpkg": {"grub-pc/install_devices_empty": False}},
pytest.raises(
SchemaValidationError,
match=(
"Cloud config schema deprecations: grub-dpkg: An alias"
" for ``grub_dpkg`` Deprecated in version 22.2. Use "
"``grub_dpkg`` instead."
),
),
False,
),
),
)
@skipUnlessJsonSchema()
def test_schema_validation(self, config, expectation, has_errors):
"""Assert expected schema validation and error messages."""
schema = get_schema()
with expectation as exc_info:
validate_cloudconfig_schema(config, schema, strict=True)
if has_errors is not None:
assert has_errors == exc_info.value.has_errors()
|
