Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jidicula/go-fuzz-action
GitHub Action for Go 1.18 fuzz testing
https://github.com/jidicula/go-fuzz-action
fuzz-testing github-action github-actions go golang test-automation
Last synced: 29 days ago
JSON representation
GitHub Action for Go 1.18 fuzz testing
- Host: GitHub
- URL: https://github.com/jidicula/go-fuzz-action
- Owner: jidicula
- License: mit
- Created: 2022-04-06T20:17:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T16:40:04.000Z (8 months ago)
- Last Synced: 2024-09-30T04:54:17.101Z (about 1 month ago)
- Topics: fuzz-testing, github-action, github-actions, go, golang, test-automation
- Homepage:
- Size: 35.2 KB
- Stars: 15
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-go - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions. (Continuous Integration / Standard CLI)
- fucking-awesome-go - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions. (Continuous Integration / Standard CLI)
- awesome-go - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions. (Continuous Integration / Standard CLI)
- awesome-go - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions. (Continuous Integration / Standard CLI)
- awesome-go-extra - go-fuzz-action - 04-06T20:17:26Z|2022-07-24T19:27:15Z| (Continuous Integration / Advanced Console UIs)
- awesome-go-with-stars - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions. (Continuous Integration / Standard CLI)
- awesome-go-plus - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions. (Continuous Integration / Standard CLI)
- awesome-go-plus - go-fuzz-action - Use Go 1.18's built-in fuzz testing in GitHub Actions.   (Continuous Integration / Standard CLI)
README
# go-fuzz-action
GitHub Action for Go fuzz testing. This Action runs Go's built-in fuzz testing, added in Go 1.18, on your code.
## Do you find this useful?
You can sponsor me [here](https://github.com/sponsors/jidicula)!
## Inputs
* `fuzz-time` [**REQUIRED**]: Fuzz target iteration duration, specified as a `time.Duration` (for example `1h30s`). Corresponds to `-fuzztime` flag for the `go test` command. **Ensure this is less than your job/workflow timeout**.
* `packages` [optional]: Run fuzz test on these packages. Corresponds to the `[packages]` input for the `go test` command.
* Default: `.`
* `fuzz-regexp` [optional]: Run the fuzz test matching the regular expression. Corresponds to the `-fuzz` flag for the `go test` command.
* Default: `Fuzz`
* `fuzz-minimize-time` [optional]: Fuzz minimization duration, specified as a `time.Duration` (for example `1h30s`). Corresponds to `-fuzzminimizetime` flag for the `go test` command. If you provide this input, ensure it is less than your job timeout.
* Default: `10s`
* `go-version` [optional]: Which version of Go to use for fuzzing. This will be passed on to `actions/setup-go@v3`.
* Default: `1.18`
## Returns:
* SUCCESS: if your fuzz tests don't raise a failure within the `fuzz-time` input constraint.
* FAILURE: if your fuzz tests raise a failure within the `fuzz-time` input constraint.
* The workflow run logs will include instructions on how to download (using the [GitHub CLI](https://cli.github.com)) the failing seed corpus to your local machine for remediation, regardless of run trigger.
* If you run this Action in a PR workflow, it'll comment these instructions on your PR: 
# Usage
⚠️This Action is not tested on `windows` GitHub Actions runners! Use with `windows` runner OS at your own risk!
Create a `.github/workflows/go-fuzz-test.yml` in your repository containing:
```yaml
name: Go fuzz test
on:
push:
pull_request:
jobs:
fuzz-test:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/[email protected]
with:
fuzz-time: 30s
```
## Fuzz test all packages in repo
If you have multiple packages in your repo and you want to fuzz test them all, create a `.github/workflows/go-fuzz-test.yml` in your repository containing:
```yaml
name: Go fuzz test
on:
push:
pull_request:
jobs:
fuzz-test:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/[email protected]
with:
packages: './...'
fuzz-time: 30s
```
## Longer minimize time
If you want the fuzz test to spend more time on minimizing the failing input to the smallest possible and most human readable value which will still produce an error, create a `.github/workflows/go-fuzz-test.yml` in your repository containing:
```yaml
name: Go fuzz test
on:
push:
pull_request:
jobs:
fuzz-test:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/[email protected]
with:
packages: './...'
fuzz-time: 30s
fuzz-minimize-time: 1m
```
## Fuzz tests with different regexp
If you have fuzz tests that don't begin with `Fuzz` (the default regexp), create a `.github/workflows/go-fuzz-test.yml` in your repository containing:
```yaml
name: Go fuzz test
on:
push:
pull_request:
jobs:
fuzz-test:
name: Fuzz test
runs-on: ubuntu-latest
steps:
- uses: jidicula/go-fuzz-action@main
with:
packages: './...'
fuzz-time: 30s
fuzz-minimize-time: 1m
fuzz-regexp: OtherFuzzRegexp
```
# Example repo
I haven't figured out how to test this adequately within this repo, so you can verify its behaviour here: https://github.com/jidicula/test-go-fuzz-action/pull/2
# Who uses this?
[These public repos](https://github.com/search?o=desc&q=uses%3A+jidicula%2Fgo-fuzz-action+-user%3Ajidicula&s=indexed&type=Code) use this Action.