.travis.yml

# Adapted from https://github.com/haskell-CI/haskell-ci

# NB: don't set `language: haskell` here.
language: c

# Request Ubuntu Trusty (14.04 LTS).
dist: trusty

# Explicitly request sudo-enabled virtual environments [Issue #1992].
sudo: required

cache:
  directories:
  - $HOME/.stack

##############################################################################
# Required Ubuntu packages

# The LaTeX/HTML test-suite requires:
# * `kpsewhich` (included in texlive-binaries)

##############################################################################
# Tests

# We use the word 'test' in a broad sense (e.g. it includes the Agda
# test suite, the benchmark suite, the compilation with a specific set
# of dependencies, the testing of other programs like `hTags`, etc.)

# Travis runs the builds on this order.

matrix:
  include:
    - env: TEST=MAIN GHC_VER=8.4.3 BUILD=CABAL CABAL_VER=2.2
      addons:
        apt:
          packages:
            - cabal-install-2.2
            - ghc-8.4.3
            - texlive-binaries
          sources:
            - hvr-ghc

    - env: TEST=MAIN GHC_VER=8.2.2 BUILD=CABAL CABAL_VER=2.0
      addons:
        apt:
          packages:
            - cabal-install-2.0
            - ghc-8.2.2
            - texlive-binaries
          sources:
            - hvr-ghc

    - env: TEST=MAIN GHC_VER=8.0.2 BUILD=CABAL CABAL_VER=1.24
      addons:
        apt:
          packages:
            - cabal-install-1.24
            - ghc-8.0.2
            - texlive-binaries
          sources:
            - hvr-ghc

    - env: TEST=MAIN GHC_VER=7.10.3 BUILD=CABAL CABAL_VER=1.22
      addons:
        apt:
          packages:
            - cabal-install-1.22
            - ghc-7.10.3
            - texlive-binaries
          sources:
            - hvr-ghc

    - env: TEST=STACKAGE GHC_VER=8.4.3 BUILD=STACK ARGS="--stack-yaml stack-8.4.3.yaml --system-ghc"
      addons:
        apt:
          packages:
            - ghc-8.4.3
          sources:
            - hvr-ghc

    - env: TEST=STACKAGE GHC_VER=8.2.2 BUILD=STACK ARGS="--stack-yaml stack-8.2.2.yaml --system-ghc"
      addons:
        apt:
          packages:
            - ghc-8.2.2
          sources:
            - hvr-ghc

    - env: TEST=STACKAGE GHC_VER=8.0.2 BUILD=STACK ARGS="--stack-yaml stack-8.0.2.yaml --system-ghc"
      addons:
        apt:
          packages:
            - ghc-8.0.2
          sources:
            - hvr-ghc

    - env: TEST=STACKAGE GHC_VER=7.10.3 BUILD=STACK ARGS="--stack-yaml stack-7.10.3.yaml --system-ghc"
      addons:
        apt:
          packages:
            - ghc-7.10.3
          sources:
            - hvr-ghc

    # Since `stack haddock` compiles Agda but `cabal haddock` does
    # not, this test is faster using `BUILD=CABAL` [Issue #2188].
    - env: TEST=HADDOCK GHC_VER=8.4.3 BUILD=CABAL CABAL_VER=2.2
      addons:
        apt:
          packages:
            - cabal-install-2.2
            - ghc-8.4.3
          sources:
            - hvr-ghc

    - env: TEST=USER_MANUAL BUILD=NOTHING
      language: python
      python: "3.4"

  allow_failures:
    - env: TEST=USER_MANUAL BUILD=NOTHING
      language: python
      python: "3.4"

  # Builds are loooong, we want to send an email as fast as possible.
  fast_finish: true
  # allow_failures:
  # - env: TEST=MAIN GHC_VER=8.2.2 BUILD=CABAL CABAL_VER=2.0

##############################################################################
before_install:

  - if [[ $TEST = "MAIN" || $TEST = "HADDOCK" ]]; then
       export PATH=/opt/ghc/$GHC_VER/bin:/opt/cabal/$CABAL_VER/bin:$PATH;
    elif [[ $TEST = "STACKAGE" ]]; then
         export PATH=/opt/ghc/$GHC_VER/bin:$PATH;
    fi

  - if [[ $BUILD = "STACK" ]]; then
       mkdir -p ~/.local/bin &&
       travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack' &&
       export PATH=$HOME/.local/bin:$PATH;
    fi

