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