https://github.com/smol-ninja/bulloak-toolchain

Automates the verification of Solidity tests written using BTT technique
https://github.com/smol-ninja/bulloak-toolchain

actions foundry github-actions solidity-test test-automation

Last synced: 4 days ago
JSON representation

Automates the verification of Solidity tests written using BTT technique

• Host: GitHub
• URL: https://github.com/smol-ninja/bulloak-toolchain
• Owner: smol-ninja
• License: mit
• Created: 2024-08-08T14:55:13.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-09-15T10:58:28.000Z (18 days ago)
• Last Synced: 2024-09-20T15:25:04.529Z (13 days ago)
• Topics: actions, foundry, github-actions, solidity-test, test-automation
• Language: Solidity
• Homepage: https://github.com/marketplace/actions/bulloak-toolchain
• Size: 17.6 KB
• Stars: 18
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bulloak Toolchain

This GitHub Action installs the [Bulloak](https://github.com/alexfertel/bulloak) toolchain and check that Solidity tests conform to BTT spec.

## Example workflow

```yaml

name: "Test"

on:

  push:

    branches:

      - main

jobs:

  ci:

    runs-on: "ubuntu-latest"

    steps:

      - name: "Check out the repo"

        uses: "actions/checkout@v4"

      - name: "Install and run Bulloak"

        uses: "smol-ninja/bulloak-toolchain@v1"

        with:

          skip-modifiers: "false"

          test-dir: "test-workspace"

```

## Inputs

| Name                 | Description                                                            | Default                                                    | Required? |

| -------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------- | --------- |

| `cache`              | Automatically configure Rust cache                                     | true                                                       | No        |

| `cache-key`          | A custom key to identify the cache                                     | "${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}" | No        |

| `cache-restore-keys` | A custom key to identify the cache to restore                          | "${{ runner.os }}-cargo-"                                  | No        |

| `save-always`        | Save the cache even if a prior step fails                              | true                                                       | No        |

| `skip-modifiers`     | Whether to ignore modifiers declaration in the Solidity test contracts | false                                                      | No        |

| `test-dir`           | The test directory which would usually be `test`                       |                                                            | Yes       |

## Outputs

| Name              | Description                                |

| ----------------- | ------------------------------------------ |

| `bulloak-version` | Version as reported by `bulloak --version` |

## Contributors

- [PaulRBerg](https://github.com/paulRBerg) - For the initial idea and motivation.

- [alexfertel](https://github.com/alexfertel) - For his amazing work on Bulloak.

- [andreivladbrg](https://github.com/andreivladbrg) - For feedback on the implementation of BTT.

## License

This project is released under the [MIT License].

[MIT License]: LICENSE