.travis.yml 12 KB

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