-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Structure the fuzz implementation to be closer to what go native will support. Add Makefile target to enable smoketesting fuzzers. Add github workflow to test and upload crash results. Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
- Loading branch information
Paulo Gomes
committed
Jan 11, 2022
1 parent
283b5db
commit ab49d7b
Showing
16 changed files
with
423 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: CIFuzz | ||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| jobs: | ||
| Fuzzing: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Build Fuzzers | ||
| id: build | ||
| uses: google/oss-fuzz/infra/cifuzz/actions/build_fuzzers@master | ||
| with: | ||
| oss-fuzz-project-name: 'fluxcd' | ||
| language: go | ||
| - name: Run Fuzzers | ||
| uses: google/oss-fuzz/infra/cifuzz/actions/run_fuzzers@master | ||
| with: | ||
| oss-fuzz-project-name: 'fluxcd' | ||
| language: go | ||
| fuzz-seconds: 60 | ||
| - name: Upload Crash | ||
| uses: actions/upload-artifact@v1 | ||
| if: failure() && steps.build.outcome == 'success' | ||
| with: | ||
| name: artifacts | ||
| path: ./out/artifacts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,3 +13,5 @@ | |
|
|
||
| # Dependency directories (remove the comment below to include it) | ||
| # vendor/ | ||
|
|
||
| build/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| FROM gcr.io/oss-fuzz-base/base-builder-go | ||
|
|
||
| COPY ./ $GOPATH/src/github.com/fluxcd/pkg/ | ||
| COPY ./tests/fuzz/oss_fuzz_build.sh $SRC/build.sh | ||
|
|
||
| WORKDIR $SRC |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # fuzz testing | ||
|
|
||
| Flux is part of Google's [oss fuzz] program which provides continuous fuzzing for | ||
| open source projects. | ||
|
|
||
| The long running fuzzing execution is configured in the [oss-fuzz repository]. | ||
| Shorter executions are done on a per-PR basis, configured as a [github workflow]. | ||
|
|
||
| For fuzzers to be called, they must be compiled within [oss_fuzz_build.sh](./oss_fuzz_build.sh). | ||
|
|
||
| ### Testing locally | ||
|
|
||
| Build fuzzers: | ||
|
|
||
| ```bash | ||
| make fuzz-build | ||
| ``` | ||
| All fuzzers will be built into `./build/fuzz/out`. | ||
|
|
||
| Smoke test fuzzers: | ||
|
|
||
| ```bash | ||
| make fuzz-smoketest | ||
| ``` | ||
|
|
||
| The smoke test runs each fuzzer once to ensure they are fully functional. | ||
|
|
||
| Run fuzzer locally: | ||
| ```bash | ||
| ./build/fuzz/out/fuzz_conditions_match | ||
| ``` | ||
|
|
||
| Run fuzzer inside a container: | ||
|
|
||
| ```bash | ||
| docker run --rm -ti \ | ||
| -v "$(pwd)/build/fuzz/out":/out \ | ||
| gcr.io/oss-fuzz/fluxcd \ | ||
| /out/fuzz_conditions_match | ||
| ``` | ||
|
|
||
|
|
||
| [oss fuzz]: https://github.com/google/oss-fuzz | ||
| [oss-fuzz repository]: https://github.com/google/oss-fuzz/tree/master/projects/fluxcd | ||
| [github workflow]: .github/workflows/cifuzz.yaml |
Oops, something went wrong.