smart-contracts-test.yml

name: Smart Contracts

on:
  pull_request:
    branches:
      - main
      - dev
      - release/*
  push:
    branches:
      - main
      - dev
      - release/*

env:
  FOUNDRY_PROFILE: ci

jobs:
  build:
    defaults:
      run:
        working-directory: contracts

    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: "Show the Foundry config"
        run: "forge config"

      - name: "Produce a build"
        run: "forge build"

      - name: "Add build summary"
        run: |
          echo "## Build result" >> $GITHUB_STEP_SUMMARY
          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

  test-unit:
    defaults:
      run:
        working-directory: contracts

    env:
      FOUNDRY_FUZZ_RUNS: "5000"

    needs: ["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: "Run the unit tests"
        run: "forge test"

      - name: "Add test summary"
        run: |
          echo "## Unit tests result" >> $GITHUB_STEP_SUMMARY
          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

  coverage:
    needs: ["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 tests"
        run: "cd contracts && forge coverage --report lcov"

      - name: "ls"
        run: "cp contracts/lcov.info ."

      - name: "Upload coverage report to Codecov"
        uses: "codecov/codecov-action@v3"
        with:
          files: "./lcov.info"
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: true
          verbose: true

      - name: "Check test coverage"
        uses: "terencetcf/github-actions-lcov-minimum-coverage-checker@v1"
        with:
          coverage-file: lcov.info
          minimum-coverage: 96

      - name: "Add coverage summary"
        run: |
          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY

  upgradeability:
    defaults:
      run:
        working-directory: contracts

    needs: ["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: "Produce a build"
        run: "forge build"

      - name: "Check contracts upgradeability"
        run: "pnpm run check:upgradeability:ci"

      - name: "Add upgradeability summary"
        run: |
          echo "## Upgradeability check result" >> $GITHUB_STEP_SUMMARY
          echo "✅ Contracts are upgradeable" >> $GITHUB_STEP_SUMMARY