gha-utils/.github/workflows/forge-test.yml at main · sablier-labs/gha-utils · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
name: "Test a Forge project"

on:
  workflow_call:
    inputs:
      cache-path:
        default: |
          cache
          node_modules
          out
          out-optimized
        required: false
        type: "string"

      foundry-fuzz-runs:
        default: 1000
        required: false
        type: "number"

      foundry-invariant-depth:
        default: 20
        required: false
        type: "number"

      foundry-invariant-runs:
        default: 20
        required: false
        type: "number"

      foundry-profile:
        default: "default"
        required: false
        type: "string"

      foundry-version:
        default: "v1.3.6"
        required: false
        type: "string"

      fuzz-seed:
        default: false
        required: false
        type: "boolean"

      match-path:
        required: true
        type: "string"

      name:
        default: "Forge tests"
        required: false
        type: "string"

      retry-attempts:
        default: 1
        description: "Number of attempts to retry if the test fails"
        required: false
        type: "number"

      working-directory:
        default: "."
        required: false
        type: "string"

    secrets:
      MAINNET_RPC_URL:
        required: false
      ROUTEMESH_API_KEY:
        required: false

jobs:
  forge-test:
    name: ${{ inputs.name }}
    defaults:
      run:
        working-directory: ${{ inputs.working-directory }}
    env:
      FOUNDRY_INVARIANT_DEPTH: ${{ inputs.foundry-invariant-depth }}
      FOUNDRY_INVARIANT_RUNS: ${{ inputs.foundry-invariant-runs }}
      FOUNDRY_FUZZ_RUNS: ${{ inputs.foundry-fuzz-runs }}
      FOUNDRY_PROFILE: ${{ inputs.foundry-profile }}
      MAINNET_RPC_URL: ${{ secrets.MAINNET_RPC_URL }}
      ROUTEMESH_API_KEY: ${{ secrets.ROUTEMESH_API_KEY }}
    runs-on: "ubuntu-latest"
    steps:
      - name: "Check out the repo"
        uses: "actions/checkout@v4"

      - name: "Install Foundry"
        uses: "foundry-rs/foundry-toolchain@v1"
        with:
          version: ${{ inputs.foundry-version }}

      - name: "Restore the cached build"
        uses: "sablier-labs/gha-utils/.github/actions/evm-cache@main"
        with:
          cache-path: ${{ inputs.cache-path }}
          fail-on-cache-miss: true

      - name: "Generate fuzz seed that changes weekly to avoid burning through RPC allowance"
        if: ${{ inputs.fuzz-seed }}
        run: |
          seed=$(echo $(($EPOCHSECONDS / 604800)))
          echo "FOUNDRY_FUZZ_SEED=$seed" >> $GITHUB_ENV

      - name: "Run the tests"
        run: |
          for attempt in $(seq 1 ${{ inputs.retry-attempts }}); do
            if forge test --match-path "${{ inputs.match-path }}"; then
              break
            elif [ $attempt -eq ${{ inputs.retry-attempts }} ]; then
              exit 1
            else
              echo "♻️ Attempt $attempt: tests failed, retrying in 60 seconds..."
              sleep 60
            fi
          done

      - name: "Add summary"
        run: | # shell
          echo "## Result for ${{ inputs.name }}" >> $GITHUB_STEP_SUMMARY
          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY