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