.travis.yml 9.58 KB
Newer Older
1
language: c
2

teor's avatar
teor committed
3
4
cache:
  ccache: true
teor's avatar
teor committed
5
6
7
8
9
  ## cargo: true
  directories:
    - $HOME/.cargo
    ## where we point CARGO_TARGET_DIR in all our cargo invocations
    - $TRAVIS_BUILD_DIR/src/rust/target
teor's avatar
teor committed
10

teor's avatar
teor committed
11
12
13
compiler:
  - gcc
  - clang
14
15
16

os:
  - linux
teor's avatar
teor committed
17
  - osx
18

teor's avatar
teor committed
19
20
## The build matrix in the following stanza expands into builds for each
## OS and compiler.
21
22
23
24
env:
  global:
    ## The Travis CI environment allows us two cores, so let's use both.
    - MAKEFLAGS="-j 2"
teor's avatar
teor committed
25
26
27
    ## We turn on hardening by default
    ## Also known as --enable-fragile-hardening in 0.3.0.3-alpha and later
    - HARDENING_OPTIONS="--enable-expensive-hardening"
teor's avatar
teor committed
28
29
    ## We turn off asciidoc by default, because it's slow
    - ASCIIDOC_OPTIONS="--disable-asciidoc"
teor's avatar
teor committed
30
31
32
33
34
35
  matrix:
    ## We want to use each build option at least once
    ##
    ## We don't list default variable values, because we set the defaults
    ## in global (or the default is unset)
    -
36
    ## TOR_RUST_DEPENDENCIES is spelt RUST_DEPENDENCIES in 0.3.2
37
    - RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true
38
39

matrix:
teor's avatar
teor committed
40
41
42
43
44
45
  ## include creates builds with gcc, linux, sudo: false
  include:
    ## We include a single coverage build with the best options for coverage
    - env: COVERAGE_OPTIONS="--enable-coverage" HARDENING_OPTIONS=""
    ## We only want to check these build option combinations once
    ## (they shouldn't vary by compiler or OS)
teor's avatar
teor committed
46
47
    ## We run rust and coverage with hardening off, which seems like enough
    # - env: HARDENING_OPTIONS=""
teor's avatar
teor committed
48
    ## We check asciidoc with distcheck, to make sure we remove doc products
49
    - env: DISTCHECK="yes" ASCIIDOC_OPTIONS=""
rl1987's avatar
rl1987 committed
50
51
    # We clone our stem repo and run `make test-stem`
    - env: TEST_STEM="yes"
52
    ## Check rust online with distcheck, to make sure we remove rust products
53
    - env: DISTCHECK="yes" RUST_OPTIONS="--enable-rust --enable-cargo-online-mode"
54
    ## Check disable module dirauth with and without rust
55
    - env: MODULES_OPTIONS="--disable-module-dirauth" RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true
56
    - env: MODULES_OPTIONS="--disable-module-dirauth"
57
58
    ## Check NSS
    - env: NSS_OPTIONS="--enable-nss"
teor's avatar
teor committed
59

60
61
62
63
64
65
66
67
  ## Uncomment to allow the build to report success (with non-required
  ## sub-builds continuing to run) if all required sub-builds have
  ## succeeded.  This is somewhat buggy currently: it can cause
  ## duplicate notifications and prematurely report success if a
  ## single sub-build has succeeded.  See
  ## https://github.com/travis-ci/travis-ci/issues/1696
  # fast_finish: true

teor's avatar
teor committed
68
69
70
71
72
  ## Careful! We use global envs, which makes it hard to exclude or
  ## allow failures by env:
  ## https://docs.travis-ci.com/user/customizing-the-build#matching-jobs-with-allow_failures
  exclude:
    ## Clang doesn't work in containerized builds, see below.
73
    - compiler: clang
teor's avatar
teor committed
74
      sudo: false
75
    ## Non-containerized gcc are slow and redundant.
teor's avatar
teor committed
76
    - compiler: gcc
77
      sudo: required
78
    ## gcc on OSX is less useful, because the default compiler is clang.
79
80
    - compiler: gcc
      os: osx
81
82
83
84
85
    ## gcc on Linux with no env is redundant, because all the custom builds use
    ## gcc on Linux
    - compiler: gcc
      os: linux
      env:
86
87
88
89
90
    ## offline rust builds for gcc on Linux are redundant, because we do an
    ## online rust build for gcc on Linux
    - compiler: gcc
      os: linux
      ## TOR_RUST_DEPENDENCIES is spelt RUST_DEPENDENCIES in 0.3.2
