test.yml

name: Pull request
on:
  pull_request:
    types: [opened, reopened, synchronize]

jobs:
  lint:
    name: Lint content
    runs-on: ubuntu-22.04
    steps:
      - name: Check out repository
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5
        with:
          fetch-depth: 0 # Enable gitlint to check all PR commit messages

      - uses: cachix/install-nix-action@8887e596b4ee1134dae06b98d573bd674693f47c # v26

      - uses: cachix/cachix-action@18cf96c7c98e048e10a83abd92116114cd8504be # v14
        with:
          name: linz
          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"

      - name: Cache pre-commit
        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
        with:
          path: ~/.cache/pre-commit
          key:
            ${{ secrets.CACHE_SEED }}-${{ hashFiles('.pre-commit-config.yaml')
            }}

      - name: Run pre-commit hooks
        run: nix-shell --pure --run 'pre-commit run --all-files'

      - name: Check all commit messages in Pull Request
        run:
          nix-shell --pure --run 'gitlint --commits origin/${{ github.base_ref
          }}..${{ github.event.pull_request.head.sha }}'

  test-machine-readable-to-human-readable-date-time:
    name: Test machine readable to human-readable date/time using Nix
    runs-on: ubuntu-22.04
    defaults:
      run:
        working-directory: machine-readable-to-human-readable-date-time
    steps:
      - name: Check out repository
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5

      - uses: cachix/install-nix-action@8887e596b4ee1134dae06b98d573bd674693f47c # v26

      - uses: cachix/cachix-action@18cf96c7c98e048e10a83abd92116114cd8504be # v14
        with:
          name: linz
          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"

      - name: Run test
        run: nix-shell --pure --run 'LC_MESSAGES=C TZ=UTC mocha'

  test-sentinel-water-extraction-nix:
    name: Test Sentinel-${{ matrix.sentinel }} using Nix
    runs-on: ubuntu-22.04
    defaults:
      run:
        working-directory:
          flooding/sentinel${{ matrix.sentinel }}_water_extraction
    strategy:
      fail-fast: false
      matrix:
        sentinel:
          - "1"
          - "2"
    steps:
      - name: Check out repository
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5

      - uses: cachix/install-nix-action@8887e596b4ee1134dae06b98d573bd674693f47c # v26

      - uses: cachix/cachix-action@18cf96c7c98e048e10a83abd92116114cd8504be # v14
        with:
          name: linz
          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"

      - name: Run test
        run:
          nix-shell --pure --run 'jupyter nbconvert --debug --execute --inplace
          --to=notebook sentinel${{ matrix.sentinel }}_water_extraction.ipynb'

  test-sentinel-water-extraction-poetry:
    name:
      Test Sentinel-${{ matrix.sentinel }} on ${{ matrix.runner }}, using Poetry
      with Python ${{ matrix.python }}
    runs-on: ${{ matrix.runner }}
    defaults:
      run:
        shell: bash --login -o errexit {0} # https://github.com/conda-incubator/setup-miniconda/tree/7e642bb2e4ca56ff706818a0febf72bb226d348d#use-a-default-shell
        working-directory:
          flooding/sentinel${{ matrix.sentinel }}_water_extraction
    strategy:
      fail-fast: false
      matrix:
        runner:
          - macos-12
          - ubuntu-22.04
          - windows-2022
        python:
          - "3.9"
          - "3.11"
        sentinel:
          - "1"
          - "2"
        include:
          - runner: macos-12
            pip-cache-dir: ~/Library/Caches/pip
          - runner: ubuntu-22.04
            pip-cache-dir: ~/.cache/pip
          - runner: windows-2022
            pip-cache-dir: ~\AppData\Local\pip\Cache
    steps:
      - name: Check out repository
        uses: actions/checkout@44c2b7a8a4ea60a981eaca3cf939b5f4305c123b # v4.1.5

      - name: Cache pip packages
        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
        with:
          path: ${{ matrix.pip-cache-dir }}
          key:
            ${{ runner.os }}-pip-${{ secrets.CACHE_SEED }}-${{ matrix.python
            }}-${{ hashFiles('./flooding/sentinel${{ matrix.sentinel
            }}_water_extraction/poetry.lock') }}
          restore-keys:
            ${{ runner.os }}-pip-${{ secrets.CACHE_SEED }}-${{ matrix.python }}

      - name: Cache Conda packages
        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
        with:
          path: ~/conda_pkgs_dir
          key:
            ${{ runner.os }}-conda-${{ secrets.CACHE_SEED }}-${{ matrix.python
            }}

      - name: Get GDAL Python package version
        run: |
          GDAL_VERSION="$(grep --max-count=1 --only-matching 'file = "GDAL-.*\.tar\.gz"' poetry.lock)"
          # Use character removal compatible with macOS 12
          GDAL_VERSION="${GDAL_VERSION#?????????????}"
          GDAL_VERSION="${GDAL_VERSION%????????}"
          echo "GDAL_VERSION=$GDAL_VERSION" >> $GITHUB_ENV

      - name: Setup Conda
        uses: conda-incubator/setup-miniconda@a4260408e20b96e80095f42ff7f1a15b27dd94ca # v3.0.4
        with:
          channels: conda-forge
          python-version: ${{ matrix.python }}

      - name: Install Conda environment packages
        run: conda install --channel=conda-forge --quiet --yes gdal=${{
          env.GDAL_VERSION }} poetry=1.3.2 # Workaround for https://github.com/python-poetry/poetry/issues/7589

      - name: Install Python packages on non-Windows runner
        run: poetry install --only=main --no-root
        if: ${{ !startsWith(runner.os, 'Windows') }}

      - name:
          Install Python packages on Windows runner (Workaround for
          https://github.com/python-poetry/poetry/issues/1031)
        uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e # v3.0.0
        with:
          timeout_minutes: 9999 # Workaround for https://github.com/nick-fields/retry/issues/107
          max_attempts: 6
          command: bash --login -o errexit -c 'cd flooding/sentinel${{
            matrix.sentinel }}_water_extraction && poetry install --only=main
            --no-root' # Workaround for https://github.com/python-poetry/poetry/issues/7363 / https://github.com/nick-fields/retry/issues/89
          shell: bash
        if: ${{ startsWith(runner.os, 'Windows') }}

      - name: Run test
        run:
          poetry run jupyter nbconvert --debug --execute --inplace --to=notebook
          sentinel${{ matrix.sentinel }}_water_extraction.ipynb

  finalise:
    if: always()
    needs:
      - lint
      - test-machine-readable-to-human-readable-date-time
      - test-sentinel-water-extraction-nix
      - test-sentinel-water-extraction-poetry
    runs-on: ubuntu-22.04
    steps:
      - name: Decide whether the needed jobs succeeded or failed
        uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2
        with:
          jobs: ${{ toJSON(needs) }}