13200: format gitinfo on all the services
[arvados.git] / build / run-library.sh
1 #!/bin/bash
2 # Copyright (C) The Arvados Authors. All rights reserved.
3 #
4 # SPDX-License-Identifier: AGPL-3.0
5
6 # A library of functions shared by the various scripts in this directory.
7
8 # This is the timestamp about when we merged changed to include licenses
9 # with Arvados packages.  We use it as a heuristic to add revisions for
10 # older packages.
11 LICENSE_PACKAGE_TS=20151208015500
12
13 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
14     RAILS_PACKAGE_ITERATION=8
15 else
16     RAILS_PACKAGE_ITERATION="$ARVADOS_BUILDING_ITERATION"
17 fi
18
19 debug_echo () {
20     echo "$@" >"$STDOUT_IF_DEBUG"
21 }
22
23 find_easy_install() {
24     for version_suffix in "$@"; do
25         if "easy_install$version_suffix" --version >/dev/null 2>&1; then
26             echo "easy_install$version_suffix"
27             return 0
28         fi
29     done
30     cat >&2 <<EOF
31 $helpmessage
32
33 Error: easy_install$1 (from Python setuptools module) not found
34
35 EOF
36     exit 1
37 }
38
39 format_last_commit_here() {
40     local format="$1"; shift
41     TZ=UTC git log -n1 --first-parent "--format=format:$format" .
42 }
43
44 version_from_git() {
45     # Output the version being built, or if we're building a
46     # dev/prerelease, output a version number based on the git log for
47     # the current working directory.
48     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
49         echo "$ARVADOS_BUILDING_VERSION"
50         return
51     fi
52
53     local git_ts git_hash prefix
54     if [[ -n "$1" ]] ; then
55         prefix="$1"
56     else
57         prefix="0.1"
58     fi
59
60     declare $(format_last_commit_here "git_ts=%ct git_hash=%h")
61     ARVADOS_BUILDING_VERSION="$(git describe --abbrev=0).$(date -ud "@$git_ts" +%Y%m%d%H%M%S)"
62     echo "$ARVADOS_BUILDING_VERSION"
63
64
65 nohash_version_from_git() {
66     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
67         echo "$ARVADOS_BUILDING_VERSION"
68         return
69     fi
70     version_from_git $1 | cut -d. -f1-4
71 }
72
73 timestamp_from_git() {
74     format_last_commit_here "%ct"
75 }
76
77 handle_python_package () {
78   # This function assumes the current working directory is the python package directory
79   if [ -n "$(find dist -name "*-$(nohash_version_from_git).tar.gz" -print -quit)" ]; then
80     # This package doesn't need rebuilding.
81     return
82   fi
83   # Make sure only to use sdist - that's the only format pip can deal with (sigh)
84   python setup.py $DASHQ_UNLESS_DEBUG sdist
85 }
86
87 handle_ruby_gem() {
88     local gem_name="$1"; shift
89     local gem_version="$(nohash_version_from_git)"
90     local gem_src_dir="$(pwd)"
91
92     if [[ -n "$ONLY_BUILD" ]] && [[ "$gem_name" != "$ONLY_BUILD" ]] ; then
93         return 0
94     fi
95
96     if ! [[ -e "${gem_name}-${gem_version}.gem" ]]; then
97         find -maxdepth 1 -name "${gem_name}-*.gem" -delete
98
99         # -q appears to be broken in gem version 2.2.2
100         $GEM build "$gem_name.gemspec" $DASHQ_UNLESS_DEBUG >"$STDOUT_IF_DEBUG" 2>"$STDERR_IF_DEBUG"
101     fi
102 }
103
104 # Usage: package_go_binary services/foo arvados-foo "Compute foo to arbitrary precision"
105 package_go_binary() {
106     local src_path="$1"; shift
107     local prog="$1"; shift
108     local description="$1"; shift
109     local license_file="${1:-agpl-3.0.txt}"; shift
110
111     if [[ -n "$ONLY_BUILD" ]] && [[ "$prog" != "$ONLY_BUILD" ]] ; then
112         return 0
113     fi
114
115     debug_echo "package_go_binary $src_path as $prog"
116
117     local basename="${src_path##*/}"
118
119     mkdir -p "$GOPATH/src/git.curoverse.com"
120     ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git"
121     (cd "$GOPATH/src/git.curoverse.com/arvados.git" && "$GOPATH/bin/govendor" sync -v)
122
123     cd "$GOPATH/src/git.curoverse.com/arvados.git/$src_path"
124     local version="$(version_from_git)"
125     local timestamp="$(timestamp_from_git)"
126
127     # Update the version number and build a new package if the vendor
128     # bundle has changed, or the command imports anything from the
129     # Arvados SDK and the SDK has changed.
130     declare -a checkdirs=(vendor)
131     if grep -qr git.curoverse.com/arvados .; then
132         checkdirs+=(sdk/go)
133         if [[ "$prog" -eq "crunch-dispatch-slurm" ]]; then
134           checkdirs+=(lib/dispatchcloud)
135         fi
136     fi
137     for dir in ${checkdirs[@]}; do
138         cd "$GOPATH/src/git.curoverse.com/arvados.git/$dir"
139         ts="$(timestamp_from_git)"
140         if [[ "$ts" -gt "$timestamp" ]]; then
141             version=$(version_from_git)
142             timestamp="$ts"
143         fi
144     done
145
146     cd $WORKSPACE/packages/$TARGET
147     test_package_presence $prog $version go
148
149     if [[ "$?" != "0" ]]; then
150       return 1
151     fi
152
153     go get -ldflags "-X main.version=${version}" "git.curoverse.com/arvados.git/$src_path"
154
155     local -a switches=()
156     systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
157     if [[ -e "${systemd_unit}" ]]; then
158         switches+=(
159             --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
160             --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
161             "${systemd_unit}=/lib/systemd/system/${prog}.service")
162     fi
163     switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
164
165     fpm_build "$GOPATH/bin/${basename}=/usr/bin/${prog}" "${prog}" 'Curoverse, Inc.' dir "${version}" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=${description}" "${switches[@]}"
166 }
167
168 default_iteration() {
169     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
170         echo "$ARVADOS_BUILDING_ITERATION"
171         return
172     fi
173     local package_name="$1"; shift
174     local package_version="$1"; shift
175     local package_type="$1"; shift
176     local iteration=1
177     if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
178            [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
179         iteration=2
180     fi
181     if [[ $package_type =~ ^python ]]; then
182       # Fix --iteration for #9242.
183       iteration=2
184     fi
185     echo $iteration
186 }
187
188 _build_rails_package_scripts() {
189     local pkgname="$1"; shift
190     local destdir="$1"; shift
191     local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
192     for scriptname in postinst prerm postrm; do
193         cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
194             >"$destdir/$scriptname" || return $?
195     done
196 }
197
198 test_rails_package_presence() {
199   local pkgname="$1"; shift
200   local srcdir="$1"; shift
201
202   if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
203     return 1
204   fi
205
206   tmppwd=`pwd`
207
208   cd $srcdir
209
210   local version="$(version_from_git)"
211
212   cd $tmppwd
213
214   test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
215 }
216
217 test_package_presence() {
218     local pkgname="$1"; shift
219     local version="$1"; shift
220     local pkgtype="$1"; shift
221     local iteration="$1"; shift
222     local arch="$1"; shift
223
224     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
225         return 1
226     fi
227
228     if [[ "$iteration" == "" ]]; then
229         iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
230     fi
231
232     if [[ "$arch" == "" ]]; then
233       rpm_architecture="x86_64"
234       deb_architecture="amd64"
235
236       if [[ "$pkgtype" =~ ^(python|python3)$ ]]; then
237         rpm_architecture="noarch"
238         deb_architecture="all"
239       fi
240
241       if [[ "$pkgtype" =~ ^(src)$ ]]; then
242         rpm_architecture="noarch"
243         deb_architecture="all"
244       fi
245
246       # These python packages have binary components
247       if [[ "$pkgname" =~ (ruamel|ciso|pycrypto|pyyaml) ]]; then
248         rpm_architecture="x86_64"
249         deb_architecture="amd64"
250       fi
251     else
252       rpm_architecture=$arch
253       deb_architecture=$arch
254     fi
255
256     if [[ "$FORMAT" == "deb" ]]; then
257         local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
258     else
259         # rpm packages get iteration 1 if we don't supply one
260         iteration=${iteration:-1}
261         local complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
262     fi
263
264     # See if we can skip building the package, only if it already exists in the
265     # processed/ directory. If so, move it back to the packages directory to make
266     # sure it gets picked up by the test and/or upload steps.
267     # Get the list of packages from the repos
268
269     if [[ "$FORMAT" == "deb" ]]; then
270       debian_distros="jessie precise stretch trusty wheezy xenial"
271
272       for D in ${debian_distros}; do
273         if [ ${pkgname:0:3} = "lib" ]; then
274           repo_subdir=${pkgname:0:4}
275         else
276           repo_subdir=${pkgname:0:1}
277         fi
278
279         repo_pkg_list=$(curl -o - http://apt.arvados.org/pool/${D}/main/${repo_subdir}/)
280         echo ${repo_pkg_list} |grep -q ${complete_pkgname}
281         if [ $? -eq 0 ]; then
282           echo "Package $complete_pkgname exists, not rebuilding!"
283           curl -o ./${complete_pkgname} http://apt.arvados.org/pool/${D}/main/${repo_subdir}/${complete_pkgname}
284           return 1
285         else
286           echo "Package $complete_pkgname not found, building"
287           return 0
288         fi
289       done
290     else
291       centos_repo="http://rpm.arvados.org/CentOS/7/dev/x86_64/"
292
293       repo_pkg_list=$(curl -o - ${centos_repo})
294       echo ${repo_pkg_list} |grep -q ${complete_pkgname}
295       if [ $? -eq 0 ]; then
296         echo "Package $complete_pkgname exists, not rebuilding!"
297         curl -o ./${complete_pkgname} ${centos_repo}${complete_pkgname}
298         return 1
299       else
300         echo "Package $complete_pkgname not found, building"
301         return 0
302       fi
303     fi
304 }
305
306 handle_rails_package() {
307     local pkgname="$1"; shift
308
309     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
310         return 0
311     fi
312     local srcdir="$1"; shift
313     cd "$srcdir"
314     local license_path="$1"; shift
315     local version="$(version_from_git)"
316     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
317     (
318         set -e
319         _build_rails_package_scripts "$pkgname" "$scripts_dir"
320         cd "$srcdir"
321         mkdir -p tmp
322         git rev-parse HEAD >git-commit.version
323         bundle package --all
324     )
325     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
326         echo "ERROR: $pkgname package prep failed" >&2
327         rm -rf "$scripts_dir"
328         EXITCODE=1
329         return 1
330     fi
331     local railsdir="/var/www/${pkgname%-server}/current"
332     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir "$version")
333     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
334     local -a switches=(--after-install "$scripts_dir/postinst"
335                        --before-remove "$scripts_dir/prerm"
336                        --after-remove "$scripts_dir/postrm")
337     if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
338         switches+=(--iteration $RAILS_PACKAGE_ITERATION)
339     fi
340     # For some reason fpm excludes need to not start with /.
341     local exclude_root="${railsdir#/}"
342     # .git and packages are for the SSO server, which is built from its
343     # repository root.
344     local -a exclude_list=(.git packages tmp log coverage Capfile\* \
345                            config/deploy\* config/application.yml)
346     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
347     if  [[ "$pkgname" != "arvados-workbench" ]]; then
348       exclude_list+=('config/database.yml')
349     fi
350     for exclude in ${exclude_list[@]}; do
351         switches+=(-x "$exclude_root/$exclude")
352     done
353     fpm_build "${pos_args[@]}" "${switches[@]}" \
354               -x "$exclude_root/vendor/cache-*" \
355               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
356     rm -rf "$scripts_dir"
357 }
358
359 # Build packages for everything
360 fpm_build () {
361   # The package source.  Depending on the source type, this can be a
362   # path, or the name of the package in an upstream repository (e.g.,
363   # pip).
364   PACKAGE=$1
365   shift
366   # The name of the package to build.
367   PACKAGE_NAME=$1
368   shift
369   # Optional: the vendor of the package.  Should be "Curoverse, Inc." for
370   # packages of our own software.  Passed to fpm --vendor.
371   VENDOR=$1
372   shift
373   # The type of source package.  Passed to fpm -s.  Default "python".
374   PACKAGE_TYPE=${1:-python}
375   shift
376   # Optional: the package version number.  Passed to fpm -v.
377   VERSION=$1
378   shift
379
380   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
381       return 0
382   fi
383
384   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
385   local python=""
386
387   case "$PACKAGE_TYPE" in
388       python)
389           # All Arvados Python2 packages depend on Python 2.7.
390           # Make sure we build with that for consistency.
391           python=python2.7
392           set -- "$@" --python-bin python2.7 \
393               --python-easyinstall "$EASY_INSTALL2" \
394               --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
395               --prefix "$PYTHON2_PREFIX" \
396               --python-install-lib "$PYTHON2_INSTALL_LIB" \
397               --python-install-data . \
398               --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
399               --depends "$PYTHON2_PACKAGE"
400           ;;
401       python3)
402           # fpm does not actually support a python3 package type.  Instead
403           # we recognize it as a convenience shortcut to add several
404           # necessary arguments to fpm's command line later, after we're
405           # done handling positional arguments.
406           PACKAGE_TYPE=python
407           python=python3
408           set -- "$@" --python-bin python3 \
409               --python-easyinstall "$EASY_INSTALL3" \
410               --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
411               --prefix "$PYTHON3_PREFIX" \
412               --python-install-lib "$PYTHON3_INSTALL_LIB" \
413               --python-install-data . \
414               --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
415               --depends "$PYTHON3_PACKAGE"
416           ;;
417   esac
418
419   declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
420   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
421       # Dependencies are built from setup.py.  Since setup.py will never
422       # refer to Debian package iterations, it doesn't make sense to
423       # enforce those in the .deb dependencies.
424       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
425   fi
426
427   # 12271 - As FPM-generated packages don't include scripts by default, the
428   # packages cleanup on upgrade depends on files being listed on the %files
429   # section in the generated SPEC files. To remove DIRECTORIES, they need to
430   # be listed in that sectiontoo, so we need to add this parameter to properly
431   # remove lingering dirs. But this only works for python2: if used on
432   # python33, it includes dirs like /opt/rh/python33 that belong to
433   # other packages.
434   if [[ "$FORMAT" = rpm ]] && [[ "$python" = python2.7 ]]; then
435     COMMAND_ARR+=('--rpm-auto-add-directories')
436   fi
437
438   if [[ "${DEBUG:-0}" != "0" ]]; then
439     COMMAND_ARR+=('--verbose' '--log' 'info')
440   fi
441
442   if [[ -n "$PACKAGE_NAME" ]]; then
443     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
444   fi
445
446   if [[ "$VENDOR" != "" ]]; then
447     COMMAND_ARR+=('--vendor' "$VENDOR")
448   fi
449
450   if [[ "$VERSION" != "" ]]; then
451     COMMAND_ARR+=('-v' "$VERSION")
452   fi
453   if [[ -n "$default_iteration_value" ]]; then
454       # We can always add an --iteration here.  If another one is specified in $@,
455       # that will take precedence, as desired.
456       COMMAND_ARR+=(--iteration "$default_iteration_value")
457   fi
458
459   if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
460   then
461       COMMAND_ARR+=(
462           --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
463           --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
464       )
465   fi
466
467   # Append --depends X and other arguments specified by fpm-info.sh in
468   # the package source dir. These are added last so they can override
469   # the arguments added by this script.
470   declare -a fpm_args=()
471   declare -a build_depends=()
472   declare -a fpm_depends=()
473   declare -a fpm_exclude=()
474   declare -a fpm_dirs=(
475       # source dir part of 'dir' package ("/source=/dest" => "/source"):
476       "${PACKAGE%%=/*}"
477       # backports ("llfuse>=1.0" => "backports/python-llfuse")
478       "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
479   if [[ -n "$PACKAGE_NAME" ]]; then
480       fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
481   fi
482   for pkgdir in "${fpm_dirs[@]}"; do
483       fpminfo="$pkgdir/fpm-info.sh"
484       if [[ -e "$fpminfo" ]]; then
485           debug_echo "Loading fpm overrides from $fpminfo"
486           source "$fpminfo"
487           break
488       fi
489   done
490   for pkg in "${build_depends[@]}"; do
491       if [[ $TARGET =~ debian|ubuntu ]]; then
492           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
493           if [[ -e $pkg_deb ]]; then
494               echo "Installing build_dep $pkg from $pkg_deb"
495               dpkg -i "$pkg_deb"
496           else
497               echo "Attemping to install build_dep $pkg using apt-get"
498               apt-get install -y "$pkg"
499           fi
500           apt-get -y -f install
501       else
502           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
503           if [[ -e $pkg_rpm ]]; then
504               echo "Installing build_dep $pkg from $pkg_rpm"
505               rpm -i "$pkg_rpm"
506           else
507               echo "Attemping to install build_dep $pkg"
508               rpm -i "$pkg"
509           fi
510       fi
511   done
512   for i in "${fpm_depends[@]}"; do
513     COMMAND_ARR+=('--depends' "$i")
514   done
515   for i in "${fpm_exclude[@]}"; do
516     COMMAND_ARR+=('--exclude' "$i")
517   done
518
519   # Append remaining function arguments directly to fpm's command line.
520   for i; do
521     COMMAND_ARR+=("$i")
522   done
523
524   COMMAND_ARR+=("${fpm_args[@]}")
525
526   COMMAND_ARR+=("$PACKAGE")
527
528   debug_echo -e "\n${COMMAND_ARR[@]}\n"
529
530   FPM_RESULTS=$("${COMMAND_ARR[@]}")
531   FPM_EXIT_CODE=$?
532
533   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
534
535   # if something went wrong and debug is off, print out the fpm command that errored
536   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
537     echo -e "\n${COMMAND_ARR[@]}\n"
538   fi
539 }
540
541 # verify build results
542 fpm_verify () {
543   FPM_EXIT_CODE=$1
544   shift
545   FPM_RESULTS=$@
546
547   FPM_PACKAGE_NAME=''
548   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
549     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
550   fi
551
552   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
553     EXITCODE=1
554     echo
555     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
556     echo
557     echo $FPM_RESULTS
558     echo
559     return 1
560   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
561     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
562     return 0
563   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
564     EXITCODE=1
565     echo "Error building package for $1:\n $FPM_RESULTS"
566     return 1
567   fi
568 }
569
570 install_package() {
571   PACKAGES=$@
572   if [[ "$FORMAT" == "deb" ]]; then
573     $SUDO apt-get install $PACKAGES --yes
574   elif [[ "$FORMAT" == "rpm" ]]; then
575     $SUDO yum -q -y install $PACKAGES
576   fi
577 }
578
579 title () {
580     txt="********** $1 **********"
581     printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
582 }
583
584 checkexit() {
585     if [[ "$1" != "0" ]]; then
586         title "!!!!!! $2 FAILED !!!!!!"
587         failures+=("$2 (`timer`)")
588     else
589         successes+=("$2 (`timer`)")
590     fi
591 }
592
593 timer_reset() {
594     t0=$SECONDS
595 }
596
597 timer() {
598     echo -n "$(($SECONDS - $t0))s"
599 }
600
601 report_outcomes() {
602     for x in "${successes[@]}"
603     do
604         echo "Pass: $x"
605     done
606
607     if [[ ${#failures[@]} == 0 ]]
608     then
609         echo "All test suites passed."
610     else
611         echo "Failures (${#failures[@]}):"
612         for x in "${failures[@]}"
613         do
614             echo "Fail: $x"
615         done
616     fi
617 }