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