.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 # This template should be usable on any system that's based on apt.
  41 .apt-template: &apt-template |
  42       export LC_ALL=C.UTF-8
  43       echo Etc/UTC > /etc/timezone
  44       mkdir -p apt-cache
  45       export APT_CACHE_DIR="$(pwd)/apt-cache"
  46       echo 'quiet "1";' \
  47            'APT::Install-Recommends "0";' \
  48            'APT::Install-Suggests "0";' \
  49            'APT::Acquire::Retries "20";' \
  50            'APT::Get::Assume-Yes "true";' \
  51            'Dpkg::Use-Pty "0";' \
  52            "Dir::Cache::Archives \"${APT_CACHE_DIR}\"; " \
  53         >> /etc/apt/apt.conf.d/99gitlab
  54       apt-get update -qq
  55       apt-get upgrade -qy
  56
  57 # This template sets us up for Debian system in particular.
  58 .debian-template: &debian-template
  59   <<: *artifacts-template
  60   variables:
  61     DEBIAN_FRONTEND: "noninteractive"
  62   # TODO: Using "cache" in this way speeds up our downloads.  It would be
  63   # even better, though, to start with a pre-upgraded debian image.
  64   #
  65   # TODO: Will we have to do this differently once we have more than one
  66   # debian version that we're using?
  67   cache:
  68     key: apt
  69     paths:
  70       - apt-cache
  71   before_script:
  72     - *apt-template
  73     # Install patches unconditionally.
  74     - apt-get install
  75         automake
  76         build-essential
  77         ca-certificates
  78         git
  79         libevent-dev
  80         liblzma-dev
  81         libscrypt-dev
  82         libseccomp-dev
  83         libssl-dev
  84         pkg-config
  85         python3
  86         zlib1g-dev
  87     # Install patches that we only need for some use cases.
  88     - if [ "$ASCIIDOC" = yes ]; then apt-get install asciidoc xmlto; fi
  89     - if [ "$DOXYGEN" = yes ]; then apt-get install doxygen; fi
  90     - if [ "$STEM" = yes ]; then apt-get install timelimit; fi
  91     - if [ "$CC" = clang ]; then apt-get install clang; fi
  92     # TODO: This next line should not be debian-only.
  93     - if [ "$STEM" = yes ]; then git clone --depth 1 https://git.torproject.org/stem.git ; export STEM_PATH="$(pwd)/stem"; fi
  94     # TODO: This next line should not be debian-only.
  95     - if [ "$CHUTNEY" = yes ]; then git clone --depth 1 https://git.torproject.org/chutney.git ;  export CHUTNEY_PATH="$(pwd)/chutney"; fi
  96     - if [ "$TRACING" = yes ]; then apt install liblttng-ust-dev; fi
  97
  98 # Minmal check on debian: just make, make check.
  99 #
 100 debian-minimal:
 101   image: debian:stable
 102   <<: *debian-template
 103   script:
 104     - ./scripts/ci/ci-driver.sh
 105
 106 #####
 107 # Run "make check" with a hardened clang on debian stable.  This takes
 108 # care of a hardening check, and a compile-with-clang check.
 109 #
 110 # TODO: This will be faster once we merge #40098 and #40099.
 111 debian-hardened:
 112   image: debian:testing
 113   <<: *debian-template
 114   variables:
 115     ALL_BUGS_ARE_FATAL: "yes"
 116     HARDENING: "yes"
 117     CC: "clang"
 118   script:
 119     - ./scripts/ci/ci-driver.sh
 120
 121 #####
 122 # Distcheck on debian stable
 123 debian-distcheck:
 124   image: debian:stable
 125   <<: *debian-template
 126   variables:
 127     DISTCHECK: "yes"
 128     CHECK: "no"
 129   script:
 130     - ./scripts/ci/ci-driver.sh
 131
 132 #####
 133 # Documentation tests on debian stable: doxygen and asciidoc.
 134 debian-docs:
 135   image: debian:stable
 136   <<: *debian-template
 137   variables:
 138     DOXYGEN: "yes"
 139     ASCIIDOC: "yes"
 140     CHECK: "no"
 141     RUN_STAGE_BUILD: "no"
 142   script:
 143     - ./scripts/ci/ci-driver.sh
 144
 145 #####
 146 # Integration tests on debian stable: chutney and stem.
 147 #
 148 # TODO: It would be cool if this target didn't have to re-build tor, and
 149 #       could instead re-use Tor from debian-minimal.  That can be done
 150 #       with the 'artifacts' mechanism, in theory, but it would be good to
 151 #       avoid having to have a system with hundreds of artifacts.
 152 debian-integration:
 153   image: debian:stable
 154   <<: *debian-template
 155   variables:
 156     CHECK: "no"
 157     CHUTNEY: "yes"
 158     STEM: "yes"
 159     ALL_BUGS_ARE_FATAL: "yes"
 160   script:
 161     - ./scripts/ci/ci-driver.sh
 162
 163 #####
 164 # Tracing build on Debian stable.
 165 debian-tracing:
 166   image: debian:stable
 167   <<: *debian-template
 168   variables:
 169     TRACING: "yes"
 170     CHECK: "no"
 171   script:
 172     - ./scripts/ci/ci-driver.sh
 173   # Ensure that we only run tracing when it's implemented.
 174   #
 175   # Once versions before 0.4.5 are obsolete, we can remove this test.
 176   rules:
 177     # This first "if" check prevents us from running a duplicate version of
 178     # this pipeline whenever we push and create an MR.  I don't understand why
 179     # it is necessary, though the following URL purports to explain:
 180     #
 181     # https://docs.gitlab.com/ee/ci/yaml/#prevent-duplicate-pipelines
 182     - if: '$CI_PIPELINE_SOURCE == "push"'
 183       exists:
 184         - src/lib/trace/trace_sys.c
 185
 186 #####
 187 # No-authority mode
 188 debian-disable-dirauth:
 189   image: debian:stable
 190   <<: *debian-template
 191   variables:
 192     DISABLE_DIRAUTH: "yes"
 193   script:
 194     - ./scripts/ci/ci-driver.sh
 195
 196 #####
 197 # No-relay mode
 198 debian-disable-relay:
 199   image: debian:stable
 200   <<: *debian-template
 201   variables:
 202     DISABLE_RELAY: "yes"
 203   script:
 204     - ./scripts/ci/ci-driver.sh
 205   # Ensure that we only run tracing when it's implemented.
 206   #
 207   # Once versions before 0.4.3 are obsolete, we can remove this test.
 208   rules:
 209     # This first "if" check prevents us from running a duplicate version of
 210     # this pipeline whenever we push and create an MR.  I don't understand why
 211     # it is necessary, though the following URL purports to explain:
 212     #
 213     # https://docs.gitlab.com/ee/ci/yaml/#prevent-duplicate-pipelines
 214     - if: '$CI_PIPELINE_SOURCE == "push"'
 215       exists:
 216         - src/feature/relay/relay_stub.c