merge bitcoin#19659: Add a seed corpus generation option to the fuzzing test_runner

This commit is contained in:
Kittywhiskers Van Gogh 2020-08-04 18:42:29 +02:00
parent 8949c143da
commit debaa56c4a

View File

@ -55,6 +55,14 @@ def main():
'--m_dir', '--m_dir',
help='Merge inputs from this directory into the seed_dir. Needs /target subdirectory.', help='Merge inputs from this directory into the seed_dir. Needs /target subdirectory.',
) )
parser.add_argument(
'-g',
'--generate',
action='store_true',
help='Create new corpus seeds (or extend the existing ones) by running'
' the given targets for a finite number of times. Outputs them to'
' the passed seed_dir.'
)
args = parser.parse_args() args = parser.parse_args()
@ -99,19 +107,20 @@ def main():
logging.info("{} of {} detected fuzz target(s) selected: {}".format(len(test_list_selection), len(test_list_all), " ".join(test_list_selection))) logging.info("{} of {} detected fuzz target(s) selected: {}".format(len(test_list_selection), len(test_list_all), " ".join(test_list_selection)))
test_list_seedless = [] if not args.generate:
for t in test_list_selection: test_list_seedless = []
corpus_path = os.path.join(args.seed_dir, t) for t in test_list_selection:
if not os.path.exists(corpus_path) or len(os.listdir(corpus_path)) == 0: corpus_path = os.path.join(args.seed_dir, t)
test_list_seedless.append(t) if not os.path.exists(corpus_path) or len(os.listdir(corpus_path)) == 0:
test_list_seedless.sort() test_list_seedless.append(t)
if test_list_seedless: test_list_seedless.sort()
logging.info( if test_list_seedless:
"Fuzzing harnesses lacking a seed corpus: {}".format( logging.info(
" ".join(test_list_seedless) "Fuzzing harnesses lacking a seed corpus: {}".format(
" ".join(test_list_seedless)
)
) )
) logging.info("Please consider adding a fuzz seed corpus at https://github.com/bitcoin-core/qa-assets")
logging.info("Please consider adding a fuzz seed corpus at https://github.com/bitcoin-core/qa-assets")
try: try:
help_output = subprocess.run( help_output = subprocess.run(
@ -132,6 +141,14 @@ def main():
sys.exit(1) sys.exit(1)
with ThreadPoolExecutor(max_workers=args.par) as fuzz_pool: with ThreadPoolExecutor(max_workers=args.par) as fuzz_pool:
if args.generate:
return generate_corpus_seeds(
fuzz_pool=fuzz_pool,
build_dir=config["environment"]["BUILDDIR"],
seed_dir=args.seed_dir,
targets=test_list_selection,
)
if args.m_dir: if args.m_dir:
merge_inputs( merge_inputs(
fuzz_pool=fuzz_pool, fuzz_pool=fuzz_pool,
@ -151,6 +168,37 @@ def main():
) )
def generate_corpus_seeds(*, fuzz_pool, build_dir, seed_dir, targets):
"""Generates new corpus seeds.
Run {targets} without input, and outputs the generated corpus seeds to
{seed_dir}.
"""
logging.info("Generating corpus seeds to {}".format(seed_dir))
def job(command):
logging.debug("Running '{}'\n".format(" ".join(command)))
logging.debug("Command '{}' output:\n'{}'\n".format(
' '.join(command),
subprocess.run(command, check=True, stderr=subprocess.PIPE,
universal_newlines=True).stderr
))
futures = []
for target in targets:
target_seed_dir = os.path.join(seed_dir, target)
os.makedirs(target_seed_dir, exist_ok=True)
command = [
os.path.join(build_dir, "src", "test", "fuzz", target),
"-runs=100000",
target_seed_dir,
]
futures.append(fuzz_pool.submit(job, command))
for future in as_completed(futures):
future.result()
def merge_inputs(*, fuzz_pool, corpus, test_list, build_dir, merge_dir): def merge_inputs(*, fuzz_pool, corpus, test_list, build_dir, merge_dir):
logging.info("Merge the inputs in the passed dir into the seed_dir. Passed dir {}".format(merge_dir)) logging.info("Merge the inputs in the passed dir into the seed_dir. Passed dir {}".format(merge_dir))
jobs = [] jobs = []