91
      env: RUST_OPTIONS="--enable-rust" TOR_RUST_DEPENDENCIES=true HARDENING_OPTIONS=""
92

teor's avatar
teor committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
## We don't need sudo. (The "apt:" stanza after this allows us to not need
## sudo; otherwise, we would need it for getting dependencies.)
##
## But we use "sudo: required" to force non-containerized builds, working
## around a Travis CI environment issue: clang LeakAnalyzer fails
## because it requires ptrace and the containerized environment no
## longer allows ptrace.
## https://github.com/travis-ci/travis-ci/issues/9033
##
## In the matrix above, we exclude redundant combinations.
sudo:
  - false
  - required

## (Linux only) Use the latest Linux image (Ubuntu Trusty)
dist: trusty

teor's avatar
teor committed
110
## Download our dependencies
teor's avatar
teor committed
111
addons:
teor's avatar
teor committed
112
  ## (Linux only)
teor's avatar
teor committed
113
114
115
116
  apt:
    packages:
      ## Required dependencies
      - libevent-dev
teor's avatar
teor committed
117
118
      ## Ubuntu comes with OpenSSL by default
      #- libssl-dev
teor's avatar
teor committed
119
120
121
      - zlib1g-dev
      ## Optional dependencies
      - libcap-dev
122
      - liblzma-dev
123
      - libnss3-dev
teor's avatar
teor committed
124
125
      - libscrypt-dev
      - libseccomp-dev
126
127
      ## zstd doesn't exist in Ubuntu Trusty
      #- libzstd
teor's avatar
teor committed
128
      ## Conditional build dependencies
teor's avatar
teor committed
129
130
131
132
133
      ## Always installed, so we don't need sudo
      - asciidoc
      - docbook-xsl
      - docbook-xml
      - xmlto
rl1987's avatar
rl1987 committed
134
      - shellcheck
teor's avatar
teor committed
135
136
137
138
139
140
141
142
143
144
145
146
  ## (OSX only)
  homebrew:
    packages:
      ## Required dependencies
      - libevent
      ## The OSX version of OpenSSL is way too old
      - openssl
      ## OSX comes with zlib by default
      ## to use a newer zlib, pass the keg path to configure (like OpenSSL)
      #- zlib
      ## Optional dependencies
      - libscrypt
147
148
      - xz
      - zstd
teor's avatar
teor committed
149
150
151
152
153
154
155
156
157
      ## Required build dependencies
      ## Tor needs pkg-config to find some dependencies at build time
      - pkg-config
      ## Optional build dependencies
      - ccache
      ## Conditional build dependencies
      ## Always installed, because manual brew installs are hard to get right
      - asciidoc
      - xmlto
rl1987's avatar
rl1987 committed
158
      - shellcheck
159

teor's avatar
teor committed
160
161
162
163
164
165
## (OSX only) Use the default OSX image
## See https://docs.travis-ci.com/user/reference/osx#os-x-version
## Default is Xcode 9.4 on macOS 10.13 as of August 2018
#osx_image: xcode9.4

before_install:
teor's avatar
teor committed
166
167
  ## Create empty rust directories for non-Rust builds, so caching succeeds
  - if [[ "$RUST_OPTIONS" == "" ]]; then mkdir -p $HOME/.cargo $TRAVIS_BUILD_DIR/src/rust/target; fi
teor's avatar
teor committed
168

169
install:
teor's avatar
teor committed
170
  ## If we're on OSX, configure ccache (ccache is automatically installed and configured on Linux)
teor's avatar
teor committed
171
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/ccache/libexec:$PATH"; fi
172
173
  ## 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
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then OPENSSL_OPTIONS=--with-openssl-dir=`brew --prefix openssl`; fi
teor's avatar
teor committed
174
175
176
  ## Install conditional features
  ## Install coveralls
  - if [[ "$COVERAGE_OPTIONS" != "" ]]; then pip install --user cpp-coveralls; fi
teor's avatar
teor committed
177
  ## If we're on OSX, and using asciidoc, configure asciidoc
