| commit | 69a6e668b531598d8375a918a5af38b12b1c7542 | [log] [tgz] |
|---|---|---|
| author | Tengpeng <66138273+tengpengli@users.noreply.github.com> | Tue Aug 25 20:27:17 2020 -0400 |
| committer | GitHub <noreply@github.com> | Tue Aug 25 20:27:17 2020 -0400 |
| tree | 9aa53e6a5015c6e889424bfbba496b2374c323cc | |
| parent | ac0acb1e38246ef94badd6db22ad5dad11250150 [diff] |
Readme (#59) Changes README for the present codes. 1) Gives a snippet to import our repository 2) Uses a tiny example to show the usage. Signed-off-by: tengpeng <tengpeng.li2020@gmail.com> modified: README.md new file: docs/cc_deps.md new file: docs/common.md
This repository contains Bazel Starlark extensions for defining fuzz tests in Bazel projects.
This is not an officially supported Google product.
To import the fuzzing rules in your project, you first need to add the snippet below to your WORKSPACE file:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( name = "rules_fuzzing", sha256 = "597622ca07b0abc36e5bea565ca66f8d3d07faed33de5d9e09117816c68da281", strip_prefix = "bazel-rules-fuzzing-ac0acb1e38246ef94badd6db22ad5dad11250150", urls = ["https://github.com/googleinterns/bazel-rules-fuzzing/archive/ac0acb1e38246ef94badd6db22ad5dad11250150.zip"], ) load("@rules_fuzzing//fuzzing:repositories.bzl", "rules_fuzzing_dependencies") rules_fuzzing_dependencies() load("@rules_fuzzing//fuzzing:dependency_imports.bzl", "fuzzing_dependency_imports") fuzzing_dependency_imports() load("@fuzzing_py_deps//:requirements.bzl", fuzzing_py_install = "pip_install") fuzzing_py_install()
Tiny example:
Assume that you have a fuzz_test.cc file to do the fuzzing test and corpus files corpus_1.txt and corpus_dir/*.
You can create a fuzz test target in the BUILD like below:
load("@rules_fuzzing//fuzzing:cc_deps.bzl", "cc_fuzz_test") cc_fuzz_test( name = "fuzz_test", srcs = ["fuzz_test.cc"], corpus = ["corpus_1.txt"] + glob(["corpus_dir/**"], )
If your .bazelrc in the project root directory has config libfuzzer:
build:libfuzzer --action_env=CC=clang build:libfuzzer --action_env=CXX=clang++ build:libfuzzer --linkopt=-fsanitize=fuzzer build:libfuzzer --copt=-fsanitize=fuzzer build:libfuzzer --@rules_fuzzing//fuzzing:engine=libfuzzer
you then can run the fuzz test above using command
bazel run fuzz_test_run --config=libfuzzer
You can also control the fuzzing test running time by passing --timeout_secs like
bazel run fuzz_test_run --config=libfuzzer -- --timeout_secs=20
If you only want to run the regression test on the corpus, set --regression:
bazel run fuzz_test_run --config=libfuzzer -- --regression=True
Feel free to copy the config setting in .bazelrc to yours.
See the examples directory for more examples.