##############################################################################
install:
  # How much memory we have.
  - vmstat -s

  # Asking for the shell.
  - echo $SHELL

  # Node is pre-installed.
  - echo "*** Node version ***"
  - node --version

  # The container environment reports a wrong number of cores. We use
  # a `sed` script (from https://github.com/hvr/multi-ghc-travis) for
  # commenting out `jobs: $ncpus` in the Cabal configuration file.

  # The version installed of cpphs should match the lower version
  # required in Agda.cabal [Issue #2315].

  - if [[ $BUILD = "CABAL" ]]; then
       echo "*** Cabal version ***" &&
       cabal --version &&
       echo "*** GHC version ***" &&
       ghc --version &&
       echo "*** Haddock version ***" &&
       haddock --version &&
       echo "*** Emacs version ***" &&
       emacs --version &&
       export PARALLEL_TESTS=2 &&
       travis_retry cabal update &&
       sed -i 's/^jobs:/-- jobs:/' $HOME/.cabal/config &&
       cat $HOME/.cabal/config &&
       export PATH=$HOME/.cabal/bin:$PATH &&
       travis_retry cabal update &&
       travis_retry cabal fetch alex happy cpphs-1.20.8 &&
       cabal install -v0 alex happy cpphs-1.20.8 &&
       echo "*** Alex version ***" &&
       alex --version &&
       echo "*** Happy version ***" &&
       happy --version &&
       echo "*** cpphs version ***" &&
       cpphs --version ;
    fi

  - if [[ $BUILD = "STACK" ]]; then
       echo "*** GHC version ***" &&
       ghc --version &&
       echo "*** Haddock version ***" &&
       haddock --version &&
       echo "*** Emacs version ***" &&
       emacs --version &&
       echo "*** Stack version ***" &&
       stack --version ;
    fi

##############################################################################
# Installing the dependencies

# N.B. that `cabal install` doesn't set up the number of jobs by default
# (cabal-install 1.22.4.0). See https://github.com/haskell/cabal/issues/2628.

# TODO (2016-02-21): Split the long lines (`\` doesn't work).

# N.B. that we use the `--force-reinstalls` option [Issue 1520].

# We are using `make CABAL_OPTS...` because we are including the
# options to `cabal install` set up in the `Makefile`.
  - if [[ $TEST = "MAIN" || $TEST = "HADDOCK" ]]; then
       travis_retry cabal fetch `cabal install --dependencies-only --force-reinstalls --dry-run | sed 1,2d | sed "s|(latest[^)]*)||g"` &&
       make CABAL_OPTS='-v0 --only-dependencies --force-reinstalls' install-bin;
    elif [[ $TEST = "STACKAGE" ]]; then
         stack build $ARGS --no-terminal --only-dependencies;
    fi

##############################################################################
# Installing Agda

  - export BUILD_DIR=$HOME/dist

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR CABAL_OPTS=-v1 install-bin;
    fi

##############################################################################
# Getting the standard library

  - if [[ $TEST = "MAIN" ]]; then
       make up-to-date-std-lib;
    fi

##############################################################################
# Installing Sphinx

# Required for making the user manual.

# Note that the `--user` option put the Sphinx binaries in
# `$HOME/.local/bin`.

  - if [[ $TEST = "USER_MANUAL" ]]; then
       pip install -r doc/user-manual/requirements.txt &&
       export PATH=$HOME/.local/bin:$PATH &&
       echo "*** sphinx-build version ***" &&
       sphinx-build --version ;
    fi

##############################################################################
# Installing TeX Live and LaTeX packages (required by the user manual)

