ci: add automated fuzz tests #697
Merged
Conversation
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 PR introduces support for automated fuzz testing. The `fuzz-go.yml` workflow is a reusable workflow which goes through two phases: * Discover all fuzz tests * Run each fuzz test in a separate GitHub Actions job (as Go doesn't currently allow running more than one fuzz test at a time). If the fuzz testing discovers a new failing test case, the test case is uploaded as an artifact and reproduction instructions are added to the summary of the workflow. Additionally, the reusable workflow can be configured to create an issue on the discovery of a new failing test case. Then, two standard workflows are created: * "Run Go fuzz tests (PR)" (`fuzz-go-pr.yml`) runs all fuzz tests for up to 5 minutes on PRs. If a new failure is discovered, the PR author can look at the summary of the run to learn how to reproduce the failure. * "Run Go fuzz tests (scheduled)" (`fuzz-go-scheduled.yml`) runs all fuzz tests for up to 30 minutes every day at midnight. If a new failure is discovered, an issue is created. Closes grafana#537 consolidate to one reusable workflow
rfratto
added
the
backport-to-agent:no
mattdurham
approved these changes
May 6, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces support for automated fuzz testing.
The
fuzz-go.ymlworkflow is a reusable workflow which goes through two phases:Discover all fuzz tests
Run each fuzz test in a separate GitHub Actions job (as Go doesn't currently allow running more than one fuzz test at a time).
If the fuzz testing discovers a new failing test case, the test case is uploaded as an artifact and reproduction instructions are added to the summary of the workflow.
Additionally, the reusable workflow can be configured to create an issue on the discovery of a new failing test case.
Then, two standard workflows are created:
"Run Go fuzz tests (PR)" (
fuzz-go-pr.yml) runs all fuzz tests for up to 5 minutes on PRs. If a new failure is discovered, the PR author can look at the summary of the run to learn how to reproduce the failure."Run Go fuzz tests (scheduled)" (
fuzz-go-scheduled.yml) runs all fuzz tests for up to 30 minutes every day at midnight. If a new failure is discovered, an issue is created.I tested this fairly extensively on the rfratto/alloy fork, where you can see that it successfully creates issues such as rfratto#5.
Closes #537.