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