OpenBB/.github/workflows/test-unit-openbb-bls.yml

name: 🧪 test openbb-bls

on:
  pull_request:
    branches: [develop, main, v5, feature/v5-platform-api]
    paths:
      - "openbb_platform/providers/bls/**"
      - ".github/workflows/test-unit-openbb-bls.yml"
  workflow_dispatch:
    inputs:
      force_cache_rebuild:
        description: "Force the build hook to regenerate the BLS cache from live download.bls.gov (ignores actions/cache)."
        type: boolean
        default: false

permissions:
  contents: read

concurrency:
  # Cancel in-flight matrix runs when a new commit lands on the same PR.
  group: test-openbb-bls-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build sdist + wheel
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
        working-directory: openbb_platform/providers/bls
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: "3.11"

      - run: python -m pip install --upgrade pip uv

      - name: Restore BLS series cache
        id: bls-cache
        uses: actions/cache@v5
        with:
          path: openbb_platform/providers/bls/openbb_bls/assets/bls_cache.zip
          key: bls-cache-${{ hashFiles('openbb_platform/providers/bls/openbb_bls/utils/generate_cache.py') }}
          restore-keys: |
            bls-cache-

      - name: Build sdist + wheel
        env:
          OPENBB_BLS_FORCE_CACHE_REBUILD: ${{ inputs.force_cache_rebuild == true && '1' || '0' }}
        run: uv build --no-sources

      - uses: actions/upload-artifact@v5
        with:
          name: openbb-bls-dist
          path: openbb_platform/providers/bls/dist/
          if-no-files-found: error
          retention-days: 7

  lint:
    name: Lint (ruff + ty)
    needs: build
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash
        working-directory: openbb_platform/providers/bls
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: "3.11"

      - run: python -m pip install --upgrade pip uv

      - uses: actions/download-artifact@v5
        with:
          name: openbb-bls-dist
          path: openbb_platform/providers/bls/dist

      - name: Seed the cache asset from the built wheel
        run: |
          WHEEL=$(ls dist/openbb_bls-*.whl | head -1)
          mkdir -p openbb_bls/assets
          python -c "
          import sys, zipfile, shutil
          wheel = sys.argv[1]
          dest = sys.argv[2]
          with zipfile.ZipFile(wheel) as z:
              with z.open('openbb_bls/assets/bls_cache.zip') as src, open(dest, 'wb') as out:
                  shutil.copyfileobj(src, out)
          " "$WHEEL" openbb_bls/assets/bls_cache.zip
          ls -la openbb_bls/assets/bls_cache.zip

      - name: Install openbb-bls in editable mode (+ dev group)
        run: |
          uv pip install --system -e .
          uv pip install --system --group dev

      - name: ruff check
        run: ruff check openbb_bls tests integration hatch_build.py

      - name: ruff format --check
        run: ruff format --check openbb_bls tests integration hatch_build.py

      - name: ty check
        run: ty check openbb_bls

  test:
    name: Test (${{ matrix.os }} / Python ${{ matrix.python_version }})
    needs: build
    strategy:
      fail-fast: false
      matrix:
        include:
          - { os: ubuntu-latest, python_version: "3.10" }
          - { os: ubuntu-latest, python_version: "3.11" }
          - { os: ubuntu-latest, python_version: "3.12" }
          - { os: ubuntu-latest, python_version: "3.13" }
          - { os: ubuntu-latest, python_version: "3.14" }
          - { os: macos-latest, python_version: "3.10" }
          - { os: macos-latest, python_version: "3.14" }
          - { os: windows-latest, python_version: "3.10" }
          - { os: windows-latest, python_version: "3.14" }
    runs-on: ${{ matrix.os }}
    defaults:
      run:
        shell: bash
        working-directory: openbb_platform/providers/bls
    steps:
      - uses: actions/checkout@v6

      - uses: actions/setup-python@v6
        with:
          python-version: ${{ matrix.python_version }}
          allow-prereleases: true

      - uses: actions/download-artifact@v5
        with:
          name: openbb-bls-dist
          path: openbb_platform/providers/bls/dist

      - run: python -m pip install --upgrade pip uv

      - name: Seed the cache asset from the built wheel
        run: |
          WHEEL=$(ls dist/openbb_bls-*.whl | head -1)
          mkdir -p openbb_bls/assets
          python -c "
          import sys, zipfile, shutil
          wheel = sys.argv[1]
          dest = sys.argv[2]
          with zipfile.ZipFile(wheel) as z:
              with z.open('openbb_bls/assets/bls_cache.zip') as src, open(dest, 'wb') as out:
                  shutil.copyfileobj(src, out)
          " "$WHEEL" openbb_bls/assets/bls_cache.zip

      - name: Install openbb-bls from source (+ dev group)
        run: |
          uv pip install --system -e .
          uv pip install --system --group dev

      - name: Run unit tests
        run: pytest tests --cov=openbb_bls --cov-report=term-missing --cov-fail-under=100