Initial Vexta Core v0.1.0 release
This commit is contained in:
commit
25c454329d
2481 changed files with 689289 additions and 0 deletions
308
test/fuzz/test_runner.py
Executable file
308
test/fuzz/test_runner.py
Executable file
|
|
@ -0,0 +1,308 @@
|
|||
#!/usr/bin/env python3
|
||||
# Copyright (c) 2019-2020 The DigiByte Core developers
|
||||
# Distributed under the MIT software license, see the accompanying
|
||||
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
"""Run fuzz test targets.
|
||||
"""
|
||||
|
||||
from concurrent.futures import ThreadPoolExecutor, as_completed
|
||||
import argparse
|
||||
import configparser
|
||||
import logging
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
|
||||
def get_fuzz_env(*, target, source_dir):
|
||||
return {
|
||||
'FUZZ': target,
|
||||
'UBSAN_OPTIONS':
|
||||
f'suppressions={source_dir}/test/sanitizer_suppressions/ubsan:print_stacktrace=1:halt_on_error=1:report_error_type=1',
|
||||
'ASAN_OPTIONS': # symbolizer disabled due to https://github.com/google/sanitizers/issues/1364#issuecomment-761072085
|
||||
'symbolize=0:detect_stack_use_after_return=1:check_initialization_order=1:strict_init_order=1',
|
||||
}
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||||
description='''Run the fuzz targets with all inputs from the corpus_dir once.''',
|
||||
)
|
||||
parser.add_argument(
|
||||
"-l",
|
||||
"--loglevel",
|
||||
dest="loglevel",
|
||||
default="INFO",
|
||||
help="log events at this level and higher to the console. Can be set to DEBUG, INFO, WARNING, ERROR or CRITICAL. Passing --loglevel DEBUG will output all logs to console.",
|
||||
)
|
||||
parser.add_argument(
|
||||
'--valgrind',
|
||||
action='store_true',
|
||||
help='If true, run fuzzing binaries under the valgrind memory error detector',
|
||||
)
|
||||
parser.add_argument(
|
||||
'-x',
|
||||
'--exclude',
|
||||
help="A comma-separated list of targets to exclude",
|
||||
)
|
||||
parser.add_argument(
|
||||
'--par',
|
||||
'-j',
|
||||
type=int,
|
||||
default=4,
|
||||
help='How many targets to merge or execute in parallel.',
|
||||
)
|
||||
parser.add_argument(
|
||||
'corpus_dir',
|
||||
help='The corpus to run on (must contain subfolders for each fuzz target).',
|
||||
)
|
||||
parser.add_argument(
|
||||
'target',
|
||||
nargs='*',
|
||||
help='The target(s) to run. Default is to run all targets.',
|
||||
)
|
||||
parser.add_argument(
|
||||
'--m_dir',
|
||||
help='Merge inputs from this directory into the corpus_dir.',
|
||||
)
|
||||
parser.add_argument(
|
||||
'-g',
|
||||
'--generate',
|
||||
action='store_true',
|
||||
help='Create new corpus (or extend the existing ones) by running'
|
||||
' the given targets for a finite number of times. Outputs them to'
|
||||
' the passed corpus_dir.'
|
||||
)
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
# Set up logging
|
||||
logging.basicConfig(
|
||||
format='%(message)s',
|
||||
level=int(args.loglevel) if args.loglevel.isdigit() else args.loglevel.upper(),
|
||||
)
|
||||
|
||||
# Read config generated by configure.
|
||||
config = configparser.ConfigParser()
|
||||
configfile = os.path.abspath(os.path.dirname(__file__)) + "/../config.ini"
|
||||
config.read_file(open(configfile, encoding="utf8"))
|
||||
|
||||
if not config["components"].getboolean("ENABLE_FUZZ"):
|
||||
logging.error("Must have fuzz targets built")
|
||||
sys.exit(1)
|
||||
|
||||
# Build list of tests
|
||||
test_list_all = parse_test_list(fuzz_bin=os.path.join(config["environment"]["BUILDDIR"], 'src', 'test', 'fuzz', 'fuzz'))
|
||||
|
||||
if not test_list_all:
|
||||
logging.error("No fuzz targets found")
|
||||
sys.exit(1)
|
||||
|
||||
logging.debug("{} fuzz target(s) found: {}".format(len(test_list_all), " ".join(sorted(test_list_all))))
|
||||
|
||||
args.target = args.target or test_list_all # By default run all
|
||||
test_list_error = list(set(args.target).difference(set(test_list_all)))
|
||||
if test_list_error:
|
||||
logging.error("Unknown fuzz targets selected: {}".format(test_list_error))
|
||||
test_list_selection = list(set(test_list_all).intersection(set(args.target)))
|
||||
if not test_list_selection:
|
||||
logging.error("No fuzz targets selected")
|
||||
if args.exclude:
|
||||
for excluded_target in args.exclude.split(","):
|
||||
if excluded_target not in test_list_selection:
|
||||
logging.error("Target \"{}\" not found in current target list.".format(excluded_target))
|
||||
continue
|
||||
test_list_selection.remove(excluded_target)
|
||||
test_list_selection.sort()
|
||||
|
||||
logging.info("{} of {} detected fuzz target(s) selected: {}".format(len(test_list_selection), len(test_list_all), " ".join(test_list_selection)))
|
||||
|
||||
if not args.generate:
|
||||
test_list_missing_corpus = []
|
||||
for t in test_list_selection:
|
||||
corpus_path = os.path.join(args.corpus_dir, t)
|
||||
if not os.path.exists(corpus_path) or len(os.listdir(corpus_path)) == 0:
|
||||
test_list_missing_corpus.append(t)
|
||||
test_list_missing_corpus.sort()
|
||||
if test_list_missing_corpus:
|
||||
logging.info(
|
||||
"Fuzzing harnesses lacking a corpus: {}".format(
|
||||
" ".join(test_list_missing_corpus)
|
||||
)
|
||||
)
|
||||
logging.info("Please consider adding a fuzz corpus at https://github.com/digibyte-core/qa-assets")
|
||||
|
||||
try:
|
||||
help_output = subprocess.run(
|
||||
args=[
|
||||
os.path.join(config["environment"]["BUILDDIR"], 'src', 'test', 'fuzz', 'fuzz'),
|
||||
'-help=1',
|
||||
],
|
||||
env=get_fuzz_env(target=test_list_selection[0], source_dir=config['environment']['SRCDIR']),
|
||||
timeout=20,
|
||||
check=True,
|
||||
stderr=subprocess.PIPE,
|
||||
universal_newlines=True,
|
||||
).stderr
|
||||
if "libFuzzer" not in help_output:
|
||||
logging.error("Must be built with libFuzzer")
|
||||
sys.exit(1)
|
||||
except subprocess.TimeoutExpired:
|
||||
logging.error("subprocess timed out: Currently only libFuzzer is supported")
|
||||
sys.exit(1)
|
||||
|
||||
with ThreadPoolExecutor(max_workers=args.par) as fuzz_pool:
|
||||
if args.generate:
|
||||
return generate_corpus(
|
||||
fuzz_pool=fuzz_pool,
|
||||
src_dir=config['environment']['SRCDIR'],
|
||||
build_dir=config["environment"]["BUILDDIR"],
|
||||
corpus_dir=args.corpus_dir,
|
||||
targets=test_list_selection,
|
||||
)
|
||||
|
||||
if args.m_dir:
|
||||
merge_inputs(
|
||||
fuzz_pool=fuzz_pool,
|
||||
corpus=args.corpus_dir,
|
||||
test_list=test_list_selection,
|
||||
src_dir=config['environment']['SRCDIR'],
|
||||
build_dir=config["environment"]["BUILDDIR"],
|
||||
merge_dir=args.m_dir,
|
||||
)
|
||||
return
|
||||
|
||||
run_once(
|
||||
fuzz_pool=fuzz_pool,
|
||||
corpus=args.corpus_dir,
|
||||
test_list=test_list_selection,
|
||||
src_dir=config['environment']['SRCDIR'],
|
||||
build_dir=config["environment"]["BUILDDIR"],
|
||||
use_valgrind=args.valgrind,
|
||||
)
|
||||
|
||||
|
||||
def generate_corpus(*, fuzz_pool, src_dir, build_dir, corpus_dir, targets):
|
||||
"""Generates new corpus.
|
||||
|
||||
Run {targets} without input, and outputs the generated corpus to
|
||||
{corpus_dir}.
|
||||
"""
|
||||
logging.info("Generating corpus to {}".format(corpus_dir))
|
||||
|
||||
def job(command, t):
|
||||
logging.debug("Running '{}'\n".format(" ".join(command)))
|
||||
logging.debug("Command '{}' output:\n'{}'\n".format(
|
||||
' '.join(command),
|
||||
subprocess.run(
|
||||
command,
|
||||
env=get_fuzz_env(target=t, source_dir=src_dir),
|
||||
check=True,
|
||||
stderr=subprocess.PIPE,
|
||||
universal_newlines=True,
|
||||
).stderr))
|
||||
|
||||
futures = []
|
||||
for target in targets:
|
||||
target_corpus_dir = os.path.join(corpus_dir, target)
|
||||
os.makedirs(target_corpus_dir, exist_ok=True)
|
||||
command = [
|
||||
os.path.join(build_dir, 'src', 'test', 'fuzz', 'fuzz'),
|
||||
"-runs=100000",
|
||||
target_corpus_dir,
|
||||
]
|
||||
futures.append(fuzz_pool.submit(job, command, target))
|
||||
|
||||
for future in as_completed(futures):
|
||||
future.result()
|
||||
|
||||
|
||||
def merge_inputs(*, fuzz_pool, corpus, test_list, src_dir, build_dir, merge_dir):
|
||||
logging.info("Merge the inputs from the passed dir into the corpus_dir. Passed dir {}".format(merge_dir))
|
||||
jobs = []
|
||||
for t in test_list:
|
||||
args = [
|
||||
os.path.join(build_dir, 'src', 'test', 'fuzz', 'fuzz'),
|
||||
'-merge=1',
|
||||
'-shuffle=0',
|
||||
'-prefer_small=1',
|
||||
'-use_value_profile=1', # Also done by oss-fuzz https://github.com/google/oss-fuzz/issues/1406#issuecomment-387790487
|
||||
os.path.join(corpus, t),
|
||||
os.path.join(merge_dir, t),
|
||||
]
|
||||
os.makedirs(os.path.join(corpus, t), exist_ok=True)
|
||||
os.makedirs(os.path.join(merge_dir, t), exist_ok=True)
|
||||
|
||||
def job(t, args):
|
||||
output = 'Run {} with args {}\n'.format(t, " ".join(args))
|
||||
output += subprocess.run(
|
||||
args,
|
||||
env=get_fuzz_env(target=t, source_dir=src_dir),
|
||||
check=True,
|
||||
stderr=subprocess.PIPE,
|
||||
universal_newlines=True,
|
||||
).stderr
|
||||
logging.debug(output)
|
||||
|
||||
jobs.append(fuzz_pool.submit(job, t, args))
|
||||
|
||||
for future in as_completed(jobs):
|
||||
future.result()
|
||||
|
||||
|
||||
def run_once(*, fuzz_pool, corpus, test_list, src_dir, build_dir, use_valgrind):
|
||||
jobs = []
|
||||
for t in test_list:
|
||||
corpus_path = os.path.join(corpus, t)
|
||||
os.makedirs(corpus_path, exist_ok=True)
|
||||
args = [
|
||||
os.path.join(build_dir, 'src', 'test', 'fuzz', 'fuzz'),
|
||||
'-runs=1',
|
||||
corpus_path,
|
||||
]
|
||||
if use_valgrind:
|
||||
args = ['valgrind', '--quiet', '--error-exitcode=1'] + args
|
||||
|
||||
def job(t, args):
|
||||
output = 'Run {} with args {}'.format(t, args)
|
||||
result = subprocess.run(
|
||||
args,
|
||||
env=get_fuzz_env(target=t, source_dir=src_dir),
|
||||
stderr=subprocess.PIPE,
|
||||
universal_newlines=True,
|
||||
)
|
||||
output += result.stderr
|
||||
return output, result
|
||||
|
||||
jobs.append(fuzz_pool.submit(job, t, args))
|
||||
|
||||
for future in as_completed(jobs):
|
||||
output, result = future.result()
|
||||
logging.debug(output)
|
||||
try:
|
||||
result.check_returncode()
|
||||
except subprocess.CalledProcessError as e:
|
||||
if e.stdout:
|
||||
logging.info(e.stdout)
|
||||
if e.stderr:
|
||||
logging.info(e.stderr)
|
||||
logging.info("Target \"{}\" failed with exit code {}".format(" ".join(result.args), e.returncode))
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def parse_test_list(*, fuzz_bin):
|
||||
test_list_all = subprocess.run(
|
||||
fuzz_bin,
|
||||
env={
|
||||
'PRINT_ALL_FUZZ_TARGETS_AND_ABORT': ''
|
||||
},
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.DEVNULL,
|
||||
universal_newlines=True,
|
||||
).stdout.splitlines()
|
||||
return test_list_all
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue