README.md

GitHub Action: Run @FuzzyMonkeyCo's monkey

This action installs monkey on GitHub workflows to run monkey tests.

name: fuzzymonkey
on: [pull_request]
jobs:
  monkey-lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: FuzzyMonkeyCo/setup-monkey@v1
    - run: monkey lint

Inputs

command

Optional. monkey command to run (e.g. fuzz or fmt).

args

Optional. Arguments to the command.

workdir

Optional. Where to run the command. (default: .).

api_key

Optional. API key from https://fuzzymonkey.co.

github_token

Required. Used only to tame download rate-limiting. (default: ${{ github.token }}).

Outputs

code

Return code of the command. (0: no error, 2: lint failure, 4: fmt failure, 6: bug found, 7: exec failed).

seed

Seed returned by monkey pastseed. Non-empty when just ran monkey fuzz & found a bug.

Examples

Minimal

name: fuzzymonkey
on: [pull_request]
jobs:
  monkey-lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: FuzzyMonkeyCo/setup-monkey@v1
    - run: monkey lint

Run a command

name: fuzzymonkey
on: [pull_request]
jobs:
  monkey-fuzz:
    name: Run monkey fuzz
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Monkey fuzz
      uses: FuzzyMonkeyCo/setup-monkey@v1
      with:
        command: fuzz

Advanced

name: Continuous fuzzing
on:
  schedule:
  - cron: '0 4 * * *' # Runs at 4AM UTC every day
jobs:

  monkey-fmt:
    name: monkey ~ fmt
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Monkey fmt
      uses: FuzzyMonkeyCo/setup-monkey@v1
      with:
        command: fmt
        workdir: ./subdirectory/
        github_token: ${{ secrets.github_token }}

  monkey-fuzz:
    name: monkey ~ fuzz
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - name: Monkey fuzz
      uses: FuzzyMonkeyCo/setup-monkey@v1
      with:
        command: fuzz
        args: --time-budget-overall=30m
        workdir: ./subdirectory/
        api_key: ${{ secrets.FUZZYMONKEY_API_KEY }}
        github_token: ${{ secrets.github_token }}