Merge branch 'cl/t9001-cleanup'
[git] / ci / lib-travisci.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         # Travis gives a tagname e.g. v2.14.0 in $TRAVIS_BRANCH when
9         # the build is triggered by a push to a tag.  Let's see if
10         # $TRAVIS_BRANCH is exactly at a tag, and if so, if it is
11         # different from $TRAVIS_BRANCH.  That way, we can tell if
12         # we are building the tip of a branch that is tagged and
13         # we can skip the build because we won't be skipping a build
14         # of a tag.
15
16         if TAG=$(git describe --exact-match "$TRAVIS_BRANCH" 2>/dev/null) &&
17                 test "$TAG" != "$TRAVIS_BRANCH"
18         then
19                 echo "$(tput setaf 2)Tip of $TRAVIS_BRANCH is exactly at $TAG$(tput sgr0)"
20                 exit 0
21         fi
22 }
23
24 good_trees_file="$HOME/travis-cache/good-trees"
25
26 # Save some info about the current commit's tree, so we can skip the build
27 # job if we encounter the same tree again and can provide a useful info
28 # message.
29 save_good_tree () {
30         echo "$(git rev-parse $TRAVIS_COMMIT^{tree}) $TRAVIS_COMMIT $TRAVIS_JOB_NUMBER $TRAVIS_JOB_ID" >>"$good_trees_file"
31         # limit the file size
32         tail -1000 "$good_trees_file" >"$good_trees_file".tmp
33         mv "$good_trees_file".tmp "$good_trees_file"
34 }
35
36 # Skip the build job if the same tree has already been built and tested
37 # successfully before (e.g. because the branch got rebased, changing only
38 # the commit messages).
39 skip_good_tree () {
40         if ! good_tree_info="$(grep "^$(git rev-parse $TRAVIS_COMMIT^{tree}) " "$good_trees_file")"
41         then
42                 # Haven't seen this tree yet, or no cached good trees file yet.
43                 # Continue the build job.
44                 return
45         fi
46
47         echo "$good_tree_info" | {
48                 read tree prev_good_commit prev_good_job_number prev_good_job_id
49
50                 if test "$TRAVIS_JOB_ID" = "$prev_good_job_id"
51                 then
52                         cat <<-EOF
53                         $(tput setaf 2)Skipping build job for commit $TRAVIS_COMMIT.$(tput sgr0)
54                         This commit has already been built and tested successfully by this build job.
55                         To force a re-build delete the branch's cache and then hit 'Restart job'.
56                         EOF
57                 else
58                         cat <<-EOF
59                         $(tput setaf 2)Skipping build job for commit $TRAVIS_COMMIT.$(tput sgr0)
60                         This commit's tree has already been built and tested successfully in build job $prev_good_job_number for commit $prev_good_commit.
61                         The log of that build job is available at https://travis-ci.org/$TRAVIS_REPO_SLUG/jobs/$prev_good_job_id
62                         To force a re-build delete the branch's cache and then hit 'Restart job'.
63                         EOF
64                 fi
65         }
66
67         exit 0
68 }
69
70 check_unignored_build_artifacts ()
71 {
72         ! git ls-files --other --exclude-standard --error-unmatch \
73                 -- ':/*' 2>/dev/null ||
74         {
75                 echo "$(tput setaf 1)error: found unignored build artifacts$(tput sgr0)"
76                 false
77         }
78 }
79
80 # Set 'exit on error' for all CI scripts to let the caller know that
81 # something went wrong.
82 # Set tracing executed commands, primarily setting environment variables
83 # and installing dependencies.
84 set -ex
85
86 mkdir -p "$HOME/travis-cache"
87
88 skip_branch_tip_with_tag
89 skip_good_tree
90
91 if test -z "$jobname"
92 then
93         jobname="$TRAVIS_OS_NAME-$CC"
94 fi
95
96 export DEVELOPER=1
97 export DEFAULT_TEST_TARGET=prove
98 export GIT_PROVE_OPTS="--timer --jobs 3 --state=failed,slow,save"
99 export GIT_TEST_OPTS="--verbose-log"
100 export GIT_TEST_CLONE_2GB=YesPlease
101
102 case "$jobname" in
103 linux-clang|linux-gcc)
104         export GIT_TEST_HTTPD=YesPlease
105
106         # The Linux build installs the defined dependency versions below.
107         # The OS X build installs the latest available versions. Keep that
108         # in mind when you encounter a broken OS X build!
109         export LINUX_P4_VERSION="16.2"
110         export LINUX_GIT_LFS_VERSION="1.5.2"
111
112         P4_PATH="$HOME/custom/p4"
113         GIT_LFS_PATH="$HOME/custom/git-lfs"
114         export PATH="$GIT_LFS_PATH:$P4_PATH:$PATH"
115         ;;
116 osx-clang|osx-gcc)
117         # t9810 occasionally fails on Travis CI OS X
118         # t9816 occasionally fails with "TAP out of sequence errors" on
119         # Travis CI OS X
120         export GIT_SKIP_TESTS="t9810 t9816"
121         ;;
122 GETTEXT_POISON)
123         export GETTEXT_POISON=YesPlease
124         ;;
125 esac