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
|
# This file is part of cloud-init. See LICENSE file for license information.
import logging
import pytest
from configobj import ConfigObj
from cloudinit import util
from cloudinit.config import cc_landscape
from cloudinit.config.schema import (
SchemaValidationError,
get_schema,
validate_cloudconfig_schema,
)
from tests.unittests.helpers import (
FilesystemMockingTestCase,
mock,
skipUnlessJsonSchema,
wrap_and_call,
)
from tests.unittests.util import get_cloud
LOG = logging.getLogger(__name__)
class TestLandscape(FilesystemMockingTestCase):
with_logs = True
def setUp(self):
super(TestLandscape, self).setUp()
self.new_root = self.tmp_dir()
self.conf = self.tmp_path("client.conf", self.new_root)
self.default_file = self.tmp_path("default_landscape", self.new_root)
self.patchUtils(self.new_root)
self.add_patch(
"cloudinit.distros.ubuntu.Distro.install_packages",
"m_install_packages",
)
def test_handler_skips_empty_landscape_cloudconfig(self):
"""Empty landscape cloud-config section does no work."""
mycloud = get_cloud("ubuntu")
mycloud.distro = mock.MagicMock()
cfg = {"landscape": {}}
cc_landscape.handle("notimportant", cfg, mycloud, None)
self.assertFalse(mycloud.distro.install_packages.called)
def test_handler_error_on_invalid_landscape_type(self):
"""Raise an error when landscape configuraiton option is invalid."""
mycloud = get_cloud("ubuntu")
cfg = {"landscape": "wrongtype"}
with self.assertRaises(RuntimeError) as context_manager:
cc_landscape.handle("notimportant", cfg, mycloud, None)
self.assertIn(
"'landscape' key existed in config, but not a dict",
str(context_manager.exception),
)
@mock.patch("cloudinit.config.cc_landscape.subp")
def test_handler_restarts_landscape_client(self, m_subp):
"""handler restarts lansdscape-client after install."""
mycloud = get_cloud("ubuntu")
cfg = {"landscape": {"client": {}}}
wrap_and_call(
"cloudinit.config.cc_landscape",
{"LSC_CLIENT_CFG_FILE": {"new": self.conf}},
cc_landscape.handle,
"notimportant",
cfg,
mycloud,
None,
)
self.assertEqual(
[mock.call(["service", "landscape-client", "restart"])],
m_subp.subp.call_args_list,
)
def test_handler_installs_client_and_creates_config_file(self):
"""Write landscape client.conf and install landscape-client."""
mycloud = get_cloud("ubuntu")
cfg = {"landscape": {"client": {}}}
expected = {
"client": {
"log_level": "info",
"url": "https://landscape.canonical.com/message-system",
"ping_url": "http://landscape.canonical.com/ping",
"data_path": "/var/lib/landscape/client",
}
}
mycloud.distro = mock.MagicMock()
wrap_and_call(
"cloudinit.config.cc_landscape",
{
"LSC_CLIENT_CFG_FILE": {"new": self.conf},
"LS_DEFAULT_FILE": {"new": self.default_file},
},
cc_landscape.handle,
"notimportant",
cfg,
mycloud,
None,
)
self.assertEqual(
[mock.call("landscape-client")],
mycloud.distro.install_packages.call_args,
)
self.assertEqual(expected, dict(ConfigObj(self.conf)))
self.assertIn(
"Wrote landscape config file to {0}".format(self.conf),
self.logs.getvalue(),
)
default_content = util.load_file(self.default_file)
self.assertEqual("RUN=1\n", default_content)
def test_handler_writes_merged_client_config_file_with_defaults(self):
"""Merge and write options from LSC_CLIENT_CFG_FILE with defaults."""
# Write existing sparse client.conf file
util.write_file(self.conf, "[client]\ncomputer_title = My PC\n")
mycloud = get_cloud("ubuntu")
cfg = {"landscape": {"client": {}}}
expected = {
"client": {
"log_level": "info",
"url": "https://landscape.canonical.com/message-system",
"ping_url": "http://landscape.canonical.com/ping",
"data_path": "/var/lib/landscape/client",
"computer_title": "My PC",
}
}
wrap_and_call(
"cloudinit.config.cc_landscape",
{"LSC_CLIENT_CFG_FILE": {"new": self.conf}},
cc_landscape.handle,
"notimportant",
cfg,
mycloud,
None,
)
self.assertEqual(expected, dict(ConfigObj(self.conf)))
self.assertIn(
"Wrote landscape config file to {0}".format(self.conf),
self.logs.getvalue(),
)
def test_handler_writes_merged_provided_cloudconfig_with_defaults(self):
"""Merge and write options from cloud-config options with defaults."""
# Write empty sparse client.conf file
util.write_file(self.conf, "")
mycloud = get_cloud("ubuntu")
cfg = {"landscape": {"client": {"computer_title": "My PC"}}}
expected = {
"client": {
"log_level": "info",
"url": "https://landscape.canonical.com/message-system",
"ping_url": "http://landscape.canonical.com/ping",
"data_path": "/var/lib/landscape/client",
"computer_title": "My PC",
}
}
wrap_and_call(
"cloudinit.config.cc_landscape",
{"LSC_CLIENT_CFG_FILE": {"new": self.conf}},
cc_landscape.handle,
"notimportant",
cfg,
mycloud,
None,
)
self.assertEqual(expected, dict(ConfigObj(self.conf)))
self.assertIn(
"Wrote landscape config file to {0}".format(self.conf),
self.logs.getvalue(),
)
class TestLandscapeSchema:
@pytest.mark.parametrize(
"config, error_msg",
[
# Allow undocumented keys client keys without error
({"landscape": {"client": {"allow_additional_keys": 1}}}, None),
# tags are comma-delimited
({"landscape": {"client": {"tags": "1,2,3"}}}, None),
({"landscape": {"client": {"tags": "1"}}}, None),
(
{
"landscape": {
"client": {},
"random-config-value": {"tags": "1"},
}
},
"Additional properties are not allowed",
),
# Require client key
({"landscape": {}}, "'client' is a required property"),
# tags are not whitespace-delimited
(
{"landscape": {"client": {"tags": "1, 2,3"}}},
"'1, 2,3' does not match",
),
],
)
@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)
|