178
  - if [[ "$ASCIIDOC_OPTIONS" == "" ]] && [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"; fi
teor's avatar
teor committed
179
180
  ## If we're using Rust, download rustup
  - if [[ "$RUST_OPTIONS" != "" ]]; then curl -Ssf -o rustup.sh https://sh.rustup.rs; fi
181
182
  ## Install the nightly channels of rustc and cargo and setup our toolchain environment
  - if [[ "$RUST_OPTIONS" != "" ]]; then sh rustup.sh -y --default-toolchain nightly; fi
teor's avatar
teor committed
183
  - if [[ "$RUST_OPTIONS" != "" ]]; then source $HOME/.cargo/env; fi
teor's avatar
teor committed
184
  ## If we're testing rust builds in offline-mode, then set up our vendored dependencies
185
  - if [[ "$TOR_RUST_DEPENDENCIES" == "true" ]]; then export TOR_RUST_DEPENDENCIES=$PWD/src/ext/rust/crates; fi
186
  - if [[ "$TEST_STEM" != "" ]]; then git clone --depth 1 https://github.com/torproject/stem.git ; export STEM_SOURCE_DIR=`pwd`/stem; fi
187
188
189
190
  ##
  ## Finally, list installed package versions
  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then dpkg-query --show; fi
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew list --versions; fi
teor's avatar
teor committed
191
192
193
194
195
196
197
  ## Get some info about rustup, rustc and cargo
  - if [[ "$RUST_OPTIONS" != "" ]]; then which rustup; fi
  - if [[ "$RUST_OPTIONS" != "" ]]; then which rustc; fi
  - if [[ "$RUST_OPTIONS" != "" ]]; then which cargo; fi
  - if [[ "$RUST_OPTIONS" != "" ]]; then rustup --version; fi
  - if [[ "$RUST_OPTIONS" != "" ]]; then rustc --version; fi
  - if [[ "$RUST_OPTIONS" != "" ]]; then cargo --version; fi
198
199
200
  ## Get python version
  - python --version
  ## run stem tests if they are enabled.
rl1987's avatar
rl1987 committed
201
  - if [[ "$TEST_STEM" != "" ]]; then pushd stem; python -c "from stem import stem; print(stem.__version__);"; git log -1; popd; fi
202
203
204

script:
  - ./autogen.sh
205
  - CONFIGURE_FLAGS="$ASCIIDOC_OPTIONS $COVERAGE_OPTIONS $HARDENING_OPTIONS $MODULES_OPTIONS $NSS_OPTIONS $OPENSSL_OPTIONS $RUST_OPTIONS --enable-fatal-warnings --disable-silent-rules"
206
  - echo "Configure flags are $CONFIGURE_FLAGS"
207
  - ./configure $CONFIGURE_FLAGS
208
  ## We run `make check` because that's what https://jenkins.torproject.org does.
rl1987's avatar
rl1987 committed
209
  - if [[ "$DISTCHECK" == "" && "$TEST_STEM" == "" ]]; then make check; fi
210
  - if [[ "$TEST_STEM" != "" ]]; then make src/app/tor test-stem; fi
211
  - if [[ "$DISTCHECK" != "" && "$TEST_STEM" == "" ]]; then make distcheck DISTCHECK_CONFIGURE_FLAGS="$CONFIGURE_FLAGS"; fi
212

213
after_failure:
teor's avatar
teor committed
214
215
  ## configure will leave a log file with more details of config failures.
  ## But the log is too long for travis' rendered view, so tail it.
216
  - tail -1000 config.log || echo "tail failed"
217
  ## `make check` will leave a log file with more details of test failures.
218
  - if [[ "$DISTCHECK" == "" ]]; then cat test-suite.log || echo "cat failed"; fi
219
  ## `make distcheck` puts it somewhere different.
220
  - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-testlog || echo "make failed"; fi
Taylor Yu's avatar
Taylor Yu committed
221
  - if [[ "$DISTCHECK" != "" ]]; then make show-distdir-core || echo "make failed"; fi
222
223
224
225

after_success:
  ## If this build was one that produced coverage, upload it.
  - if [[ "$COVERAGE_OPTIONS" != "" ]]; then coveralls -b . --exclude src/test --exclude src/trunnel --gcov-options '\-p'; fi
teor's avatar
teor committed
226
227
228
229
230
231
232
233
234
235
236
237
238

notifications:
  irc:
    channels:
      - "irc.oftc.net#tor-ci"
    template:
      - "%{repository} %{branch} %{commit} - %{author}: %{commit_subject}"
      - "Build #%{build_number} %{result}. Details: %{build_url}"
    on_success: change
    on_failure: change
  email:
    on_success: never
    on_failure: change