.travis.yml

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