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
|
# This file is part of cloud-init. See LICENSE file for license information.
import logging
import os
import shutil
import tempfile
from copy import deepcopy
from unittest import mock
import pytest
from cloudinit import cloud, distros, helpers, util
from cloudinit.config import cc_resolv_conf
from cloudinit.config.cc_resolv_conf import generate_resolv_conf
from cloudinit.config.schema import (
SchemaValidationError,
get_schema,
validate_cloudconfig_schema,
)
from tests.unittests.helpers import (
FilesystemMockingTestCase,
cloud_init_project_dir,
skipUnlessJsonSchema,
)
from tests.unittests.util import MockDistro
LOG = logging.getLogger(__name__)
EXPECTED_HEADER = """\
# Your system has been configured with 'manage-resolv-conf' set to true.
# As a result, cloud-init has written this file with configuration data
# that it has been provided. Cloud-init, by default, will write this file
# a single time (PER_ONCE).
#\n\n"""
class TestResolvConf(FilesystemMockingTestCase):
with_logs = True
cfg = {"manage_resolv_conf": True, "resolv_conf": {}}
def setUp(self):
super(TestResolvConf, self).setUp()
self.tmp = tempfile.mkdtemp()
util.ensure_dir(os.path.join(self.tmp, "data"))
self.addCleanup(shutil.rmtree, self.tmp)
def _fetch_distro(self, kind, conf=None):
cls = distros.fetch(kind)
paths = helpers.Paths({"cloud_dir": self.tmp})
conf = {} if conf is None else conf
return cls(kind, conf, paths)
def call_resolv_conf_handler(self, distro_name, conf, cc=None):
if not cc:
ds = None
distro = self._fetch_distro(distro_name, conf)
paths = helpers.Paths({"cloud_dir": self.tmp})
cc = cloud.Cloud(ds, paths, {}, distro, None)
cc_resolv_conf.handle("cc_resolv_conf", conf, cc, [])
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_resolv_conf_systemd_resolved(self, m_render_to_file):
self.call_resolv_conf_handler("photon", self.cfg)
assert [
mock.call(mock.ANY, "/etc/systemd/resolved.conf", mock.ANY)
] == m_render_to_file.call_args_list
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_resolv_conf_no_param(self, m_render_to_file):
tmp = deepcopy(self.cfg)
self.logs.truncate(0)
tmp.pop("resolv_conf")
self.call_resolv_conf_handler("photon", tmp)
self.assertIn(
"manage_resolv_conf True but no parameters provided",
self.logs.getvalue(),
)
assert [
mock.call(mock.ANY, "/etc/systemd/resolved.conf", mock.ANY)
] not in m_render_to_file.call_args_list
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_resolv_conf_manage_resolv_conf_false(self, m_render_to_file):
tmp = deepcopy(self.cfg)
self.logs.truncate(0)
tmp["manage_resolv_conf"] = False
self.call_resolv_conf_handler("photon", tmp)
self.assertIn(
"'manage_resolv_conf' present but set to False",
self.logs.getvalue(),
)
assert [
mock.call(mock.ANY, "/etc/systemd/resolved.conf", mock.ANY)
] not in m_render_to_file.call_args_list
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_resolv_conf_etc_resolv_conf(self, m_render_to_file):
self.call_resolv_conf_handler("rhel", self.cfg)
assert [
mock.call(mock.ANY, "/etc/resolv.conf", mock.ANY)
] == m_render_to_file.call_args_list
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_resolv_conf_invalid_resolve_conf_fn(self, m_render_to_file):
ds = None
distro = self._fetch_distro("rhel", self.cfg)
paths = helpers.Paths({"cloud_dir": self.tmp})
cc = cloud.Cloud(ds, paths, {}, distro, None)
cc.distro.resolve_conf_fn = "bla"
self.logs.truncate(0)
self.call_resolv_conf_handler("rhel", self.cfg, cc)
self.assertIn(
"No template found, not rendering resolve configs",
self.logs.getvalue(),
)
assert [
mock.call(mock.ANY, "/etc/resolv.conf", mock.ANY)
] not in m_render_to_file.call_args_list
class TestGenerateResolvConf:
dist = MockDistro()
tmpl_fn = cloud_init_project_dir("templates/resolv.conf.tmpl")
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_dist_resolv_conf_fn(self, m_render_to_file):
self.dist.resolve_conf_fn = "/tmp/resolv-test.conf"
generate_resolv_conf(
self.tmpl_fn, mock.MagicMock(), self.dist.resolve_conf_fn
)
assert [
mock.call(mock.ANY, self.dist.resolve_conf_fn, mock.ANY)
] == m_render_to_file.call_args_list
@mock.patch("cloudinit.config.cc_resolv_conf.templater.render_to_file")
def test_target_fname_is_used_if_passed(self, m_render_to_file):
path = "/use/this/path"
generate_resolv_conf(self.tmpl_fn, mock.MagicMock(), path)
assert [
mock.call(mock.ANY, path, mock.ANY)
] == m_render_to_file.call_args_list
# Patch in templater so we can assert on the actual generated content
@mock.patch("cloudinit.templater.util.write_file")
# Parameterise with the value to be passed to generate_resolv_conf as the
# params parameter, and the expected line after the header as
# expected_extra_line.
@pytest.mark.parametrize(
"params,expected_extra_line",
[
# No options
({}, None),
# Just a true flag
({"options": {"foo": True}}, "options foo"),
# Just a false flag
({"options": {"foo": False}}, None),
# Just an option
({"options": {"foo": "some_value"}}, "options foo:some_value"),
# A true flag and an option
(
{"options": {"foo": "some_value", "bar": True}},
"options bar foo:some_value",
),
# Two options
(
{"options": {"foo": "some_value", "bar": "other_value"}},
"options bar:other_value foo:some_value",
),
# Everything
(
{
"options": {
"foo": "some_value",
"bar": "other_value",
"baz": False,
"spam": True,
}
},
"options spam bar:other_value foo:some_value",
),
],
)
def test_flags_and_options(
self, m_write_file, params, expected_extra_line
):
target_fn = "/etc/resolv.conf"
generate_resolv_conf(self.tmpl_fn, params, target_fn)
expected_content = EXPECTED_HEADER
if expected_extra_line is not None:
# If we have any extra lines, expect a trailing newline
expected_content += "\n".join([expected_extra_line, ""])
assert [
mock.call(mock.ANY, expected_content, mode=mock.ANY)
] == m_write_file.call_args_list
class TestResolvConfSchema:
@pytest.mark.parametrize(
"config, error_msg",
[
# Valid
({"manage_resolv_conf": False}, None),
({"resolv_conf": {"options": {"any": "thing"}}}, None),
# Invalid
(
{"manage_resolv_conf": "asdf"},
"'asdf' is not of type 'boolean'",
),
# What may be some common misunderstandings of the template
(
{"resolv_conf": {"nameserver": ["1.1.1.1"]}},
"Additional properties are not allowed",
),
(
{"resolv_conf": {"nameservers": "1.1.1.1"}},
"'1.1.1.1' is not of type 'array'",
),
(
{"resolv_conf": {"search": ["foo.com"]}},
"Additional properties are not allowed",
),
(
{"resolv_conf": {"searchdomains": "foo.com"}},
"'foo.com' is not of type 'array'",
),
(
{"resolv_conf": {"domain": ["foo.com"]}},
r"\['foo.com'\] is not of type 'string'",
),
(
{"resolv_conf": {"sortlist": "1.2.3.4"}},
"'1.2.3.4' is not of type 'array'",
),
(
{"resolv_conf": {"options": "timeout: 1"}},
"'timeout: 1' is not of type 'object'",
),
(
{"resolv_conf": {"options": "rotate"}},
"'rotate' is not of type 'object'",
),
(
{"resolv_conf": {"options": ["rotate"]}},
r"\['rotate'\] is not of type 'object'",
),
],
)
@skipUnlessJsonSchema()
def test_schema_validation(self, config, error_msg):
if error_msg is None:
validate_cloudconfig_schema(config, get_schema(), strict=True)
else:
with pytest.raises(SchemaValidationError, match=error_msg):
validate_cloudconfig_schema(config, get_schema(), strict=True)
# vi: ts=4 expandtab
|
