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
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:
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.
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 ## The default target for chutney jobs
38 - CHUTNEY_MAKE="test-network-all"
40 ## This matrix entry is required, but it doesn't actually create any jobs
44 ## include creates builds with gcc, linux, unless we override those defaults
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"
51 ## We also run basic tests on macOS
54 ## Turn off some newer features, turn on clang's -Wtypedef-redefinition
55 env: C_DIALECT_OPTIONS="-std=gnu99"
57 ## We run chutney on Linux, because it's faster than chutney on macOS
58 ## Chutney is a fast job, clang is slower on Linux, so we do Chutney clang
59 - env: CHUTNEY="yes" CHUTNEY_ALLOW_FAILURES="2" SKIP_MAKE_CHECK="yes"
62 ## We check asciidoc with distcheck, to make sure we remove doc products
63 - env: DISTCHECK="yes" ASCIIDOC_OPTIONS="" SKIP_MAKE_CHECK="yes"
65 ## We check disable module relay
66 - env: MODULES_OPTIONS="--disable-module-relay"
67 ## We check disable module dirauth
68 - env: MODULES_OPTIONS="--disable-module-dirauth"
70 ## We run rust on Linux, because it's faster than rust on macOS
71 ## We check rust offline
72 - env: RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true
75 ## Use -std=gnu99 to turn off some newer features, and maybe turn on some
76 ## extra gcc warnings?
77 - env: NSS_OPTIONS="--enable-nss" C_DIALECT_OPTIONS="-std=gnu99"
79 ## We include a single coverage build with the best options for coverage
80 - env: COVERAGE_OPTIONS="--enable-coverage" HARDENING_OPTIONS="" TOR_TEST_RNG_SEED="636f766572616765"
82 ## We clone our stem repo and run `make test-stem`
83 - env: TEST_STEM="yes" SKIP_MAKE_CHECK="yes"
85 ## We run `make doxygen` without `make check`.
86 - env: SKIP_MAKE_CHECK="yes" DOXYGEN="yes"
88 ## macOS builds are very slow, and we have a limited number of
89 ## concurrent macOS jobs. We're not actively developing Rust, so it is
90 ## the lowest priority.
91 ## We run rust on macOS, because we have seen macOS rust failures before
92 #- env: RUST_VERSION="nightly" RUST_OPTIONS="--enable-rust --enable-cargo-online-mode"
96 ## Allow the build to report success (with non-required sub-builds
97 ## continuing to run) if all required sub-builds have succeeded.
100 ## Careful! We use global envs, which makes it hard to allow failures by env:
101 ## https://docs.travis-ci.com/user/customizing-the-build#matching-jobs-with-allow_failures
103 ## macOS rust and chutney are very slow, so we let the build finish before
104 ## they are done. We'd like to fast finish, but still eventually show
105 ## any failures in the build status. But Travis doesn't have that ability.
107 ## Since this job is disabled, there's not much point having an exception
109 #- env: RUST_VERSION="nightly" RUST_OPTIONS="--enable-rust --enable-cargo-online-mode"
113 ## Since we're actively developing IPv6, we want to require the IPv6
115 #- env: CHUTNEY_MAKE="test-network-ipv6" CHUTNEY="yes" CHUTNEY_ALLOW_FAILURES="2" SKIP_MAKE_CHECK="yes"
118 ## (Linux only) Use a recent Linux image (Ubuntu Bionic)
121 ## Download our dependencies
126 ## Required dependencies
128 ## Ubuntu comes with OpenSSL by default
131 ## Optional dependencies
138 ## Optional build dependencies
141 ## Conditional build dependencies
142 ## Always installed, so we don't need sudo
149 ## preventing or diagnosing hangs
154 ## Required dependencies
156 ## The OSX version of OpenSSL is way too old
158 ## OSX comes with zlib by default
159 ## to use a newer zlib, pass the keg path to configure (like OpenSSL)
161 ## Optional dependencies
165 ## Required build dependencies
166 ## Tor needs pkg-config to find some dependencies at build time
168 ## Optional build dependencies
172 ## Conditional build dependencies
173 ## Always installed, because manual brew installs are hard to get right
177 ## preventing or diagnosing hangs
180 ## (OSX only) Use a recent macOS image
181 ## See https://docs.travis-ci.com/user/reference/osx#os-x-version
182 ## Default is Xcode 9.4 on macOS 10.13 as of October 2019
183 ## Recent is Xcode 11.2 on macOS 10.14 as of October 2019
187 ## Set pipefail: we use pipes
188 - set -o pipefail || echo "pipefail failed"
189 ## Create empty rust directories for non-Rust builds, so caching succeeds
190 - if [[ "$RUST_OPTIONS" == "" ]]; then mkdir -p $HOME/.cargo $TRAVIS_BUILD_DIR/src/rust/target; fi
193 ## If we're on OSX, configure ccache (ccache is automatically installed and configured on Linux)
194 - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/ccache/libexec:$PATH"; fi
195 ## 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
196 - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then OPENSSL_OPTIONS=--with-openssl-dir=`brew --prefix openssl`; fi
197 ## Install conditional features
199 - if [[ "$COVERAGE_OPTIONS" != "" ]]; then pip install --user cpp-coveralls; fi
200 ## If we're on OSX, and using asciidoc, configure asciidoc
201 - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"; fi
202 ## If we're using Rust, download rustup
203 - if [[ "$RUST_OPTIONS" != "" ]]; then curl -Ssf -o rustup.sh https://sh.rustup.rs; fi
204 ## Install the stable channels of rustc and cargo and setup our toolchain environment
205 - if [[ "$RUST_OPTIONS" != "" ]]; then sh rustup.sh -y --default-toolchain $RUST_VERSION; fi
206 - if [[ "$RUST_OPTIONS" != "" ]]; then source $HOME/.cargo/env; fi
207 ## If we're testing rust builds in offline-mode, then set up our vendored dependencies
208 - if [[ "$TOR_RUST_DEPENDENCIES" == "true" ]]; then export TOR_RUST_DEPENDENCIES=$PWD/src/ext/rust/crates; fi
209 ## If we're running chutney, install it.
210 - if [[ "$CHUTNEY" != "" ]]; then git clone --depth 1 https://github.com/torproject/chutney.git ; export CHUTNEY_PATH="$(pwd)/chutney"; fi
211 ## If we're running stem, install it.
212 - if [[ "$TEST_STEM" != "" ]]; then git clone --depth 1 https://github.com/torproject/stem.git ; export STEM_SOURCE_DIR=`pwd`/stem; fi
214 ## Finally, list installed package versions
215 - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then dpkg-query --show; fi
216 - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew list --versions; fi
217 ## Get some info about rustup, rustc and cargo
218 - if [[ "$RUST_OPTIONS" != "" ]]; then which rustup; fi
219 - if [[ "$RUST_OPTIONS" != "" ]]; then which rustc; fi
220 - if [[ "$RUST_OPTIONS" != "" ]]; then which cargo; fi
221 - if [[ "$RUST_OPTIONS" != "" ]]; then rustup --version; fi
222 - if [[ "$RUST_OPTIONS" != "" ]]; then rustc --version; fi
223 - if [[ "$RUST_OPTIONS" != "" ]]; then cargo --version; fi
224 ## Get python version
226 ## If we're running chutney, show the chutney commit
227 - if [[ "$CHUTNEY" != "" ]]; then pushd "$CHUTNEY_PATH"; git log -1 ; popd ; fi
228 ## If we're running stem, show the stem version and commit
229 - if [[ "$TEST_STEM" != "" ]]; then pushd stem; python -c "from stem import stem; print(stem.__version__);"; git log -1; popd; fi
230 ## Get the coccinelle version
231 ## Installs are unreliable on macOS, so we just rely on brew list --versions
232 - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then spatch --version; fi
233 ## We don't want Tor tests to depend on default configuration file at
234 ## ~/.torrc. So we put some random bytes in there, to make sure we get build
235 ## failures in case Tor is reading it during CI jobs.
236 - dd ibs=1 count=1024 if=/dev/urandom > ~/.torrc
239 # Skip test_rebind on macOS
240 - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export TOR_SKIP_TEST_REBIND=true; fi
242 - CONFIGURE_FLAGS="$ASCIIDOC_OPTIONS $COVERAGE_OPTIONS $HARDENING_OPTIONS $MODULES_OPTIONS $NSS_OPTIONS $OPENSSL_OPTIONS $RUST_OPTIONS --enable-fatal-warnings --disable-silent-rules"
243 - echo "Configure flags are $CONFIGURE_FLAGS CC=\"$CC $C_DIALECT_OPTIONS\""
244 - ./configure $CONFIGURE_FLAGS CC="$CC $C_DIALECT_OPTIONS"
245 ## We run `make check` because that's what https://jenkins.torproject.org does.
246 - if [[ "$SKIP_MAKE_CHECK" == "" ]]; then make check; fi
247 - if [[ "$DISTCHECK" != "" ]]; then make distcheck DISTCHECK_CONFIGURE_FLAGS="$CONFIGURE_FLAGS"; fi
248 - if [[ "$CHUTNEY" != "" ]]; then make "$CHUTNEY_MAKE"; fi
249 ## Diagnostic for bug 29437: kill stem if it hangs for 9.5 minutes
250 ## Travis will kill the job after 10 minutes with no output
251 - 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
252 - if [[ "$DOXYGEN" != "" ]]; then make doxygen; fi
253 ## If this build was one that produced coverage, upload it.
254 - if [[ "$COVERAGE_OPTIONS" != "" ]]; then coveralls -b . --exclude src/test --exclude src/trunnel --gcov-options '\-p' || echo "Coverage failed"; fi
257 ## configure will leave a log file with more details of config failures.
258 ## But the log is too long for travis' rendered view, so tail it.
259 - tail -1000 config.log || echo "tail failed"
260 ## `make check` will leave a log file with more details of test failures.
261 - if [[ "$SKIP_MAKE_CHECK" == "" ]]; then cat test-suite.log || echo "cat failed"; fi
262 ## `make distcheck` puts it somewhere different.
263 - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-testlog || echo "make failed"; fi
264 - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-core || echo "make failed"; fi
265 - if [[ "$CHUTNEY" != "" ]]; then ls test_network_log || echo "ls failed"; cat test_network_log/* || echo "cat failed"; fi
266 - if [[ "$TEST_STEM" != "" ]]; then tail -1000 "$STEM_SOURCE_DIR"/test/data/tor_log || echo "tail failed"; fi
267 - if [[ "$TEST_STEM" != "" ]]; then grep -v "SocketClosed" stem.log | tail -1000 || echo "grep | tail failed"; fi
270 ## Delete all gcov files.
271 - if [[ "$COVERAGE_OPTIONS" != "" ]]; then make reset-gcov; fi
272 ## Delete the cargo registry before caching .cargo, because it's cheaper to
273 ## download the registry and throw it away, rather than caching it
274 - rm -rf $HOME/.cargo/registry
279 - "irc.oftc.net#tor-ci"
281 - "%{repository} %{branch} %{commit} - %{author}: %{commit_subject}"
282 - "Build #%{build_number} %{result}. Details: %{build_url}"