.gitlab-ci.yml

   1 ####
   2 # DO NOT EDIT THIS FILE IN MASTER.  ONLY EDIT IT IN THE OLDEST SUPPORTED
   3 # BRANCH, THEN MERGE FORWARD.
   4 ####
   5
   6 # This file controls how gitlab validates Tor commits and merge requests.
   7 #
   8 # It is primarily based on a set of scripts and configurations by
   9 # Hans-Christoph Steiner.  It only copies parts of those scripts and
  10 # configurations for now.  If you want a new piece of functionality
  11 # (more debians, more fedoras, android support) then you shouldn't
  12 # start from scratch: have a look at the original ticket, at
  13 # https://gitlab.torproject.org/tpo/core/tor/-/issues/32193 !
  14 #
  15 # The file to copy from is
  16 # https://gitlab.torproject.org/tpo/core/tor/-/merge_requests/96/diffs#diff-content-587d266bb27a4dc3022bbed44dfa19849df3044c
  17 #
  18 # Having said that, if there is anything really stupid here, don't
  19 # blame it on Hans-Christoph! Tor probably added it on their own.
  20 #
  21 # Copyright 2020, The Tor Project, Inc.
  22 # See LICENSE for licence information.
  23
  24 # These variables are set everywhere, unconditionally.
  25 variables:
  26   TERM: "ansi"
  27   DEBUG_CI: "yes"
  28
  29 # This template is for exporting ephemeral things from the scripts.  By
  30 # convention we expect our scripts to copy stuff into artifacts/, rather than
  31 # having a big list of files that be treated as artifacts.
  32 .artifacts-template: &artifacts-template
  33   artifacts:
  34     name: "${CI_PROJECT_PATH}_${CI_JOB_STAGE}_${CI_COMMIT_REF_NAME}_${CI_COMMIT_SHA}"
  35     expire_in: 1 week
  36     when: always
  37     paths:
  38       - artifacts/
  39
  40
  41 # This template is used for x86-64 builds.
  42 .x86-64-template: &x86-64-template
  43   tags:
  44     - amd64
  45
  46 # This template should be usable on any system that's based on apt.
  47 .apt-template: &apt-template |
  48       export LC_ALL=C.UTF-8
  49       echo Etc/UTC > /etc/timezone
  50       mkdir -p apt-cache
  51       export APT_CACHE_DIR="$(pwd)/apt-cache"
  52       echo 'quiet "1";' \
  53            'APT::Install-Recommends "0";' \
  54            'APT::Install-Suggests "0";' \
  55            'APT::Acquire::Retries "20";' \
  56            'APT::Get::Assume-Yes "true";' \
  57            'Dpkg::Use-Pty "0";' \
  58            "Dir::Cache::Archives \"${APT_CACHE_DIR}\"; " \
  59         >> /etc/apt/apt.conf.d/99gitlab
  60       apt-get update -qq
  61       apt-get upgrade -qy
  62
  63 # This template sets us up for Debian system in particular.
  64 .debian-template: &debian-template
  65   <<: *artifacts-template
  66   <<: *x86-64-template
  67   variables:
  68     DEBIAN_FRONTEND: "noninteractive"
  69   # TODO: Using "cache" in this way speeds up our downloads.  It would be
  70   # even better, though, to start with a pre-upgraded debian image.
  71   #
  72   # TODO: Will we have to do this differently once we have more than one
  73   # debian version that we're using?
  74   cache:
  75     key: apt
  76     paths:
  77       - apt-cache
  78   before_script:
  79     - *apt-template
  80     # Install patches unconditionally.
  81     - apt-get install
  82         automake
  83         build-essential
  84         ca-certificates
  85         git
  86         libevent-dev
  87         liblzma-dev
  88         libscrypt-dev
  89         libseccomp-dev
  90         libssl-dev
  91         pkg-config
  92         python3
  93         zlib1g-dev
  94     # Install patches that we only need for some use cases.
  95     - if [ "$ASCIIDOC" = yes ]; then apt-get install asciidoc xmlto; fi
  96     - if [ "$DOXYGEN" = yes ]; then apt-get install doxygen; fi
  97     - if [ "$STEM" = yes ]; then apt-get install timelimit; fi
  98     - if [ "$CC" = clang ]; then apt-get install clang; fi
  99     - if [ "$NSS" = yes ]; then apt-get install libnss3 libnss3-dev; fi
 100     # TODO: This next line should not be debian-only.
 101     - if [ "$STEM" = yes ]; then git clone --depth 1 https://git.torproject.org/stem.git ; export STEM_PATH="$(pwd)/stem"; fi
 102     # TODO: This next line should not be debian-only.
 103     - if [ "$CHUTNEY" = yes ]; then git clone --depth 1 https://git.torproject.org/chutney.git ;  export CHUTNEY_PATH="$(pwd)/chutney"; fi
 104     - if [ "$TRACING" = yes ]; then apt install liblttng-ust-dev; fi
 105
 106 # Minimal check on debian: just make, make check.
 107 #
 108 debian-minimal:
 109   image: debian:buster
 110   <<: *debian-template
 111   script:
 112     - ./scripts/ci/ci-driver.sh
 113
 114 # Minmal check on debian/i386: just make, make check.
 115 #
 116 debian-i386-minimal:
 117   image: i386/debian:buster
 118   <<: *debian-template
 119   script:
 120     - ./scripts/ci/ci-driver.sh
 121
 122 #####
 123 # Run "make check" with a hardened clang on debian stable.  This takes
 124 # care of a hardening check, and a compile-with-clang check.
 125 #
 126 # TODO: This will be faster once we merge #40098 and #40099.
 127 debian-hardened:
 128   image: debian:bullseye
 129   <<: *debian-template
 130   variables:
 131     ALL_BUGS_ARE_FATAL: "yes"
 132     HARDENING: "yes"
 133     CC: "clang"
 134   script:
 135     - ./scripts/ci/ci-driver.sh
 136
 137 #####
 138 # Distcheck on debian stable
 139 debian-distcheck:
 140   image: debian:buster
 141   <<: *debian-template
 142   variables:
 143     DISTCHECK: "yes"
 144     CHECK: "no"
 145   script:
 146     - ./scripts/ci/ci-driver.sh
 147
 148 #####
 149 # Documentation tests on debian stable: doxygen and asciidoc.
 150 debian-docs:
 151   image: debian:buster
 152   <<: *debian-template
 153   variables:
 154     DOXYGEN: "yes"
 155     ASCIIDOC: "yes"
 156     CHECK: "no"
 157     RUN_STAGE_BUILD: "no"
 158   script:
 159     - ./scripts/ci/ci-driver.sh
 160
 161 #####
 162 # Integration tests on debian stable: chutney and stem.
 163 #
 164 # TODO: It would be cool if this target didn't have to re-build tor, and
 165 #       could instead re-use Tor from debian-minimal.  That can be done
 166 #       with the 'artifacts' mechanism, in theory, but it would be good to
 167 #       avoid having to have a system with hundreds of artifacts.
 168 debian-integration:
 169   image: debian:buster
 170   <<: *debian-template
 171   variables:
 172     CHECK: "no"
 173     CHUTNEY: "yes"
 174     CHUTNEY_MAKE_TARGET: "test-network-all"
 175     STEM: "yes"
 176     ALL_BUGS_ARE_FATAL: "yes"
 177   script:
 178     - ./scripts/ci/ci-driver.sh
 179
 180 #####
 181 # Tracing build on Debian stable.
 182 debian-tracing:
 183   image: debian:buster
 184   <<: *debian-template
 185   variables:
 186     TRACING: "yes"
 187     CHECK: "no"
 188     DISTCHECK: "yes"
 189   script:
 190     - ./scripts/ci/ci-driver.sh
 191   # Ensure that we only run tracing when it's implemented.
 192   #
 193   # Once versions before 0.4.5 are obsolete, we can remove this test.
 194   rules:
 195     # This first "if" check prevents us from running a duplicate version of
 196     # this pipeline whenever we push and create an MR.  I don't understand why
 197     # it is necessary, though the following URL purports to explain:
 198     #
 199     # https://docs.gitlab.com/ee/ci/yaml/#prevent-duplicate-pipelines
 200     - if: '$CI_PIPELINE_SOURCE == "push"'
 201       exists:
 202         - src/lib/trace/trace_sys.c
 203
 204 #####
 205 # No-authority mode
 206 debian-disable-dirauth:
 207   image: debian:buster
 208   <<: *debian-template
 209   variables:
 210     DISABLE_DIRAUTH: "yes"
 211   script:
 212     - ./scripts/ci/ci-driver.sh
 213
 214 #####
 215 # No-relay mode
 216 debian-disable-relay:
 217   image: debian:buster
 218   <<: *debian-template
 219   variables:
 220     DISABLE_RELAY: "yes"
 221   script:
 222     - ./scripts/ci/ci-driver.sh
 223   # Ensure that we only run tracing when it's implemented.
 224   #
 225   # Once versions before 0.4.3 are obsolete, we can remove this test.
 226   rules:
 227     # This first "if" check prevents us from running a duplicate version of
 228     # this pipeline whenever we push and create an MR.  I don't understand why
 229     # it is necessary, though the following URL purports to explain:
 230     #
 231     # https://docs.gitlab.com/ee/ci/yaml/#prevent-duplicate-pipelines
 232     - if: '$CI_PIPELINE_SOURCE == "push"'
 233       exists:
 234         - src/feature/relay/relay_stub.c
 235
 236 #####
 237 # NSS check on debian
 238 debian-nss:
 239   image: debian:buster
 240   <<: *debian-template
 241   variables:
 242     NSS: "yes"
 243   script:
 244     - ./scripts/ci/ci-driver.sh