-
Notifications
You must be signed in to change notification settings - Fork 544
/
ci_build.py
executable file
·803 lines (642 loc) · 30.3 KB
/
ci_build.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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
#!/usr/bin/env python3
"""
CI build script
(C) 2017-2022 Jack Lloyd
2022-2023 René Meusel - Rohde & Schwarz Cybersecurity
Botan is released under the Simplified BSD License (see license.txt)
"""
import os
import platform
import subprocess
import sys
import time
import tempfile
import optparse # pylint: disable=deprecated-module
import multiprocessing
def get_concurrency():
def_concurrency = 2
max_concurrency = 16
try:
return min(max_concurrency, multiprocessing.cpu_count())
except ImportError:
return def_concurrency
def known_targets():
return [
'amalgamation',
'bsi',
'codeql',
'coverage',
'cross-android-arm32',
'cross-android-arm64',
'cross-android-arm64-amalgamation',
'cross-arm32',
'cross-arm32-baremetal',
'cross-arm64',
'cross-arm64-amalgamation',
'cross-i386',
'cross-ios-arm64',
'cross-mips64',
'cross-ppc32',
'cross-ppc64',
'cross-s390x',
'cross-riscv64',
'cross-win64',
'docs',
'emscripten',
'examples',
'format',
'fuzzers',
'hybrid-tls13-interop-test',
'lint',
'minimized',
'nist',
'sanitizer',
'shared',
'static',
'valgrind',
'valgrind-full',
]
def is_running_in_github_actions():
return os.environ.get("GITHUB_ACTIONS", "false") == "true"
class LoggingGroup:
"""
Context Manager that opportunistically uses GitHub Actions workflow commands
to group all log output inside the managed context into an expandable group.
"""
def __init__(self, group_title):
self.group_title = group_title
def __enter__(self):
if is_running_in_github_actions():
print("::group::%s" % self.group_title)
else:
print("Running '%s' ..." % self.group_title)
sys.stdout.flush()
return is_running_in_github_actions()
def __exit__(self, exc_type, exc_value, exc_tb):
if is_running_in_github_actions():
print("::endgroup::")
def build_targets(target, target_os):
if target in ['shared', 'minimized', 'bsi', 'nist']:
yield 'shared'
elif target in ['static', 'examples', 'fuzzers', 'cross-arm32-baremetal', 'emscripten']:
yield 'static'
elif target_os in ['windows']:
yield 'shared'
elif target_os in ['ios', 'mingw']:
yield 'static'
else:
yield 'shared'
yield 'static'
if target not in ['examples']:
yield 'cli'
yield 'tests'
if target in ['coverage']:
yield 'bogo_shim'
if target in ['sanitizer'] and target_os not in ['windows']:
yield 'bogo_shim'
if target in ['examples']:
yield 'examples'
def determine_flags(target, target_os, target_cpu, target_cc, cc_bin, ccache,
root_dir, build_dir, test_results_dir, pkcs11_lib, use_gdb,
disable_werror, extra_cxxflags, disabled_tests):
"""
Return the configure.py flags as well as make/test running prefixes
"""
is_cross_target = target.startswith('cross-')
if target_os not in ['linux', 'osx', 'windows', 'freebsd']:
print('Error unknown OS %s' % (target_os))
return (None, None, None)
if is_cross_target:
if target_os == 'osx':
target_os = 'ios'
elif target == 'cross-win64':
target_os = 'mingw'
elif target in ['cross-android-arm32', 'cross-android-arm64', 'cross-android-arm64-amalgamation']:
target_os = 'android'
if target_os == 'windows' and target_cc == 'gcc':
target_os = 'mingw'
if target == 'cross-arm32-baremetal':
target_os = 'none'
if target == 'emscripten':
target_os = 'emscripten'
make_prefix = []
test_prefix = []
test_cmd = [os.path.join(build_dir, 'botan-test'),
'--data-dir=%s' % os.path.join(root_dir, 'src', 'tests', 'data'),
'--run-memory-intensive-tests']
# generate JUnit test report
if test_results_dir:
if not os.path.isdir(test_results_dir):
raise Exception("Test results directory does not exist")
def sanitize_kv(some_string):
return some_string.replace(':', '').replace(',', '')
report_props = {"ci_target": target, "os": target_os}
test_cmd += ['--test-results-dir=%s' % test_results_dir]
test_cmd += ['--report-properties=%s' %
','.join(['%s:%s' % (sanitize_kv(k), sanitize_kv(v)) for k, v in report_props.items()])]
install_prefix = tempfile.mkdtemp(prefix='botan-install-')
flags = ['--prefix=%s' % (install_prefix),
'--cc=%s' % (target_cc),
'--os=%s' % (target_os),
'--build-targets=%s' % ','.join(build_targets(target, target_os)),
'--with-build-dir=%s' % build_dir,
'--link-method=symlink',
'--enable-experimental-features']
if ccache is not None:
flags += ['--no-store-vc-rev', '--compiler-cache=%s' % (ccache)]
if not disable_werror:
flags += ['--werror-mode']
if target_cpu is not None:
flags += ['--cpu=%s' % (target_cpu)]
for flag in extra_cxxflags:
flags += ['--extra-cxxflags=%s' % (flag)]
if target in ['minimized']:
flags += ['--minimized-build', '--enable-modules=system_rng,sha2_32,sha2_64,aes']
if target in ['amalgamation', 'cross-arm64-amalgamation', 'cross-android-arm64-amalgamation']:
flags += ['--amalgamation']
if target in ['bsi', 'nist']:
# tls is optional for bsi/nist but add it so verify tests work with these minimized configs
flags += ['--module-policy=%s' % (target), '--enable-modules=tls12']
if target == 'docs':
flags += ['--with-doxygen', '--with-sphinx', '--with-rst2man']
test_cmd = None
if target == 'codeql':
test_cmd = None
if target == 'hybrid-tls13-interop-test':
test_cmd = None
if target == 'cross-win64':
# this test compiles under MinGW but fails when run under Wine
disabled_tests.append('certstor_system')
if target_os == 'mingw':
# make sure to link against static versions of libstdc++, libgcc* and winpthread
flags += ['--ldflags=-static']
if target == 'coverage':
flags += ['--with-coverage-info']
if target in ['coverage']:
flags += ['--with-debug-info']
if target in ['coverage', 'sanitizer', 'fuzzers']:
flags += ['--unsafe-terminate-on-asserts']
if target in ['valgrind', 'valgrind-full']:
flags += ['--with-valgrind']
test_prefix = ['valgrind', '--error-exitcode=9', '-v', '--leak-check=full', '--show-reachable=yes']
# valgrind is single threaded anyway
test_cmd += ['--test-threads=1']
if target != 'valgrind-full':
# valgrind is slow, so some tests only run in the nightly check
slow_tests = [
'argon2', 'bcrypt', 'bcrypt_pbkdf', 'compression_tests', 'cryptobox',
'dh_invalid', 'dh_kat', 'dh_keygen', 'dl_group_gen', 'dlies',
'dsa_kat_verify', 'dsa_param', 'ecc_basemul', 'ecdsa_verify_wycheproof',
'ed25519_sign', 'elgamal_decrypt', 'elgamal_encrypt', 'elgamal_keygen',
'ffi_dsa', 'ffi_elgamal', 'hash_nist_mc', 'mce_keygen',
'passhash9', 'pbkdf', 'pwdhash', 'rsa_encrypt', 'rsa_pss', 'rsa_pss_raw',
'scrypt', 'srp6_kat', 'srp6_rt', 'unit_tls', 'x509_path_bsi',
'x509_path_rsa_pss', 'xmss_keygen', 'xmss_keygen_reference',
'xmss_sign', 'xmss_verify', 'xmss_verify_invalid' ]
disabled_tests += slow_tests
if target == 'examples':
flags += ['--with-boost']
test_cmd = None
if target == 'fuzzers':
flags += ['--unsafe-fuzzer-mode']
if target in ['fuzzers', 'coverage']:
flags += ['--build-fuzzers=test']
if target in ['fuzzers', 'sanitizer']:
flags += ['--with-debug-asserts']
if target_cc in ['clang', 'gcc']:
flags += ['--enable-sanitizers=address,undefined']
else:
flags += ['--enable-sanitizers=address']
if target in ['valgrind', 'valgrind-full', 'sanitizer', 'fuzzers']:
flags += ['--disable-modules=locking_allocator']
if target == 'emscripten':
flags += ['--cpu=wasm']
# need to find a way to run the wasm-compiled tests w/o a browser
test_cmd = None
if is_cross_target:
if target_os == 'ios':
make_prefix = ['xcrun', '--sdk', 'iphoneos']
test_cmd = None
if target == 'cross-ios-arm64':
flags += ['--cpu=arm64', '--cc-abi-flags=-arch arm64 -stdlib=libc++']
else:
raise Exception("Unknown cross target '%s' for iOS" % (target))
elif target_os == 'android':
ndk = os.getenv('ANDROID_NDK')
if ndk is None:
raise Exception('Android CI build requires ANDROID_NDK env variable be set')
api_lvl = int(os.getenv('ANDROID_API_LEVEL', '0'))
if api_lvl == 0:
# If not set arbitrarily choose API 21 (Android 5.0) for ARMv7 and 31 (Android 12) for AArch64
api_lvl = 21 if target == 'cross-android-arm32' else 31
toolchain_dir = os.path.join(ndk, 'toolchains/llvm/prebuilt/linux-x86_64/bin')
test_cmd = None
if target == 'cross-android-arm32':
cc_bin = os.path.join(toolchain_dir, 'armv7a-linux-androideabi%d-clang++' % (api_lvl))
flags += ['--cpu=armv7',
'--ar-command=%s' % (os.path.join(toolchain_dir, 'llvm-ar'))]
elif target in ['cross-android-arm64', 'cross-android-arm64-amalgamation']:
cc_bin = os.path.join(toolchain_dir, 'aarch64-linux-android%d-clang++' % (api_lvl))
flags += ['--cpu=arm64',
'--ar-command=%s' % (os.path.join(toolchain_dir, 'llvm-ar'))]
if api_lvl < 18:
flags += ['--without-os-features=getauxval']
if api_lvl >= 28:
flags += ['--with-os-features=getentropy']
elif target == 'cross-i386':
flags += ['--cpu=x86_32']
elif target == 'cross-win64':
# MinGW in 16.04 is lacking std::mutex for unknown reason
cc_bin = 'x86_64-w64-mingw32-g++'
flags += ['--cpu=x86_64', '--cc-abi-flags=-static',
'--ar-command=x86_64-w64-mingw32-ar', '--without-os-feature=threads']
test_cmd = [os.path.join(root_dir, 'botan-test.exe')] + test_cmd[1:]
test_prefix = ['wine']
else:
if target == 'cross-arm32':
flags += ['--cpu=armv7', '--extra-cxxflags=-D_FILE_OFFSET_BITS=64']
cc_bin = 'arm-linux-gnueabihf-g++'
test_prefix = ['qemu-arm', '-L', '/usr/arm-linux-gnueabihf/']
# disable a few tests that are exceptionally slow under arm32 qemu
disabled_tests += ['dh_invalid', 'dlies', 'xmss_sign']
elif target in ['cross-arm64', 'cross-arm64-amalgamation']:
flags += ['--cpu=aarch64']
cc_bin = 'aarch64-linux-gnu-g++'
test_prefix = ['qemu-aarch64', '-L', '/usr/aarch64-linux-gnu/']
elif target == 'cross-ppc32':
flags += ['--cpu=ppc32']
cc_bin = 'powerpc-linux-gnu-g++'
test_prefix = ['qemu-ppc', '-L', '/usr/powerpc-linux-gnu/']
elif target == 'cross-ppc64':
flags += ['--cpu=ppc64', '--with-endian=little']
cc_bin = 'powerpc64le-linux-gnu-g++'
test_prefix = ['qemu-ppc64le', '-cpu', 'power10', '-L', '/usr/powerpc64le-linux-gnu/']
elif target == 'cross-riscv64':
flags += ['--cpu=riscv64']
cc_bin = 'riscv64-linux-gnu-g++'
test_prefix = ['qemu-riscv64', '-L', '/usr/riscv64-linux-gnu/']
elif target == 'cross-s390x':
flags += ['--cpu=s390x']
cc_bin = 's390x-linux-gnu-g++'
test_prefix = ['qemu-s390x', '-L', '/usr/s390x-linux-gnu/']
elif target == 'cross-mips64':
flags += ['--cpu=mips64', '--with-endian=big']
cc_bin = 'mips64-linux-gnuabi64-g++'
test_prefix = ['qemu-mips64', '-L', '/usr/mips64-linux-gnuabi64/']
test_cmd.remove('simd_32') # no SIMD on MIPS
elif target in ['cross-arm32-baremetal']:
flags += ['--cpu=arm32', '--disable-neon', '--without-stack-protector', '--ldflags=-specs=nosys.specs']
cc_bin = 'arm-none-eabi-c++'
test_cmd = None
else:
raise Exception("Unknown cross target '%s' for Linux" % (target))
else:
# Flags specific to native targets
if target_os in ['osx', 'linux']:
flags += ['--with-bzip2', '--with-sqlite', '--with-zlib']
if target_os in ['osx', 'ios']:
flags += ['--with-commoncrypto']
def add_boost_support(target, target_os):
if target in ['coverage', 'shared']:
return True
if target == 'sanitizer' and target_os == 'linux':
return True
return False
if add_boost_support(target, target_os):
flags += ['--with-boost']
if target_cc == 'clang':
# make sure clang ignores warnings in boost headers
flags += ["--extra-cxxflags=--system-header-prefix=boost/"]
if 'BOOST_INCLUDEDIR' in os.environ:
# ./configure.py needs boost's location on some platforms
# BOOST_INCLUDEDIR is set by the setup_gh_actions.* script
flags += ['--with-external-includedir', os.environ.get('BOOST_INCLUDEDIR')]
if target_os == 'mingw':
# apparently mingw needs this legacy socket library version for reasons
# as per: https://stackoverflow.com/questions/38770895/how-to-fix-undefined-reference-to-getacceptexsockaddrs-boost-asio-in-clion#comment105791579_38771260
flags += ['--ldflags=-static -lwsock32']
if target_os == 'linux':
flags += ['--with-lzma']
if target in ['coverage']:
flags += ['--with-tpm']
test_cmd += ['--run-online-tests']
if pkcs11_lib and os.access(pkcs11_lib, os.R_OK):
test_cmd += ['--pkcs11-lib=%s' % (pkcs11_lib)]
if target in ['coverage', 'sanitizer']:
test_cmd += ['--run-long-tests']
if target_os == 'windows' and target == 'sanitizer':
# GitHub Actions worker intermittently ran out of memory when
# asked to allocate multi-gigabyte buffers under MSVC's ASan.
test_cmd.remove('--run-memory-intensive-tests')
# MSVC sanitizer produces very slow code causing some of the
# slower tests to take as long as 5 minutes
test_cmd.remove('--run-long-tests')
flags += ['--cc-bin=%s' % (cc_bin)]
if test_cmd is None:
run_test_command = None
else:
if use_gdb:
disabled_tests.append("os_utils")
# render 'disabled_tests' array into test_cmd
if disabled_tests:
test_cmd += ['--skip-tests=%s' % (','.join(disabled_tests))]
if use_gdb:
(cmd, args) = test_cmd[0], test_cmd[1:]
run_test_command = test_prefix + ['gdb', cmd,
'-ex', 'run %s' % (' '.join(args)),
'-ex', 'bt',
'-ex', 'quit']
else:
run_test_command = test_prefix + test_cmd
return flags, run_test_command, make_prefix
def run_cmd(cmd, root_dir, build_dir):
"""
Execute a command, die if it failed
"""
with LoggingGroup(' '.join(cmd)):
start = time.time()
cmd = [os.path.expandvars(elem) for elem in cmd]
sub_env = os.environ.copy()
sub_env['LD_LIBRARY_PATH'] = os.path.abspath(build_dir)
sub_env['DYLD_LIBRARY_PATH'] = os.path.abspath(build_dir)
sub_env['PYTHONPATH'] = os.path.abspath(os.path.join(root_dir, 'src/python'))
cwd = None
redirect_stdout_fd = None
redirect_stdout_fsname = None
if len(cmd) >= 3 and cmd[-2] == '>':
redirect_stdout_fsname = cmd[-1]
redirect_stdout_fd = open(redirect_stdout_fsname, 'w', encoding='utf8')
cmd = cmd[:-2]
if len(cmd) > 1 and cmd[0].startswith('indir:'):
cwd = cmd[0][6:]
cmd = cmd[1:]
while len(cmd) > 1 and cmd[0].startswith('env:') and cmd[0].find('=') > 0:
env_key, env_val = cmd[0][4:].split('=')
sub_env[env_key] = env_val
cmd = cmd[1:]
proc = subprocess.Popen(cmd, cwd=cwd, close_fds=True, env=sub_env, stdout=redirect_stdout_fd)
proc.communicate()
time_taken = int(time.time() - start)
if time_taken > 10:
print("Ran for %d seconds" % (time_taken))
if proc.returncode != 0:
print("Command '%s' failed with error code %d" % (' '.join(cmd), proc.returncode))
if redirect_stdout_fd is not None:
redirect_stdout_fd.close()
last_lines = open(redirect_stdout_fsname, encoding='utf8').readlines()[-100:]
print("%s", ''.join(last_lines))
if cmd[0] not in ['lcov', 'codecov']:
sys.exit(proc.returncode)
def default_os():
platform_os = platform.system().lower()
if platform_os == 'darwin':
return 'osx'
return platform_os
def default_cc():
platform_os = platform.system().lower()
return 'msvc' if platform_os == 'windows' else 'gcc'
def default_make_tool():
platform_os = platform.system().lower()
return 'nmake' if platform_os == 'windows' else 'make'
def parse_args(args):
"""
Parse arguments
"""
parser = optparse.OptionParser()
parser.add_option('--os', default=default_os(),
help='Set the target os (default %default)')
parser.add_option('--cpu', default=None,
help='Specify a target CPU platform')
parser.add_option('--cc', default=default_cc(),
help='Set the target compiler type (default %default)')
parser.add_option('--cc-bin', default=None,
help='Set path to compiler')
parser.add_option('--root-dir', metavar='D', default='.',
help='Set directory to execute from (default %default)')
parser.add_option('--build-dir', metavar='D', default='.',
help='Set directory to place build artifacts into (default %default)')
parser.add_option('--boringssl-dir', metavar='D', default='boringssl',
help='Set directory of BoringSSL checkout to use for BoGo tests')
parser.add_option('--make-tool', metavar='TOOL', default=default_make_tool(),
help='Specify tool to run to build source (default %default)')
parser.add_option('--extra-cxxflags', metavar='FLAGS', default=[], action='append',
help='Specify extra build flags')
parser.add_option('--disabled-tests', metavar='DISABLED_TESTS', default=[], action='append',
help='Comma separated list of tests that should not be run')
parser.add_option('--dry-run', action='store_true', default=False,
help='Just show commands to be executed')
parser.add_option('--build-jobs', metavar='J', default=get_concurrency(),
help='Set number of jobs to run in parallel (default %default)')
parser.add_option('--compiler-cache', default=None, metavar='CC',
help='Set a compiler cache to use (ccache, sccache)')
parser.add_option('--pkcs11-lib', default=os.getenv('PKCS11_LIB'), metavar='LIB',
help='Set PKCS11 lib to use for testing')
parser.add_option('--disable-werror', action='store_true', default=False,
help='Allow warnings to compile')
parser.add_option('--run-under-gdb', dest='use_gdb', action='store_true', default=False,
help='Run test suite under gdb and capture backtrace')
parser.add_option('--test-results-dir', default=None,
help='Directory to store JUnit XML test reports')
return parser.parse_args(args)
def have_prog(prog):
"""
Check if some named program exists in the path
"""
for path in os.environ['PATH'].split(os.pathsep):
exe_file = os.path.join(path, prog)
for ef in [exe_file, exe_file + ".exe"]:
if os.path.exists(ef) and os.access(ef, os.X_OK):
return True
return False
def validate_make_tool(make_tool, build_jobs):
if make_tool == '':
return validate_make_tool('make', build_jobs)
if make_tool not in ['ninja', 'nmake', 'make']:
raise Exception("Don't know about %s as a make tool" % (make_tool))
if make_tool in ['make']:
return make_tool, ['-j%d' % (build_jobs), '-k']
else:
return make_tool, []
def main(args=None):
"""
Parse options, do the things
"""
if os.getenv('COVERITY_SCAN_BRANCH') == '1':
print('Skipping build COVERITY_SCAN_BRANCH set in environment')
return 0
if args is None:
args = sys.argv
print("Invoked as '%s'" % (' '.join(args)))
(options, args) = parse_args(args)
if len(args) != 2:
print('Usage: %s [options] target' % (args[0]))
return 1
target = args[1]
if target not in known_targets():
print("Unknown target '%s'" % (target))
return 2
py_interp = 'python3'
if options.cc_bin is None:
if options.cc == 'gcc':
options.cc_bin = 'g++'
elif options.cc == 'clang':
options.cc_bin = 'clang++'
elif options.cc == 'msvc':
options.cc_bin = 'cl'
elif options.cc == "emcc":
options.cc_bin = "em++"
else:
print('Error unknown compiler %s' % (options.cc))
return 1
if options.compiler_cache is None:
# Autodetect compiler cache
if have_prog('sccache'):
options.compiler_cache = 'sccache'
elif have_prog('ccache'):
options.compiler_cache = 'ccache'
if options.compiler_cache:
print("Found '%s' installed, will use it..." % (options.compiler_cache))
if options.compiler_cache not in [None, 'ccache', 'sccache']:
raise Exception("Don't know about %s as a compiler cache" % (options.compiler_cache))
root_dir = options.root_dir
build_dir = options.build_dir
if not os.access(root_dir, os.R_OK):
raise Exception('Bad root dir setting, dir %s not readable' % (root_dir))
if not os.path.exists(build_dir):
os.makedirs(build_dir)
elif not os.path.isdir(build_dir) or not os.access(build_dir, os.R_OK | os.W_OK):
raise Exception("Bad build dir setting %s is not a directory or not accessible" % (build_dir))
cmds = []
if target == 'lint':
pylint_rc = '--rcfile=%s' % (os.path.join(root_dir, 'src/configs/pylint.rc'))
pylint_flags = [pylint_rc, '--reports=no']
py_scripts = [
'configure.py',
'src/python/botan3.py',
'src/scripts/ci_build.py',
'src/scripts/install.py',
'src/scripts/ci_check_headers.py',
'src/scripts/ci_check_install.py',
'src/scripts/dist.py',
'src/scripts/cleanup.py',
'src/scripts/check.py',
'src/scripts/build_docs.py',
'src/scripts/website.py',
'src/scripts/bench.py',
'src/scripts/test_python.py',
'src/scripts/test_fuzzers.py',
'src/scripts/test_cli.py',
'src/scripts/python_unittests.py',
'src/scripts/python_unittests_unix.py',
'src/scripts/dev_tools/run_clang_format.py',
'src/scripts/dev_tools/run_clang_tidy.py',
'src/editors/vscode/scripts/bogo.py',
'src/editors/vscode/scripts/common.py',
'src/editors/vscode/scripts/test.py']
full_paths = [os.path.join(root_dir, s) for s in py_scripts]
cmds.append([py_interp, '-m', 'pylint'] + pylint_flags + full_paths)
elif target == 'format':
cmds.append([py_interp,
os.path.join(root_dir, 'src/scripts/dev_tools/run_clang_format.py'),
'--clang-format=clang-format-15',
'--src-dir=%s' % (os.path.join(root_dir, 'src')),
'--check'])
else:
if options.test_results_dir:
os.makedirs(options.test_results_dir)
config_flags, run_test_command, make_prefix = determine_flags(
target, options.os, options.cpu, options.cc, options.cc_bin,
options.compiler_cache, root_dir, build_dir, options.test_results_dir,
options.pkcs11_lib, options.use_gdb, options.disable_werror,
options.extra_cxxflags, options.disabled_tests)
make_tool, make_opts = validate_make_tool(options.make_tool, options.build_jobs)
cmds.append([py_interp,
os.path.join(root_dir, 'configure.py')] +
['--build-tool=' + make_tool] +
config_flags)
make_cmd = [make_tool] + make_opts
if build_dir != '.':
make_cmd = ['indir:%s' % build_dir] + [make_tool] + make_opts
if target == 'docs':
cmds.append(make_cmd + ['docs'])
else:
if options.compiler_cache is not None:
cmds.append([options.compiler_cache, '--show-stats'])
make_targets = ['libs', 'tests', 'cli']
if target in ['coverage', 'fuzzers']:
make_targets += ['fuzzer_corpus_zip', 'fuzzers']
if target in ['examples']:
make_targets += ['examples']
if target in ['coverage', 'sanitizer'] and options.os not in ['windows']:
make_targets += ['bogo_shim']
cmds.append(make_prefix + make_cmd + make_targets)
if options.compiler_cache is not None:
cmds.append([options.compiler_cache, '--show-stats'])
if run_test_command is not None:
cmds.append(run_test_command)
if target in ['coverage', 'sanitizer'] and options.os != 'windows':
if not options.boringssl_dir:
raise Exception('coverage build needs --boringssl-dir')
runner_dir = os.path.abspath(os.path.join(options.boringssl_dir, 'ssl', 'test', 'runner'))
cmds.append(['indir:%s' % (runner_dir),
'go', 'test', '-pipe',
'-num-workers', str(4*get_concurrency()),
'-shim-path', os.path.abspath(os.path.join(build_dir, 'botan_bogo_shim')),
'-shim-config', os.path.abspath(os.path.join(root_dir, 'src', 'bogo_shim', 'config.json'))])
if target in ['coverage', 'fuzzers']:
cmds.append([py_interp, os.path.join(root_dir, 'src/scripts/test_fuzzers.py'),
os.path.join(build_dir, 'fuzzer_corpus'),
os.path.join(build_dir, 'build/fuzzer')])
if target in ['shared', 'coverage', 'sanitizer']:
botan_exe = os.path.join(build_dir, 'botan-cli.exe' if options.os == 'windows' else 'botan')
args = ['--threads=%d' % (options.build_jobs)]
if target in ['coverage']:
args.append('--run-slow-tests')
if root_dir != '.':
args.append('--test-data-dir=%s' % root_dir)
test_scripts = ['test_cli.py', 'test_cli_crypt.py']
for script in test_scripts:
test_data_arg = []
cmds.append([py_interp, os.path.join(root_dir, 'src/scripts', script)] +
args + test_data_arg + [botan_exe])
if target in ['hybrid-tls13-interop-test']:
cmds.append([py_interp, os.path.join(root_dir, 'src/scripts/test_cli.py'),
'--run-online-tests', os.path.join(build_dir, 'botan'), 'pqc_hybrid_tests'])
python_tests = [os.path.join(root_dir, 'src/scripts/test_python.py')]
if root_dir != '.':
python_tests.append('--test-data-dir=%s' % root_dir)
if target in ['shared', 'coverage'] and not (options.os == 'windows' and options.cpu == 'x86'):
cmds.append([py_interp, '-b'] + python_tests)
if target in ['shared', 'static', 'bsi', 'nist']:
cmds.append(make_cmd + ['install'])
build_config = os.path.join(build_dir, 'build', 'build_config.json')
cmds.append([py_interp, os.path.join(root_dir, 'src/scripts/ci_check_install.py'), build_config])
cmds.append([py_interp, os.path.join(root_dir, 'src/scripts/ci_check_headers.py'), build_config])
if target in ['coverage']:
if have_prog('coverage'):
cmds.append(['coverage', 'run', '--branch',
'--rcfile', os.path.join(root_dir, 'src/configs/coverage.rc')] +
python_tests)
cov_file = os.path.join(build_dir, 'coverage.lcov')
raw_cov_file = os.path.join(build_dir, 'coverage.raw.lcov')
cmds.append(['lcov', '--capture', '--directory', build_dir,
'--output-file', raw_cov_file])
cmds.append(['lcov', '--remove', raw_cov_file, '/usr/*', '--output-file', cov_file])
cmds.append(['lcov', '--list', cov_file])
cmds.append([os.path.join(root_dir, 'src/scripts/rewrite_lcov.py'), cov_file])
if have_prog('coveralls'):
# If coveralls command exists, assume we are in CI and report to coveralls.io
cmds.append(['coveralls', '--format=lcov', '--file=%s' % (cov_file)])
else:
# Otherwise generate a local HTML report
cmds.append(['genhtml', cov_file, '--output-directory', os.path.join(build_dir, 'lcov-out')])
cmds.append(make_cmd + ['clean'])
cmds.append(make_cmd + ['distclean'])
for cmd in cmds:
if options.dry_run:
print('$ ' + ' '.join(cmd))
else:
run_cmd(cmd, root_dir, build_dir)
return 0
if __name__ == '__main__':
sys.exit(main())