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
|
#!/usr/bin/python3
#
# Copyright (C) 2020 Canonical, Ltd.
# Author: Lukas Märdian <lukas.maerdian@canonical.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 3.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import unittest
import tempfile
import glob
import netifaces
import netplan.cli.utils as utils
from unittest.mock import patch
DEVICES = ['eth0', 'eth1', 'ens3', 'ens4', 'br0']
# Consider switching to something more standard, like MockProc
class MockCmd:
"""MockCmd will mock a given command name and capture all calls to it"""
def __init__(self, name):
self._tmp = tempfile.TemporaryDirectory()
self.name = name
self.path = os.path.join(self._tmp.name, name)
self.call_log = os.path.join(self._tmp.name, "call.log")
with open(self.path, "w") as fp:
fp.write("""#!/bin/bash
printf "%%s" "$(basename "$0")" >> %(log)s
printf '\\0' >> %(log)s
for arg in "$@"; do
printf "%%s" "$arg" >> %(log)s
printf '\\0' >> %(log)s
done
printf '\\0' >> %(log)s
""" % {'log': self.call_log})
os.chmod(self.path, 0o755)
def calls(self):
"""
calls() returns the calls to the given mock command in the form of
[ ["cmd", "call1-arg1"], ["cmd", "call2-arg1"], ... ]
"""
with open(self.call_log) as fp:
b = fp.read()
calls = []
for raw_call in b.rstrip("\0\0").split("\0\0"):
call = raw_call.rstrip("\0")
calls.append(call.split("\0"))
return calls
def set_output(self, output):
with open(self.path, "a") as fp:
fp.write("cat << EOF\n%s\nEOF" % output)
def set_timeout(self, timeout_dsec=10):
with open(self.path, "a") as fp:
fp.write("""
if [[ "$*" == *try* ]]
then
ACTIVE=1
trap 'ACTIVE=0' SIGUSR1
trap 'ACTIVE=0' SIGINT
while (( $ACTIVE > 0 )) && (( $ACTIVE <= {} ))
do
ACTIVE=$(($ACTIVE+1))
sleep 0.1
done
fi
""".format(timeout_dsec))
def set_returncode(self, returncode):
with open(self.path, "a") as fp:
fp.write("exit %d" % returncode)
class TestUtils(unittest.TestCase):
def setUp(self):
self.workdir = tempfile.TemporaryDirectory()
os.makedirs(os.path.join(self.workdir.name, 'etc/netplan'))
os.makedirs(os.path.join(self.workdir.name,
'run/NetworkManager/system-connections'))
def _create_nm_keyfile(self, filename, ifname):
with open(os.path.join(self.workdir.name,
'run/NetworkManager/system-connections/', filename), 'w') as f:
f.write('[connection]\n')
f.write('key=value\n')
f.write('interface-name=%s\n' % ifname)
f.write('key2=value2\n')
def test_nm_interfaces(self):
self._create_nm_keyfile('netplan-test.nmconnection', 'eth0')
self._create_nm_keyfile('netplan-test2.nmconnection', 'eth1')
ifaces = utils.nm_interfaces(glob.glob(os.path.join(self.workdir.name,
'run/NetworkManager/system-connections/*.nmconnection')),
DEVICES)
self.assertTrue('eth0' in ifaces)
self.assertTrue('eth1' in ifaces)
self.assertTrue(len(ifaces) == 2)
def test_nm_interfaces_globbing(self):
self._create_nm_keyfile('netplan-test.nmconnection', 'eth?')
ifaces = utils.nm_interfaces(glob.glob(os.path.join(self.workdir.name,
'run/NetworkManager/system-connections/*.nmconnection')),
DEVICES)
self.assertTrue('eth0' in ifaces)
self.assertTrue('eth1' in ifaces)
self.assertTrue(len(ifaces) == 2)
def test_nm_interfaces_globbing2(self):
self._create_nm_keyfile('netplan-test.nmconnection', 'e*')
ifaces = utils.nm_interfaces(glob.glob(os.path.join(self.workdir.name,
'run/NetworkManager/system-connections/*.nmconnection')),
DEVICES)
self.assertTrue('eth0' in ifaces)
self.assertTrue('eth1' in ifaces)
self.assertTrue('ens3' in ifaces)
self.assertTrue('ens4' in ifaces)
self.assertTrue(len(ifaces) == 4)
def test_find_matching_iface_too_many(self):
# too many matches
iface = utils.find_matching_iface(DEVICES, {'name': 'e*'})
self.assertEqual(iface, None)
@patch('netplan.cli.utils.get_interface_macaddress')
def test_find_matching_iface(self, gim):
# we mock-out get_interface_macaddress to return useful values for the test
gim.side_effect = lambda x: '00:01:02:03:04:05' if x == 'eth1' else '00:00:00:00:00:00'
match = {'name': 'e*', 'macaddress': '00:01:02:03:04:05'}
iface = utils.find_matching_iface(DEVICES, match)
self.assertEqual(iface, 'eth1')
@patch('netplan.cli.utils.get_interface_driver_name')
def test_find_matching_iface_name_and_driver(self, gidn):
# we mock-out get_interface_driver_name to return useful values for the test
gidn.side_effect = lambda x: 'foo' if x == 'ens4' else 'bar'
match = {'name': 'ens?', 'driver': 'f*'}
iface = utils.find_matching_iface(DEVICES, match)
self.assertEqual(iface, 'ens4')
@patch('netifaces.ifaddresses')
def test_interface_macaddress(self, ifaddr):
ifaddr.side_effect = lambda _: {netifaces.AF_LINK: [{'addr': '00:01:02:03:04:05'}]}
self.assertEqual(utils.get_interface_macaddress('eth42'), '00:01:02:03:04:05')
@patch('netifaces.ifaddresses')
def test_interface_macaddress_empty(self, ifaddr):
ifaddr.side_effect = lambda _: {}
self.assertEqual(utils.get_interface_macaddress('eth42'), '')
def test_netplan_get_filename_by_id(self):
file_a = os.path.join(self.workdir.name, 'etc/netplan/a.yaml')
file_b = os.path.join(self.workdir.name, 'etc/netplan/b.yaml')
with open(file_a, 'w') as f:
f.write('network:\n ethernets:\n id_a:\n dhcp4: true')
with open(file_b, 'w') as f:
f.write('network:\n ethernets:\n id_b:\n dhcp4: true\n id_a:\n dhcp4: true')
# netdef:b can only be found in b.yaml
basename = os.path.basename(utils.netplan_get_filename_by_id('id_b', self.workdir.name))
self.assertEqual(basename, 'b.yaml')
# netdef:a is defined in a.yaml, overriden by b.yaml
basename = os.path.basename(utils.netplan_get_filename_by_id('id_a', self.workdir.name))
self.assertEqual(basename, 'b.yaml')
def test_netplan_get_filename_by_id_no_files(self):
self.assertIsNone(utils.netplan_get_filename_by_id('some-id', self.workdir.name))
def test_netplan_get_filename_by_id_invalid(self):
file = os.path.join(self.workdir.name, 'etc/netplan/a.yaml')
with open(file, 'w') as f:
f.write('''network:
tunnels:
id_a:
mode: sit
local: 0.0.0.0
remote: 0.0.0.0
key: 0.0.0.0''')
self.assertIsNone(utils.netplan_get_filename_by_id('some-id', self.workdir.name))
def test_systemctl(self):
self.mock_systemctl = MockCmd('systemctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_systemctl.path) + os.pathsep + path_env
utils.systemctl('start', ['service1', 'service2'])
self.assertEquals(self.mock_systemctl.calls(), [['systemctl', 'start', '--no-block', 'service1', 'service2']])
def test_networkd_interfaces(self):
self.mock_networkctl = MockCmd('networkctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_networkctl.path) + os.pathsep + path_env
self.mock_networkctl.set_output('''
1 lo loopback carrier unmanaged
2 ens3 ether routable configured
3 wlan0 wlan routable configuring
174 wwan0 wwan off linger''')
res = utils.networkd_interfaces()
self.assertEquals(self.mock_networkctl.calls(), [['networkctl', '--no-pager', '--no-legend']])
self.assertIn('wlan0', res)
self.assertIn('ens3', res)
def test_networkctl_reconfigure(self):
self.mock_networkctl = MockCmd('networkctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_networkctl.path) + os.pathsep + path_env
utils.networkctl_reconfigure(['eth0', 'eth1'])
self.assertEquals(self.mock_networkctl.calls(), [
['networkctl', 'reload'],
['networkctl', 'reconfigure', 'eth0', 'eth1']
])
def test_is_nm_snap_enabled(self):
self.mock_cmd = MockCmd('systemctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
self.assertTrue(utils.is_nm_snap_enabled())
self.assertEquals(self.mock_cmd.calls(), [
['systemctl', '--quiet', 'is-enabled', 'snap.network-manager.networkmanager.service']
])
def test_is_nm_snap_enabled_false(self):
self.mock_cmd = MockCmd('systemctl')
self.mock_cmd.set_returncode(1)
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
self.assertFalse(utils.is_nm_snap_enabled())
self.assertEquals(self.mock_cmd.calls(), [
['systemctl', '--quiet', 'is-enabled', 'snap.network-manager.networkmanager.service']
])
def test_systemctl_network_manager(self):
self.mock_cmd = MockCmd('systemctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
utils.systemctl_network_manager('start')
self.assertEquals(self.mock_cmd.calls(), [
['systemctl', '--quiet', 'is-enabled', 'snap.network-manager.networkmanager.service'],
['systemctl', 'start', '--no-block', 'snap.network-manager.networkmanager.service']
])
def test_systemctl_is_active(self):
self.mock_cmd = MockCmd('systemctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
self.assertTrue(utils.systemctl_is_active('some.service'))
self.assertEquals(self.mock_cmd.calls(), [
['systemctl', '--quiet', 'is-active', 'some.service']
])
def test_systemctl_is_active_false(self):
self.mock_cmd = MockCmd('systemctl')
self.mock_cmd.set_returncode(1)
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
self.assertFalse(utils.systemctl_is_active('some.service'))
self.assertEquals(self.mock_cmd.calls(), [
['systemctl', '--quiet', 'is-active', 'some.service']
])
def test_systemctl_daemon_reload(self):
self.mock_cmd = MockCmd('systemctl')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
utils.systemctl_daemon_reload()
self.assertEquals(self.mock_cmd.calls(), [
['systemctl', 'daemon-reload']
])
def test_ip_addr_flush(self):
self.mock_cmd = MockCmd('ip')
path_env = os.environ['PATH']
os.environ['PATH'] = os.path.dirname(self.mock_cmd.path) + os.pathsep + path_env
utils.ip_addr_flush('eth42')
self.assertEquals(self.mock_cmd.calls(), [
['ip', 'addr', 'flush', 'eth42']
])
|
