code.yml

name: Unit Tests & Code Coverage

on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_dispatch: # allow manual triggering

defaults:
  run:
    shell: bash -l {0}

jobs:
  lint:
    name: Code style
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

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

      - name: Install package
        run: |
          set -vxeuo pipefail
          python -m pip install --upgrade pip
  
      - name: Run ruff
        uses: davidslusser/actions_python_ruff@v1.0.2
        with:
          python_version: "3.11"
          # see .ruff.toml file for options

  test-matrix:
    name: Python ${{ matrix.python-version }}
    runs-on: ubuntu-latest
    needs: lint
    strategy:
      matrix:
        python-version:
          - "3.9"
          - "3.10"
          - "3.11"
          # - "3.12"
      max-parallel: 5

    steps:
      - uses: actions/checkout@v4

      - name: Create Python ${{ matrix.python-version }} environment
        # needed for Unpack step
        uses: mamba-org/setup-micromamba@v2
        with:
          cache-environment: true
          cache-environment-key: env-key-${{ matrix.python-version }}
          condarc: |
            channel-priority: flexible
          environment-file: environment.yml
          environment-name: anaconda-test-env-py-${{ matrix.python-version }}
          create-args: >-
            coveralls
            pytest
            pytest-cov
            python=${{ matrix.python-version }}
            setuptools-scm

      - name: Unpack
        run: |
          set -vxeuo pipefail
          pip install databroker-pack
          which databroker-pack
          which databroker-unpack
          cd resources
          bash ./unpack.sh
          cmd="import databroker;"
          cmd+=" print(list(databroker.catalog));"
          cmd+=" print(databroker.catalog_search_path());"
          python -c "${cmd}"
          cd ..

      # - name: Directory Listings
      #   run: |
      #     set -vxeuo pipefail
      #     ls -lAFghR ~/.local/share/intake
      #     ls -lAFghR /tmp/*_test/

      - name: Start EPICS IOCs in Docker
        run: |
          set -vxeuo pipefail
          bash ./.github/scripts/iocmgr.sh start GP gp
          bash ./.github/scripts/iocmgr.sh start ADSIM ad
          docker ps -a
          ls -lAFgh /tmp/docker_ioc/iocad/
          ls -lAFgh /tmp/docker_ioc/iocgp/

      - name: Confirm EPICS IOC is available via caget
        shell: bash -l {0}
        run: |
          set -vxeuo pipefail
          docker exec iocgp grep float1 /home/iocgp/dbl-all.txt
          docker exec iocgp /opt/base/bin/linux-x86_64/caget gp:UPTIME gp:gp:float1
          docker exec iocad /opt/base/bin/linux-x86_64/caget ad:cam1:Acquire_RBV
          which caget
          caget gp:UPTIME
          caget gp:gp:float1
          caget ad:cam1:Acquire_RBV

      - name: Confirm EPICS IOC is available via PyEpics
        shell: bash -l {0}
        run: |
          python -c "import epics; print(epics.caget('gp:UPTIME'))"
          CMD="import epics"
          CMD+="; print(epics.caget('gp:UPTIME'))"
          python -c "${CMD}"

      - name: Confirm EPICS IOC is available via ophyd
        shell: bash -l {0}
        run: |
          CMD="import ophyd"
          CMD+="; up = ophyd.EpicsSignalRO('gp:UPTIME', name='up')"
          CMD+="; pv = ophyd.EpicsSignalRO('gp:gp:float1', name='pv')"
          CMD+="; up.wait_for_connection()"
          CMD+="; print(up.get(), pv.get())"
          python -c "${CMD}"
  
      - name: Test catalog length, expect 53
        shell: bash -l {0}
        run: |
          CMD="import databroker"
          CMD+="; print(len(databroker.catalog['apstools_test']))"
          python -c "${CMD}"

      - name: Run tests with pytest & coverage
        shell: bash -l {0}
        run: |
          set -vxeuo pipefail
          coverage run --concurrency=thread --parallel-mode -m pytest -vvv --exitfirst .
          coverage combine
          coverage report --precision 3

      - name: Upload coverage data to coveralls.io
        shell: bash -l {0}
        run: |
          set -vxeuo pipefail
          micromamba list coveralls
          which coveralls
          coveralls debug
          coveralls --service=github
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          COVERALLS_FLAG_NAME: ${{ matrix.python-version }}
          COVERALLS_PARALLEL: true

  # https://coveralls-python.readthedocs.io/en/latest/usage/configuration.html#github-actions-support
  coveralls:
    name: Report unit test coverage to coveralls
    needs: test-matrix
    runs-on: ubuntu-latest
    container: python:3-slim

    steps:
      - name: Gather coverage and report to Coveralls
        run: |
          set -vxeuo pipefail
          echo "Finally!"
          pip3 install --upgrade coveralls
          # debug mode: output prepared json and reported files list to stdout
          # https://coveralls-python.readthedocs.io/en/latest/troubleshooting.html
          coveralls debug
          coveralls --service=github --finish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}