-
-
Notifications
You must be signed in to change notification settings - Fork 248
/
noxfile.py
376 lines (315 loc) · 10.4 KB
/
noxfile.py
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
import getpass
import json
import os
import subprocess
import sys
import nox
nox.options.envdir = f'./.nox-{getpass.getuser()}'
nox.options.reuse_existing_virtualenvs = False
nox.options.sessions = [
'linter',
'repo',
'unit',
'lab',
'neutron',
'integration',
'linux-python3.9',
'linux-python3.10',
'linux-python3.11',
'linux-python3.12',
'core-python3.10',
'core-python3.11',
'core-python3.12',
'minimal',
]
linux_kernel_modules = [
'dummy',
'bonding',
'8021q',
'mpls_router',
'mpls_iptunnel',
'l2tp_ip',
'l2tp_eth',
'l2tp_netlink',
]
def add_session_config(func):
'''Decorator to load the session config.
Usage::
@nox.session
@load_session_config
def my_session_func(session, config):
pass
Command line usage::
nox -e my_session_name -- '{"option": value}'
The session config must be a valid JSON dictionary of options.
'''
def wrapper(session):
if session.posargs and len(session.posargs[0]) > 0:
config = json.loads(session.posargs[0])
else:
config = {}
session.debug(f'session config: {config}')
return func(session, config)
wrapper.__name__ = func.__name__
wrapper.__doc__ = func.__doc__
wrapper.__has_user_config__ = True
return wrapper
def options(module, config):
'''Return pytest options set.'''
ret = [
'python',
'-m',
'pytest',
'--basetemp',
'./log',
'--junitxml=junit.xml',
]
timeout = 60
if config.get('exitfirst', True):
ret.append('--exitfirst')
if config.get('verbose', True):
ret.append('--verbose')
if config.get('fail_on_warnings'):
ret.insert(1, 'error')
ret.insert(1, '-W')
if config.get('timeout'):
timeout = config["timeout"]
ret.append(f'--timeout={timeout}')
if config.get('pdb'):
ret.append('--pdb')
if config.get('coverage'):
ret.append('--cov-report=html')
ret.append('--cov=pyroute2')
if config.get('tests_prefix'):
module = f'{config["tests_prefix"]}/{module}'
if config.get('sub'):
module = f'{module}/{config["sub"]}'
ret.append(module)
return ret
def setup_linux(session):
'''Setup a Linux system.
Load all the modules, but ignore any errors: missing kernel API
will be handled at the test module level. Same for sysctl.
'''
if sys.platform == 'linux' and getpass.getuser() == 'root':
for module in linux_kernel_modules:
session.run(
'modprobe', module, external=True, success_codes=[0, 1]
)
session.run(
'sysctl',
'net.mpls.platform_labels=2048',
external=True,
success_codes=[0, 255],
)
def setup_venv_minimal(session, config):
if not config.get('reuse'):
session.install('--upgrade', 'pip')
session.install('build')
session.install('twine')
session.install('-r', 'requirements.dev.txt')
session.install('-r', 'requirements.docs.txt')
session.run('mv', '-f', 'setup.cfg', '.setup.cfg.orig', external=True)
session.run(
'mv', '-f', 'pyroute2/__init__.py', '.init.py.orig', external=True
)
session.run('cp', 'setup.minimal.cfg', 'setup.cfg', external=True)
session.run(
'cp', 'pyroute2/minimal.py', 'pyroute2/__init__.py', external=True
)
session.run('python', '-m', 'build')
session.run('python', '-m', 'twine', 'check', 'dist/*')
session.install('.')
session.run('mv', '-f', '.setup.cfg.orig', 'setup.cfg', external=True)
session.run(
'mv', '-f', '.init.py.orig', 'pyroute2/__init__.py', external=True
)
session.run('rm', '-rf', 'build', external=True)
tmpdir = os.path.abspath(session.create_tmp())
session.run('cp', '-a', 'lab', tmpdir, external=True)
session.run('cp', '-a', 'tests', tmpdir, external=True)
session.run('cp', '-a', 'examples', tmpdir, external=True)
return tmpdir
def setup_venv_common(session, flavour='dev'):
session.install('--upgrade', 'pip')
session.install('-r', f'requirements.{flavour}.txt')
session.install('.')
return os.path.abspath(session.create_tmp())
def setup_venv_dev(session):
tmpdir = setup_venv_common(session)
session.run('cp', '-a', 'tests', tmpdir, external=True)
session.run('cp', '-a', 'examples', tmpdir, external=True)
session.chdir(f'{tmpdir}/tests')
return tmpdir
def setup_venv_repo(session):
tmpdir = setup_venv_common(session, 'repo')
for item in (
('tests', tmpdir),
('noxfile.py', tmpdir),
('VERSION', tmpdir),
('CHANGELOG.rst', tmpdir),
):
session.run('cp', '-a', *item, external=True)
git_ls_files = subprocess.run(
['git', 'ls-files', 'requirements*'], stdout=subprocess.PIPE
)
files = [x.decode('utf-8') for x in git_ls_files.stdout.split()]
for fname in files:
session.run('cp', '-a', fname, tmpdir, external=True)
session.chdir(tmpdir)
return tmpdir
def setup_venv_docs(session):
tmpdir = setup_venv_common(session, 'docs')
session.run('cp', '-a', 'docs', tmpdir, external=True)
session.run('cp', '-a', 'examples', tmpdir, external=True)
[
session.run('cp', src, dst, external=True)
for (src, dst) in (
('README.rst', f'{tmpdir}/docs/general.rst'),
('README.report.rst', f'{tmpdir}/docs/report.rst'),
('README.contribute.rst', f'{tmpdir}/docs/devcontribute.rst'),
('CHANGELOG.rst', f'{tmpdir}/docs/changelog.rst'),
)
]
return tmpdir
@nox.session(name='test-platform')
def test_platform(session):
'''Test platform capabilities. Requires root to run.'''
setup_venv_common(session)
session.run('pyroute2-test-platform')
@nox.session
def docs(session):
'''Generate project docs.'''
tmpdir = setup_venv_docs(session)
cwd = os.path.abspath(os.getcwd())
# man pages
session.chdir(f'{tmpdir}/docs/')
session.run('make', 'man', 'SPHINXOPTS="-W"', external=True)
session.run('cp', '-a', 'man', f'{cwd}/docs/', external=True)
# html
session.chdir(f'{tmpdir}/docs/')
session.run('make', 'html', 'SPHINXOPTS="-W"', external=True)
session.run('cp', '-a', 'html', f'{cwd}/docs/', external=True)
session.run('make', 'doctest', external=True)
session.chdir(cwd)
session.run('bash', 'util/aafigure_mapper.sh', external=True)
#
session.log('8<---------------------------------------------------------')
session.log('compiled docs:')
session.log(f'html pages -> {cwd}/docs/html')
session.log(f'man pages -> {cwd}/docs/man')
@nox.session
def linter(session):
'''Run code checks and linters.'''
session.install('pre-commit')
session.run('pre-commit', 'run', '-a')
@nox.session
@add_session_config
def unit(session, config):
'''Run unit tests.'''
setup_venv_dev(session)
session.run(*options('test_unit', config))
@nox.session
@add_session_config
def decoder(session, config):
'''Run decoder tests.'''
setup_venv_dev(session)
session.run(*options('test_decoder', config))
@nox.session
@add_session_config
def integration(session, config):
'''Run integration tests (lnst, kuryr, ...).'''
setup_venv_dev(session)
session.run(*options('test_integration', config))
@nox.session(python=['python3.9', 'python3.10', 'python3.11', 'python3.12'])
@add_session_config
def linux(session, config):
'''Run Linux functional tests. Requires root to run all the tests.'''
setup_linux(session)
workspace = setup_venv_dev(session)
session.run(
*options('test_linux', config),
env={
'WORKSPACE': workspace,
'SKIPDB': 'postgres',
'PYTHONPATH': f'{workspace}/tests/mocklib',
},
)
@nox.session(python=['python3.10', 'python3.11', 'python3.12'])
@add_session_config
def core(session, config):
'''Run Linux tests in asyncio.'''
setup_linux(session)
workspace = setup_venv_dev(session)
session.run(
*options('test_core', config),
env={
'WORKSPACE': workspace,
'SKIPDB': 'postgres',
'PYTHONPATH': f'{workspace}/tests/mocklib',
},
)
@nox.session
@add_session_config
def minimal(session, config):
'''Run tests on pyroute2.minimal package.'''
tmpdir = setup_venv_minimal(session, config)
session.chdir(f'{tmpdir}/tests')
session.run(*options('test_minimal', config))
@nox.session
@add_session_config
def lab(session, config):
'''Test lab code blocks.'''
workspace = setup_venv_minimal(session, config)
for fname in os.listdir('dist'):
if fname.startswith('pyroute2.minimal') and fname.endswith('whl'):
break
session.run('python', 'util/make_lab_templates.py', fname, external=True)
session.run('make', '-C', 'lab', 'html', external=True)
session.run('cp', f'dist/{fname}', 'lab/_build/html/', external=True)
# make tests
session.chdir(f'{workspace}/tests')
session.run(*options('test_lab', config), env={'WORKSPACE': workspace})
@nox.session
@add_session_config
def openbsd(session, config):
'''Run OpenBSD tests. Requires OpenBSD >= 7.1'''
setup_venv_dev(session)
session.run(*options('test_openbsd', config))
@nox.session
@add_session_config
def windows(session, config):
'''Rin Windows tests.'''
setup_venv_dev(session)
session.run(*options('test_windows', config))
@nox.session
@add_session_config
def neutron(session, config):
'''Run Neutron integration tests.'''
setup_venv_dev(session)
session.run(*options('test_neutron', config))
@nox.session
@add_session_config
def repo(session, config):
'''Run repo tests.'''
setup_venv_repo(session)
config['tests_prefix'] = 'tests'
session.run(*options('test_repo', config))
@nox.session
def build(session):
'''Run package build.'''
session.install('build')
session.install('twine')
session.run('python', '-m', 'build')
session.run('python', '-m', 'twine', 'check', 'dist/*')
@nox.session
@add_session_config
def build_minimal(session, config):
'''Build the minimal package'''
setup_venv_minimal(session, config)
@nox.session
@add_session_config
def upload(session, config):
'''Upload built packages'''
session.install('twine')
session.run('python', '-m', 'twine', 'upload', 'dist/*')