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
|
#
# Functional tests of netplan's keyfile parser that verify that the generated
# YAML files look as expected. These are run during "make check" and
# don't touch the system configuration at all.
#
# Copyright (C) 2021 Canonical, Ltd.
# Author: Lukas Märdian <slyon@ubuntu.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/>.
from configparser import ConfigParser
import netplan
import os
import re
import sys
import shutil
import tempfile
import unittest
import contextlib
import subprocess
exe_generate = os.environ.get('NETPLAN_GENERATE_PATH',
os.path.join(os.path.dirname(os.path.dirname(
os.path.dirname(os.path.abspath(__file__)))), 'generate'))
# make sure we point to libnetplan properly.
os.environ.update({'LD_LIBRARY_PATH': '.:{}'.format(os.environ.get('LD_LIBRARY_PATH'))})
# make sure we fail on criticals
os.environ['G_DEBUG'] = 'fatal-criticals'
WOKE_REPLACE_REGEX = ' +# wokeignore:rule=[a-z]+'
# A contextmanager to catch the output on a low level so that it catches output
# from a subprocess or C library call, in addition to normal python output
@contextlib.contextmanager
def capture_stderr():
stderr_fd = 2 # 2 = stderr
with tempfile.NamedTemporaryFile(mode='w+b') as tmp:
stderr_copy = os.dup(stderr_fd)
try:
sys.stderr.flush()
os.dup2(tmp.fileno(), stderr_fd)
yield tmp
finally:
sys.stderr.flush()
os.dup2(stderr_copy, stderr_fd)
os.close(stderr_copy)
class TestKeyfileBase(unittest.TestCase):
def setUp(self):
self.workdir = tempfile.TemporaryDirectory()
self.confdir = os.path.join(self.workdir.name, 'etc', 'netplan')
self.maxDiff = None
os.makedirs(self.confdir)
def tearDown(self):
shutil.rmtree(self.workdir.name)
super().tearDown()
def generate_from_keyfile(self, keyfile, netdef_id=None, expect_fail=False, filename=None, regenerate=True):
'''Call libnetplan with given keyfile string as configuration'''
# Autodetect default 'NM-<UUID>' netdef-id
ssid = ''
keyfile = re.sub(WOKE_REPLACE_REGEX, '', keyfile)
# calculate the UUID+SSID string
found_values = 0
uuid = 'UNKNOWN_UUID'
ssid = ''
for line in keyfile.splitlines():
if line.startswith('uuid='):
uuid = line.split('=')[1]
found_values += 1
elif line.startswith('ssid='):
ssid += '-' + line.split('=')[1]
found_values += 1
if found_values >= 2:
break
if not netdef_id:
netdef_id = 'NM-' + uuid
yaml_path = os.path.join(self.workdir.name, 'etc', 'netplan', '90-NM-'+uuid+'.yaml')
generated_file = 'netplan-{}{}.nmconnection'.format(netdef_id, ssid)
original_file = filename or generated_file
f = os.path.join(self.workdir.name,
'run/NetworkManager/system-connections/{}'.format(original_file))
os.makedirs(os.path.dirname(f))
# Create the original keyfile that will be parsed by netplan
with open(f, 'w') as file:
file.write(keyfile)
with capture_stderr() as outf:
parser = netplan.Parser()
if expect_fail:
try:
parser.load_keyfile(f)
except netplan.NetplanException as err:
return err.message
else:
ret = parser.load_keyfile(f) # Throws netplan.NetplanExcption on failure
self.assertTrue(ret)
# If the original file does not have a standard netplan-*.nmconnection
# filename it is being deleted in favor of the newly generated file.
# It has been parsed and is not needed anymore in this case
if generated_file != original_file:
os.remove(f)
state = netplan.State()
state.import_parser_results(parser)
with open(yaml_path, 'w') as f:
os.chmod(yaml_path, mode=0o600)
state._dump_yaml(f)
# check re-generated keyfile
if regenerate:
self.assert_nm_regenerate({generated_file: keyfile})
with open(outf.name, 'r') as f:
output = f.read().strip() # output from stderr (fd=2) on C/library level
return output
def assert_netplan(self, file_contents_map):
for uuid in file_contents_map.keys():
file_contents_map[uuid] = re.sub(WOKE_REPLACE_REGEX, '', file_contents_map[uuid])
path = os.path.join(self.confdir, '90-NM-{}.yaml'.format(uuid))
self.assertTrue(os.path.isfile(path))
st = os.stat(path)
permission = oct(st.st_mode & 0o777)
self.assertEqual(permission, '0o600')
with open(os.path.join(self.confdir, '90-NM-{}.yaml'.format(uuid)), 'r') as f:
self.assertEqual(f.read(), file_contents_map[uuid])
def normalize_keyfile(self, file_contents):
parser = ConfigParser()
parser.read_string(file_contents)
sections = parser.sections()
res = []
# Sort sections and keys
sections.sort()
for s in sections:
items = parser.items(s)
if s == 'ipv6' and len(items) == 1 and items[0] == ('method', 'ignore'):
continue
line = '\n[' + s + ']'
res.append(line)
items.sort(key=lambda tup: tup[0])
for k, v in items:
# Normalize lines
if k == 'addr-gen-mode':
v = v.replace('1', 'stable-privacy').replace('0', 'eui64')
elif k == 'ip6-privacy' and v == '0':
continue
elif k == 'wake-on-lan' and v == '1':
continue
elif k == 'stp' and v == 'true':
continue
elif k.startswith('route'):
v = v.replace(',::', ',').replace(',0.0.0.0', ',')
v = v.strip(',')
line = (k + '=' + v).strip(';')
res.append(line)
return '\n'.join(res).strip()+'\n'
def assert_nm_regenerate(self, file_contents_map):
argv = [exe_generate, '--root-dir', self.workdir.name]
p = subprocess.Popen(argv, stdout=subprocess.PIPE,
stderr=subprocess.PIPE, text=True)
returncode = p.wait(5)
(out, err) = p.communicate()
self.assertEqual(returncode, 0, err)
self.assertEqual(out, '')
con_dir = os.path.join(self.workdir.name, 'run', 'NetworkManager', 'system-connections')
if file_contents_map:
self.assertEqual(set(os.listdir(con_dir)),
set([n for n in file_contents_map]))
for fname, contents in file_contents_map.items():
contents = re.sub(WOKE_REPLACE_REGEX, '', contents)
with open(os.path.join(con_dir, fname)) as f:
generated_keyfile = self.normalize_keyfile(f.read())
normalized_contents = self.normalize_keyfile(contents)
self.assertEqual(generated_keyfile, normalized_contents,
'Re-generated keyfile does not match')
else: # pragma: nocover (only needed for test debugging)
if os.path.exists(con_dir):
self.assertEqual(os.listdir(con_dir), [])
return err
|
