oss-fuzz/infra/README.md

28 lines
1.2 KiB
Markdown

# infra
> OSS-Fuzz project infrastructure
Core infrastructure:
* [`base-images`](base-images/) - docker images for building fuzz targets & corresponding jenkins
pipeline.
Continuous Integration infrastracture:
* [`libfuzzer-pipeline.groovy`](libfuzzer-pipeline.groovy/) - jenkins pipeline that runs for each OSS-Fuzz
project.
* [`docker-cleanup`](docker-cleanup/) - jenkins pipeline to clean stale docker images & processes.
* [`push-images`](push-images/) - jenkins pipeline to push built base images.
* [`jenkins-cluster`](jenkins-cluster/) - kubernetes cluster definition for our jenkins-based build (not operational yet,
[#10](https://github.com/google/oss-fuzz/issues/10)).
## helper.py
> script to automate common docker operations
| Command | Description |
|---------|-------------
| `generate` | Generates skeleton files for a new project |
| `build_image` | Builds a docker image for a given project |
| `build_fuzzers` | Builds fuzz targets for a given project |
| `run_fuzzer` | Runs a fuzz target in a docker container |
| `coverage` | Runs a fuzz target in a docker container and computes a coverage report |
| `shell` | Starts a shell inside the docker image for a project |