# A *recent* version of TeX Live is required for making the user
# manual. The installation of TeX Live was based on the instructions
# used by Travis when the build environment is `language : r`.

  - if [[ $TEST = "USER_MANUAL" ]]; then
       travis_retry curl -Lo /tmp/texlive.tar.gz https://github.com/jimhester/ubuntu-bin/releases/download/latest/texlive.tar.gz &&
       tar xzf /tmp/texlive.tar.gz -C ~ &&
       export PATH=$HOME/texlive/bin/x86_64-linux:$PATH &&
       tlmgr update --self &&
       tlmgr install anyfontsize capt-of cmap dejavu dvipng fncychap latexmk needspace &&
       echo "*** pdfLaTeX version ***" &&
       pdflatex --version &&
       echo "*** Latexmk version ***" &&
       latexmk --version &&
       echo "*** XeLaTeX version ***" &&
       xelatex --version ;
    fi

##############################################################################
# Installing a recent version of Node (see Issue #2192)

  - if [[ $TEST = "MAIN" ]]; then
       export AGDA_HOME=`pwd` &&
       export NODE_VERSION=v0.12.16 &&
       export NODE_DIR=node-${NODE_VERSION}-linux-x64 &&
       export NODE_TARBALL=${NODE_DIR}.tar.xz &&
       cd $HOME &&
       travis_retry wget https://nodejs.org/download/release/${NODE_VERSION}/${NODE_TARBALL} &&
       tar xJf ${NODE_TARBALL} &&
       export PATH=${HOME}/${NODE_DIR}/bin:$PATH &&
       cd $AGDA_HOME &&
       echo "*** Node version ***" &&
       node --version ;
    fi

##############################################################################
# Some tests

# ASR (2016-09-17). Running the following tests, which use stack, here
# instead of in the `script` section is faster because Agda's
# dependencies are not installed again.

##############################################################################
# We test on Stackage the default and non-default Agda flags.

# Default flags: `cpphs` instead of `cpp`, `debug` off and
# `enable-cluster-counting` off.

# Issues related to the flags: `cpp` instead of `cpphs` [Issue #1647]
# and the `debug` flag [Issue #2070].

# N.B. that these tests are not include in the Makefile tests.

  - if [[ $TEST = "STACKAGE" ]]; then
       stack build $ARGS --no-terminal &&
       stack build $ARGS --no-terminal --flag Agda:-cpphs --flag Agda:debug --flag Agda:enable-cluster-counting;
    fi

##############################################################################
script:

##############################################################################

  - if [[ $TEST = "MAIN" ]]; then
       make check-whitespace;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS} --hide-successes" BUILD_DIR=$BUILD_DIR succeed;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS} --hide-successes" BUILD_DIR=$BUILD_DIR fail;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR interaction;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR interactive;
    fi

# We don't run LaTeX/XeLaTeX/LuaLaTeX on Travis (see Issues #1022 and
# #1675), but we still compare the generated tex/html files with the
# golden files.

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS} --hide-successes" BUILD_DIR=$BUILD_DIR DONT_RUN_LATEX="Y" latex-html-test;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR examples;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR library-test;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR api-test;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS} --hide-successes" BUILD_DIR=$BUILD_DIR user-manual-test;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS} --hide-successes" BUILD_DIR=$BUILD_DIR internal-tests;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR benchmark-without-logs;
    fi

# 2016-04-15: The option `AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS}"` doesn't work
# with the `compiler-test`.

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="--hide-successes" BUILD_DIR=$BUILD_DIR compiler-test;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make AGDA_TESTS_OPTIONS="-j${PARALLEL_TESTS} --hide-successes" BUILD_DIR=$BUILD_DIR lib-succeed;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR lib-interaction;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR TAGS;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       cabal install -v0 --ghc-option=-w shelltestrunner &&
       make test-size-solver;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make BUILD_DIR=$BUILD_DIR testing-emacs-mode;
    fi

  - if [[ $TEST = "MAIN" ]]; then
       make install-agda-bisect;
    fi

##############################################################################
# Testing Haddock [Issue 1773]

  - if [[ $TEST = "HADDOCK" ]]; then
       make BUILD_DIR=$BUILD_DIR haddock;
    fi

##############################################################################
# Making the user manual

  - if [[ $TEST = "USER_MANUAL" ]]; then
       make user-manual-html &&
       make user-manual-pdf &&
       make user-manual-linkcheck ;
    fi

##############################################################################
# Every master and maintenance branches >= 2.5 or >= maint-2.4 must
# be here. You can also add your private branches if you want travis to
# test them.

branches:
  only:
    - master
    - future
    - maint-2.4
    - stable-2.5
    - release-2.5.1