qs_codec/.github/workflows/test.yml at main · techouse/qs_codec · 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
name: Test

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_call:

defaults:
  run:
    shell: bash

permissions:
  contents: read

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

jobs:
  analyze:
    name: "Analyze"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.x"
          cache: "pip"
      - name: Install dependencies
        run: pip install -r requirements_dev.txt
      - name: Run static analysis
        run: tox -e linters
  test:
    name: ${{ format('Test ({0})', matrix.py) }}
    needs: analyze
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        include:
          - toxenv: "python3.8"
            py: "3.8"
          - toxenv: "python3.9"
            py: "3.9"
          - toxenv: "python3.10"
            py: "3.10"
          - toxenv: "python3.11"
            py: "3.11"
          - toxenv: "python3.12"
            py: "3.12"
          - toxenv: "python3.13"
            py: "3.13"
          - toxenv: "python3.13t"
            py: "3.13t"
          - toxenv: "python3.14"
            py: "3.14"
          - toxenv: "python3.14t"
            py: "3.14t"
          - toxenv: "pypy3.8"
            py: "pypy-3.8"
          - toxenv: "pypy3.9"
            py: "pypy-3.9"
          - toxenv: "pypy3.10"
            py: "pypy-3.10"
          - toxenv: "pypy3.11"
            py: "pypy-3.11"
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.py }}
        uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.py }}
          cache: "pip"
      - uses: actions/cache@v5
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-1
          restore-keys: |
            ${{ runner.os }}-pip-
      - name: Install dependencies
        run: |
          pip install -U codecov tox-gh-actions
          pip install -r requirements_dev.txt
      - name: Test with tox
        run: tox
      - name: Check Code Coverage
        uses: irongut/CodeCoverageSummary@v1.3.0
        with:
          filename: ./coverage.xml
          thresholds: 90
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v6
        continue-on-error: true
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          slug: techouse/qs_codec
          files: ./coverage.xml
          env_vars: OS,PYTHON
          verbose: true
      - name: Upload coverage to Codacy
        continue-on-error: true
        uses: codacy/codacy-coverage-reporter-action@v1
        if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
        with:
          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
          coverage-reports: coverage.xml
  ensure_compatibility:
    name: "Ensure compatibility with qs"
    needs: analyze
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.x"
          cache: "pip"
      - name: Setup Node
        uses: actions/setup-node@v6
        with:
          node-version: 24
      - name: Install Python dependencies
        run: pip install -e .
      - name: Install Node dependencies
        working-directory: tests/comparison
        run: npm install
      - name: Run a comparison test between qs_codec and qs for JavaScript
        working-directory: tests/comparison
        continue-on-error: true
        run: |
          set -e
          node_output=$(node qs.js)
          python_output=$(python3 qs.py)
          if [ "$node_output" == "$python_output" ]; then
              echo "The outputs are identical."
          else
              echo "The outputs are different."
              exit 1
          fi
  ci_required:
    name: "CI Required"
    if: ${{ always() }}
    needs:
      - analyze
      - test
      - ensure_compatibility
    runs-on: ubuntu-latest
    env:
      ANALYZE_RESULT: ${{ needs.analyze.result }}
      TEST_RESULT: ${{ needs.test.result }}
      ENSURE_COMPATIBILITY_RESULT: ${{ needs.ensure_compatibility.result }}
    steps:
      - name: Verify required job results
        run: |
          set -euo pipefail

          results=(
            "analyze:${ANALYZE_RESULT}"
            "test:${TEST_RESULT}"
            "ensure_compatibility:${ENSURE_COMPATIBILITY_RESULT}"
          )

          failed=0
          for entry in "${results[@]}"; do
            job="${entry%%:*}"
            result="${entry#*:}"
            echo "${job}: ${result}"
            if [[ "${result}" != "success" ]]; then
              echo "::error::${job} finished with result '${result}'"
              failed=1
            fi
          done

          exit "${failed}"