Merge branch 'maint-0.3.4'
[tor.git] / .travis.yml
blob7db7577856d7c14afe5a5b399b881c8c16bf7dfa
1 language: c
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
11 compiler:
12   - gcc
13   - clang
15 os:
16   - linux
17   - osx
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     - RUST_OPTIONS="--enable-rust --enable-cargo-online-mode" HARDENING_OPTIONS=""
42 matrix:
43   ## include creates builds with gcc, linux, sudo: false
44   include:
45     ## We include a single coverage build with the best options for coverage
46     - env: COVERAGE_OPTIONS="--enable-coverage" HARDENING_OPTIONS=""
47     ## We only want to check these build option combinations once
48     ## (they shouldn't vary by compiler or OS)
49     ## We run rust and coverage with hardening off, which seems like enough
50     # - env: HARDENING_OPTIONS=""
51     ## We check asciidoc with distcheck, to make sure we remove doc products
52     - env: DISTCHECK="yes" ASCIIDOC_OPTIONS=""
53     ## Check rust offline with distcheck, to make sure we remove rust products
54     ## But without hardening (see above)
55     - env: DISTCHECK="yes" RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true HARDENING_OPTIONS=""
56     ## Check disable module dirauth with rust, and without rust but with distcheck
57     - env: MODULES_OPTIONS="--disable-module-dirauth" RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true HARDENING_OPTIONS=""
58     - env: DISTCHECK="yes" MODULES_OPTIONS="--disable-module-dirauth"
60   ## Uncomment to allow the build to report success (with non-required
61   ## sub-builds continuing to run) if all required sub-builds have
62   ## succeeded.  This is somewhat buggy currently: it can cause
63   ## duplicate notifications and prematurely report success if a
64   ## single sub-build has succeeded.  See
65   ## https://github.com/travis-ci/travis-ci/issues/1696
66   # fast_finish: true
68   ## Careful! We use global envs, which makes it hard to exclude or
69   ## allow failures by env:
70   ## https://docs.travis-ci.com/user/customizing-the-build#matching-jobs-with-allow_failures
71   exclude:
72     ## Clang doesn't work in containerized builds, see below.
73     - compiler: clang
74       sudo: false
75     ## We also exclude non-containerized gcc, because they're slow and redundant.
76     - compiler: gcc
77       sudo: required
79 ## We don't need sudo. (The "apt:" stanza after this allows us to not need
80 ## sudo; otherwise, we would need it for getting dependencies.)
82 ## But we use "sudo: required" to force non-containerized builds, working
83 ## around a Travis CI environment issue: clang LeakAnalyzer fails
84 ## because it requires ptrace and the containerized environment no
85 ## longer allows ptrace.
86 ## https://github.com/travis-ci/travis-ci/issues/9033
88 ## In the matrix above, we exclude redundant combinations.
89 sudo:
90   - false
91   - required
93 ## (Linux only) Use the latest Linux image (Ubuntu Trusty)
94 dist: trusty
96 ## (Linux only) Download our dependencies
97 addons:
98   apt:
99     packages:
100       ## Required dependencies
101       - libevent-dev
102       - zlib1g-dev
103       ## Optional dependencies
104       - libcap-dev
105       - liblzma-dev
106       - libscrypt-dev
107       - libseccomp-dev
108       ## zstd doesn't exist in Ubuntu Trusty
109       #- libzstd
110       ## Conditional dependencies
111       ## Always installed, so we don't need sudo
112       - asciidoc
113       - docbook-xsl
114       - docbook-xml
115       - xmlto
117 ## (OSX only) Use the default OSX image
118 ## See https://docs.travis-ci.com/user/reference/osx#os-x-version
119 ## Default is Xcode 9.4 on macOS 10.13 as of August 2018
120 #osx_image: xcode9.4
122 before_install:
123   ## If we're on OSX, homebrew usually needs to be updated first
124   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi
125   ## We might be upgrading some useless packages, but that's better than missing an upgrade
126   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew upgrade; fi
127   ## Create empty rust directories for non-Rust builds, so caching succeeds
128   - if [[ "$RUST_OPTIONS" == "" ]]; then mkdir -p $HOME/.cargo $TRAVIS_BUILD_DIR/src/rust/target; fi
130 install:
131   ## If we're on OSX use brew to install ccache (ccache is automatically installed on Linux)
132   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install ccache; fi
133   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/ccache/libexec:$PATH"; fi
134   ## If we're on OSX use brew to install required dependencies (for Linux, see the "apt:" section above)
135   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install libevent; fi
136   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install openssl; fi
137   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install pkg-config; fi
138   ## macOS comes with zlib by default, so the homebrew install is keg-only
139   # - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install zlib; fi
140   ## If we're on OSX also install the optional dependencies
141   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install libscrypt; fi
142   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install xz; fi
143   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install zstd; fi
144   ## 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
145   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then OPENSSL_OPTIONS=--with-openssl-dir=`brew --prefix openssl`; fi
146   ## Install conditional features
147   ## Install coveralls
148   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then pip install --user cpp-coveralls; fi
149   ## If we're on OSX, and using asciidoc, install asciidoc
150   - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install asciidoc; fi
151   - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install xmlto; fi
152   - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"; fi
153   ## If we're using Rust, download rustup
154   - if [[ "$RUST_OPTIONS" != "" ]]; then curl -Ssf -o rustup.sh https://sh.rustup.rs; fi
155   ## Install the stable channels of rustc and cargo and setup our toolchain environment
156   - if [[ "$RUST_OPTIONS" != "" ]]; then sh rustup.sh -y --default-toolchain stable; fi
157   - if [[ "$RUST_OPTIONS" != "" ]]; then source $HOME/.cargo/env; fi
158   ## If we're testing rust builds in offline-mode, then set up our vendored dependencies
159   - if [[ "$TOR_RUST_DEPENDENCIES" == "true" ]]; then export TOR_RUST_DEPENDENCIES=$PWD/src/ext/rust/crates; fi
160   ##
161   ## Finally, list installed package versions
162   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then dpkg-query --show; fi
163   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew list --versions; fi
164   ## Get some info about rustup, rustc and cargo
165   - if [[ "$RUST_OPTIONS" != "" ]]; then which rustup; fi
166   - if [[ "$RUST_OPTIONS" != "" ]]; then which rustc; fi
167   - if [[ "$RUST_OPTIONS" != "" ]]; then which cargo; fi
168   - if [[ "$RUST_OPTIONS" != "" ]]; then rustup --version; fi
169   - if [[ "$RUST_OPTIONS" != "" ]]; then rustc --version; fi
170   - if [[ "$RUST_OPTIONS" != "" ]]; then cargo --version; fi
172 script:
173   - ./autogen.sh
174   - CONFIGURE_FLAGS="$ASCIIDOC_OPTIONS $COVERAGE_OPTIONS $HARDENING_OPTIONS $MODULES_OPTIONS $OPENSSL_OPTIONS $RUST_OPTIONS --enable-fatal-warnings --disable-silent-rules"
175   - echo $CONFIGURE_FLAGS
176   - ./configure $CONFIGURE_FLAGS
177   ## We run `make check` because that's what https://jenkins.torproject.org does.
178   - if [[ "$DISTCHECK" == "" ]]; then make check; fi
179   - if [[ "$DISTCHECK" != "" ]]; then make distcheck DISTCHECK_CONFIGURE_FLAGS="$CONFIGURE_FLAGS"; fi
181 after_failure:
182   ## configure will leave a log file with more details of config failures.
183   ## But the log is too long for travis' rendered view, so tail it.
184   - tail -1000 config.log
185   ## `make check` will leave a log file with more details of test failures.
186   - if [[ "$DISTCHECK" == "" ]]; then cat test-suite.log; fi
187   ## `make distcheck` puts it somewhere different.
188   - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-testlog; fi
190 after_success:
191   ## If this build was one that produced coverage, upload it.
192   - if [[ "$COVERAGE_OPTIONS" != "" ]]; then coveralls -b . --exclude src/test --exclude src/trunnel --gcov-options '\-p'; fi
194 notifications:
195   irc:
196     channels:
197       - "irc.oftc.net#tor-ci"
198     template:
199       - "%{repository} %{branch} %{commit} - %{author}: %{commit_subject}"
200       - "Build #%{build_number} %{result}. Details: %{build_url}"
201     on_success: change
202     on_failure: change
203   email:
204     on_success: never
205     on_failure: change