1# Library of functions shared by all CI scripts 2 3skip_branch_tip_with_tag () { 4 # Sometimes, a branch is pushed at the same time the tag that points 5 # at the same commit as the tip of the branch is pushed, and building 6 # both at the same time is a waste. 7 # 8 # When the build is triggered by a push to a tag, $CI_BRANCH will 9 # have that tagname, e.g. v2.14.0. Let's see if $CI_BRANCH is 10 # exactly at a tag, and if so, if it is different from $CI_BRANCH. 11 # That way, we can tell if we are building the tip of a branch that 12 # is tagged and we can skip the build because we won't be skipping a 13 # build of a tag. 14 15 if TAG=$(git describe --exact-match "$CI_BRANCH" 2>/dev/null) && 16 test "$TAG" != "$CI_BRANCH" 17 then 18 echo "$(tput setaf 2)Tip of $CI_BRANCH is exactly at $TAG$(tput sgr0)" 19 exit 0 20 fi 21} 22 23# Save some info about the current commit's tree, so we can skip the build 24# job if we encounter the same tree again and can provide a useful info 25# message. 26save_good_tree () { 27 echo "$(git rev-parse $CI_COMMIT^{tree}) $CI_COMMIT $CI_JOB_NUMBER $CI_JOB_ID" >>"$good_trees_file" 28 # limit the file size 29 tail -1000 "$good_trees_file" >"$good_trees_file".tmp 30 mv "$good_trees_file".tmp "$good_trees_file" 31} 32 33# Skip the build job if the same tree has already been built and tested 34# successfully before (e.g. because the branch got rebased, changing only 35# the commit messages). 36skip_good_tree () { 37 if test "$TRAVIS_DEBUG_MODE" = true || test true = "$GITHUB_ACTIONS" 38 then 39 return 40 fi 41 42 if ! good_tree_info="$(grep "^$(git rev-parse $CI_COMMIT^{tree}) " "$good_trees_file")" 43 then 44 # Haven't seen this tree yet, or no cached good trees file yet. 45 # Continue the build job. 46 return 47 fi 48 49 echo "$good_tree_info" | { 50 read tree prev_good_commit prev_good_job_number prev_good_job_id 51 52 if test "$CI_JOB_ID" = "$prev_good_job_id" 53 then 54 cat <<-EOF 55 $(tput setaf 2)Skipping build job for commit $CI_COMMIT.$(tput sgr0) 56 This commit has already been built and tested successfully by this build job. 57 To force a re-build delete the branch's cache and then hit 'Restart job'. 58 EOF 59 else 60 cat <<-EOF 61 $(tput setaf 2)Skipping build job for commit $CI_COMMIT.$(tput sgr0) 62 This commit's tree has already been built and tested successfully in build job $prev_good_job_number for commit $prev_good_commit. 63 The log of that build job is available at $(url_for_job_id $prev_good_job_id) 64 To force a re-build delete the branch's cache and then hit 'Restart job'. 65 EOF 66 fi 67 } 68 69 exit 0 70} 71 72check_unignored_build_artifacts () 73{ 74 ! git ls-files --other --exclude-standard --error-unmatch \ 75 -- ':/*' 2>/dev/null || 76 { 77 echo "$(tput setaf 1)error: found unignored build artifacts$(tput sgr0)" 78 false 79 } 80} 81 82# GitHub Action doesn't set TERM, which is required by tput 83export TERM=${TERM:-dumb} 84 85# Clear MAKEFLAGS that may come from the outside world. 86export MAKEFLAGS= 87 88# Set 'exit on error' for all CI scripts to let the caller know that 89# something went wrong. 90# Set tracing executed commands, primarily setting environment variables 91# and installing dependencies. 92set -ex 93 94if test true = "$TRAVIS" 95then 96 CI_TYPE=travis 97 # When building a PR, TRAVIS_BRANCH refers to the *target* branch. Not 98 # what we want here. We want the source branch instead. 99 CI_BRANCH="${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}" 100 CI_COMMIT="$TRAVIS_COMMIT" 101 CI_JOB_ID="$TRAVIS_JOB_ID" 102 CI_JOB_NUMBER="$TRAVIS_JOB_NUMBER" 103 CI_OS_NAME="$TRAVIS_OS_NAME" 104 CI_REPO_SLUG="$TRAVIS_REPO_SLUG" 105 106 cache_dir="$HOME/travis-cache" 107 108 url_for_job_id () { 109 echo "https://travis-ci.org/$CI_REPO_SLUG/jobs/$1" 110 } 111 112 BREW_INSTALL_PACKAGES="git-lfs gettext" 113 export GIT_PROVE_OPTS="--timer --jobs 3 --state=failed,slow,save" 114 export GIT_TEST_OPTS="--verbose-log -x --immediate" 115 MAKEFLAGS="$MAKEFLAGS --jobs=2" 116elif test -n "$SYSTEM_COLLECTIONURI" || test -n "$SYSTEM_TASKDEFINITIONSURI" 117then 118 CI_TYPE=azure-pipelines 119 # We are running in Azure Pipelines 120 CI_BRANCH="$BUILD_SOURCEBRANCH" 121 CI_COMMIT="$BUILD_SOURCEVERSION" 122 CI_JOB_ID="$BUILD_BUILDID" 123 CI_JOB_NUMBER="$BUILD_BUILDNUMBER" 124 CI_OS_NAME="$(echo "$AGENT_OS" | tr A-Z a-z)" 125 test darwin != "$CI_OS_NAME" || CI_OS_NAME=osx 126 CI_REPO_SLUG="$(expr "$BUILD_REPOSITORY_URI" : '.*/\([^/]*/[^/]*\)$')" 127 CC="${CC:-gcc}" 128 129 # use a subdirectory of the cache dir (because the file share is shared 130 # among *all* phases) 131 cache_dir="$HOME/test-cache/$SYSTEM_PHASENAME" 132 133 url_for_job_id () { 134 echo "$SYSTEM_TASKDEFINITIONSURI$SYSTEM_TEAMPROJECT/_build/results?buildId=$1" 135 } 136 137 export GIT_PROVE_OPTS="--timer --jobs 10 --state=failed,slow,save" 138 export GIT_TEST_OPTS="--verbose-log -x --write-junit-xml" 139 MAKEFLAGS="$MAKEFLAGS --jobs=10" 140 test windows_nt != "$CI_OS_NAME" || 141 GIT_TEST_OPTS="--no-chain-lint --no-bin-wrappers $GIT_TEST_OPTS" 142elif test true = "$GITHUB_ACTIONS" 143then 144 CI_TYPE=github-actions 145 CI_BRANCH="$GITHUB_REF" 146 CI_COMMIT="$GITHUB_SHA" 147 CI_OS_NAME="$(echo "$RUNNER_OS" | tr A-Z a-z)" 148 test macos != "$CI_OS_NAME" || CI_OS_NAME=osx 149 CI_REPO_SLUG="$GITHUB_REPOSITORY" 150 CI_JOB_ID="$GITHUB_RUN_ID" 151 CC="${CC:-gcc}" 152 DONT_SKIP_TAGS=t 153 154 cache_dir="$HOME/none" 155 156 export GIT_PROVE_OPTS="--timer --jobs 10" 157 export GIT_TEST_OPTS="--verbose-log -x" 158 MAKEFLAGS="$MAKEFLAGS --jobs=10" 159 test windows != "$CI_OS_NAME" || 160 GIT_TEST_OPTS="--no-chain-lint --no-bin-wrappers $GIT_TEST_OPTS" 161else 162 echo "Could not identify CI type" >&2 163 env >&2 164 exit 1 165fi 166 167good_trees_file="$cache_dir/good-trees" 168 169mkdir -p "$cache_dir" 170 171test -n "${DONT_SKIP_TAGS-}" || 172skip_branch_tip_with_tag 173skip_good_tree 174 175if test -z "$jobname" 176then 177 jobname="$CI_OS_NAME-$CC" 178fi 179 180export DEVELOPER=1 181export DEFAULT_TEST_TARGET=prove 182export GIT_TEST_CLONE_2GB=true 183export SKIP_DASHED_BUILT_INS=YesPlease 184 185case "$jobname" in 186linux-clang|linux-gcc|linux-leaks) 187 if [ "$jobname" = linux-gcc ] 188 then 189 export CC=gcc-8 190 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/python3" 191 else 192 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/python2" 193 fi 194 195 export GIT_TEST_HTTPD=true 196 197 # The Linux build installs the defined dependency versions below. 198 # The OS X build installs much more recent versions, whichever 199 # were recorded in the Homebrew database upon creating the OS X 200 # image. 201 # Keep that in mind when you encounter a broken OS X build! 202 export LINUX_P4_VERSION="16.2" 203 export LINUX_GIT_LFS_VERSION="1.5.2" 204 205 P4_PATH="$HOME/custom/p4" 206 GIT_LFS_PATH="$HOME/custom/git-lfs" 207 export PATH="$GIT_LFS_PATH:$P4_PATH:$PATH" 208 ;; 209osx-clang|osx-gcc) 210 if [ "$jobname" = osx-gcc ] 211 then 212 export CC=gcc-9 213 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=$(which python3)" 214 else 215 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=$(which python2)" 216 fi 217 218 # t9810 occasionally fails on Travis CI OS X 219 # t9816 occasionally fails with "TAP out of sequence errors" on 220 # Travis CI OS X 221 export GIT_SKIP_TESTS="t9810 t9816" 222 ;; 223linux-gcc-default) 224 ;; 225Linux32) 226 CC=gcc 227 ;; 228linux-musl) 229 CC=gcc 230 MAKEFLAGS="$MAKEFLAGS PYTHON_PATH=/usr/bin/python3 USE_LIBPCRE2=Yes" 231 MAKEFLAGS="$MAKEFLAGS NO_REGEX=Yes ICONV_OMITS_BOM=Yes" 232 MAKEFLAGS="$MAKEFLAGS GIT_TEST_UTF8_LOCALE=C.UTF-8" 233 ;; 234esac 235 236case "$jobname" in 237linux-leaks) 238 export SANITIZE=leak 239 export GIT_TEST_PASSING_SANITIZE_LEAK=true 240 ;; 241esac 242 243MAKEFLAGS="$MAKEFLAGS CC=${CC:-cc}" 244