tests.yml

name: Tests
on:
  push:
    branches:
      - master
      - dev_master
  pull_request:
    branches:
      - master
      - dev_master

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  tests_master:
    name: Test against ScopeSim release
    runs-on: ${{ matrix.os }}
    # Run if our target is IRDB master, or when this is ran manually.
    if: github.base_ref == 'master' || github.base_ref == ''
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        python-version: ['3.10', '3.11', '3.12']

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.github_actions.txt
          pip uninstall -y scopesim_templates
          pip install git+https://github.com/AstarVienna/ScopeSim_Templates.git
      - name: Run Pytest
        run: pytest
      - name: Store badge report files
        uses: actions/upload-artifact@v4
        with:
          name: badge-report
          path: _REPORTS

  tests_devmaster:
    name: Test against ScopeSim main
    runs-on: ${{ matrix.os }}
    # Run if our target is IRDB dev_master, or when this is ran manually.
    if: github.base_ref == 'dev_master' || github.base_ref == ''
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        python-version: ['3.10', '3.11', '3.12']

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.github_actions.txt
          pip uninstall -y scopesim scopesim_templates
          pip install git+https://github.com/AstarVienna/ScopeSim.git
          pip install git+https://github.com/AstarVienna/ScopeSim_Templates.git
      - name: Run Pytest
        run: pytest

  micado_notebooks:
    name: Run MICADO Notebooks
    # Run the notebooks. This is a time-consuming step, but important to catch
    # errors. It is therefore only ran on the master and dev_master branches,
    # or when manually triggered. It is not ran on pull requests.
    runs-on: ubuntu-latest
    # Run if we are on the master or dev_master branch, or if this job permissions:
    # started manually.
    # TODO: Do something smarter than github.base_ref == '', see
    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
    if: github.ref == 'dev_master' || github.ref == 'master' || github.base_ref == ''
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          # No matrix is used since this is a time-consuming tosk.
          python-version: 3.11
      - name: Install dependencies
        # TODO: Also test against ScopeSIM@master?
        # TODO: And/or ScopeSIM_Templates@dev_master?
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.github_actions.txt
          pip uninstall -y scopesim scopesim_templates
          pip install git+https://github.com/AstarVienna/ScopeSim.git
          pip install git+https://github.com/AstarVienna/ScopeSim_Templates.git
      - name: Run Notebooks
        env:
          PYDEVD_DISABLE_FILE_VALIDATION: 1
        run: |
          echo "## MICADO Notebooks tested" >> $GITHUB_STEP_SUMMARY
          sed -i "s/USE_FULL_DETECTOR = True/USE_FULL_DETECTOR = False/g" MICADO/docs/example_notebooks/*.ipynb
          sed -i 's/# cmd\[\\"!SIM.spectral.spectral_bin_width/cmd\[\\"!SIM.spectral.spectral_bin_width/g'   MICADO/docs/example_notebooks/*.ipynb
          for fn in MICADO/docs/example_notebooks/*.ipynb
          do 
            echo "${fn}"
            echo "- ${fn}" >> $GITHUB_STEP_SUMMARY
            /usr/bin/time -v jupytext --execute --update "${fn}"
          done

  metis_notebooks:
    name: Run METIS Notebooks
    # Run the notebooks. This is a time-consuming step, but important to catch
    # errors. It is therefore only ran on the master and dev_master branches,
    # or when manually triggered. It is not ran on pull requests.
    runs-on: ubuntu-latest
    # Run if we are on the master or dev_master branch, or if this job permissions:
    # started manually.
    # TODO: Do something smarter than github.base_ref == '', see
    # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
    if: github.ref == 'dev_master' || github.ref == 'master' || github.base_ref == ''
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          # No matrix is used since this is a time-consuming tosk.
          python-version: 3.11
      - name: Install dependencies
        # TODO: Also test against ScopeSIM@master?
        # TODO: And/or ScopeSIM_Templates@dev_master?
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.github_actions.txt
          pip uninstall -y scopesim scopesim_templates
          pip install git+https://github.com/AstarVienna/ScopeSim.git
          pip install git+https://github.com/AstarVienna/ScopeSim_Templates.git
      - name: Run Notebooks
        env:
          PYDEVD_DISABLE_FILE_VALIDATION: 1
        run: |
          echo "## METIS Notebooks tested" >> $GITHUB_STEP_SUMMARY
          echo "### Example Notebooks" >> $GITHUB_STEP_SUMMARY
          for fn in METIS/docs/example_notebooks/*.ipynb
          do
            echo "${fn}"
            echo "- ${fn}" >> $GITHUB_STEP_SUMMARY
            /usr/bin/time -v jupytext --execute --update "${fn}"
          done
          echo "## Demo Notebooks" >> $GITHUB_STEP_SUMMARY
          for fn in METIS/docs/example_notebooks/demos/*.ipynb
          do
            echo "${fn}"
            echo "- ${fn}" >> $GITHUB_STEP_SUMMARY
            /usr/bin/time -v jupytext --execute --update "${fn}"
          done