.travis.yml

   1 language: c
   2
   3 cache:
   4   ccache: true
   5   ## cargo: true
   6   directories:
   7     - $HOME/.cargo
   8     ## where we point CARGO_TARGET_DIR in all our cargo invocations
   9     - $TRAVIS_BUILD_DIR/src/rust/target
  10
  11 compiler:
  12   - gcc
  13   - clang
  14
  15 os:
  16   - linux
  17   - osx
  18
  19 ## The build matrix in the following stanza expands into builds for each
  20 ## OS and compiler.
  21 env:
  22   global:
  23     ## The Travis CI environment allows us two cores, so let's use both.
  24     - MAKEFLAGS="-j 2"
  25     ## We turn on hardening by default
  26     ## Also known as --enable-fragile-hardening in 0.3.0.3-alpha and later
  27     - HARDENING_OPTIONS="--enable-expensive-hardening"
  28     ## We turn off asciidoc by default, because it's slow
  29     - ASCIIDOC_OPTIONS="--disable-asciidoc"
  30   matrix:
  31     ## We want to use each build option at least once
  32     ##
  33     ## We don't list default variable values, because we set the defaults
  34     ## in global (or the default is unset)
  35     -
  36     ## We turn off hardening for Rust builds, because they are incompatible,
  37     ## and it's going to take a while for them to be fixed. See:
  38     ##   https:/trac.torproject.org/projects/tor/ticket/25386
  39     ##   https:/trac.torproject.org/projects/tor/ticket/26398
  40     ## TOR_RUST_DEPENDENCIES is spelt RUST_DEPENDENCIES in 0.3.2
  41     - RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true HARDENING_OPTIONS=""
  42
  43 matrix:
  44   ## include creates builds with gcc, linux, sudo: false
  45   include:
  46     ## We include a single coverage build with the best options for coverage
  47     - env: COVERAGE_OPTIONS="--enable-coverage" HARDENING_OPTIONS=""
  48     ## We only want to check these build option combinations once
  49     ## (they shouldn't vary by compiler or OS)
  50     ## We run rust and coverage with hardening off, which seems like enough
  51     # - env: HARDENING_OPTIONS=""
  52     ## We check asciidoc with distcheck, to make sure we remove doc products
  53     - env: DISTCHECK="yes" ASCIIDOC_OPTIONS=""
  54     ## Check rust online with distcheck, to make sure we remove rust products
  55     ## But without hardening (see above)
  56     - env: DISTCHECK="yes" RUST_OPTIONS="--enable-rust --enable-cargo-online-mode" HARDENING_OPTIONS=""
  57
  58   ## Uncomment to allow the build to report success (with non-required
  59   ## sub-builds continuing to run) if all required sub-builds have
  60   ## succeeded.  This is somewhat buggy currently: it can cause
  61   ## duplicate notifications and prematurely report success if a
  62   ## single sub-build has succeeded.  See
  63   ## https://github.com/travis-ci/travis-ci/issues/1696
  64   # fast_finish: true
  65
  66   ## Careful! We use global envs, which makes it hard to exclude or
  67   ## allow failures by env:
  68   ## https://docs.travis-ci.com/user/customizing-the-build#matching-jobs-with-allow_failures
  69   exclude:
  70     ## Clang doesn't work in containerized builds, see below.
  71     - compiler: clang
  72       sudo: false
  73     ## Non-containerized gcc are slow and redundant.
  74     - compiler: gcc
  75       sudo: required
  76     ## gcc on OSX is less useful, because the default compiler is clang.
  77     - compiler: gcc
  78       os: osx
  79     ## gcc on Linux with no env is redundant, because all the custom builds use
  80     ## gcc on Linux
  81     - compiler: gcc
  82       os: linux
  83       env:
  84     ## offline rust builds for gcc on Linux are redundant, because we do an
  85     ## online rust build for gcc on Linux
  86     - compiler: gcc
  87       os: linux
  88       ## TOR_RUST_DEPENDENCIES is spelt RUST_DEPENDENCIES in 0.3.2
  89       env: RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true HARDENING_OPTIONS=""
  90
  91 ## We don't need sudo. (The "apt:" stanza after this allows us to not need
  92 ## sudo; otherwise, we would need it for getting dependencies.)
  93 ##
  94 ## But we use "sudo: required" to force non-containerized builds, working
  95 ## around a Travis CI environment issue: clang LeakAnalyzer fails
  96 ## because it requires ptrace and the containerized environment no
  97 ## longer allows ptrace.
  98 ## https://github.com/travis-ci/travis-ci/issues/9033
  99 ##
 100 ## In the matrix above, we exclude redundant combinations.
 101 sudo:
 102   - false
 103   - required
 104
 105 ## (Linux only) Use the latest Linux image (Ubuntu Trusty)
 106 dist: trusty
 107
 108 ## Download our dependencies
 109 addons:
 110   ## (Linux only)
 111   apt:
 112     packages:
 113       ## Required dependencies
 114       - libevent-dev
 115       ## Ubuntu comes with OpenSSL by default
 116       #- libssl-dev
 117       - zlib1g-dev
 118       ## Optional dependencies
 119       - libcap-dev
 120       - liblzma-dev
 121       - libscrypt-dev
 122       - libseccomp-dev
 123       ## zstd doesn't exist in Ubuntu Trusty
 124       #- libzstd
 125       ## Conditional build dependencies
 126       ## Always installed, so we don't need sudo
 127       - asciidoc
 128       - docbook-xsl
 129       - docbook-xml
 130       - xmlto
 131   ## (OSX only)
 132   homebrew:
 133     packages:
 134       ## Required dependencies
 135       - libevent
 136       ## The OSX version of OpenSSL is way too old
 137       - openssl
 138       ## OSX comes with zlib by default
 139       ## to use a newer zlib, pass the keg path to configure (like OpenSSL)
 140       #- zlib
 141       ## Optional dependencies
 142       - libscrypt
 143       - xz
 144       - zstd
 145       ## Required build dependencies
 146       ## Tor needs pkg-config to find some dependencies at build time
 147       - pkg-config
 148       ## Optional build dependencies
 149       - ccache
 150       ## Conditional build dependencies
 151       ## Always installed, because manual brew installs are hard to get right
 152       - asciidoc
 153       - xmlto
 154
 155 ## (OSX only) Use the default OSX image
 156 ## See https://docs.travis-ci.com/user/reference/osx#os-x-version
 157 ## Default is Xcode 9.4 on macOS 10.13 as of August 2018
 158 #osx_image: xcode9.4
 159
 160 before_install:
 161   ## Create empty rust directories for non-Rust builds, so caching succeeds
 162   - if [[ "$RUST_OPTIONS" == "" ]]; then mkdir -p $HOME/.cargo $TRAVIS_BUILD_DIR/src/rust/target; fi
 163
 164 install:
 165   ## If we're on OSX, configure ccache (ccache is automatically installed and configured on Linux)
 166   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/ccache/libexec:$PATH"; fi
 167   ## If we're on OSX, OpenSSL is keg-only, so tor 0.2.9 and later need to be configured --with-openssl-dir= to build
 168   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then OPENSSL_OPTIONS=--with-openssl-dir=`brew --prefix openssl`; fi
 169   ## Install conditional features
 170   ## Install coveralls
 171   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then pip install --user cpp-coveralls; fi
 172   ## If we're on OSX, and using asciidoc, configure asciidoc
 173   - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"; fi
 174   ## If we're using Rust, download rustup
 175   - if [[ "$RUST_OPTIONS" != "" ]]; then curl -Ssf -o rustup.sh https://sh.rustup.rs; fi
 176   ## Install the stable channels of rustc and cargo and setup our toolchain environment
 177   - if [[ "$RUST_OPTIONS" != "" ]]; then sh rustup.sh -y --default-toolchain stable; fi
 178   - if [[ "$RUST_OPTIONS" != "" ]]; then source $HOME/.cargo/env; fi
 179   ## If we're testing rust builds in offline-mode, then set up our vendored dependencies
 180   - if [[ "$TOR_RUST_DEPENDENCIES" == "true" ]]; then export TOR_RUST_DEPENDENCIES=$PWD/src/ext/rust/crates; fi
 181   ##
 182   ## Finally, list installed package versions
 183   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then dpkg-query --show; fi
 184   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew list --versions; fi
 185   ## Get some info about rustup, rustc and cargo
 186   - if [[ "$RUST_OPTIONS" != "" ]]; then which rustup; fi
 187   - if [[ "$RUST_OPTIONS" != "" ]]; then which rustc; fi
 188   - if [[ "$RUST_OPTIONS" != "" ]]; then which cargo; fi
 189   - if [[ "$RUST_OPTIONS" != "" ]]; then rustup --version; fi
 190   - if [[ "$RUST_OPTIONS" != "" ]]; then rustc --version; fi
 191   - if [[ "$RUST_OPTIONS" != "" ]]; then cargo --version; fi
 192
 193 script:
 194   - ./autogen.sh
 195   - CONFIGURE_FLAGS="$ASCIIDOC_OPTIONS $COVERAGE_OPTIONS $HARDENING_OPTIONS $OPENSSL_OPTIONS $RUST_OPTIONS --enable-fatal-warnings --disable-silent-rules"
 196   - echo "Configure flags are $CONFIGURE_FLAGS"
 197   - ./configure $CONFIGURE_FLAGS
 198   ## We run `make check` because that's what https://jenkins.torproject.org does.
 199   - if [[ "$DISTCHECK" == "" ]]; then make check; fi
 200   - if [[ "$DISTCHECK" != "" ]]; then make distcheck DISTCHECK_CONFIGURE_FLAGS="$CONFIGURE_FLAGS"; fi
 201
 202 after_failure:
 203   ## configure will leave a log file with more details of config failures.
 204   ## But the log is too long for travis' rendered view, so tail it.
 205   - tail -1000 config.log || echo "tail failed"
 206   ## `make check` will leave a log file with more details of test failures.
 207   - if [[ "$DISTCHECK" == "" ]]; then cat test-suite.log || echo "cat failed"; fi
 208   ## `make distcheck` puts it somewhere different.
 209   - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-testlog || echo "make failed"; fi
 210
 211 after_success:
 212   ## If this build was one that produced coverage, upload it.
 213   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then coveralls -b . --exclude src/test --exclude src/trunnel --gcov-options '\-p'; fi
 214
 215 notifications:
 216   irc:
 217     channels:
 218       - "irc.oftc.net#tor-ci"
 219     template:
 220       - "%{repository} %{branch} %{commit} - %{author}: %{commit_subject}"
 221       - "Build #%{build_number} %{result}. Details: %{build_url}"
 222     on_success: change
 223     on_failure: change
 224   email:
 225     on_success: never
 226     on_failure: change