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