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