.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       rm -f /etc/apt/apt.conf.d/docker-clean
  53       echo 'quiet "1";' \
  54            'APT::Install-Recommends "0";' \
  55            'APT::Install-Suggests "0";' \
  56            'APT::Acquire::Retries "20";' \
  57            'APT::Get::Assume-Yes "true";' \
  58            'Dpkg::Use-Pty "0";' \
  59            "Dir::Cache::Archives \"${APT_CACHE_DIR}\"; " \
  60         >> /etc/apt/apt.conf.d/99gitlab
  61       apt-get update -qq
  62       apt-get upgrade -qy
  63
  64 # This template sets us up for Debian system in particular.
  65 .debian-template: &debian-template
  66   <<: *artifacts-template
  67   <<: *x86-64-template
  68   variables:
  69     DEBIAN_FRONTEND: "noninteractive"
  70   # TODO: Using "cache" in this way speeds up our downloads.  It would be
  71   # even better, though, to start with a pre-upgraded debian image.
  72   #
  73   # TODO: Will we have to do this differently once we have more than one
  74   # debian version that we're using?
  75   cache:
  76     key: apt
  77     paths:
  78       - apt-cache
  79   before_script:
  80     - *apt-template
  81     # Install patches unconditionally.
  82     - apt-get install
  83         apt-utils
  84         automake
  85         build-essential
  86         ca-certificates
  87         file
  88         git
  89         libevent-dev
  90         liblzma-dev
  91         libscrypt-dev
  92         libseccomp-dev
  93         libssl-dev
  94         pkg-config
  95         python3
  96         zlib1g-dev
  97     # Install patches that we only need for some use cases.
  98     - if [ "$ASCIIDOC" = yes ]; then apt-get install asciidoc xmlto; fi
  99     - if [ "$DOXYGEN" = yes ]; then apt-get install doxygen; fi
 100     - if [ "$STEM" = yes ]; then apt-get install timelimit; fi
 101     - if [ "$CC" = clang ]; then apt-get install clang; fi
 102     - if [ "$NSS" = yes ]; then apt-get install libnss3 libnss3-dev; fi
 103     # TODO: This next line should not be debian-only.
 104     - if [ "$STEM" = yes ]; then git clone --depth 1 https://gitlab.torproject.org/tpo/network-health/stem.git ; export STEM_PATH="$(pwd)/stem"; fi
 105     # TODO: This next line should not be debian-only.
 106     - if [ "$CHUTNEY" = yes ]; then git clone --depth 1 https://gitlab.torproject.org/tpo/core/chutney.git ;  export CHUTNEY_PATH="$(pwd)/chutney"; fi
 107     - if [ "$TRACING" = yes ]; then apt install liblttng-ust-dev; fi
 108
 109 # Minimal check on debian: just make, make check.
 110 #
 111 debian-minimal:
 112   image: debian:bullseye
 113   <<: *debian-template
 114   script:
 115     - ./scripts/ci/ci-driver.sh
 116
 117 # Minmal check on debian/i386: just make, make check.
 118 #
 119 debian-i386-minimal:
 120   image: i386/debian:bullseye
 121   <<: *debian-template
 122   script:
 123     - ./scripts/ci/ci-driver.sh
 124
 125 #####
 126 # Run "make check" with a hardened clang on debian stable.  This takes
 127 # care of a hardening check, and a compile-with-clang check.
 128 #
 129 # TODO: This will be faster once we merge #40098 and #40099.
 130 debian-hardened:
 131   image: debian:bullseye
 132   <<: *debian-template
 133   variables:
 134     ALL_BUGS_ARE_FATAL: "yes"
 135     HARDENING: "yes"
 136     CC: "clang"
 137   script:
 138     - ./scripts/ci/ci-driver.sh
 139
 140 #####
 141 # Distcheck on debian stable
 142 debian-distcheck:
 143   image: debian:bullseye
 144   <<: *debian-template
 145   variables:
 146     DISTCHECK: "yes"
 147     CHECK: "no"
 148   script:
 149     - ./scripts/ci/ci-driver.sh
 150
 151 #####
 152 # Documentation tests on debian stable: doxygen and asciidoc.
 153 debian-docs:
 154   image: debian:bullseye
 155   <<: *debian-template
 156   variables:
 157     DOXYGEN: "yes"
 158     ASCIIDOC: "yes"
 159     CHECK: "no"
 160     RUN_STAGE_BUILD: "no"
 161   script:
 162     - ./scripts/ci/ci-driver.sh
 163
 164 #####
 165 # Integration tests on debian stable: chutney and stem.
 166 #
 167 # TODO: It would be cool if this target didn't have to re-build tor, and
 168 #       could instead re-use Tor from debian-minimal.  That can be done
 169 #       with the 'artifacts' mechanism, in theory, but it would be good to
 170 #       avoid having to have a system with hundreds of artifacts.
 171 debian-integration:
 172   image: debian:bullseye
 173   <<: *debian-template
 174   variables:
 175     CHECK: "no"
 176     CHUTNEY: "yes"
 177     CHUTNEY_MAKE_TARGET: "test-network-all"
 178     STEM: "yes"
 179     ALL_BUGS_ARE_FATAL: "yes"
 180   script:
 181     - ./scripts/ci/ci-driver.sh
 182
 183 #####
 184 # Tracing build on Debian stable.
 185 debian-tracing:
 186   image: debian:bullseye
 187   <<: *debian-template
 188   variables:
 189     TRACING: "yes"
 190     CHECK: "no"
 191     DISTCHECK: "yes"
 192   script:
 193     - ./scripts/ci/ci-driver.sh
 194
 195 #####
 196 # No-authority mode
 197 debian-disable-dirauth:
 198   image: debian:bullseye
 199   <<: *debian-template
 200   variables:
 201     DISABLE_DIRAUTH: "yes"
 202   script:
 203     - ./scripts/ci/ci-driver.sh
 204
 205 #####
 206 # No-relay mode
 207 debian-disable-relay:
 208   image: debian:bullseye
 209   <<: *debian-template
 210   variables:
 211     DISABLE_RELAY: "yes"
 212   script:
 213     - ./scripts/ci/ci-driver.sh
 214
 215 #####
 216 # NSS check on debian
 217 debian-nss:
 218   image: debian:bullseye
 219   <<: *debian-template
 220   variables:
 221     NSS: "yes"
 222   script:
 223     - ./scripts/ci/ci-driver.sh
 224
 225 #####
 226 # Debian packaging triggers for maintenance branches
 227 debian-packaging-0.4.5:
 228   stage: deploy
 229   trigger:
 230     project: tpo/core/debian/tor
 231     branch: debian-0.4.5
 232   rules:
 233     - if: $CI_PROJECT_NAMESPACE == "tpo/core" &&
 234           $CI_COMMIT_BRANCH == "maint-0.4.5"
 235 debian-packaging-0.4.6:
 236   stage: deploy
 237   trigger:
 238     project: tpo/core/debian/tor
 239     branch: debian-0.4.6
 240   rules:
 241     - if: $CI_PROJECT_NAMESPACE == "tpo/core" &&
 242           $CI_COMMIT_BRANCH == "maint-0.4.6"