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