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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
# This file is part of cloud-init. See LICENSE file for license information.
from cloudinit.config import cc_ntp
from cloudinit.sources import DataSourceNone
from cloudinit import templater
from cloudinit import (distros, helpers, cloud, util)
from ..helpers import FilesystemMockingTestCase, mock
import logging
import os
import shutil
import tempfile
LOG = logging.getLogger(__name__)
NTP_TEMPLATE = """
## template: jinja
{% if pools %}# pools
{% endif %}
{% for pool in pools -%}
pool {{pool}} iburst
{% endfor %}
{%- if servers %}# servers
{% endif %}
{% for server in servers -%}
server {{server}} iburst
{% endfor %}
"""
NTP_EXPECTED_UBUNTU = """
# pools
pool 0.mycompany.pool.ntp.org iburst
# servers
server 192.168.23.3 iburst
"""
class TestNtp(FilesystemMockingTestCase):
def setUp(self):
super(TestNtp, self).setUp()
self.subp = util.subp
self.new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.new_root)
def _get_cloud(self, distro, metadata=None):
self.patchUtils(self.new_root)
paths = helpers.Paths({})
cls = distros.fetch(distro)
mydist = cls(distro, {}, paths)
myds = DataSourceNone.DataSourceNone({}, mydist, paths)
if metadata:
myds.metadata.update(metadata)
return cloud.Cloud(myds, paths, {}, mydist, None)
@mock.patch("cloudinit.config.cc_ntp.util")
def test_ntp_install(self, mock_util):
cc = self._get_cloud('ubuntu')
cc.distro = mock.MagicMock()
cc.distro.name = 'ubuntu'
mock_util.which.return_value = None
install_func = mock.MagicMock()
cc_ntp.install_ntp(install_func, packages=['ntpx'], check_exe='ntpdx')
self.assertTrue(install_func.called)
mock_util.which.assert_called_with('ntpdx')
install_pkg = install_func.call_args_list[0][0][0]
self.assertEqual(sorted(install_pkg), ['ntpx'])
@mock.patch("cloudinit.config.cc_ntp.util")
def test_ntp_install_not_needed(self, mock_util):
cc = self._get_cloud('ubuntu')
cc.distro = mock.MagicMock()
cc.distro.name = 'ubuntu'
mock_util.which.return_value = ["/usr/sbin/ntpd"]
cc_ntp.install_ntp(cc)
self.assertFalse(cc.distro.install_packages.called)
def test_ntp_rename_ntp_conf(self):
with mock.patch.object(os.path, 'exists',
return_value=True) as mockpath:
with mock.patch.object(util, 'rename') as mockrename:
cc_ntp.rename_ntp_conf()
mockpath.assert_called_with('/etc/ntp.conf')
mockrename.assert_called_with('/etc/ntp.conf', '/etc/ntp.conf.dist')
def test_ntp_rename_ntp_conf_skip_missing(self):
with mock.patch.object(os.path, 'exists',
return_value=False) as mockpath:
with mock.patch.object(util, 'rename') as mockrename:
cc_ntp.rename_ntp_conf()
mockpath.assert_called_with('/etc/ntp.conf')
mockrename.assert_not_called()
def ntp_conf_render(self, distro):
"""ntp_conf_render
Test rendering of a ntp.conf from template for a given distro
"""
cfg = {'ntp': {}}
mycloud = self._get_cloud(distro)
distro_names = cc_ntp.generate_server_names(distro)
with mock.patch.object(templater, 'render_to_file') as mocktmpl:
with mock.patch.object(os.path, 'isfile', return_value=True):
with mock.patch.object(util, 'rename'):
cc_ntp.write_ntp_config_template(cfg, mycloud)
mocktmpl.assert_called_once_with(
('/etc/cloud/templates/ntp.conf.%s.tmpl' % distro),
'/etc/ntp.conf',
{'servers': [], 'pools': distro_names})
def test_ntp_conf_render_rhel(self):
"""Test templater.render_to_file() for rhel"""
self.ntp_conf_render('rhel')
def test_ntp_conf_render_debian(self):
"""Test templater.render_to_file() for debian"""
self.ntp_conf_render('debian')
def test_ntp_conf_render_fedora(self):
"""Test templater.render_to_file() for fedora"""
self.ntp_conf_render('fedora')
def test_ntp_conf_render_sles(self):
"""Test templater.render_to_file() for sles"""
self.ntp_conf_render('sles')
def test_ntp_conf_render_ubuntu(self):
"""Test templater.render_to_file() for ubuntu"""
self.ntp_conf_render('ubuntu')
def test_ntp_conf_servers_no_pools(self):
distro = 'ubuntu'
pools = []
servers = ['192.168.2.1']
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
mycloud = self._get_cloud(distro)
with mock.patch.object(templater, 'render_to_file') as mocktmpl:
with mock.patch.object(os.path, 'isfile', return_value=True):
with mock.patch.object(util, 'rename'):
cc_ntp.write_ntp_config_template(cfg.get('ntp'), mycloud)
mocktmpl.assert_called_once_with(
('/etc/cloud/templates/ntp.conf.%s.tmpl' % distro),
'/etc/ntp.conf',
{'servers': servers, 'pools': pools})
def test_ntp_conf_custom_pools_no_server(self):
distro = 'ubuntu'
pools = ['0.mycompany.pool.ntp.org']
servers = []
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
mycloud = self._get_cloud(distro)
with mock.patch.object(templater, 'render_to_file') as mocktmpl:
with mock.patch.object(os.path, 'isfile', return_value=True):
with mock.patch.object(util, 'rename'):
cc_ntp.write_ntp_config_template(cfg.get('ntp'), mycloud)
mocktmpl.assert_called_once_with(
('/etc/cloud/templates/ntp.conf.%s.tmpl' % distro),
'/etc/ntp.conf',
{'servers': servers, 'pools': pools})
def test_ntp_conf_custom_pools_and_server(self):
distro = 'ubuntu'
pools = ['0.mycompany.pool.ntp.org']
servers = ['192.168.23.3']
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
mycloud = self._get_cloud(distro)
with mock.patch.object(templater, 'render_to_file') as mocktmpl:
with mock.patch.object(os.path, 'isfile', return_value=True):
with mock.patch.object(util, 'rename'):
cc_ntp.write_ntp_config_template(cfg.get('ntp'), mycloud)
mocktmpl.assert_called_once_with(
('/etc/cloud/templates/ntp.conf.%s.tmpl' % distro),
'/etc/ntp.conf',
{'servers': servers, 'pools': pools})
def test_ntp_conf_contents_match(self):
"""Test rendered contents of /etc/ntp.conf for ubuntu"""
pools = ['0.mycompany.pool.ntp.org']
servers = ['192.168.23.3']
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
mycloud = self._get_cloud('ubuntu')
side_effect = [NTP_TEMPLATE.lstrip()]
# work backwards from util.write_file and mock out call path
# write_ntp_config_template()
# cloud.get_template_filename()
# os.path.isfile()
# templater.render_to_file()
# templater.render_from_file()
# util.load_file()
# util.write_file()
#
with mock.patch.object(util, 'write_file') as mockwrite:
with mock.patch.object(util, 'load_file', side_effect=side_effect):
with mock.patch.object(os.path, 'isfile', return_value=True):
with mock.patch.object(util, 'rename'):
cc_ntp.write_ntp_config_template(cfg.get('ntp'),
mycloud)
mockwrite.assert_called_once_with(
'/etc/ntp.conf',
NTP_EXPECTED_UBUNTU,
mode=420)
def test_ntp_handler(self):
"""Test ntp handler renders ubuntu ntp.conf template"""
pools = ['0.mycompany.pool.ntp.org']
servers = ['192.168.23.3']
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
mycloud = self._get_cloud('ubuntu')
mycloud.distro = mock.MagicMock()
mycloud.distro.uses_systemd.return_value = True
side_effect = [NTP_TEMPLATE.lstrip()]
with mock.patch.object(util, 'which', return_value=None):
with mock.patch.object(os.path, 'exists'):
with mock.patch.object(util, 'write_file') as mockwrite:
with mock.patch.object(util, 'load_file',
side_effect=side_effect):
with mock.patch.object(os.path, 'isfile',
return_value=True):
with mock.patch.object(util, 'rename'):
with mock.patch.object(util, 'subp') as msubp:
cc_ntp.handle("notimportant", cfg,
mycloud, LOG, None)
mockwrite.assert_called_once_with(
'/etc/ntp.conf',
NTP_EXPECTED_UBUNTU,
mode=420)
msubp.assert_any_call(['systemctl', 'reload-or-restart', 'ntp'],
capture=True)
@mock.patch("cloudinit.config.cc_ntp.install_ntp")
@mock.patch("cloudinit.config.cc_ntp.write_ntp_config_template")
@mock.patch("cloudinit.config.cc_ntp.rename_ntp_conf")
def test_write_config_before_install(self, mock_ntp_rename,
mock_ntp_write_config,
mock_install_ntp):
pools = ['0.mycompany.pool.ntp.org']
servers = ['192.168.23.3']
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
cc = self._get_cloud('ubuntu')
cc.distro = mock.MagicMock()
mock_parent = mock.MagicMock()
mock_parent.attach_mock(mock_ntp_rename, 'mock_ntp_rename')
mock_parent.attach_mock(mock_ntp_write_config, 'mock_ntp_write_config')
mock_parent.attach_mock(mock_install_ntp, 'mock_install_ntp')
cc_ntp.handle('cc_ntp', cfg, cc, LOG, None)
"""Check call order"""
mock_parent.assert_has_calls([
mock.call.mock_ntp_rename(),
mock.call.mock_ntp_write_config(cfg.get('ntp'), cc),
mock.call.mock_install_ntp(cc.distro.install_packages,
packages=['ntp'], check_exe="ntpd")])
@mock.patch("cloudinit.config.cc_ntp.reload_ntp")
@mock.patch("cloudinit.config.cc_ntp.install_ntp")
@mock.patch("cloudinit.config.cc_ntp.write_ntp_config_template")
@mock.patch("cloudinit.config.cc_ntp.rename_ntp_conf")
def test_reload_ntp_fail_raises_exception(self, mock_rename,
mock_write_conf,
mock_install,
mock_reload):
pools = ['0.mycompany.pool.ntp.org']
servers = ['192.168.23.3']
cfg = {
'ntp': {
'pools': pools,
'servers': servers,
}
}
cc = self._get_cloud('ubuntu')
cc.distro = mock.MagicMock()
mock_reload.side_effect = [util.ProcessExecutionError]
self.assertRaises(util.ProcessExecutionError,
cc_ntp.handle, 'cc_ntp',
cfg, cc, LOG, None)
@mock.patch("cloudinit.config.cc_ntp.util")
def test_no_ntpcfg_does_nothing(self, mock_util):
cc = self._get_cloud('ubuntu')
cc.distro = mock.MagicMock()
cc_ntp.handle('cc_ntp', {}, cc, LOG, [])
self.assertFalse(cc.distro.install_packages.called)
self.assertFalse(mock_util.subp.called)
@mock.patch("cloudinit.config.cc_ntp.util")
def test_reload_ntp_systemd(self, mock_util):
cc_ntp.reload_ntp(systemd=True)
self.assertTrue(mock_util.subp.called)
mock_util.subp.assert_called_with(
['systemctl', 'reload-or-restart', 'ntp'], capture=True)
@mock.patch("cloudinit.config.cc_ntp.util")
def test_reload_ntp_service(self, mock_util):
cc_ntp.reload_ntp(systemd=False)
self.assertTrue(mock_util.subp.called)
mock_util.subp.assert_called_with(
['service', 'ntp', 'restart'], capture=True)
# vi: ts=4 expandtab
|
