test: use "given" keyword in branching trees #1599
Workflow file for this run
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
| name: "CI" | |
| concurrency: | |
| cancel-in-progress: true | |
| group: ${{github.workflow}}-${{github.ref}} | |
| env: | |
| API_KEY_ETHERSCAN: ${{ secrets.API_KEY_ETHERSCAN }} | |
| API_KEY_INFURA: ${{ secrets.API_KEY_INFURA }} | |
| RPC_URL_MAINNET: ${{ secrets.RPC_URL_MAINNET }} | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| push: | |
| branches: | |
| - "main" | |
| jobs: | |
| lint: | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Install Pnpm" | |
| uses: "pnpm/action-setup@v2" | |
| with: | |
| version: "8" | |
| - name: "Install Node.js" | |
| uses: "actions/setup-node@v3" | |
| with: | |
| cache: "pnpm" | |
| node-version: "lts/*" | |
| - name: "Install the Node.js dependencies" | |
| run: "pnpm install" | |
| - name: "Lint the contracts" | |
| run: "pnpm lint" | |
| - name: "Add lint summary" | |
| run: | | |
| echo "## Lint result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| build: | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Install Pnpm" | |
| uses: "pnpm/action-setup@v2" | |
| with: | |
| version: "8" | |
| - name: "Install Node.js" | |
| uses: "actions/setup-node@v3" | |
| with: | |
| cache: "pnpm" | |
| node-version: "lts/*" | |
| - name: "Install the Node.js dependencies" | |
| run: "pnpm install" | |
| - name: "Show the Foundry config" | |
| run: "forge config" | |
| - name: "Generate and prepare the contract artifacts" | |
| run: "./shell/prepare-artifacts.sh" | |
| - name: "Cache the build so that it can be re-used by the other jobs" | |
| uses: "actions/cache/save@v3" | |
| with: | |
| path: "out-optimized" | |
| key: "foundry-build-${{ github.sha }}" | |
| - name: "Store the contract artifacts in CI" | |
| uses: "actions/upload-artifact@v3" | |
| with: | |
| name: "contract-artifacts" | |
| path: "artifacts" | |
| - name: "Add build summary" | |
| run: | | |
| echo "## Build result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| test-unit: | |
| needs: ["lint", "build"] | |
| env: | |
| FOUNDRY_FUZZ_RUNS: "5000" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Restore the cached build" | |
| uses: "actions/cache/restore@v3" | |
| with: | |
| fail-on-cache-miss: true | |
| key: "foundry-build-${{ github.sha }}" | |
| path: "out-optimized" | |
| - name: "Run the unit tests against the optimized build" | |
| run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/unit/**/*.sol\"" | |
| - name: "Add test summary" | |
| run: | | |
| echo "## Unit tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| test-integration: | |
| needs: ["lint", "build"] | |
| env: | |
| FOUNDRY_FUZZ_RUNS: "5000" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Restore the cached build" | |
| uses: "actions/cache/restore@v3" | |
| with: | |
| fail-on-cache-miss: true | |
| key: "foundry-build-${{ github.sha }}" | |
| path: "out-optimized" | |
| - name: "Run the integration tests against the optimized build" | |
| run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/integration/**/*.sol\"" | |
| - name: "Add test summary" | |
| run: | | |
| echo "## Integration tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| test-utils: | |
| needs: ["lint", "build"] | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Restore the cached build" | |
| uses: "actions/cache/restore@v3" | |
| with: | |
| fail-on-cache-miss: true | |
| key: "foundry-build-${{ github.sha }}" | |
| path: "out-optimized" | |
| - name: "Run the utils tests against the optimized build" | |
| run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/utils/**/*.sol\"" | |
| - name: "Add test summary" | |
| run: | | |
| echo "## Utils tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| test-invariant: | |
| needs: ["lint", "build"] | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Restore the cached build" | |
| uses: "actions/cache/restore@v3" | |
| with: | |
| fail-on-cache-miss: true | |
| key: "foundry-build-${{ github.sha }}" | |
| path: "out-optimized" | |
| - name: "Run the invariant tests against the optimized build" | |
| run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/invariant/**/*.sol\"" | |
| - name: "Add test summary" | |
| run: | | |
| echo "## Invariant tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| test-fork: | |
| needs: ["lint", "build"] | |
| env: | |
| FOUNDRY_FUZZ_RUNS: "100" | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Restore the cached build" | |
| uses: "actions/cache/restore@v3" | |
| with: | |
| fail-on-cache-miss: true | |
| key: "foundry-build-${{ github.sha }}" | |
| path: "out-optimized" | |
| - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance" | |
| run: | | |
| echo "FOUNDRY_FUZZ_SEED=$(echo $(($EPOCHSECONDS / 604800)))" >> $GITHUB_ENV | |
| - name: "Run the fork tests against the optimized build" | |
| run: "FOUNDRY_PROFILE=test-optimized forge test --match-path \"test/fork/**/*.sol\"" | |
| - name: "Add test summary" | |
| run: | | |
| echo "## Fork tests result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Passed" >> $GITHUB_STEP_SUMMARY | |
| coverage: | |
| needs: ["lint", "build"] | |
| runs-on: "ubuntu-latest" | |
| steps: | |
| - name: "Check out the repo" | |
| uses: "actions/checkout@v3" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install Foundry" | |
| uses: "foundry-rs/foundry-toolchain@v1" | |
| - name: "Generate the coverage report using the unit and the integration tests" | |
| run: "forge coverage --match-path \"test/{unit,integration}/**/*.sol\" --report lcov" | |
| - name: "Upload coverage report to Codecov" | |
| uses: "codecov/codecov-action@v3" | |
| with: | |
| files: "./lcov.info" | |
| - name: "Add coverage summary" | |
| run: | | |
| echo "## Coverage result" >> $GITHUB_STEP_SUMMARY | |
| echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY |