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