forked from Backblaze/B2_Command_Line_Tool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
noxfile.py
547 lines (444 loc) · 17.6 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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
######################################################################
#
# File: noxfile.py
#
# Copyright 2020 Backblaze Inc. All Rights Reserved.
#
# License https://www.backblaze.com/using_b2_code.html
#
######################################################################
import datetime
import hashlib
import os
import pathlib
import platform
import string
import subprocess
from glob import glob
from typing import List, Tuple
import nox
import pkg_resources
CI = os.environ.get('CI') is not None
CD = CI and (os.environ.get('CD') is not None)
INSTALL_SDK_FROM = os.environ.get('INSTALL_SDK_FROM')
NO_STATICX = os.environ.get('NO_STATICX') is not None
NOX_PYTHONS = os.environ.get('NOX_PYTHONS')
PYTHON_VERSIONS = [
'3.7',
'3.8',
'3.9',
'3.10',
'3.11',
] if NOX_PYTHONS is None else NOX_PYTHONS.split(',')
PYTHON_DEFAULT_VERSION = PYTHON_VERSIONS[-1]
PY_PATHS = ['b2', 'test', 'noxfile.py', 'setup.py']
DOCKER_TEMPLATE = pathlib.Path('./Dockerfile.template')
FILES_USED_IN_TESTS = ['README.md', 'CHANGELOG.md']
SYSTEM = platform.system().lower()
REQUIREMENTS_FORMAT = ['yapf==0.27', 'ruff==0.0.272']
REQUIREMENTS_LINT = REQUIREMENTS_FORMAT + ['pytest==6.2.5', 'liccheck==0.6.2']
REQUIREMENTS_TEST = [
"pexpect==4.8.0",
"pytest==6.2.5",
"pytest-cov==3.0.0",
'pytest-xdist==2.5.0',
'backoff==2.1.2',
'more_itertools==8.13.0',
]
REQUIREMENTS_BUILD = ['setuptools>=20.2']
REQUIREMENTS_BUNDLE = [
'pyinstaller~=5.12',
"patchelf-wrapper==1.2.0;platform_system=='Linux'",
"staticx~=0.13.9;platform_system=='Linux'",
]
WINDOWS_TIMESTAMP_SERVER = 'http://timestamp.digicert.com'
WINDOWS_SIGNTOOL_PATH = 'C:/Program Files (x86)/Windows Kits/10/bin/10.0.17763.0/x86/signtool.exe'
nox.options.reuse_existing_virtualenvs = True
nox.options.sessions = [
'lint',
'test',
]
run_kwargs = {}
# In CI, use Python interpreter provided by GitHub Actions
if CI:
nox.options.force_venv_backend = 'none'
# Inside the CI we need to silence most of the outputs to be able to use GITHUB_OUTPUT properly.
# Nox passes `stderr` and `stdout` directly to subprocess.Popen.
run_kwargs = dict(
stderr=subprocess.DEVNULL,
stdout=subprocess.DEVNULL,
)
def install_myself(session, extras=None):
"""Install from the source."""
arg = '.'
if extras:
arg += '[%s]' % ','.join(extras)
# `--no-install` works only on `run_always` in case where there is a virtualenv available.
# This is to be used also on the docker image during tests, where we have no venv, thus
# we're ensuring that `--no-install` doesn't work on this installation.
# Internal member is used, as there is no public interface for fetching options.
if not session._runner.global_config.no_install: # noqa
session.run('pip', 'install', '-e', arg, **run_kwargs)
if INSTALL_SDK_FROM:
cwd = os.getcwd()
os.chdir(INSTALL_SDK_FROM)
session.run('pip', 'uninstall', 'b2sdk', '-y')
session.run('python', 'setup.py', 'develop')
os.chdir(cwd)
elif CI and not CD:
# In CI, install B2 SDK from the master branch
session.run(
'pip', 'install', 'git+https://github.com/Backblaze/b2-sdk-python.git#egg=b2sdk',
**run_kwargs
)
@nox.session(name='format', python=PYTHON_DEFAULT_VERSION)
def format_(session):
"""Lint the code and apply fixes in-place whenever possible."""
session.run('pip', 'install', *REQUIREMENTS_FORMAT)
# TODO: incremental mode for yapf
session.run('yapf', '--in-place', '--parallel', '--recursive', *PY_PATHS)
session.run('ruff', 'check', '--fix', *PY_PATHS)
# session.run(
# 'docformatter',
# '--in-place',
# '--recursive',
# '--wrap-summaries=100',
# '--wrap-descriptions=100',
# *PY_PATHS,
# )
@nox.session(python=PYTHON_DEFAULT_VERSION)
def lint(session):
"""Run linters in readonly mode."""
install_myself(session)
session.run('pip', 'install', *REQUIREMENTS_LINT)
session.run('yapf', '--diff', '--parallel', '--recursive', *PY_PATHS)
session.run('ruff', 'check', *PY_PATHS)
# session.run(
# 'docformatter',
# '--check',
# '--recursive',
# '--wrap-summaries=100',
# '--wrap-descriptions=100',
# *PY_PATHS,
# )
session.run('pytest', 'test/static')
# Before checking licenses, create an updated requirements.txt file, which accepts any b2sdk version. This way
# the tool will still work if the SDK was installed from the master branch or a different directory.
updated_requirements = os.path.join(session.create_tmp(), 'requirements.txt')
with open('requirements.txt') as orig_req_file, \
open(updated_requirements, 'w') as updated_req_file:
requirements = pkg_resources.parse_requirements(orig_req_file)
for requirement in requirements:
if requirement.project_name == "b2sdk":
updated_req_file.write("b2sdk\n")
else:
updated_req_file.write(f"{requirement}\n")
session.run('liccheck', '-s', 'setup.cfg', '-r', updated_requirements)
@nox.session(python=PYTHON_VERSIONS)
def unit(session):
"""Run unit tests."""
install_myself(session, ['license'])
session.run('pip', 'install', *REQUIREMENTS_TEST)
session.run(
'pytest',
'-n',
'auto',
'--cov=b2',
'--cov-branch',
'--cov-report=xml',
'--doctest-modules',
*session.posargs,
'test/unit',
)
if not session.posargs:
session.notify('cover')
@nox.session(python=PYTHON_VERSIONS)
def integration(session):
"""Run integration tests."""
install_myself(session, ['license'])
session.run('pip', 'install', *REQUIREMENTS_TEST)
session.run(
'pytest',
'-s',
'-n',
'auto',
'--log-level',
'INFO',
'-W',
'ignore::DeprecationWarning:rst2ansi.visitor:',
*session.posargs,
'test/integration',
)
@nox.session(python=PYTHON_VERSIONS)
def test(session):
"""Run all tests."""
if session.python:
session.notify(f'unit-{session.python}')
session.notify(f'integration-{session.python}')
else:
session.notify('unit')
session.notify('integration')
@nox.session(python=PYTHON_DEFAULT_VERSION)
def cleanup_buckets(session):
"""Remove buckets from previous test runs."""
install_myself(session)
session.run('pip', 'install', *REQUIREMENTS_TEST)
session.run('pytest', '-s', '-x', *session.posargs, 'test/integration/cleanup_buckets.py')
@nox.session
def cover(session):
"""Perform coverage analysis."""
session.run('pip', 'install', 'coverage')
session.run('coverage', 'report', '--fail-under=75', '--show-missing', '--skip-covered')
session.run('coverage', 'erase')
@nox.session(python=PYTHON_DEFAULT_VERSION)
def build(session):
"""Build the distribution."""
# TODO: consider using wheel as well
session.run('pip', 'install', *REQUIREMENTS_BUILD, **run_kwargs)
session.run('nox', '-s', 'dump_license', '-fb', 'venv', **run_kwargs)
session.run('python', 'setup.py', 'check', '--metadata', '--strict', **run_kwargs)
session.run('rm', '-rf', 'build', 'dist', 'b2.egg-info', external=True, **run_kwargs)
session.run('python', 'setup.py', 'sdist', *session.posargs, **run_kwargs)
# Set outputs for GitHub Actions
if CI:
# Path have to be specified with unix style slashes even for windows,
# otherwise glob won't find files on windows in action-gh-release.
print('asset_path=dist/*')
version = os.environ['GITHUB_REF'].replace('refs/tags/v', '')
print(f'version={version}')
@nox.session(python=PYTHON_DEFAULT_VERSION)
def dump_license(session: nox.Session):
install_myself(session, ['license'])
session.run('b2', 'license', '--dump', '--with-packages')
@nox.session(python=PYTHON_DEFAULT_VERSION)
def bundle(session: nox.Session):
"""Bundle the distribution."""
session.run('pip', 'install', *REQUIREMENTS_BUNDLE, **run_kwargs)
session.run('rm', '-rf', 'build', 'dist', 'b2.egg-info', external=True, **run_kwargs)
install_myself(session, ['license'])
session.run('b2', 'license', '--dump', '--with-packages', **run_kwargs)
session.run('pyinstaller', *session.posargs, 'b2.spec', **run_kwargs)
if SYSTEM == 'linux' and not NO_STATICX:
session.run(
'staticx', '--no-compress', '--strip', '--loglevel', 'INFO', 'dist/b2',
'dist/b2-static', **run_kwargs
)
session.run('mv', '-f', 'dist/b2-static', 'dist/b2', external=True, **run_kwargs)
# Set outputs for GitHub Actions
if CI:
# Path have to be specified with unix style slashes even for windows,
# otherwise glob won't find files on windows in action-gh-release.
print('asset_path=dist/*')
executable = str(next(pathlib.Path('dist').glob('*')))
print(f'sut_path={executable}')
@nox.session(python=False)
def sign(session):
"""Sign the bundled distribution (macOS and Windows only)."""
def sign_windows(cert_file, cert_password):
session.run('certutil', '-f', '-p', cert_password, '-importpfx', cert_file, **run_kwargs)
session.run(
WINDOWS_SIGNTOOL_PATH,
'sign',
'/f',
cert_file,
'/p',
cert_password,
'/tr',
WINDOWS_TIMESTAMP_SERVER,
'/td',
'sha256',
'/fd',
'sha256',
'dist/b2.exe',
external=True,
**run_kwargs
)
session.run(
WINDOWS_SIGNTOOL_PATH,
'verify',
'/pa',
'/all',
'dist/b2.exe',
external=True,
**run_kwargs
)
if SYSTEM == 'windows':
try:
certificate_file, certificate_password = session.posargs
except ValueError:
session.error('pass the certificate file and the password as positional arguments')
return
sign_windows(certificate_file, certificate_password)
elif SYSTEM == 'linux':
session.log('signing is not supported for Linux')
else:
session.error(f'unrecognized platform: {SYSTEM}')
# Append OS name to the binary
asset_old_path = glob('dist/*')[0]
name, ext = os.path.splitext(os.path.basename(asset_old_path))
asset_path = f'dist/{name}-{SYSTEM}{ext}'
session.run('mv', '-f', asset_old_path, asset_path, external=True, **run_kwargs)
# Set outputs for GitHub Actions
if CI:
# Path have to be specified with unix style slashes even for windows,
# otherwise glob won't find files on windows in action-gh-release.
print('asset_path=dist/*')
def _calculate_hashes(
file_path: pathlib.Path,
algorithms: List[str],
) -> List['hashlib._Hash']: # noqa
read_size = 1024 * 1024
hash_structures = [hashlib.new(algo) for algo in algorithms]
with open(file_path, 'rb') as f:
while True:
buffer = f.read(read_size)
if not buffer:
break
for hash_struct in hash_structures:
hash_struct.update(buffer)
return hash_structures
def _save_hashes(output_file: pathlib.Path, hashes: List['hashlib._Hash']) -> None: # noqa
longest_algo_name = max([len(elem.name) for elem in hashes])
line_format = '{algo:<%s} {hash_value}' % longest_algo_name
output_lines = []
for hash_struct in hashes:
hash_value = hash_struct.hexdigest()
output_lines.append(line_format.format(algo=hash_struct.name, hash_value=hash_value))
output_file.write_bytes('\n'.join(output_lines).encode('ascii'))
@nox.session(python=PYTHON_DEFAULT_VERSION)
def make_dist_digest(_session):
wanted_algos = ['sha256', 'sha512', 'sha3_256', 'sha3_512']
available_algos = [algo for algo in wanted_algos if algo in hashlib.algorithms_available]
directory = pathlib.Path('dist')
glob_match = '*'
hashes_file_suffix = '_hashes'
did_find_any_file = False
for dist_file in directory.glob(glob_match):
if dist_file.stem.endswith(hashes_file_suffix):
continue
hashes_list = _calculate_hashes(dist_file, available_algos)
output_file = dist_file.with_stem(dist_file.name + hashes_file_suffix).with_suffix('.txt')
_save_hashes(output_file, hashes_list)
did_find_any_file = True
if not did_find_any_file:
raise RuntimeError(
f'No file found in {str(directory / glob_match)}, but was expected to find some.'
)
@nox.session(python=PYTHON_DEFAULT_VERSION)
def doc(session):
"""Build the documentation."""
install_myself(session, extras=['doc'])
session.cd('doc')
sphinx_args = ['-b', 'html', '-T', '-W', 'source', 'build/html']
session.run('rm', '-rf', 'build', external=True)
if not session.interactive:
session.run('sphinx-build', *sphinx_args)
session.notify('doc_cover')
else:
sphinx_args[-2:-2] = [
'-E', '--open-browser', '--watch', '../b2', '--ignore', '*.pyc', '--ignore', '*~'
]
session.run('sphinx-autobuild', *sphinx_args)
@nox.session
def doc_cover(session):
"""Perform coverage analysis for the documentation."""
install_myself(session, extras=['doc'])
session.cd('doc')
sphinx_args = ['-b', 'coverage', '-T', '-W', 'source', 'build/coverage']
report_file = 'build/coverage/python.txt'
session.run('sphinx-build', *sphinx_args)
session.run('cat', report_file, external=True)
with open('build/coverage/python.txt') as fd:
# If there is no undocumented files, the report should have only 2 lines (header)
if sum(1 for _ in fd) != 2:
session.error('sphinx coverage has failed')
def _read_readme_name_and_description() -> Tuple[str, str]:
"""
Get name and the description from the readme. First line is assumed to be the project name,
second contains list of all different checks. Third one and the following contains some description.
We assume that description can be multiline, and it ends with an empty line.
An example of the content from README.md can look like this:
..note:
# B2 Command Line Tool
[![Continuous Integration](https://github.com/Backblaze/B2_Command_Line_Tool/ ... (a very long line)
(a few empty lines)
The command-line tool that gives easy access to all of the capabilities of B2 Cloud Storage.
This program provides command-line access to the B2 service.
From this we should parse the following:
"B2 Command Line Tool" as the name and
"The command-line tool that gives easy access to all of the capabilities of B2 Cloud Storage." as the description.
"""
with open('README.md') as f:
non_empty_lines = 0
full_name = None
description_parts = []
for line_with_ends in f.readlines():
line = line_with_ends.strip()
if len(line) == 0:
# If we found an empty line after we got anything for our description – finish.
if len(description_parts) > 0:
break
continue
non_empty_lines += 1
if non_empty_lines == 1:
# Markdown header starts with some "# ", we strip everything up to first space.
full_name = line.split(' ', maxsplit=1)[1]
if non_empty_lines < 3:
continue
description_parts.append(line)
return full_name, ' '.join(description_parts)
@nox.session(python=PYTHON_DEFAULT_VERSION)
def docker(session):
"""Build the docker image."""
build(session)
install_myself(session)
# This string is like `b2 command line tool, version <sem-ver-string>`
version = session.run('b2', 'version', silent=True).split(' ')[-1].strip()
dist_path = 'dist'
tests_image_dir = '/test'
tests_path = 'test/'
full_name, description = _read_readme_name_and_description()
vcs_ref = session.run("git", "rev-parse", "HEAD", external=True, silent=True).strip()
built_distribution = list(pathlib.Path('.').glob(f'{dist_path}/*'))[0]
username = 'b2'
template_mapping = dict(
username='b2',
homedir=f'/{username}',
python_version=session.python,
vendor='Backblaze',
name=full_name,
description=description,
version=version,
url='https://www.backblaze.com',
# TODO: consider fetching it from `git ls-remote --get-url origin`
vcs_url='https://github.com/Backblaze/B2_Command_Line_Tool',
vcs_ref=vcs_ref,
build_date=datetime.datetime.utcnow().isoformat(),
tests_image_dir=tests_image_dir,
tests_path=tests_path,
tar_path=dist_path,
tar_name=built_distribution.name,
files_used_by_tests='\n'.join([f'COPY {filename} .' for filename in FILES_USED_IN_TESTS])
)
template_file = DOCKER_TEMPLATE.read_text()
template = string.Template(template_file)
dockerfile = template.substitute(template_mapping)
pathlib.Path('./Dockerfile').write_text(dockerfile)
@nox.session(python=PYTHON_DEFAULT_VERSION)
def docker_test(session):
"""Run unittests against the docker image."""
docker(session)
image_tag = 'b2:test'
session.run('docker', 'build', '-t', image_tag, '--target', 'test', '.', external=True)
docker_test_run = [
'docker',
'run',
'--rm',
'-e',
'B2_TEST_APPLICATION_KEY',
'-e',
'B2_TEST_APPLICATION_KEY_ID',
image_tag,
]
session.run(*docker_test_run, 'unit', external=True)
session.run(*docker_test_run, 'integration', '--', '--cleanup', external=True)