tools-python.yml

# The Python test suites under Tools/, which nothing ran.
#
# `Tools/linux-capture` carries 212 tests across 8 files — the frame decoder, the HCI extractor, the
# activity and sync decoders, the spot-HRV path, and the SpO2 promote gate that #103 is waiting on. Every
# one of them only ever executed when a contributor remembered to, which meant a decoder could regress and
# the suite that would have caught it stayed green by never being run.
#
# Cheap to run: pure stdlib `unittest`, no dependencies, no fixtures to fetch, ubuntu rather than macOS —
# about 25 seconds end to end.
#
# NOT path-filtered, and that is deliberate. It used to fire only on `Tools/**.py`, on the premise that a
# suite can only break when its own source changes. That is false for `test_home_i18n.py`, which asserts
# on the CONTENTS of app and package files — AppModel.swift, the xcstrings catalogues, ReadinessEngine,
# DayNavBar. A Swift-only commit broke it (#1671 moved a sign and a hardcoded °C out of a localized
# literal) and the filter meant this job never ran, so `main` sat red until a contributor touching
# `Tools/` for something unrelated tripped over it in their own PR (#1691).
#
# Widening the filter to name those paths would just re-create the trap one edit later: the list is
# whatever the assertions happen to read today. Twenty-five seconds on every PR is cheaper than a gate
# that is green because it did not run.
name: Tools Python CI

on:
  # Path-filtered like swift-packages.yml / app-build.yml. Without this the workflow ran on
  # EVERY pull request and every push to main, including the many that touch no Python at all - and with a
  # Windows runner now in it, billed at twice a Linux minute, that is a real cost for a job whose inputs
  # cannot have changed. The workflow file itself is included so a change to the job still tests itself.
  pull_request:
    branches: [main]
    paths:
      - 'Tools/**'
      - '.github/workflows/tools-python.yml'
  push:
    branches: [main]
    paths:
      - 'Tools/**'
      - '.github/workflows/tools-python.yml'
  workflow_dispatch:

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

jobs:
  linux-capture:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      # `discover` rather than a hand-listed set, so a NEW test file is picked up without editing this
      # workflow — the failure mode that leaves a suite unrun is exactly what this job exists to end.
      #
      # The count assertion is the same idea one level up: `discover` exits 0 having found NOTHING, so a
      # wrong working-directory or a renamed pattern would turn this job green while running no tests at
      # all. Checking a floor makes that fail loudly instead. Raise the floor when suites are added; do
      # not lower it to make a red run pass.
      - name: Run Tools/linux-capture tests
        run: |
          set -o pipefail   # GitHub's default shell is `bash -e` WITHOUT pipefail: piping into tee
                            # would return tee's status and swallow a failing suite entirely.
          python3 -m unittest discover -p "test_*.py" -v 2>&1 | tee "$RUNNER_TEMP/out.txt"
          ran=$(grep -oE '^Ran [0-9]+ test' "$RUNNER_TEMP/out.txt" | grep -oE '[0-9]+')
          echo "collected ${ran:-0} tests"
          if [ "${ran:-0}" -lt 200 ]; then
            echo "::error::expected at least 200 tests, collected ${ran:-0} — discovery is broken, not the suite"
            exit 1
          fi
        working-directory: Tools/linux-capture

      # The floor is DELIBERATELY below the current count, not equal to it: it catches discovery breaking
      # (a wrong working directory, a renamed pattern) rather than tracking every test added. Raise it
      # when suites are added. Lower it ONLY when suites are deliberately REMOVED, and say which — it was
      # last lowered from 114 to 70 when the Android app was removed from this fork, taking the
      # Kotlin-asserting suites in test_home_i18n / test_steps_i18n / test_appchangelog_gen with it.
      - name: Run core Tools/ tests
        run: |
          set -o pipefail
          mapfile -t files < <(find . -maxdepth 1 -name 'test_*.py' -printf '%f\n' | sort)
          modules=("${files[@]%.py}")
          python3 -m unittest -v "${modules[@]}" 2>&1 | tee "$RUNNER_TEMP/out.txt"
          ran=$(grep -oE '^Ran [0-9]+ test' "$RUNNER_TEMP/out.txt" | grep -oE '[0-9]+')
          echo "collected ${ran:-0} tests"
          if [ "${ran:-0}" -lt 70 ]; then
            echo "::error::expected at least 70 core Tools tests, collected ${ran:-0} — discovery is broken, not the suite"
            exit 1
          fi
        working-directory: Tools
  windows-capture:
    runs-on: windows-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      # Keep Windows locale defaults and exercise a strict legacy console, including subprocesses.
      # UTF-8 mode would hide implicit file encodings; replacement output would hide console bugs.
      - name: Run Tools/linux-capture tests with legacy Windows encodings
        working-directory: Tools/linux-capture
        env:
          PYTHONUTF8: '0'
          PYTHONIOENCODING: 'cp1252:strict'
          PYTHONLEGACYWINDOWSSTDIO: '1'
        shell: python
        run: |
          import sys
          import unittest

          suite = unittest.defaultTestLoader.discover('.', pattern='test_*.py')
          count = suite.countTestCases()
          print(f'collected {count} tests', flush=True)
          result = unittest.TextTestRunner(verbosity=2).run(suite)
          if count < 200 or result.testsRun < 200:
              print('::error::expected at least 200 tests; discovery or execution is incomplete')
              sys.exit(1)
          sys.exit(0 if result.wasSuccessful() else 1)