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
|
# This file is part of cloud-init. See LICENSE file for license information.
"""Tests related to cloudinit.stages module."""
import os
from cloudinit import stages
from cloudinit import sources
from cloudinit.sources import NetworkConfigSource
from cloudinit.event import EventType
from cloudinit.util import write_file
from cloudinit.tests.helpers import CiTestCase, mock
TEST_INSTANCE_ID = 'i-testing'
class FakeDataSource(sources.DataSource):
def __init__(self, paths=None, userdata=None, vendordata=None,
network_config=''):
super(FakeDataSource, self).__init__({}, None, paths=paths)
self.metadata = {'instance-id': TEST_INSTANCE_ID}
self.userdata_raw = userdata
self.vendordata_raw = vendordata
self._network_config = None
if network_config: # Permit for None value to setup attribute
self._network_config = network_config
@property
def network_config(self):
return self._network_config
def _get_data(self):
return True
class TestInit(CiTestCase):
with_logs = True
allowed_subp = False
def setUp(self):
super(TestInit, self).setUp()
self.tmpdir = self.tmp_dir()
self.init = stages.Init()
# Setup fake Paths for Init to reference
self.init._cfg = {'system_info': {
'distro': 'ubuntu', 'paths': {'cloud_dir': self.tmpdir,
'run_dir': self.tmpdir}}}
self.init.datasource = FakeDataSource(paths=self.init.paths)
def test_wb__find_networking_config_disabled(self):
"""find_networking_config returns no config when disabled."""
disable_file = os.path.join(
self.init.paths.get_cpath('data'), 'upgraded-network')
write_file(disable_file, '')
self.assertEqual(
(None, disable_file),
self.init._find_networking_config())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_disabled_by_kernel(
self, m_cmdline, m_initramfs):
"""find_networking_config returns when disabled by kernel cmdline."""
m_cmdline.return_value = {'config': 'disabled'}
m_initramfs.return_value = {'config': ['fake_initrd']}
self.assertEqual(
(None, NetworkConfigSource.cmdline),
self.init._find_networking_config())
self.assertEqual('DEBUG: network config disabled by cmdline\n',
self.logs.getvalue())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_disabled_by_initrd(
self, m_cmdline, m_initramfs):
"""find_networking_config returns when disabled by kernel cmdline."""
m_cmdline.return_value = {}
m_initramfs.return_value = {'config': 'disabled'}
self.assertEqual(
(None, NetworkConfigSource.initramfs),
self.init._find_networking_config())
self.assertEqual('DEBUG: network config disabled by initramfs\n',
self.logs.getvalue())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_disabled_by_datasrc(
self, m_cmdline, m_initramfs):
"""find_networking_config returns when disabled by datasource cfg."""
m_cmdline.return_value = {} # Kernel doesn't disable networking
m_initramfs.return_value = {} # initramfs doesn't disable networking
self.init._cfg = {'system_info': {'paths': {'cloud_dir': self.tmpdir}},
'network': {}} # system config doesn't disable
self.init.datasource = FakeDataSource(
network_config={'config': 'disabled'})
self.assertEqual(
(None, NetworkConfigSource.ds),
self.init._find_networking_config())
self.assertEqual('DEBUG: network config disabled by ds\n',
self.logs.getvalue())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_disabled_by_sysconfig(
self, m_cmdline, m_initramfs):
"""find_networking_config returns when disabled by system config."""
m_cmdline.return_value = {} # Kernel doesn't disable networking
m_initramfs.return_value = {} # initramfs doesn't disable networking
self.init._cfg = {'system_info': {'paths': {'cloud_dir': self.tmpdir}},
'network': {'config': 'disabled'}}
self.assertEqual(
(None, NetworkConfigSource.system_cfg),
self.init._find_networking_config())
self.assertEqual('DEBUG: network config disabled by system_cfg\n',
self.logs.getvalue())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test__find_networking_config_uses_datasrc_order(
self, m_cmdline, m_initramfs):
"""find_networking_config should check sources in DS defined order"""
# cmdline and initramfs, which would normally be preferred over other
# sources, disable networking; in this case, though, the DS moves them
# later so its own config is preferred
m_cmdline.return_value = {'config': 'disabled'}
m_initramfs.return_value = {'config': 'disabled'}
ds_net_cfg = {'config': {'needle': True}}
self.init.datasource = FakeDataSource(network_config=ds_net_cfg)
self.init.datasource.network_config_sources = [
NetworkConfigSource.ds, NetworkConfigSource.system_cfg,
NetworkConfigSource.cmdline, NetworkConfigSource.initramfs]
self.assertEqual(
(ds_net_cfg, NetworkConfigSource.ds),
self.init._find_networking_config())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test__find_networking_config_warns_if_datasrc_uses_invalid_src(
self, m_cmdline, m_initramfs):
"""find_networking_config should check sources in DS defined order"""
ds_net_cfg = {'config': {'needle': True}}
self.init.datasource = FakeDataSource(network_config=ds_net_cfg)
self.init.datasource.network_config_sources = [
'invalid_src', NetworkConfigSource.ds]
self.assertEqual(
(ds_net_cfg, NetworkConfigSource.ds),
self.init._find_networking_config())
self.assertIn('WARNING: data source specifies an invalid network'
' cfg_source: invalid_src',
self.logs.getvalue())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test__find_networking_config_warns_if_datasrc_uses_unavailable_src(
self, m_cmdline, m_initramfs):
"""find_networking_config should check sources in DS defined order"""
ds_net_cfg = {'config': {'needle': True}}
self.init.datasource = FakeDataSource(network_config=ds_net_cfg)
self.init.datasource.network_config_sources = [
NetworkConfigSource.fallback, NetworkConfigSource.ds]
self.assertEqual(
(ds_net_cfg, NetworkConfigSource.ds),
self.init._find_networking_config())
self.assertIn('WARNING: data source specifies an unavailable network'
' cfg_source: fallback',
self.logs.getvalue())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_returns_kernel(
self, m_cmdline, m_initramfs):
"""find_networking_config returns kernel cmdline config if present."""
expected_cfg = {'config': ['fakekernel']}
m_cmdline.return_value = expected_cfg
m_initramfs.return_value = {'config': ['fake_initrd']}
self.init._cfg = {'system_info': {'paths': {'cloud_dir': self.tmpdir}},
'network': {'config': ['fakesys_config']}}
self.init.datasource = FakeDataSource(
network_config={'config': ['fakedatasource']})
self.assertEqual(
(expected_cfg, NetworkConfigSource.cmdline),
self.init._find_networking_config())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_returns_initramfs(
self, m_cmdline, m_initramfs):
"""find_networking_config returns kernel cmdline config if present."""
expected_cfg = {'config': ['fake_initrd']}
m_cmdline.return_value = {}
m_initramfs.return_value = expected_cfg
self.init._cfg = {'system_info': {'paths': {'cloud_dir': self.tmpdir}},
'network': {'config': ['fakesys_config']}}
self.init.datasource = FakeDataSource(
network_config={'config': ['fakedatasource']})
self.assertEqual(
(expected_cfg, NetworkConfigSource.initramfs),
self.init._find_networking_config())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_returns_system_cfg(
self, m_cmdline, m_initramfs):
"""find_networking_config returns system config when present."""
m_cmdline.return_value = {} # No kernel network config
m_initramfs.return_value = {} # no initramfs network config
expected_cfg = {'config': ['fakesys_config']}
self.init._cfg = {'system_info': {'paths': {'cloud_dir': self.tmpdir}},
'network': expected_cfg}
self.init.datasource = FakeDataSource(
network_config={'config': ['fakedatasource']})
self.assertEqual(
(expected_cfg, NetworkConfigSource.system_cfg),
self.init._find_networking_config())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_returns_datasrc_cfg(
self, m_cmdline, m_initramfs):
"""find_networking_config returns datasource net config if present."""
m_cmdline.return_value = {} # No kernel network config
m_initramfs.return_value = {} # no initramfs network config
# No system config for network in setUp
expected_cfg = {'config': ['fakedatasource']}
self.init.datasource = FakeDataSource(network_config=expected_cfg)
self.assertEqual(
(expected_cfg, NetworkConfigSource.ds),
self.init._find_networking_config())
@mock.patch('cloudinit.stages.cmdline.read_initramfs_config')
@mock.patch('cloudinit.stages.cmdline.read_kernel_cmdline_config')
def test_wb__find_networking_config_returns_fallback(
self, m_cmdline, m_initramfs):
"""find_networking_config returns fallback config if not defined."""
m_cmdline.return_value = {} # Kernel doesn't disable networking
m_initramfs.return_value = {} # no initramfs network config
# Neither datasource nor system_info disable or provide network
fake_cfg = {'config': [{'type': 'physical', 'name': 'eth9'}],
'version': 1}
def fake_generate_fallback():
return fake_cfg
# Monkey patch distro which gets cached on self.init
distro = self.init.distro
distro.generate_fallback_config = fake_generate_fallback
self.assertEqual(
(fake_cfg, NetworkConfigSource.fallback),
self.init._find_networking_config())
self.assertNotIn('network config disabled', self.logs.getvalue())
def test_apply_network_config_disabled(self):
"""Log when network is disabled by upgraded-network."""
disable_file = os.path.join(
self.init.paths.get_cpath('data'), 'upgraded-network')
def fake_network_config():
return (None, disable_file)
self.init._find_networking_config = fake_network_config
self.init.apply_network_config(True)
self.assertIn(
'INFO: network config is disabled by %s' % disable_file,
self.logs.getvalue())
@mock.patch('cloudinit.net.get_interfaces_by_mac')
@mock.patch('cloudinit.distros.ubuntu.Distro')
def test_apply_network_on_new_instance(self, m_ubuntu, m_macs):
"""Call distro apply_network_config methods on is_new_instance."""
net_cfg = {
'version': 1, 'config': [
{'subnets': [{'type': 'dhcp'}], 'type': 'physical',
'name': 'eth9', 'mac_address': '42:42:42:42:42:42'}]}
def fake_network_config():
return net_cfg, NetworkConfigSource.fallback
m_macs.return_value = {'42:42:42:42:42:42': 'eth9'}
self.init._find_networking_config = fake_network_config
self.init.apply_network_config(True)
self.init.distro.apply_network_config_names.assert_called_with(net_cfg)
self.init.distro.apply_network_config.assert_called_with(
net_cfg, bring_up=True)
@mock.patch('cloudinit.distros.ubuntu.Distro')
def test_apply_network_on_same_instance_id(self, m_ubuntu):
"""Only call distro.apply_network_config_names on same instance id."""
old_instance_id = os.path.join(
self.init.paths.get_cpath('data'), 'instance-id')
write_file(old_instance_id, TEST_INSTANCE_ID)
net_cfg = {
'version': 1, 'config': [
{'subnets': [{'type': 'dhcp'}], 'type': 'physical',
'name': 'eth9', 'mac_address': '42:42:42:42:42:42'}]}
def fake_network_config():
return net_cfg, NetworkConfigSource.fallback
self.init._find_networking_config = fake_network_config
self.init.apply_network_config(True)
self.init.distro.apply_network_config_names.assert_called_with(net_cfg)
self.init.distro.apply_network_config.assert_not_called()
self.assertIn(
'No network config applied. Neither a new instance'
" nor datasource network update on '%s' event" % EventType.BOOT,
self.logs.getvalue())
@mock.patch('cloudinit.net.get_interfaces_by_mac')
@mock.patch('cloudinit.distros.ubuntu.Distro')
def test_apply_network_on_datasource_allowed_event(self, m_ubuntu, m_macs):
"""Apply network if datasource.update_metadata permits BOOT event."""
old_instance_id = os.path.join(
self.init.paths.get_cpath('data'), 'instance-id')
write_file(old_instance_id, TEST_INSTANCE_ID)
net_cfg = {
'version': 1, 'config': [
{'subnets': [{'type': 'dhcp'}], 'type': 'physical',
'name': 'eth9', 'mac_address': '42:42:42:42:42:42'}]}
def fake_network_config():
return net_cfg, NetworkConfigSource.fallback
m_macs.return_value = {'42:42:42:42:42:42': 'eth9'}
self.init._find_networking_config = fake_network_config
self.init.datasource = FakeDataSource(paths=self.init.paths)
self.init.datasource.update_events = {'network': [EventType.BOOT]}
self.init.apply_network_config(True)
self.init.distro.apply_network_config_names.assert_called_with(net_cfg)
self.init.distro.apply_network_config.assert_called_with(
net_cfg, bring_up=True)
# vi: ts=4 expandtab
|
