README.md
1# infra
2> OSS-Fuzz project infrastructure
3
4Core infrastructure:
5* [`base-images`](base-images/) - docker images for building fuzz targets & corresponding jenkins
6 pipeline.
7
8Continuous Integration infrastructure:
9
10* [`libfuzzer-pipeline.groovy`](libfuzzer-pipeline.groovy/) - jenkins pipeline that runs for each OSS-Fuzz
11 project.
12* [`docker-cleanup`](docker-cleanup/) - jenkins pipeline to clean stale docker images & processes.
13* [`push-images`](push-images/) - jenkins pipeline to push built base images.
14* [`jenkins-cluster`](jenkins-cluster/) - kubernetes cluster definition for our jenkins-based build (not operational yet,
15[#10](https://github.com/google/oss-fuzz/issues/10)).
16
17## helper.py
18> script to automate common docker operations
19
20| Command | Description |
21|---------|-------------
22| `generate` | Generates skeleton files for a new project |
23| `build_image` | Builds a docker image for a given project |
24| `build_fuzzers` | Builds fuzz targets for a given project |
25| `run_fuzzer` | Runs a fuzz target in a docker container |
26| `coverage` | Runs fuzz target(s) in a docker container and generates a code coverage report. See [Code Coverage doc](https://google.github.io/oss-fuzz/advanced-topics/code-coverage/) |
27| `reproduce` | Runs a testcase to reproduce a crash |
28| `shell` | Starts a shell inside the docker image for a project |
29