run_tests_develop.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# A coverage report will be created for the Python 3.9 version
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions


name: ppipes_dev

on:
  push:
    branches-ignore: [ master ]
  pull_request:
    branches-ignore: [ master ]

jobs:
  tests:
    name: Tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11', '3.12']
        os:  [ ubuntu-latest, windows-latest ]
    steps:
      - uses: actions/checkout@v4
      - name: Install uv
        uses: astral-sh/setup-uv@38f3f104447c67c051c4a08e39b64a148898af3a #v4.2.0
        with:
          enable-cache: true
          cache-dependency-glob: "**/pyproject.toml"
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: uv sync --extra test
      - name: Test with pytest
        if: ${{ matrix.python-version != '3.11' }}
        run: |
          uv run pytest -n auto
      - name: Test without numba
        if: ${{ matrix.python-version == '3.11' }}
        run: |
          uv pip uninstall numba
          uv run pytest -n auto
      - name: Test with pytest and Codecov
        if: ${{ matrix.python-version == '3.11' }}
        run: |
          uv pip install pytest-cov
          uv run pytest --cov=./ --cov-report=xml
      - name: Upload coverage to Codecov
        if: ${{ matrix.python-version == '3.11' }}
        uses: codecov/codecov-action@v4
        with:
          verbose: true
          token: ${{ secrets.CODECOV_TOKEN }}
          dry_run: ${{ github.ref != 'refs/heads/develop' }}
          exclude: |
            '**/test/**'
            '**/__init__.py'
            'doc/**'
            'tutorials/**'
            'pandapipes/networks/network_files/**'
            '**.yml'
            '**.rst'

  linting:
    name: Linting
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install uv
        uses: astral-sh/setup-uv@38f3f104447c67c051c4a08e39b64a148898af3a #v4.2.0
        with:
          enable-cache: true
          cache-dependency-glob: "**/pyproject.toml"
          python-version: 3.11
      - name: Install dependencies
        run: |
          uv sync
          uv pip install flake8
      - name: Lint with flake8 (syntax errors and undefinded names)
        run: |
          # stop the build if there are Python syntax errors or undefined names
          uv run flake8 . --exclude .venv --count --select=E9,F63,F7,F82 --show-source --statistics
      - name: Lint with flake8 (all errors/warnings)
        run: |
          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
          uv run flake8 . --exclude .venv --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

  tutorial_tests:
    name: Tutorial tests
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11', '3.12']
        os:  [ ubuntu-latest, windows-latest ]
    steps:
      - uses: actions/checkout@v4
      - name: Install uv
        uses: astral-sh/setup-uv@38f3f104447c67c051c4a08e39b64a148898af3a #v4.2.0
        with:
          enable-cache: true
          cache-dependency-glob: "**/pyproject.toml"
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          uv sync --extra test --extra plotting
      - name: Test with pytest
        run: |
          uv run pytest --nbmake -n auto "./tutorials"
      - name: Test without numba
        if: ${{ matrix.python-version == '3.11' }}
        run: |
          uv pip uninstall numba
          uv run pytest --nbmake -n auto "./tutorials"

  docs_check:
    name: Sphinx docs check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Check sphinx build
        uses: ammaraskar/sphinx-action@7.4.7
        with:
          pre-build-command: "python -m pip install uv && uv pip install .[docs] --system"
          build-command: "sphinx-build -b html source _build -W"
          docs-folder: "doc/"