databricks-sql-python/.github/workflows/code-quality-checks.yml at main · 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
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"]
        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:
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Setup Poetry
        uses: ./.github/actions/setup-poetry
        with:
          python-version: ${{ matrix.python-version }}
          cache-suffix: "${{ matrix.dependency-version }}-"
      - 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
      - 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 -m "not realkernel"

  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:
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Install Kerberos system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libkrb5-dev
      - name: Setup Poetry
        uses: ./.github/actions/setup-poetry
        with:
          python-version: ${{ matrix.python-version }}
          # Install ONLY the pyarrow extra (not --all-extras) so this
          # tier isolates the "pyarrow present, kernel absent"
          # configuration. --all-extras would also pull the kernel wheel,
          # making this job redundant with "Unit Tests + Kernel".
          install-args: "--extras pyarrow"
          cache-suffix: "pyarrow-${{ matrix.dependency-version }}-"
      - 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
      - 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 -m "not realkernel"

  run-unit-tests-with-kernel:
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest
    strategy:
      matrix:
        # Kernel wheel is cp310-abi3 (Requires-Python >=3.10), so this
        # matrix omits 3.9 — the [kernel] extra is a no-op there.
        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]

    name: "Unit Tests + Kernel (Python ${{ matrix.python-version }})"

    steps:
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Install Kerberos system dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y libkrb5-dev
      - name: Setup Poetry
        uses: ./.github/actions/setup-poetry
        with:
          python-version: ${{ matrix.python-version }}
          # Install the kernel extra (pulls the published
          # databricks-sql-kernel wheel, which transitively brings
          # pyarrow). Explicit --extras kernel rather than --all-extras
          # so this tier targets the kernel configuration specifically.
          install-args: "--extras kernel"
          cache-suffix: "kernel-"
      - name: Show installed versions
        run: |
          echo "=== with databricks-sql-kernel ==="
          poetry run pip list
      - name: Assert the real kernel wheel is installed (not a stub)
        run: |
          poetry run python -c "import databricks_sql_kernel as k; assert k.__file__, 'kernel wheel missing __file__ — not the real wheel'; print('real kernel wheel:', k.__file__)"
      - name: Unit tests (kernel wheel present, realkernel deselected)
        # The bulk of tests/unit fakes databricks_sql_kernel in
        # sys.modules, so the real-wheel routing test is deselected here
        # and run on its own below (a shared session would shadow the
        # real wheel — both real-wheel tests fail loudly if that happens).
        run: poetry run python -m pytest tests/unit -m "not realkernel"
      - name: Drive use_kernel=True through the REAL wheel (routing)
        # Separate invocation, explicit file path: never collects the
        # fake-module test file, so sys.modules stays unpolluted. This is
        # the no-network proof that sql.connect(use_kernel=True) actually
        # instantiates the real KernelDatabricksClient (not a stub, not a
        # Thrift fallback). Fails loudly if the real wheel is shadowed.
        run: poetry run python -m pytest tests/unit/test_session.py -m realkernel -v

  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:
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Setup Poetry
        uses: ./.github/actions/setup-poetry
        with:
          python-version: ${{ matrix.python-version }}
      - 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:
      - name: Check out repository
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
      - name: Setup Poetry
        uses: ./.github/actions/setup-poetry
        with:
          python-version: ${{ matrix.python-version }}
      - name: Mypy
        run: |
          mkdir .mypy_cache
          poetry run mypy --install-types --non-interactive src