aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/reproducing.md
diff options
context:
space:
mode:
authorGravatar Max Moroz <dor3s1@gmail.com>2018-05-18 15:03:45 -0700
committerGravatar GitHub <noreply@github.com>2018-05-18 15:03:45 -0700
commit6428bf6611f490b06bf1a322b04834942cc210f5 (patch)
treedd22cb6ee53b8fe444c5693cc4c353059a65e51e /docs/reproducing.md
parent9cf647f1f4311bfcd701835d8d274c76528c3da2 (diff)
[docs] Clean up the conflicts in reproducing.md. (#1428)
* [docs] Clean up the conflicts in reproducing.md. * Add engine arg everywhere + move bad build checks instruction back to the bottom * Remove enginge argument from instructions not related to build checks
Diffstat (limited to 'docs/reproducing.md')
-rw-r--r--docs/reproducing.md23
1 files changed, 7 insertions, 16 deletions
diff --git a/docs/reproducing.md b/docs/reproducing.md
index 1f74af92..3fea02a6 100644
--- a/docs/reproducing.md
+++ b/docs/reproducing.md
@@ -29,6 +29,8 @@ If you are not sure how to build the fuzzer using the project's build system,
you may also use Docker ([how?](installing_docker.md), [why?](faq.md#why-do-you-use-docker)) commands
to replicate the exact build steps used by OSS-Fuzz and then feed the reproducer input to the fuzz target.
+## Building using Docker
+
### Pull the latest Docker images
```bash
@@ -39,23 +41,13 @@ $ python infra/helper.py pull_images
configurations, scripts, and other changes. In some cases, a particular issue
can be reproduced only with a fresh image being used.
-### Reproduce crashes with Docker
+### Build the image and the fuzzers
-- *Reproduce using latest OSS-Fuzz build:*
-
-## Building using Docker
```bash
$ python infra/helper.py build_image $PROJECT_NAME
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME
```
-## Reproducing build checks
-Our infrastructure runs some sanity tests to make sure that your build was correctly configured, even if it succeeded. To reproduce these locally, run:
-
-```bash
-$ python infra/helper.py check_build --sanitizer <address/memory/undefined> $PROJECT_NAME <fuzz_target_name>
-```
-
## Reproducing bugs
```bash
$ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_path>
@@ -84,11 +76,10 @@ $ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_pa
- *Submit fix*. Submit the fix in the project's repository. ClusterFuzz will automatically pick up the changes, recheck the testcase and will close the issue (in &lt; 1 day).
- *Improve fuzzing support*. Consider [improving fuzzing support](ideal_integration.md) in your project's build and test system.
-
-### Reproducing OSS-Fuzz bad build failures
+## Reproducing build checks
+Our infrastructure runs some sanity tests to make sure that your build was correctly configured, even if it succeeded. To reproduce these locally, run:
```bash
$ python infra/helper.py build_image $PROJECT_NAME
-$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME
-$ python infra/helper.py check_build $PROJECT_NAME <fuzz_target_name>
-```
+$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> --engine <libfuzzer/afl/hongfuzz> $PROJECT_NAME
+$ python infra/helper.py check_build --sanitizer <address/memory/undefined> --engine <libfuzzer/afl/hongfuzz> $PROJECT_NAME <fuzz_target_name>```