13690: Add Composer install documentation
[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 lib)
133     fi
134     for dir in ${checkdirs[@]}; do
135         cd "$GOPATH/src/git.curoverse.com/arvados.git/$dir"
136         ts="$(timestamp_from_git)"
137         if [[ "$ts" -gt "$timestamp" ]]; then
138             version=$(version_from_git)
139             timestamp="$ts"
140         fi
141     done
142
143     cd $WORKSPACE/packages/$TARGET
144     test_package_presence $prog $version go
145
146     if [[ "$?" != "0" ]]; then
147       return 1
148     fi
149
150     go get -ldflags "-X main.version=${version}" "git.curoverse.com/arvados.git/$src_path"
151
152     local -a switches=()
153     systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
154     if [[ -e "${systemd_unit}" ]]; then
155         switches+=(
156             --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
157             --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
158             "${systemd_unit}=/lib/systemd/system/${prog}.service")
159     fi
160     switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
161
162     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[@]}"
163 }
164
165 default_iteration() {
166     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
167         echo "$ARVADOS_BUILDING_ITERATION"
168         return
169     fi
170     local package_name="$1"; shift
171     local package_version="$1"; shift
172     local package_type="$1"; shift
173     local iteration=1
174     if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
175            [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
176         iteration=2
177     fi
178     if [[ $package_type =~ ^python ]]; then
179       # Fix --iteration for #9242.
180       iteration=2
181     fi
182     echo $iteration
183 }
184
185 _build_rails_package_scripts() {
186     local pkgname="$1"; shift
187     local destdir="$1"; shift
188     local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
189     for scriptname in postinst prerm postrm; do
190         cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
191             >"$destdir/$scriptname" || return $?
192     done
193 }
194
195 test_rails_package_presence() {
196   local pkgname="$1"; shift
197   local srcdir="$1"; shift
198
199   if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
200     return 1
201   fi
202
203   tmppwd=`pwd`
204
205   cd $srcdir
206
207   local version="$(version_from_git)"
208
209   cd $tmppwd
210
211   test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
212 }
213
214 test_package_presence() {
215     local pkgname="$1"; shift
216     local version="$1"; shift
217     local pkgtype="$1"; shift
218     local iteration="$1"; shift
219     local arch="$1"; shift
220
221     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
222         return 1
223     fi
224
225     if [[ "$iteration" == "" ]]; then
226         iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
227     fi
228
229     if [[ "$arch" == "" ]]; then
230       rpm_architecture="x86_64"
231       deb_architecture="amd64"
232
233       if [[ "$pkgtype" =~ ^(python|python3)$ ]]; then
234         rpm_architecture="noarch"
235         deb_architecture="all"
236       fi
237
238       if [[ "$pkgtype" =~ ^(src)$ ]]; then
239         rpm_architecture="noarch"
240         deb_architecture="all"
241       fi
242
243       # These python packages have binary components
244       if [[ "$pkgname" =~ (ruamel|ciso|pycrypto|pyyaml) ]]; then
245         rpm_architecture="x86_64"
246         deb_architecture="amd64"
247       fi
248     else
249       rpm_architecture=$arch
250       deb_architecture=$arch
251     fi
252
253     if [[ "$FORMAT" == "deb" ]]; then
254         local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
255     else
256         # rpm packages get iteration 1 if we don't supply one
257         iteration=${iteration:-1}
258         local complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
259     fi
260
261     # See if we can skip building the package, only if it already exists in the
262     # processed/ directory. If so, move it back to the packages directory to make
263     # sure it gets picked up by the test and/or upload steps.
264     # Get the list of packages from the repos
265
266     if [[ "$FORMAT" == "deb" ]]; then
267       debian_distros="jessie precise stretch trusty wheezy xenial"
268
269       for D in ${debian_distros}; do
270         if [ ${pkgname:0:3} = "lib" ]; then
271           repo_subdir=${pkgname:0:4}
272         else
273           repo_subdir=${pkgname:0:1}
274         fi
275
276         repo_pkg_list=$(curl -o - http://apt.arvados.org/pool/${D}/main/${repo_subdir}/)
277         echo ${repo_pkg_list} |grep -q ${complete_pkgname}
278         if [ $? -eq 0 ]; then
279           echo "Package $complete_pkgname exists, not rebuilding!"
280           curl -o ./${complete_pkgname} http://apt.arvados.org/pool/${D}/main/${repo_subdir}/${complete_pkgname}
281           return 1
282         else
283           echo "Package $complete_pkgname not found, building"
284           return 0
285         fi
286       done
287     else
288       centos_repo="http://rpm.arvados.org/CentOS/7/dev/x86_64/"
289
290       repo_pkg_list=$(curl -o - ${centos_repo})
291       echo ${repo_pkg_list} |grep -q ${complete_pkgname}
292       if [ $? -eq 0 ]; then
293         echo "Package $complete_pkgname exists, not rebuilding!"
294         curl -o ./${complete_pkgname} ${centos_repo}${complete_pkgname}
295         return 1
296       else
297         echo "Package $complete_pkgname not found, building"
298         return 0
299       fi
300     fi
301 }
302
303 handle_rails_package() {
304     local pkgname="$1"; shift
305
306     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
307         return 0
308     fi
309     local srcdir="$1"; shift
310     cd "$srcdir"
311     local license_path="$1"; shift
312     local version="$(version_from_git)"
313     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
314     (
315         set -e
316         _build_rails_package_scripts "$pkgname" "$scripts_dir"
317         cd "$srcdir"
318         mkdir -p tmp
319         git rev-parse HEAD >git-commit.version
320         bundle package --all
321     )
322     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
323         echo "ERROR: $pkgname package prep failed" >&2
324         rm -rf "$scripts_dir"
325         EXITCODE=1
326         return 1
327     fi
328     local railsdir="/var/www/${pkgname%-server}/current"
329     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir "$version")
330     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
331     local -a switches=(--after-install "$scripts_dir/postinst"
332                        --before-remove "$scripts_dir/prerm"
333                        --after-remove "$scripts_dir/postrm")
334     if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
335         switches+=(--iteration $RAILS_PACKAGE_ITERATION)
336     fi
337     # For some reason fpm excludes need to not start with /.
338     local exclude_root="${railsdir#/}"
339     # .git and packages are for the SSO server, which is built from its
340     # repository root.
341     local -a exclude_list=(.git packages tmp log coverage Capfile\* \
342                            config/deploy\* config/application.yml)
343     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
344     if  [[ "$pkgname" != "arvados-workbench" ]]; then
345       exclude_list+=('config/database.yml')
346     fi
347     for exclude in ${exclude_list[@]}; do
348         switches+=(-x "$exclude_root/$exclude")
349     done
350     fpm_build "${pos_args[@]}" "${switches[@]}" \
351               -x "$exclude_root/vendor/cache-*" \
352               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
353     rm -rf "$scripts_dir"
354 }
355
356 # Build packages for everything
357 fpm_build () {
358   # The package source.  Depending on the source type, this can be a
359   # path, or the name of the package in an upstream repository (e.g.,
360   # pip).
361   PACKAGE=$1
362   shift
363   # The name of the package to build.
364   PACKAGE_NAME=$1
365   shift
366   # Optional: the vendor of the package.  Should be "Curoverse, Inc." for
367   # packages of our own software.  Passed to fpm --vendor.
368   VENDOR=$1
369   shift
370   # The type of source package.  Passed to fpm -s.  Default "python".
371   PACKAGE_TYPE=${1:-python}
372   shift
373   # Optional: the package version number.  Passed to fpm -v.
374   VERSION=$1
375   shift
376
377   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
378       return 0
379   fi
380
381   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
382   local python=""
383
384   case "$PACKAGE_TYPE" in
385       python)
386           # All Arvados Python2 packages depend on Python 2.7.
387           # Make sure we build with that for consistency.
388           python=python2.7
389           set -- "$@" --python-bin python2.7 \
390               --python-easyinstall "$EASY_INSTALL2" \
391               --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
392               --prefix "$PYTHON2_PREFIX" \
393               --python-install-lib "$PYTHON2_INSTALL_LIB" \
394               --python-install-data . \
395               --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
396               --depends "$PYTHON2_PACKAGE"
397           ;;
398       python3)
399           # fpm does not actually support a python3 package type.  Instead
400           # we recognize it as a convenience shortcut to add several
401           # necessary arguments to fpm's command line later, after we're
402           # done handling positional arguments.
403           PACKAGE_TYPE=python
404           python=python3
405           set -- "$@" --python-bin python3 \
406               --python-easyinstall "$EASY_INSTALL3" \
407               --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
408               --prefix "$PYTHON3_PREFIX" \
409               --python-install-lib "$PYTHON3_INSTALL_LIB" \
410               --python-install-data . \
411               --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
412               --depends "$PYTHON3_PACKAGE"
413           ;;
414   esac
415
416   declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
417   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
418       # Dependencies are built from setup.py.  Since setup.py will never
419       # refer to Debian package iterations, it doesn't make sense to
420       # enforce those in the .deb dependencies.
421       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
422   fi
423
424   # 12271 - As FPM-generated packages don't include scripts by default, the
425   # packages cleanup on upgrade depends on files being listed on the %files
426   # section in the generated SPEC files. To remove DIRECTORIES, they need to
427   # be listed in that sectiontoo, so we need to add this parameter to properly
428   # remove lingering dirs. But this only works for python2: if used on
429   # python33, it includes dirs like /opt/rh/python33 that belong to
430   # other packages.
431   if [[ "$FORMAT" = rpm ]] && [[ "$python" = python2.7 ]]; then
432     COMMAND_ARR+=('--rpm-auto-add-directories')
433   fi
434
435   if [[ "${DEBUG:-0}" != "0" ]]; then
436     COMMAND_ARR+=('--verbose' '--log' 'info')
437   fi
438
439   if [[ -n "$PACKAGE_NAME" ]]; then
440     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
441   fi
442
443   if [[ "$VENDOR" != "" ]]; then
444     COMMAND_ARR+=('--vendor' "$VENDOR")
445   fi
446
447   if [[ "$VERSION" != "" ]]; then
448     COMMAND_ARR+=('-v' "$VERSION")
449   fi
450   if [[ -n "$default_iteration_value" ]]; then
451       # We can always add an --iteration here.  If another one is specified in $@,
452       # that will take precedence, as desired.
453       COMMAND_ARR+=(--iteration "$default_iteration_value")
454   fi
455
456   if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
457   then
458       COMMAND_ARR+=(
459           --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
460           --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
461       )
462   fi
463
464   # Append --depends X and other arguments specified by fpm-info.sh in
465   # the package source dir. These are added last so they can override
466   # the arguments added by this script.
467   declare -a fpm_args=()
468   declare -a build_depends=()
469   declare -a fpm_depends=()
470   declare -a fpm_exclude=()
471   declare -a fpm_dirs=(
472       # source dir part of 'dir' package ("/source=/dest" => "/source"):
473       "${PACKAGE%%=/*}"
474       # backports ("llfuse>=1.0" => "backports/python-llfuse")
475       "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
476   if [[ -n "$PACKAGE_NAME" ]]; then
477       fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
478   fi
479   for pkgdir in "${fpm_dirs[@]}"; do
480       fpminfo="$pkgdir/fpm-info.sh"
481       if [[ -e "$fpminfo" ]]; then
482           debug_echo "Loading fpm overrides from $fpminfo"
483           source "$fpminfo"
484           break
485       fi
486   done
487   for pkg in "${build_depends[@]}"; do
488       if [[ $TARGET =~ debian|ubuntu ]]; then
489           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
490           if [[ -e $pkg_deb ]]; then
491               echo "Installing build_dep $pkg from $pkg_deb"
492               dpkg -i "$pkg_deb"
493           else
494               echo "Attemping to install build_dep $pkg using apt-get"
495               apt-get install -y "$pkg"
496           fi
497           apt-get -y -f install
498       else
499           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
500           if [[ -e $pkg_rpm ]]; then
501               echo "Installing build_dep $pkg from $pkg_rpm"
502               rpm -i "$pkg_rpm"
503           else
504               echo "Attemping to install build_dep $pkg"
505               rpm -i "$pkg"
506           fi
507       fi
508   done
509   for i in "${fpm_depends[@]}"; do
510     COMMAND_ARR+=('--depends' "$i")
511   done
512   for i in "${fpm_exclude[@]}"; do
513     COMMAND_ARR+=('--exclude' "$i")
514   done
515
516   # Append remaining function arguments directly to fpm's command line.
517   for i; do
518     COMMAND_ARR+=("$i")
519   done
520
521   COMMAND_ARR+=("${fpm_args[@]}")
522
523   COMMAND_ARR+=("$PACKAGE")
524
525   debug_echo -e "\n${COMMAND_ARR[@]}\n"
526
527   FPM_RESULTS=$("${COMMAND_ARR[@]}")
528   FPM_EXIT_CODE=$?
529
530   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
531
532   # if something went wrong and debug is off, print out the fpm command that errored
533   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
534     echo -e "\n${COMMAND_ARR[@]}\n"
535   fi
536 }
537
538 # verify build results
539 fpm_verify () {
540   FPM_EXIT_CODE=$1
541   shift
542   FPM_RESULTS=$@
543
544   FPM_PACKAGE_NAME=''
545   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
546     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
547   fi
548
549   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
550     EXITCODE=1
551     echo
552     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
553     echo
554     echo $FPM_RESULTS
555     echo
556     return 1
557   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
558     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
559     return 0
560   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
561     EXITCODE=1
562     echo "Error building package for $1:\n $FPM_RESULTS"
563     return 1
564   fi
565 }
566
567 install_package() {
568   PACKAGES=$@
569   if [[ "$FORMAT" == "deb" ]]; then
570     $SUDO apt-get install $PACKAGES --yes
571   elif [[ "$FORMAT" == "rpm" ]]; then
572     $SUDO yum -q -y install $PACKAGES
573   fi
574 }
575
576 title () {
577     txt="********** $1 **********"
578     printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
579 }
580
581 checkexit() {
582     if [[ "$1" != "0" ]]; then
583         title "!!!!!! $2 FAILED !!!!!!"
584         failures+=("$2 (`timer`)")
585     else
586         successes+=("$2 (`timer`)")
587     fi
588 }
589
590 timer_reset() {
591     t0=$SECONDS
592 }
593
594 timer() {
595     echo -n "$(($SECONDS - $t0))s"
596 }
597
598 report_outcomes() {
599     for x in "${successes[@]}"
600     do
601         echo "Pass: $x"
602     done
603
604     if [[ ${#failures[@]} == 0 ]]
605     then
606         echo "All test suites passed."
607     else
608         echo "Failures (${#failures[@]}):"
609         for x in "${failures[@]}"
610         do
611             echo "Fail: $x"
612         done
613     fi
614 }