slither/.github/workflows/test.yml at master · crytic/slither · 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
---
name: Pytest

defaults:
  run:
    shell: bash

on:
  push:
    branches: [master]
  pull_request:
    paths:
      - 'slither/**'
      - 'tests/**'
      - 'pyproject.toml'
      - 'uv.lock'
      - '.github/scripts/**'
      - '.github/actions/**'
      - '.github/workflows/test.yml'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: ["ubuntu-latest", "windows-2025"]
        type: ["unit", "integration", "tool"]
        python: >-
          ${{ (github.event_name == 'pull_request' && fromJSON('["3.10", "3.14"]'))
          || fromJSON('["3.10", "3.11", "3.12", "3.13", "3.14"]') }}
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
        with:
          persist-credentials: false
      - name: Install uv and Python ${{ matrix.python }}
        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b  # v7
        with:
          python-version: ${{ matrix.python }}
          activate-environment: true
          enable-cache: true

      - name: Install dependencies
        run: |
          uv sync --group test

      - name: Setup node
        uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238  # v6
        with:
          node-version: '20'
          cache: 'npm'
          cache-dependency-path: '**/package-lock.json'

      - name: Install test dependencies
        env:
          TEST_TYPE: ${{ matrix.type }}
        run: |
          if [ "$TEST_TYPE" = "tool" ]; then
            # Setup Ganache for slither-read-storage tests.
            npm install --global ganache
          elif [ "$TEST_TYPE" = "integration" ]; then
            # Setup Hardhat for compilation tests.
            pushd tests/e2e/compilation/test_data/test_node_modules/ || exit
            npm install hardhat
            popd || exit
          fi
      - name: Install Vyper
        run: |
          INSTALLDIR="$RUNNER_TEMP/vyper-install"
          if [[ "$RUNNER_OS" = "Windows" ]]; then
              URL="https://github.com/vyperlang/vyper/releases/download/v0.3.7/vyper.0.3.7+commit.6020b8bb.windows.exe"
              FILENAME="vyper.exe"
          elif [[ "$RUNNER_OS" = "Linux" ]]; then
              URL="https://github.com/vyperlang/vyper/releases/download/v0.3.7/vyper.0.3.7+commit.6020b8bb.linux"
              FILENAME="vyper"
          else
              echo "Unknown OS"
              exit 1
          fi
          mkdir -p "$INSTALLDIR"
          curl "$URL" -o "$INSTALLDIR/$FILENAME" -L
          chmod 755 "$INSTALLDIR/$FILENAME"
          echo "$INSTALLDIR" >> "$GITHUB_PATH"
      - name: Run ${{ matrix.type }} tests
        env:
          TEST_TYPE: ${{ matrix.type }}
          MATRIX_OS: ${{ matrix.os }}
        # Only run coverage on ubuntu-latest.
        run: |
          if [ "$MATRIX_OS" = "ubuntu-latest" ]; then
            TEST_ARGS=(--cov=slither --cov-append)
          elif [ "$MATRIX_OS" = "windows-2025" ]; then
            TEST_ARGS=()
          fi
          bash "./.github/scripts/${TEST_TYPE}_test_runner.sh" "${TEST_ARGS[@]}"


      - name: Upload coverage
        uses: ./.github/actions/upload-coverage
        # only aggregate test coverage over linux-based tests to avoid any OS-specific filesystem information stored in
        # coverage metadata.
        if: ${{ matrix.os == 'ubuntu-latest' && matrix.python == '3.10' }}

  coverage:
    needs:
      - tests

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
        with:
          persist-credentials: false
      - name: Install uv and Python
        uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b  # v7
        with:
          python-version: "3.10"
          activate-environment: true
          enable-cache: true

      - run: uv pip install coverage[toml]

      - name: download coverage data
        uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131  # v7
        with:
          pattern: coverage-data-*
          merge-multiple: true

      - name: combine coverage data
        id: combinecoverage
        run: |
          set +e
          python -m coverage combine
          echo "## python coverage" >> "$GITHUB_STEP_SUMMARY"
          python -m coverage report -m --format=markdown >> "$GITHUB_STEP_SUMMARY"