.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
  16 os:
  17   - linux
  18
  19 ## We don't use the build matrix cross-product, because it makes too many jobs
  20 ## Instead, we list each job under matrix: include:
  21 env:
  22   global:
  23     ## The Travis CI environment allows us two cores, so let's use both.  Also,
  24     ## let's use the "-k" flag so that we get all of the compilation failures,
  25     ## not just the first one.
  26     - MAKEFLAGS="-k -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     ## Turn off tor's sandbox in chutney, until we fix sandbox errors that are
  33     ## triggered by Ubuntu Xenial and Bionic. See #32722.
  34     - CHUTNEY_TOR_SANDBOX="0"
  35   matrix:
  36     ## This matrix entry is required, but it doesn't actually create any jobs
  37     -
  38
  39 matrix:
  40   ## include creates builds with gcc, linux, unless we override those defaults
  41   include:
  42     ## We run basic tests on macOS
  43     - compiler: clang
  44       os: osx
  45       ## Turn off some newer features, turn on clang's -Wtypedef-redefinition
  46       env: C_DIALECT_OPTIONS="-std=gnu99"
  47     ## We check NSS
  48     ## Use -std=gnu99 to turn off some newer features, and maybe turn on some
  49     ## extra gcc warnings?
  50     - env: NSS_OPTIONS="--enable-nss" C_DIALECT_OPTIONS="-std=gnu99"
  51     ## We run chutney on Linux, because it's faster than chutney on macOS
  52     ## Chutney is a fast job, clang is slower on Linux, so we do Chutney clang
  53     - env: CHUTNEY="yes" CHUTNEY_ALLOW_FAILURES="2" SKIP_MAKE_CHECK="yes"
  54       compiler: clang
  55     ## We check asciidoc with distcheck, to make sure we remove doc products
  56     ## We use Linux clang, because there are no other Linux clang jobs
  57     - env: DISTCHECK="yes" ASCIIDOC_OPTIONS="" SKIP_MAKE_CHECK="yes"
  58       compiler: clang
  59     ## We include a single coverage build with the best options for coverage
  60     - env: COVERAGE_OPTIONS="--enable-coverage" HARDENING_OPTIONS=""
  61     ## We run rust on Linux, because it's faster than rust on macOS
  62     ## We check rust offline
  63     - env: RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true
  64     ## We check asciidoc with distcheck, to make sure we remove doc products
  65     - env: DISTCHECK="yes" ASCIIDOC_OPTIONS="" SKIP_MAKE_CHECK="yes"
  66     ## We check disable module dirauth
  67     - env: MODULES_OPTIONS="--disable-module-dirauth"
  68     ## macOS builds are very slow, and we have a limited number of
  69     ## concurrent macOS jobs. We're not actively developing Rust, so it is
  70     ## the lowest priority.
  71     ## We run rust on macOS, because we have seen macOS rust failures before
  72     #- env: RUST_OPTIONS="--enable-rust --enable-cargo-online-mode"
  73     #  compiler: clang
  74     #  os: osx
  75     ## We run chutney on macOS, because macOS Travis has IPv6
  76     - env: CHUTNEY="yes" CHUTNEY_ALLOW_FAILURES="2" SKIP_MAKE_CHECK="yes"
  77       os: osx
  78     ## We clone our stem repo and run `make test-stem`
  79     - env: TEST_STEM="yes" SKIP_MAKE_CHECK="yes"
  80
  81   ## Allow the build to report success (with non-required sub-builds
  82   ## continuing to run) if all required sub-builds have succeeded.
  83   fast_finish: true
  84
  85   ## Careful! We use global envs, which makes it hard to allow failures by env:
  86   ## https://docs.travis-ci.com/user/customizing-the-build#matching-jobs-with-allow_failures
  87   allow_failures:
  88     ## macOS rust and chutney are very slow, so we let the build finish before
  89     ## they are done.  We'd like to fast finish, but still eventually show
  90     ## any failures in the build status. But Travis doesn't have that ability.
  91     - env: RUST_OPTIONS="--enable-rust --enable-cargo-online-mode"
  92       compiler: clang
  93       os: osx
  94     - env: CHUTNEY="yes" CHUTNEY_ALLOW_FAILURES="2" SKIP_MAKE_CHECK="yes"
  95       os: osx
  96     ## test-stem sometimes hangs on Travis
  97     - env: TEST_STEM="yes" SKIP_MAKE_CHECK="yes"
  98
  99 ## (Linux only) Use a recent Linux image (Ubuntu Bionic)
 100 dist: bionic
 101
 102 ## Download our dependencies
 103 addons:
 104   ## (Linux only)
 105   apt:
 106     packages:
 107       ## Required dependencies
 108       - libevent-dev
 109       ## Ubuntu comes with OpenSSL by default
 110       #- libssl-dev
 111       - zlib1g-dev
 112       ## Optional dependencies
 113       - libcap-dev
 114       - liblzma-dev
 115       - libnss3-dev
 116       - libscrypt-dev
 117       - libseccomp-dev
 118       - libzstd-dev
 119       ## Conditional build dependencies
 120       ## Always installed, so we don't need sudo
 121       - asciidoc
 122       - docbook-xsl
 123       - docbook-xml
 124       - xmlto
 125       ## Utilities
 126       ## preventing or diagnosing hangs
 127       - timelimit
 128   ## (OSX only)
 129   homebrew:
 130     packages:
 131       ## Required dependencies
 132       - libevent
 133       ## The OSX version of OpenSSL is way too old
 134       - openssl
 135       ## OSX comes with zlib by default
 136       ## to use a newer zlib, pass the keg path to configure (like OpenSSL)
 137       #- zlib
 138       ## Optional dependencies
 139       - libscrypt
 140       - xz
 141       - zstd
 142       ## Required build dependencies
 143       ## Tor needs pkg-config to find some dependencies at build time
 144       - pkg-config
 145       ## Optional build dependencies
 146       - ccache
 147       ## Conditional build dependencies
 148       ## Always installed, because manual brew installs are hard to get right
 149       - asciidoc
 150       - xmlto
 151       ## Utilities
 152       ## preventing or diagnosing hangs
 153       - timelimit
 154
 155 ## (OSX only) Use a recent macOS 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 October 2019
 158 ## Recent is Xcode 11.2 on macOS 10.14 as of October 2019
 159 osx_image: xcode11.2
 160
 161 before_install:
 162   ## Create empty rust directories for non-Rust builds, so caching succeeds
 163   - if [[ "$RUST_OPTIONS" == "" ]]; then mkdir -p $HOME/.cargo $TRAVIS_BUILD_DIR/src/rust/target; fi
 164
 165 install:
 166   ## If we're on OSX, configure ccache (ccache is automatically installed and configured on Linux)
 167   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/ccache/libexec:$PATH"; fi
 168   ## 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
 169   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then OPENSSL_OPTIONS=--with-openssl-dir=`brew --prefix openssl`; fi
 170   ## Install conditional features
 171   ## Install coveralls
 172   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then pip install --user cpp-coveralls; fi
 173   ## If we're on OSX, and using asciidoc, configure asciidoc
 174   - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"; fi
 175   ## If we're using Rust, download rustup
 176   - if [[ "$RUST_OPTIONS" != "" ]]; then curl -Ssf -o rustup.sh https://sh.rustup.rs; fi
 177   ## Install the nightly channels of rustc and cargo and setup our toolchain environment
 178   - if [[ "$RUST_OPTIONS" != "" ]]; then sh rustup.sh -y --default-toolchain nightly; fi
 179   - if [[ "$RUST_OPTIONS" != "" ]]; then source $HOME/.cargo/env; fi
 180   ## If we're testing rust builds in offline-mode, then set up our vendored dependencies
 181   - if [[ "$TOR_RUST_DEPENDENCIES" == "true" ]]; then export TOR_RUST_DEPENDENCIES=$PWD/src/ext/rust/crates; fi
 182   ## If we're running chutney, install it.
 183   - if [[ "$CHUTNEY" != "" ]]; then git clone --depth 1 https://github.com/torproject/chutney.git ; export CHUTNEY_PATH="$(pwd)/chutney"; fi
 184   ## If we're running stem, install it.
 185   - if [[ "$TEST_STEM" != "" ]]; then git clone --depth 1 https://github.com/torproject/stem.git ; export STEM_SOURCE_DIR=`pwd`/stem; fi
 186   ##
 187   ## Finally, list installed package versions
 188   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then dpkg-query --show; fi
 189   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew list --versions; fi
 190   ## Get some info about rustup, rustc and cargo
 191   - if [[ "$RUST_OPTIONS" != "" ]]; then which rustup; fi
 192   - if [[ "$RUST_OPTIONS" != "" ]]; then which rustc; fi
 193   - if [[ "$RUST_OPTIONS" != "" ]]; then which cargo; fi
 194   - if [[ "$RUST_OPTIONS" != "" ]]; then rustup --version; fi
 195   - if [[ "$RUST_OPTIONS" != "" ]]; then rustc --version; fi
 196   - if [[ "$RUST_OPTIONS" != "" ]]; then cargo --version; fi
 197   ## Get python version
 198   - python --version
 199   ## If we're running chutney, show the chutney commit
 200   - if [[ "$CHUTNEY" != "" ]]; then pushd "$CHUTNEY_PATH"; git log -1 ; popd ; fi
 201   ## If we're running stem, show the stem version and commit
 202   - if [[ "$TEST_STEM" != "" ]]; then pushd stem; python -c "from stem import stem; print(stem.__version__);"; git log -1; popd; fi
 203
 204 script:
 205   # Skip test_rebind on macOS
 206   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export TOR_SKIP_TEST_REBIND=true; fi
 207   - ./autogen.sh
 208   - CONFIGURE_FLAGS="$ASCIIDOC_OPTIONS $COVERAGE_OPTIONS $HARDENING_OPTIONS $MODULES_OPTIONS $NSS_OPTIONS $OPENSSL_OPTIONS $RUST_OPTIONS --enable-fatal-warnings --disable-silent-rules"
 209   - echo "Configure flags are $CONFIGURE_FLAGS CC=\"$CC $C_DIALECT_OPTIONS\""
 210   - ./configure $CONFIGURE_FLAGS CC="$CC $C_DIALECT_OPTIONS"
 211   ## We run `make check` because that's what https://jenkins.torproject.org does.
 212   - if [[ "$SKIP_MAKE_CHECK" == "" ]]; then make check; fi
 213   - if [[ "$DISTCHECK" != "" ]]; then make distcheck DISTCHECK_CONFIGURE_FLAGS="$CONFIGURE_FLAGS"; fi
 214   - if [[ "$CHUTNEY" != "" ]]; then make test-network-all; fi
 215   ## Diagnostic for bug 29437: kill stem if it hangs for 9.5 minutes
 216   ## Travis will kill the job after 10 minutes with no output
 217   - 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 --test control.controller --test control.base_controller --test process --log TRACE --log-file stem.log; fi
 218   ## If this build was one that produced coverage, upload it.
 219   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then coveralls -b . --exclude src/test --exclude src/trunnel --gcov-options '\-p' || echo "Coverage failed"; fi
 220
 221 after_failure:
 222   ## configure will leave a log file with more details of config failures.
 223   ## But the log is too long for travis' rendered view, so tail it.
 224   - tail -1000 config.log || echo "tail failed"
 225   ## `make check` will leave a log file with more details of test failures.
 226   - if [[ "$SKIP_MAKE_CHECK" == "" ]]; then cat test-suite.log || echo "cat failed"; fi
 227   ## `make distcheck` puts it somewhere different.
 228   - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-testlog || echo "make failed"; fi
 229   - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-core || echo "make failed"; fi
 230   - if [[ "$CHUTNEY" != "" ]]; then ls test_network_log || echo "ls failed"; cat test_network_log/* || echo "cat failed"; fi
 231   - if [[ "$TEST_STEM" != "" ]]; then tail -1000 "$STEM_SOURCE_DIR"/test/data/tor_log || echo "tail failed"; fi
 232   - if [[ "$TEST_STEM" != "" ]]; then grep -v "SocketClosed" stem.log | tail -1000 || echo "grep | tail failed"; fi
 233
 234 before_cache:
 235   ## Delete all gcov files.
 236   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then make reset-gcov; fi
 237   ## Delete the cargo registry before caching .cargo, because it's cheaper to
 238   ## download the registry and throw it away, rather than caching it
 239   - rm -rf $HOME/.cargo/registry
 240
 241 notifications:
 242   irc:
 243     channels:
 244       - "irc.oftc.net#tor-ci"
 245     template:
 246       - "%{repository} %{branch} %{commit} - %{author}: %{commit_subject}"
 247       - "Build #%{build_number} %{result}. Details: %{build_url}"
 248     on_success: change
 249     on_failure: change
 250   email:
 251     on_success: never
 252     on_failure: change