plugin-contract.yml

name: Plugin contract tests

# PR-CI-weight: the plugin registry, its safety guarantees (protected-column
# safety, risk ceiling, network-off-by-default, failure isolation), the
# fd.testing contract helpers, and the shipped examples/plugins/* stay valid.
on:
  pull_request:
  push:
    branches: [main]

permissions:
  contents: read

jobs:
  plugin-contract:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
        with:
          python-version: "3.12"
          cache: pip
      - name: Install
        run: |
          python -m pip install -U pip
          pip install -e ".[dev]"
      - name: Plugin system + contract tests
        run: pytest tests/test_plugins.py -q --no-cov
      - name: Example plugins are importable and contract-valid
        run: |
          python - <<'EOF'
          import sys
          import freshdata as fd

          sys.path[:0] = [
              "examples/plugins/custom_expert",
              "examples/plugins/custom_backend",
              "examples/plugins/custom_validator",
          ]
          from acronym_expert import AcronymExpert
          from keyword_backend import KeywordBackend
          from min_rows_validator import MinRowsValidator

          fd.testing.expert_contract(AcronymExpert())
          fd.testing.semantic_backend_contract(KeywordBackend())
          fd.testing.validator_contract(MinRowsValidator())
          print("all example plugins pass their contracts")
          EOF