ci: rename the library of common functions
[git] / ci / lib.sh
1 # Library of functions shared by all CI scripts
2
3 skip_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.
26 save_good_tree () {
27         echo "$(git rev-parse $TRAVIS_COMMIT^{tree}) $TRAVIS_COMMIT $TRAVIS_JOB_NUMBER $TRAVIS_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).
36 skip_good_tree () {
37         if ! good_tree_info="$(grep "^$(git rev-parse $TRAVIS_COMMIT^{tree}) " "$good_trees_file")"
38         then
39                 # Haven't seen this tree yet, or no cached good trees file yet.
40                 # Continue the build job.
41                 return
42         fi
43
44         echo "$good_tree_info" | {
45                 read tree prev_good_commit prev_good_job_number prev_good_job_id
46
47                 if test "$TRAVIS_JOB_ID" = "$prev_good_job_id"
48                 then
49                         cat <<-EOF
50                         $(tput setaf 2)Skipping build job for commit $TRAVIS_COMMIT.$(tput sgr0)
51                         This commit has already been built and tested successfully by this build job.
52                         To force a re-build delete the branch's cache and then hit 'Restart job'.
53                         EOF
54                 else
55                         cat <<-EOF
56                         $(tput setaf 2)Skipping build job for commit $TRAVIS_COMMIT.$(tput sgr0)
57                         This commit's tree has already been built and tested successfully in build job $prev_good_job_number for commit $prev_good_commit.
58                         The log of that build job is available at https://travis-ci.org/$TRAVIS_REPO_SLUG/jobs/$prev_good_job_id
59                         To force a re-build delete the branch's cache and then hit 'Restart job'.
60                         EOF
61                 fi
62         }
63
64         exit 0
65 }
66
67 check_unignored_build_artifacts ()
68 {
69         ! git ls-files --other --exclude-standard --error-unmatch \
70                 -- ':/*' 2>/dev/null ||
71         {
72                 echo "$(tput setaf 1)error: found unignored build artifacts$(tput sgr0)"
73                 false
74         }
75 }
76
77 # Set 'exit on error' for all CI scripts to let the caller know that
78 # something went wrong.
79 # Set tracing executed commands, primarily setting environment variables
80 # and installing dependencies.
81 set -ex
82
83 # When building a PR, TRAVIS_BRANCH refers to the *target* branch. Not what we
84 # want here. We want the source branch instead.
85 CI_BRANCH="${TRAVIS_PULL_REQUEST_BRANCH:-$TRAVIS_BRANCH}"
86
87 cache_dir="$HOME/travis-cache"
88 good_trees_file="$cache_dir/good-trees"
89
90 mkdir -p "$cache_dir"
91
92 skip_branch_tip_with_tag
93 skip_good_tree
94
95 if test -z "$jobname"
96 then
97         jobname="$TRAVIS_OS_NAME-$CC"
98 fi
99
100 export DEVELOPER=1
101 export DEFAULT_TEST_TARGET=prove
102 export GIT_PROVE_OPTS="--timer --jobs 3 --state=failed,slow,save"
103 export GIT_TEST_OPTS="--verbose-log -x --immediate"
104 export GIT_TEST_CLONE_2GB=YesPlease
105 if [ "$jobname" = linux-gcc ]; then
106         export CC=gcc-8
107 fi
108
109 case "$jobname" in
110 linux-clang|linux-gcc)
111         export GIT_TEST_HTTPD=YesPlease
112
113         # The Linux build installs the defined dependency versions below.
114         # The OS X build installs the latest available versions. Keep that
115         # in mind when you encounter a broken OS X build!
116         export LINUX_P4_VERSION="16.2"
117         export LINUX_GIT_LFS_VERSION="1.5.2"
118
119         P4_PATH="$HOME/custom/p4"
120         GIT_LFS_PATH="$HOME/custom/git-lfs"
121         export PATH="$GIT_LFS_PATH:$P4_PATH:$PATH"
122         ;;
123 osx-clang|osx-gcc)
124         # t9810 occasionally fails on Travis CI OS X
125         # t9816 occasionally fails with "TAP out of sequence errors" on
126         # Travis CI OS X
127         export GIT_SKIP_TESTS="t9810 t9816"
128         ;;
129 GIT_TEST_GETTEXT_POISON)
130         export GIT_TEST_GETTEXT_POISON=YesPlease
131         ;;
132 esac