|
| 1 | +name: Reusable Lazy Imports Tests |
| 2 | + |
| 3 | +# Run the CPython test suite with global lazy imports forced on |
| 4 | +# (``-X lazy_imports=all``). |
| 5 | +# |
| 6 | +# Modules that are known to fail under lazy imports are listed in |
| 7 | +# Lib/test/lazy_imports_all_exclude.txt and skipped here. Remove entries from |
| 8 | +# that file as the modules are fixed so this workflow starts guarding them |
| 9 | +# against regressions. Excluded modules are also checked separately so the |
| 10 | +# workflow fails when one starts passing and its exclusion should be removed. |
| 11 | + |
| 12 | +on: |
| 13 | + workflow_call: |
| 14 | + |
| 15 | +permissions: |
| 16 | + contents: read |
| 17 | + |
| 18 | +env: |
| 19 | + FORCE_COLOR: 1 |
| 20 | + |
| 21 | +jobs: |
| 22 | + test-lazy-imports-all: |
| 23 | + name: 'Run Tests with lazy_imports=all' |
| 24 | + runs-on: ubuntu-26.04 |
| 25 | + timeout-minutes: 60 |
| 26 | + env: |
| 27 | + EXCLUDE_FILE: Lib/test/lazy_imports_all_exclude.txt |
| 28 | + steps: |
| 29 | + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 |
| 30 | + with: |
| 31 | + persist-credentials: false |
| 32 | + - name: Register gcc problem matcher |
| 33 | + run: echo "::add-matcher::.github/problem-matchers/gcc.json" |
| 34 | + - name: Install dependencies |
| 35 | + run: sudo ./.github/workflows/posix-deps-apt.sh |
| 36 | + - name: Configure CPython |
| 37 | + run: ./configure --config-cache --with-pydebug |
| 38 | + - name: Build CPython |
| 39 | + run: make -j4 |
| 40 | + - name: Display build info |
| 41 | + run: make pythoninfo |
| 42 | + - name: Verify lazy imports are fully enabled |
| 43 | + run: ./python -X lazy_imports=all -c "import sys; assert sys.flags.lazy_imports == 1, sys.flags.lazy_imports; print('lazy imports all enabled')" |
| 44 | + - name: Build test list (all tests minus the known-failing exclusions) |
| 45 | + run: | |
| 46 | + set -euo pipefail |
| 47 | + ./python -m test --list-tests > all_tests.txt |
| 48 | + # Strip comments/blank lines from the exclusion file, then drop those |
| 49 | + # exact test names (whole-line, fixed-string match) from the run list. |
| 50 | + grep -vE '^\s*(#.*)?$' "$EXCLUDE_FILE" > exclude_tests.txt || true |
| 51 | + grep -vxF -f exclude_tests.txt all_tests.txt > run_tests.txt |
| 52 | + # Fail loudly if any exclusion entry matched nothing: a stale or |
| 53 | + # mistyped name (or a change in `--list-tests` output) would otherwise |
| 54 | + # silently stop excluding a module and let it fail the run. |
| 55 | + stale=$(comm -23 <(sort -u exclude_tests.txt) <(sort -u all_tests.txt)) |
| 56 | + if [ -n "$stale" ]; then |
| 57 | + echo "::error::Stale entries in $EXCLUDE_FILE (no longer match 'python -m test --list-tests'); remove or fix them:" |
| 58 | + echo "$stale" |
| 59 | + exit 1 |
| 60 | + fi |
| 61 | + echo "Excluding $(wc -l < exclude_tests.txt) module(s); running $(wc -l < run_tests.txt) of $(wc -l < all_tests.txt)." |
| 62 | + - name: Run tests with lazy imports |
| 63 | + run: xvfb-run xargs -a run_tests.txt ./python -X lazy_imports=all -m test --fast-ci --timeout=900 < /dev/null |
| 64 | + - name: Verify excluded tests still need exclusion |
| 65 | + run: | |
| 66 | + set -euo pipefail |
| 67 | + unexpected_passes=() |
| 68 | + while IFS= read -r test_name; do |
| 69 | + [ -n "$test_name" ] || continue |
| 70 | + echo "Checking excluded test: $test_name" |
| 71 | + if xvfb-run ./python -X lazy_imports=all -m test --fast-ci --timeout=900 "$test_name"; then |
| 72 | + unexpected_passes+=("$test_name") |
| 73 | + fi |
| 74 | + done < exclude_tests.txt |
| 75 | + if [ "${#unexpected_passes[@]}" -ne 0 ]; then |
| 76 | + echo "::error::These tests still appear in $EXCLUDE_FILE but now pass with -X lazy_imports=all. Remove them from the exclude file:" |
| 77 | + printf '%s\n' "${unexpected_passes[@]}" |
| 78 | + exit 1 |
| 79 | + fi |
0 commit comments