servant/.github/workflows/master.yml

name: CI

# Trigger the workflow on push or pull request, but only for the master branch
on:
  pull_request:
  push:
    branches: [master]

jobs:
  cabal:
    name: ${{ matrix.os }} / ghc ${{ matrix.ghc }}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        cabal: ["3.4"]
        ghc:
          - "8.6.5"
          - "8.8.4"
          - "8.10.7"
          - "9.0.1"

    steps:
    - uses: actions/checkout@v2

    - uses: haskell/actions/setup@v1
      id: setup-haskell-cabal
      name: Setup Haskell
      with:
        ghc-version: ${{ matrix.ghc }}
        cabal-version: ${{ matrix.cabal }}

    - name: Freeze
      run: |
        cabal configure --enable-tests --enable-benchmarks --test-show-details=direct
        cabal freeze        

    - uses: actions/cache@v2.1.3
      name: Cache ~/.cabal/store and dist-newstyle
      with:
        path: |
          ${{ steps.setup-haskell-cabal.outputs.cabal-store }}
          dist-newstyle          
        key: ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}
        restore-keys: |
          ${{ runner.os }}-${{ matrix.ghc }}-          

    - name: Configure
      run: |
        # Using separate store-dir because default one already has 'ghc-paths' package installed
        # with hardcoded path to ghcup's GHC path (which it was built with). This leads to failure in
        # doctest, as it tries to invoke that GHC, and it doesn't exist here.
        cabal --store-dir /tmp/cabal-store install --ignore-project -j2 doctest --constraint='doctest ^>=0.18'        

    - name: Build
      run: |
        cabal build all        

    - name: Test
      run: |
        cabal test all        

    - name: Run doctests
      # doctests are broken on GHC 9 due to compiler bug:
      # https://gitlab.haskell.org/ghc/ghc/-/issues/19460
      continue-on-error: ${{ matrix.ghc == '9.0.1' }}
      run: |
        # Necessary for doctest to be found in $PATH
        export PATH="$HOME/.cabal/bin:$PATH"

        # Filter out base-compat-batteries from .ghc.environment.*, as its modules
        # conflict with those of base-compat.
        #
        # FIXME: This is an ugly hack. Ultimately, we'll want to use cabal-doctest
        # (or cabal v2-doctest, if it ever lands) to provide a clean GHC environment.
        # This might allow running doctests in GHCJS build as well.
        perl -i -e 'while (<ARGV>) { print unless /package-id\s+(base-compat-batteries)-\d+(\.\d+)*/; }' .ghc.environment.*

        (cd servant && doctest src)
        (cd servant-client && doctest src)
        (cd servant-client-core && doctest src)
        (cd servant-http-streams && doctest src)
        (cd servant-docs && doctest src)
        (cd servant-foreign && doctest src)
        (cd servant-server && doctest src)
        (cd servant-machines && doctest src)
        (cd servant-conduit && doctest src)
        (cd servant-pipes && doctest src)        

  stack:
    name: stack / ghc ${{ matrix.ghc }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        stack: ["2.7.3"]
        ghc: ["8.10.4"]

    steps:
    - uses: actions/checkout@v2

    - uses: haskell/actions/setup@v1
      name: Setup Haskell Stack
      with:
        ghc-version: ${{ matrix.ghc }}
        stack-version: ${{ matrix.stack }}

    - uses: actions/cache@v2.1.3
      name: Cache ~/.stack
      with:
        path: ~/.stack
        key: ${{ runner.os }}-${{ matrix.ghc }}-stack

    - name: Install dependencies
      run: |
        stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks --only-dependencies        

    - name: Build
      run: |
        stack build --system-ghc --test --bench --no-run-tests --no-run-benchmarks        

    - name: Test
      run: |
        stack test --system-ghc        

  ghcjs:
    name: ubuntu-18.04 / ghcjs 8.4
    runs-on: "ubuntu-18.04"

    steps:
    - uses: actions/checkout@v2

    - name: "Setup PATH"
      run: |
        echo "PATH=$HOME/.cabal/bin:/opt/ghcjs/8.4/bin:$PATH" >> $GITHUB_ENV        

    - name: Install ghcjs and cabal
      run: |
        # Default GitHub image dropped ppa:hvr/ghc, so we add it ourselves
        sudo add-apt-repository ppa:hvr/ghc
        sudo add-apt-repository ppa:hvr/ghcjs
        sudo apt-get update -y
        sudo apt-get install ghcjs-8.4
        sudo apt-get install cabal-install

        # Override cabal.project with the lightweight GHCJS one
        cp cabal.ghcjs.project cabal.project
        cat cabal.project        

    - name: Cabal update and freeze
      run: |
        cabal v2-update
        cabal v2-freeze        

    - uses: actions/cache@v2.1.3
      name: Cache ~/.cabal/store and dist-newstyle
      with:
        path: |
          ~/.cabal/store
          dist-newstyle          
        key: ubuntu-18.04-ghcjs8.4-${{ hashFiles('cabal.project.freeze') }}
        restore-keys: |
          ubuntu-18.04-ghcjs8.4-          

    - name: Install cabal-plan and hspec-discover
      run: |
        cabal v2-install -w /opt/ghc/8.4.4/bin/ghc --ignore-project cabal-plan --constraint='cabal-plan ^>=0.6.0.0' --constraint='cabal-plan +exe'
        cabal v2-install -w /opt/ghc/8.4.4/bin/ghc --ignore-project hspec-discover        

    - name: Build
      run: |
        cabal v2-build --ghcjs -w /opt/ghcjs/8.4/bin/ghcjs --enable-tests --enable-benchmarks all        

    - name: Run tests
      run: |
        # cabal v2-test does not work with GHCJS
        # See: https://github.com/haskell/cabal/issues/6175
        #
        # This invokes cabal-plan to figure out test binaries, and invokes them with node.
        cabal-plan list-bins '*:test:*' | while read -r line; do testpkg=$(echo "$line" | perl -pe 's/:.*//'); testexe=$(echo "$line" | awk '{ print $2 }'); echo "testing $textexe in package $textpkg"; (cd "$(pkgdir $testpkg)" && nodejs "$testexe".jsexe/all.js); done