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
|
# This file is part of cloud-init. See LICENSE file for license information.
import os
import re
import shutil
import tempfile
from functools import partial
from typing import Optional
import pytest
from cloudinit import util
from cloudinit.config.cc_rsyslog import (
DEF_DIR,
DEF_FILENAME,
DEF_RELOAD,
apply_rsyslog_changes,
load_config,
parse_remotes_line,
remotes_to_rsyslog_cfg,
)
from cloudinit.config.schema import (
SchemaValidationError,
get_schema,
validate_cloudconfig_schema,
)
from tests.unittests.helpers import TestCase, skipUnlessJsonSchema
class TestLoadConfig(TestCase):
def setUp(self):
super(TestLoadConfig, self).setUp()
self.basecfg = {
"config_filename": DEF_FILENAME,
"config_dir": DEF_DIR,
"service_reload_command": DEF_RELOAD,
"configs": [],
"remotes": {},
}
def test_legacy_full(self):
found = load_config(
{
"rsyslog": ["*.* @192.168.1.1"],
"rsyslog_dir": "mydir",
"rsyslog_filename": "myfilename",
}
)
self.basecfg.update(
{
"configs": ["*.* @192.168.1.1"],
"config_dir": "mydir",
"config_filename": "myfilename",
"service_reload_command": "auto",
}
)
self.assertEqual(found, self.basecfg)
def test_legacy_defaults(self):
found = load_config({"rsyslog": ["*.* @192.168.1.1"]})
self.basecfg.update({"configs": ["*.* @192.168.1.1"]})
self.assertEqual(found, self.basecfg)
def test_new_defaults(self):
self.assertEqual(load_config({}), self.basecfg)
def test_new_configs(self):
cfgs = ["*.* myhost", "*.* my2host"]
self.basecfg.update({"configs": cfgs})
self.assertEqual(
load_config({"rsyslog": {"configs": cfgs}}), self.basecfg
)
class TestApplyChanges(TestCase):
def setUp(self):
self.tmp = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.tmp)
def test_simple(self):
cfgline = "*.* foohost"
changed = apply_rsyslog_changes(
configs=[cfgline], def_fname="foo.cfg", cfg_dir=self.tmp
)
fname = os.path.join(self.tmp, "foo.cfg")
self.assertEqual([fname], changed)
self.assertEqual(util.load_file(fname), cfgline + "\n")
def test_multiple_files(self):
configs = [
"*.* foohost",
{"content": "abc", "filename": "my.cfg"},
{
"content": "filefoo-content",
"filename": os.path.join(self.tmp, "mydir/mycfg"),
},
]
changed = apply_rsyslog_changes(
configs=configs, def_fname="default.cfg", cfg_dir=self.tmp
)
expected = [
(os.path.join(self.tmp, "default.cfg"), "*.* foohost\n"),
(os.path.join(self.tmp, "my.cfg"), "abc\n"),
(os.path.join(self.tmp, "mydir/mycfg"), "filefoo-content\n"),
]
self.assertEqual([f[0] for f in expected], changed)
actual = []
for fname, _content in expected:
util.load_file(fname)
actual.append(
(
fname,
util.load_file(fname),
)
)
self.assertEqual(expected, actual)
def test_repeat_def(self):
configs = ["*.* foohost", "*.warn otherhost"]
changed = apply_rsyslog_changes(
configs=configs, def_fname="default.cfg", cfg_dir=self.tmp
)
fname = os.path.join(self.tmp, "default.cfg")
self.assertEqual([fname], changed)
expected_content = "\n".join([c for c in configs]) + "\n"
found_content = util.load_file(fname)
self.assertEqual(expected_content, found_content)
def test_multiline_content(self):
configs = ["line1", "line2\nline3\n"]
apply_rsyslog_changes(
configs=configs, def_fname="default.cfg", cfg_dir=self.tmp
)
fname = os.path.join(self.tmp, "default.cfg")
expected_content = "\n".join([c for c in configs])
found_content = util.load_file(fname)
self.assertEqual(expected_content, found_content)
class TestParseRemotesLine(TestCase):
def test_valid_port(self):
r = parse_remotes_line("foo:9")
self.assertEqual(9, r.port)
def test_invalid_port(self):
with self.assertRaises(ValueError):
parse_remotes_line("*.* foo:abc")
def test_valid_ipv6(self):
r = parse_remotes_line("*.* [::1]")
self.assertEqual("*.* @[::1]", str(r))
def test_valid_ipv6_with_port(self):
r = parse_remotes_line("*.* [::1]:100")
self.assertEqual(r.port, 100)
self.assertEqual(r.addr, "::1")
self.assertEqual("*.* @[::1]:100", str(r))
def test_invalid_multiple_colon(self):
with self.assertRaises(ValueError):
parse_remotes_line("*.* ::1:100")
def test_name_in_string(self):
r = parse_remotes_line("syslog.host", name="foobar")
self.assertEqual("*.* @syslog.host # foobar", str(r))
class TestRemotesToSyslog(TestCase):
def test_simple(self):
# str rendered line must appear in remotes_to_ryslog_cfg return
mycfg = "*.* myhost"
myline = str(parse_remotes_line(mycfg, name="myname"))
r = remotes_to_rsyslog_cfg({"myname": mycfg})
lines = r.splitlines()
self.assertEqual(1, len(lines))
self.assertTrue(myline in r.splitlines())
def test_header_footer(self):
header = "#foo head"
footer = "#foo foot"
r = remotes_to_rsyslog_cfg(
{"myname": "*.* myhost"}, header=header, footer=footer
)
lines = r.splitlines()
self.assertTrue(header, lines[0])
self.assertTrue(footer, lines[-1])
def test_with_empty_or_null(self):
mycfg = "*.* myhost"
myline = str(parse_remotes_line(mycfg, name="myname"))
r = remotes_to_rsyslog_cfg(
{"myname": mycfg, "removed": None, "removed2": ""}
)
lines = r.splitlines()
self.assertEqual(1, len(lines))
self.assertTrue(myline in r.splitlines())
class TestRsyslogSchema:
@pytest.mark.parametrize(
"config, error_msg",
[
({"rsyslog": {"remotes": {"any": "string"}}}, None),
(
{"rsyslog": {"unknown": "a"}},
"Additional properties are not allowed",
),
({"rsyslog": {"configs": [{"filename": "a"}]}}, ""),
(
{
"rsyslog": {
"configs": [
{"filename": "a", "content": "a", "a": "a"}
]
}
},
"",
),
(
{"rsyslog": {"remotes": ["a"]}},
r"\['a'\] is not of type 'object'",
),
({"rsyslog": {"remotes": "a"}}, "'a' is not of type 'object"),
({"rsyslog": {"service_reload_command": "a"}}, ""),
],
)
@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)
class TestInvalidKeyType:
@pytest.mark.parametrize(
"config, error_msg",
[
(
{"rsyslog": {"configs": 1}},
(
"Invalid type for key `configs`. Expected type(s): "
"<class 'list'>. Current type: <class 'int'>"
),
),
(
{"rsyslog": {"configs": [], "config_dir": 1}},
(
"Invalid type for key `config_dir`. Expected type(s): "
"<class 'str'>. Current type: <class 'int'>"
),
),
(
{"rsyslog": {"configs": [], "config_filename": True}},
(
"Invalid type for key `config_filename`. Expected type(s):"
" <class 'str'>. Current type: <class 'bool'>"
),
),
(
{"rsyslog": {"service_reload_command": 3.14}},
(
"Invalid type for key `service_reload_command`. "
"Expected type(s): (<class 'str'>, <class 'list'>). "
"Current type: <class 'float'>"
),
),
(
{"rsyslog": {"remotes": ["1", 2, 3.14]}},
(
"Invalid type for key `remotes`. Expected type(s): "
"<class 'dict'>. Current type: <class 'list'>"
),
),
],
)
def test_invalid_key_types(self, config: dict, error_msg: Optional[str]):
callable_ = partial(load_config, config)
if error_msg is None:
callable_()
else:
with pytest.raises(ValueError, match=re.escape(error_msg)):
callable_()
# vi: ts=4 expandtab
|
