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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
# This file is part of cloud-init. See LICENSE file for license information.
import logging
import textwrap
from cloudinit.config import cc_puppet
from cloudinit import util
from tests.unittests.helpers import CiTestCase, HttprettyTestCase, mock
from tests.unittests.util import get_cloud
LOG = logging.getLogger(__name__)
@mock.patch('cloudinit.config.cc_puppet.subp.subp')
@mock.patch('cloudinit.config.cc_puppet.os')
class TestAutostartPuppet(CiTestCase):
def test_wb_autostart_puppet_updates_puppet_default(self, m_os, m_subp):
"""Update /etc/default/puppet to autostart if it exists."""
def _fake_exists(path):
return path == '/etc/default/puppet'
m_os.path.exists.side_effect = _fake_exists
cc_puppet._autostart_puppet(LOG)
self.assertEqual(
[mock.call(['sed', '-i', '-e', 's/^START=.*/START=yes/',
'/etc/default/puppet'], capture=False)],
m_subp.call_args_list)
def test_wb_autostart_pupppet_enables_puppet_systemctl(self, m_os, m_subp):
"""If systemctl is present, enable puppet via systemctl."""
def _fake_exists(path):
return path == '/bin/systemctl'
m_os.path.exists.side_effect = _fake_exists
cc_puppet._autostart_puppet(LOG)
expected_calls = [mock.call(
['/bin/systemctl', 'enable', 'puppet.service'], capture=False)]
self.assertEqual(expected_calls, m_subp.call_args_list)
def test_wb_autostart_pupppet_enables_puppet_chkconfig(self, m_os, m_subp):
"""If chkconfig is present, enable puppet via checkcfg."""
def _fake_exists(path):
return path == '/sbin/chkconfig'
m_os.path.exists.side_effect = _fake_exists
cc_puppet._autostart_puppet(LOG)
expected_calls = [mock.call(
['/sbin/chkconfig', 'puppet', 'on'], capture=False)]
self.assertEqual(expected_calls, m_subp.call_args_list)
@mock.patch('cloudinit.config.cc_puppet._autostart_puppet')
class TestPuppetHandle(CiTestCase):
with_logs = True
def setUp(self):
super(TestPuppetHandle, self).setUp()
self.new_root = self.tmp_dir()
self.conf = self.tmp_path('puppet.conf')
self.csr_attributes_path = self.tmp_path(
'csr_attributes.yaml')
self.cloud = get_cloud()
def test_skips_missing_puppet_key_in_cloudconfig(self, m_auto):
"""Cloud-config containing no 'puppet' key is skipped."""
cfg = {}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertIn(
"no 'puppet' configuration found", self.logs.getvalue())
self.assertEqual(0, m_auto.call_count)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_starts_puppet_service(self, m_subp, m_auto):
"""Cloud-config 'puppet' configuration starts puppet."""
cfg = {'puppet': {'install': False}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(1, m_auto.call_count)
self.assertIn(
[mock.call(['service', 'puppet', 'start'], capture=False)],
m_subp.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_empty_puppet_config_installs_puppet(self, m_subp, m_auto):
"""Cloud-config empty 'puppet' configuration installs latest puppet."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(
[mock.call(('puppet', None))],
self.cloud.distro.install_packages.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_on_true(self, m_subp, _):
"""Cloud-config with 'puppet' key installs when 'install' is True."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {'install': True}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(
[mock.call(('puppet', None))],
self.cloud.distro.install_packages.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.install_puppet_aio', autospec=True)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_aio(self, m_subp, m_aio, _):
"""Cloud-config with 'puppet' key installs
when 'install_type' is 'aio'."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {'install': True, 'install_type': 'aio'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
m_aio.assert_called_with(
cc_puppet.AIO_INSTALL_URL,
None, None, True)
@mock.patch('cloudinit.config.cc_puppet.install_puppet_aio', autospec=True)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_aio_with_version(self,
m_subp, m_aio, _):
"""Cloud-config with 'puppet' key installs
when 'install_type' is 'aio' and 'version' is specified."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {'install': True,
'version': '6.24.0', 'install_type': 'aio'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
m_aio.assert_called_with(
cc_puppet.AIO_INSTALL_URL,
'6.24.0', None, True)
@mock.patch('cloudinit.config.cc_puppet.install_puppet_aio', autospec=True)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_aio_with_collection(self,
m_subp,
m_aio, _):
"""Cloud-config with 'puppet' key installs
when 'install_type' is 'aio' and 'collection' is specified."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {'install': True,
'collection': 'puppet6', 'install_type': 'aio'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
m_aio.assert_called_with(
cc_puppet.AIO_INSTALL_URL,
None, 'puppet6', True)
@mock.patch('cloudinit.config.cc_puppet.install_puppet_aio', autospec=True)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_aio_with_custom_url(self,
m_subp,
m_aio, _):
"""Cloud-config with 'puppet' key installs
when 'install_type' is 'aio' and 'aio_install_url' is specified."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet':
{'install': True,
'aio_install_url': 'http://test.url/path/to/script.sh',
'install_type': 'aio'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
m_aio.assert_called_with(
'http://test.url/path/to/script.sh', None, None, True)
@mock.patch('cloudinit.config.cc_puppet.install_puppet_aio', autospec=True)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_aio_without_cleanup(self,
m_subp,
m_aio, _):
"""Cloud-config with 'puppet' key installs
when 'install_type' is 'aio' and no cleanup."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {'install': True,
'cleanup': False, 'install_type': 'aio'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
m_aio.assert_called_with(
cc_puppet.AIO_INSTALL_URL,
None, None, False)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_installs_puppet_version(self, m_subp, _):
"""Cloud-config 'puppet' configuration can specify a version."""
self.cloud.distro = mock.MagicMock()
cfg = {'puppet': {'version': '3.8'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(
[mock.call(('puppet', '3.8'))],
self.cloud.distro.install_packages.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.get_config_value')
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_config_updates_puppet_conf(self,
m_subp, m_default, m_auto):
"""When 'conf' is provided update values in PUPPET_CONF_PATH."""
def _fake_get_config_value(puppet_bin, setting):
return self.conf
m_default.side_effect = _fake_get_config_value
cfg = {
'puppet': {
'conf': {'agent': {'server': 'puppetserver.example.org'}}}}
util.write_file(
self.conf, '[agent]\nserver = origpuppet\nother = 3')
self.cloud.distro = mock.MagicMock()
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
content = util.load_file(self.conf)
expected = '[agent]\nserver = puppetserver.example.org\nother = 3\n\n'
self.assertEqual(expected, content)
@mock.patch('cloudinit.config.cc_puppet.get_config_value')
@mock.patch('cloudinit.config.cc_puppet.subp.subp')
def test_puppet_writes_csr_attributes_file(self,
m_subp, m_default, m_auto):
"""When csr_attributes is provided
creates file in PUPPET_CSR_ATTRIBUTES_PATH."""
def _fake_get_config_value(puppet_bin, setting):
return self.csr_attributes_path
m_default.side_effect = _fake_get_config_value
self.cloud.distro = mock.MagicMock()
cfg = {
'puppet': {
'csr_attributes': {
'custom_attributes': {
'1.2.840.113549.1.9.7':
'342thbjkt82094y0uthhor289jnqthpc2290'
},
'extension_requests': {
'pp_uuid': 'ED803750-E3C7-44F5-BB08-41A04433FE2E',
'pp_image_name': 'my_ami_image',
'pp_preshared_key':
'342thbjkt82094y0uthhor289jnqthpc2290'
}
}
}
}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
content = util.load_file(self.csr_attributes_path)
expected = textwrap.dedent("""\
custom_attributes:
1.2.840.113549.1.9.7: 342thbjkt82094y0uthhor289jnqthpc2290
extension_requests:
pp_image_name: my_ami_image
pp_preshared_key: 342thbjkt82094y0uthhor289jnqthpc2290
pp_uuid: ED803750-E3C7-44F5-BB08-41A04433FE2E
""")
self.assertEqual(expected, content)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_runs_puppet_if_requested(self, m_subp, m_auto):
"""Run puppet with default args if 'exec' is set to True."""
cfg = {'puppet': {'exec': True}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(1, m_auto.call_count)
self.assertIn(
[mock.call(['puppet', 'agent', '--test'], capture=False)],
m_subp.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_starts_puppetd(self, m_subp, m_auto):
"""Run puppet with default args if 'exec' is set to True."""
cfg = {'puppet': {}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(1, m_auto.call_count)
self.assertIn(
[mock.call(['service', 'puppet', 'start'], capture=False)],
m_subp.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_skips_puppetd(self, m_subp, m_auto):
"""Run puppet with default args if 'exec' is set to True."""
cfg = {'puppet': {'start_service': False}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(0, m_auto.call_count)
self.assertNotIn(
[mock.call(['service', 'puppet', 'start'], capture=False)],
m_subp.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_runs_puppet_with_args_list_if_requested(self,
m_subp, m_auto):
"""Run puppet with 'exec_args' list if 'exec' is set to True."""
cfg = {'puppet': {'exec': True, 'exec_args': [
'--onetime', '--detailed-exitcodes']}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(1, m_auto.call_count)
self.assertIn(
[mock.call(
['puppet', 'agent', '--onetime', '--detailed-exitcodes'],
capture=False)],
m_subp.call_args_list)
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=("", ""))
def test_puppet_runs_puppet_with_args_string_if_requested(self,
m_subp, m_auto):
"""Run puppet with 'exec_args' string if 'exec' is set to True."""
cfg = {'puppet': {'exec': True,
'exec_args': '--onetime --detailed-exitcodes'}}
cc_puppet.handle('notimportant', cfg, self.cloud, LOG, None)
self.assertEqual(1, m_auto.call_count)
self.assertIn(
[mock.call(
['puppet', 'agent', '--onetime', '--detailed-exitcodes'],
capture=False)],
m_subp.call_args_list)
URL_MOCK = mock.Mock()
URL_MOCK.contents = b'#!/bin/bash\necho "Hi Mom"'
@mock.patch('cloudinit.config.cc_puppet.subp.subp', return_value=(None, None))
@mock.patch(
'cloudinit.config.cc_puppet.url_helper.readurl',
return_value=URL_MOCK, autospec=True,
)
class TestInstallPuppetAio(HttprettyTestCase):
def test_install_with_default_arguments(self, m_readurl, m_subp):
"""Install AIO with no arguments"""
cc_puppet.install_puppet_aio()
self.assertEqual(
[mock.call([mock.ANY, '--cleanup'], capture=False)],
m_subp.call_args_list)
def test_install_with_custom_url(self, m_readurl, m_subp):
"""Install AIO from custom URL"""
cc_puppet.install_puppet_aio('http://custom.url/path/to/script.sh')
m_readurl.assert_called_with(
url='http://custom.url/path/to/script.sh',
retries=5)
self.assertEqual(
[mock.call([mock.ANY, '--cleanup'], capture=False)],
m_subp.call_args_list)
def test_install_with_version(self, m_readurl, m_subp):
"""Install AIO with specific version"""
cc_puppet.install_puppet_aio(cc_puppet.AIO_INSTALL_URL, '7.6.0')
self.assertEqual(
[mock.call([mock.ANY, '-v', '7.6.0', '--cleanup'], capture=False)],
m_subp.call_args_list)
def test_install_with_collection(self, m_readurl, m_subp):
"""Install AIO with specific collection"""
cc_puppet.install_puppet_aio(
cc_puppet.AIO_INSTALL_URL, None, 'puppet6-nightly')
self.assertEqual(
[mock.call([mock.ANY, '-c', 'puppet6-nightly', '--cleanup'],
capture=False)],
m_subp.call_args_list)
def test_install_with_no_cleanup(self, m_readurl, m_subp):
"""Install AIO with no cleanup"""
cc_puppet.install_puppet_aio(
cc_puppet.AIO_INSTALL_URL, None, None, False)
self.assertEqual(
[mock.call([mock.ANY], capture=False)],
m_subp.call_args_list)
|
