tests.yml

name: Tests

on:
    pull_request:
    push:
      branches:
        - '**'

jobs:
  build:
    name: GHC ${{ matrix.ghc-version }} on ${{ matrix.platform.arch }} ${{ matrix.platform.os }}
    runs-on: ${{ matrix.platform.os }}
    strategy:
      fail-fast: false
      matrix:
        platform:
          - { os: ubuntu-latest, arch: x64 }
          - { os: macos-13, arch: x64 }
          - { os: macos-14, arch: arm }
          - { os: windows-latest, arch: x64 }
        ghc-version:
          - 'latest'
          - '9.10'
          - '9.8'
          - '9.6'
          - '9.4'
          - '9.2'
          - '9.0'
          - '8.10'
          - '8.8'
          - '8.6'
          - '8.4'
          - '8.2'

        exclude:
          # Exclude GHC 8.2 on Windows (GHC bug: undefined reference to `__stdio_common_vswprintf_s')
          - platform:
              os: windows-latest
            ghc-version: '8.2'

          # Only allow ARM jobs with GHC >= 9.2
          # (It's tedious to not be able to use matrix.ghc-version >= 9.2 as a conditional here.)
          - platform:
              arch: arm
            ghc-version: '9.0'
          - platform:
              arch: arm
            ghc-version: '8.10'
          - platform:
              arch: arm
            ghc-version: '8.8'
          - platform:
              arch: arm
            ghc-version: '8.6'
          - platform:
              arch: arm
            ghc-version: '8.4'
          - platform:
              arch: arm
            ghc-version: '8.2'

    steps:
      - uses: actions/checkout@v4

      - name: Set up GHC ${{ matrix.ghc-version }}
        uses: haskell-actions/setup@v2
        id: setup
        with:
          ghc-version: ${{ matrix.ghc-version }}
          # Defaults, added for clarity:
          cabal-version: 'latest'
          cabal-update: true

      - name: Set up autotools (Darwin)
        if: ${{ runner.os == 'macOS' }}
        run: brew install autoconf

      - name: Set up autotools (Windows)
        if: ${{ runner.os == 'Windows' }}
        uses: msys2/setup-msys2@v2
        with:
          update: true
          install: >-
            autotools

      - name: Run autoreconf (Windows)
        if: ${{ runner.os == 'Windows' }}
        run: autoreconf -i
        shell: "msys2 {0}"

      - name: Run autoreconf (Linux & Mac)
        if: ${{ runner.os != 'Windows' }}
        run: autoreconf -i

      - name: Configure the build
        run: |
          cabal configure --enable-tests --enable-benchmarks --disable-documentation
          cabal build all --dry-run
        # The last step generates dist-newstyle/cache/plan.json for the cache key.

      - name: Restore cached dependencies
        uses: actions/cache/restore@v3
        id: cache
        env:
          key: ${{ runner.os }}-ghc-${{ steps.setup.outputs.ghc-version }}-cabal-${{ steps.setup.outputs.cabal-version }}
        with:
          path: ${{ steps.setup.outputs.cabal-store }}
          key: ${{ env.key }}-plan-${{ hashFiles('**/plan.json') }}
          restore-keys: ${{ env.key }}-

      - name: Install dependencies
        # If we had an exact cache hit, the dependencies will be up to date.
        if: steps.cache.outputs.cache-hit != 'true'
        run: cabal build process --only-dependencies

      # Cache dependencies already here, so that we do not have to rebuild them should the subsequent steps fail.
      - name: Save cached dependencies
        uses: actions/cache/save@v3
        # If we had an exact cache hit, trying to save the cache would error because of key clash.
        if: steps.cache.outputs.cache-hit != 'true'
        with:
          path: ${{ steps.setup.outputs.cabal-store }}
          key: ${{ steps.cache.outputs.cache-primary-key }}

      - name: Build
        run: cabal build process

      - name: Run tests
        run: cabal run process-tests:test

        # On Windows and with GHC >= 9.0, re-run the test-suite using WinIO.
      - name: Re-run tests with WinIO (Windows && GHC >= 9.0)
        if: ${{ runner.os == 'Windows' && matrix.ghc-version >= '9.0' }}
        run: cabal run process-tests:test -- +RTS --io-manager=native -RTS

      - name: Source dist
        run: cabal sdist all --ignore-project

      - name: Build documentation
        run: cabal haddock process

      - name: Check process.cabal
        run: cabal check

      - name: Check process-tests.cabal
        working-directory: ./test
        run: cabal check