databricks-sql-python/.github/workflows/code-quality-checks.yml at 744214a8168bdda8871fc4039532f943bf06388b · databricks/databricks-sql-python · 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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
name: Code Quality Checks

on: [pull_request]

permissions:
  contents: read
  id-token: write

jobs:
  run-unit-tests:
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
        dependency-version: ["default", "min"]
        # Optimize matrix - test min/max on subset of Python versions
        exclude:
          - python-version: "3.12"
            dependency-version: "min"
          - python-version: "3.13"
            dependency-version: "min"

    name: "Unit Tests (Python ${{ matrix.python-version }}, ${{ matrix.dependency-version }} deps)"

    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Set up python ${{ matrix.python-version }}
        id: setup-python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: ${{ matrix.python-version }}
      #----------------------------------------------
      #  -----  configure JFrog PyPI proxy  -----
      #----------------------------------------------
      - name: Setup JFrog
        uses: ./.github/actions/setup-jfrog
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        run: |
          pip install poetry==2.2.1
          poetry config virtualenvs.create true
          poetry config virtualenvs.in-project true
          poetry config installer.parallel true
      - name: Configure Poetry for JFrog
        run: |
          poetry config repositories.jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry config http-basic.jfrog gha-service-account "${JFROG_ACCESS_TOKEN}"
          poetry source add --priority=primary jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry lock --no-update

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ matrix.dependency-version }}-${{ github.event.repository.name }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      - name: Install library
        run: poetry install --no-interaction
      #----------------------------------------------
      # override with custom dependency versions
      #----------------------------------------------
      - name: Install Python tools for custom versions
        if: matrix.dependency-version != 'default'
        run: poetry run pip install toml packaging

      - name: Generate requirements file
        if: matrix.dependency-version != 'default'
        run: |
          poetry run python scripts/dependency_manager.py ${{ matrix.dependency-version }} --output requirements-${{ matrix.dependency-version }}.txt
          echo "Generated requirements for ${{ matrix.dependency-version }} versions:"
          cat requirements-${{ matrix.dependency-version }}.txt

      - name: Override with custom dependency versions
        if: matrix.dependency-version != 'default'
        run: poetry run pip install -r requirements-${{ matrix.dependency-version }}.txt

      #----------------------------------------------
      #              run test suite
      #----------------------------------------------
      - name: Show installed versions
        run: |
          echo "=== Dependency Version: ${{ matrix.dependency-version }} ==="
          poetry run pip list

      - name: Run tests
        run: poetry run python -m pytest tests/unit
  run-unit-tests-with-arrow:
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
        dependency-version: ["default", "min"]
        exclude:
          - python-version: "3.12"
            dependency-version: "min"
          - python-version: "3.13"
            dependency-version: "min"

    name: "Unit Tests + PyArrow (Python ${{ matrix.python-version }}, ${{ matrix.dependency-version }} deps)"

    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      -   name: Check out repository
          uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2
      -   name: Set up python ${{ matrix.python-version }}
          id: setup-python
          uses: actions/setup-python@e9aba2c848f5ebd159c070c61ea2c4e2b122355e # v2
          with:
            python-version: ${{ matrix.python-version }}
      #----------------------------------------------
      #  -----  configure JFrog PyPI proxy  -----
      #----------------------------------------------
      -   name: Setup JFrog
          uses: ./.github/actions/setup-jfrog
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      -   name: Install Poetry
          run: |
            pip install poetry==2.2.1
            poetry config virtualenvs.create true
            poetry config virtualenvs.in-project true
            poetry config installer.parallel true
      -   name: Configure Poetry for JFrog
          run: |
            poetry config repositories.jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
            poetry config http-basic.jfrog gha-service-account "${JFROG_ACCESS_TOKEN}"
            poetry source add --priority=primary jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry lock --no-update

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      -   name: Load cached venv
          id: cached-poetry-dependencies
          uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
          with:
            path: .venv-pyarrow
            key: venv-pyarrow-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ matrix.dependency-version }}-${{ github.event.repository.name }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      -   name: Install dependencies
          if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
          run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      -   name: Install Kerberos system dependencies
          run: |
            sudo apt-get update
            sudo apt-get install -y libkrb5-dev
      -   name: Install library
          run: poetry install --no-interaction --all-extras
      #----------------------------------------------
      # override with custom dependency versions
      #----------------------------------------------
      -   name: Install Python tools for custom versions
          if: matrix.dependency-version != 'default'
          run: poetry run pip install toml packaging

      -   name: Generate requirements file with pyarrow
          if: matrix.dependency-version != 'default'
          run: |
            poetry run python scripts/dependency_manager.py ${{ matrix.dependency-version }} --output requirements-${{ matrix.dependency-version }}-arrow.txt
            echo "Generated requirements for ${{ matrix.dependency-version }} versions with PyArrow:"
            cat requirements-${{ matrix.dependency-version }}-arrow.txt

      -   name: Override with custom dependency versions
          if: matrix.dependency-version != 'default'
          run: poetry run pip install -r requirements-${{ matrix.dependency-version }}-arrow.txt
      #----------------------------------------------
      #              run test suite
      #----------------------------------------------
      -   name: Show installed versions
          run: |
            echo "=== Dependency Version: ${{ matrix.dependency-version }} with PyArrow ==="
            poetry run pip list

      -   name: Run tests
          run: poetry run python -m pytest tests/unit
  check-linting:
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Set up python ${{ matrix.python-version }}
        id: setup-python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: ${{ matrix.python-version }}
      #----------------------------------------------
      #  -----  configure JFrog PyPI proxy  -----
      #----------------------------------------------
      - name: Setup JFrog
        uses: ./.github/actions/setup-jfrog
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        run: |
          pip install poetry==2.2.1
          poetry config virtualenvs.create true
          poetry config virtualenvs.in-project true
          poetry config installer.parallel true
      - name: Configure Poetry for JFrog
        run: |
          poetry config repositories.jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry config http-basic.jfrog gha-service-account "${JFROG_ACCESS_TOKEN}"
          poetry source add --priority=primary jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry lock --no-update

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ github.event.repository.name }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      - name: Install library
        run: poetry install --no-interaction
      #----------------------------------------------
      #              black the code
      #----------------------------------------------
      - name: Black
        run: poetry run black --check src

  check-types:
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
    steps:
      #----------------------------------------------
      #       check-out repo and set-up python
      #----------------------------------------------
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Set up python ${{ matrix.python-version }}
        id: setup-python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: ${{ matrix.python-version }}
      #----------------------------------------------
      #  -----  configure JFrog PyPI proxy  -----
      #----------------------------------------------
      - name: Setup JFrog
        uses: ./.github/actions/setup-jfrog
      #----------------------------------------------
      #  -----  install & configure poetry  -----
      #----------------------------------------------
      - name: Install Poetry
        run: |
          pip install poetry==2.2.1
          poetry config virtualenvs.create true
          poetry config virtualenvs.in-project true
          poetry config installer.parallel true
      - name: Configure Poetry for JFrog
        run: |
          poetry config repositories.jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry config http-basic.jfrog gha-service-account "${JFROG_ACCESS_TOKEN}"
          poetry source add --priority=primary jfrog https://databricks.jfrog.io/artifactory/api/pypi/db-pypi/simple
          poetry lock --no-update

      #----------------------------------------------
      #       load cached venv if cache exists
      #----------------------------------------------
      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ github.event.repository.name }}-${{ hashFiles('**/poetry.lock') }}
      #----------------------------------------------
      # install dependencies if cache does not exist
      #----------------------------------------------
      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: poetry install --no-interaction --no-root
      #----------------------------------------------
      # install your root project, if required
      #----------------------------------------------
      - name: Install library
        run: poetry install --no-interaction
      #----------------------------------------------
      #              mypy the code
      #----------------------------------------------
      - name: Mypy
        run: |
          mkdir .mypy_cache # Workaround for bad error message "error: --install-types failed (no mypy cache directory)"; see https://github.com/python/mypy/issues/10768#issuecomment-2178450153
          poetry run mypy --install-types --non-interactive src