Merge branch '10722-cwl-subworkflow' closes #10722
[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     go get "git.curoverse.com/arvados.git/$src_path"
117
118     declare -a switches=()
119     systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
120     if [[ -e "${systemd_unit}" ]]; then
121         switches+=(
122             --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
123             --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
124             "${systemd_unit}=/lib/systemd/system/${prog}.service")
125     fi
126     switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
127
128     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[@]}"
129 }
130
131 default_iteration() {
132     local package_name="$1"; shift
133     local package_version="$1"; shift
134     local iteration=1
135     if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
136            [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
137         iteration=2
138     fi
139     echo $iteration
140 }
141
142 _build_rails_package_scripts() {
143     local pkgname="$1"; shift
144     local destdir="$1"; shift
145     local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
146     for scriptname in postinst prerm postrm; do
147         cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
148             >"$destdir/$scriptname" || return $?
149     done
150 }
151
152 handle_rails_package() {
153     local pkgname="$1"; shift
154
155     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
156         return 0
157     fi
158
159     local srcdir="$1"; shift
160     local license_path="$1"; shift
161     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
162     local version_file="$(mktemp --tmpdir "$pkgname-XXXXXXXX.version")" && (
163         set -e
164         _build_rails_package_scripts "$pkgname" "$scripts_dir"
165         cd "$srcdir"
166         mkdir -p tmp
167         version_from_git >"$version_file"
168         git rev-parse HEAD >git-commit.version
169         bundle package --all
170     )
171     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
172         echo "ERROR: $pkgname package prep failed" >&2
173         rm -rf "$scripts_dir" "$version_file"
174         EXITCODE=1
175         return 1
176     fi
177     local railsdir="/var/www/${pkgname%-server}/current"
178     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir
179                        "$(cat "$version_file")")
180     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
181     local -a switches=(--iteration=6
182                        --after-install "$scripts_dir/postinst"
183                        --before-remove "$scripts_dir/prerm"
184                        --after-remove "$scripts_dir/postrm")
185     # For some reason fpm excludes need to not start with /.
186     local exclude_root="${railsdir#/}"
187     # .git and packages are for the SSO server, which is built from its
188     # repository root.
189     local -a exclude_list=(.git packages tmp log coverage Capfile\* \
190                            config/deploy\* config/application.yml)
191     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
192     if  [[ "$pkgname" != "arvados-workbench" ]]; then
193       exclude_list+=('config/database.yml')
194     fi
195     for exclude in ${exclude_list[@]}; do
196         switches+=(-x "$exclude_root/$exclude")
197     done
198     fpm_build "${pos_args[@]}" "${switches[@]}" \
199               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
200     rm -rf "$scripts_dir" "$version_file"
201 }
202
203 # Build packages for everything
204 fpm_build () {
205   # The package source.  Depending on the source type, this can be a
206   # path, or the name of the package in an upstream repository (e.g.,
207   # pip).
208   PACKAGE=$1
209   shift
210   # The name of the package to build.
211   PACKAGE_NAME=$1
212   shift
213   # Optional: the vendor of the package.  Should be "Curoverse, Inc." for
214   # packages of our own software.  Passed to fpm --vendor.
215   VENDOR=$1
216   shift
217   # The type of source package.  Passed to fpm -s.  Default "python".
218   PACKAGE_TYPE=${1:-python}
219   shift
220   # Optional: the package version number.  Passed to fpm -v.
221   VERSION=$1
222   shift
223
224   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
225       return 0
226   fi
227
228   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION")"
229
230   case "$PACKAGE_TYPE" in
231       python)
232           # All Arvados Python2 packages depend on Python 2.7.
233           # Make sure we build with that for consistency.
234           set -- "$@" --python-bin python2.7 \
235               --python-easyinstall "$EASY_INSTALL2" \
236               --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
237               --prefix "$PYTHON2_PREFIX" \
238               --python-install-lib "$PYTHON2_INSTALL_LIB" \
239               --python-install-data . \
240               --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
241               --depends "$PYTHON2_PACKAGE"
242           # Fix --iteration for #9242.
243           default_iteration_value=$(($default_iteration_value + 1))
244           ;;
245       python3)
246           # fpm does not actually support a python3 package type.  Instead
247           # we recognize it as a convenience shortcut to add several
248           # necessary arguments to fpm's command line later, after we're
249           # done handling positional arguments.
250           PACKAGE_TYPE=python
251           set -- "$@" --python-bin python3 \
252               --python-easyinstall "$EASY_INSTALL3" \
253               --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
254               --prefix "$PYTHON3_PREFIX" \
255               --python-install-lib "$PYTHON3_INSTALL_LIB" \
256               --python-install-data . \
257               --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
258               --depends "$PYTHON3_PACKAGE"
259           # Fix --iteration for #9242.
260           default_iteration_value=$(($default_iteration_value + 1))
261           ;;
262   esac
263
264   declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
265   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
266       # Dependencies are built from setup.py.  Since setup.py will never
267       # refer to Debian package iterations, it doesn't make sense to
268       # enforce those in the .deb dependencies.
269       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
270   fi
271
272   if [[ "${DEBUG:-0}" != "0" ]]; then
273     COMMAND_ARR+=('--verbose' '--log' 'info')
274   fi
275
276   if [[ -n "$PACKAGE_NAME" ]]; then
277     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
278   fi
279
280   if [[ "$VENDOR" != "" ]]; then
281     COMMAND_ARR+=('--vendor' "$VENDOR")
282   fi
283
284   if [[ "$VERSION" != "" ]]; then
285     COMMAND_ARR+=('-v' "$VERSION")
286   fi
287   # We can always add an --iteration here.  If another one is specified in $@,
288   # that will take precedence, as desired.
289   COMMAND_ARR+=(--iteration "$default_iteration_value")
290
291   if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
292   then
293       COMMAND_ARR+=(
294           --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
295           --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
296       )
297   fi
298
299   # Append --depends X and other arguments specified by fpm-info.sh in
300   # the package source dir. These are added last so they can override
301   # the arguments added by this script.
302   declare -a fpm_args=()
303   declare -a build_depends=()
304   declare -a fpm_depends=()
305   declare -a fpm_exclude=()
306   declare -a fpm_dirs=(
307       # source dir part of 'dir' package ("/source=/dest" => "/source"):
308       "${PACKAGE%%=/*}"
309       # backports ("llfuse>=1.0" => "backports/python-llfuse")
310       "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
311   if [[ -n "$PACKAGE_NAME" ]]; then
312       fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
313   fi
314   for pkgdir in "${fpm_dirs[@]}"; do
315       fpminfo="$pkgdir/fpm-info.sh"
316       if [[ -e "$fpminfo" ]]; then
317           debug_echo "Loading fpm overrides from $fpminfo"
318           source "$fpminfo"
319           break
320       fi
321   done
322   for pkg in "${build_depends[@]}"; do
323       if [[ $TARGET =~ debian|ubuntu ]]; then
324           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
325           if [[ -e $pkg_deb ]]; then
326               echo "Installing build_dep $pkg from $pkg_deb"
327               dpkg -i "$pkg_deb"
328           else
329               echo "Attemping to install build_dep $pkg using apt-get"
330               apt-get install -y "$pkg"
331           fi
332           apt-get -y -f install
333       else
334           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
335           if [[ -e $pkg_rpm ]]; then
336               echo "Installing build_dep $pkg from $pkg_rpm"
337               rpm -i "$pkg_rpm"
338           else
339               echo "Attemping to install build_dep $pkg"
340               rpm -i "$pkg"
341           fi
342       fi
343   done
344   for i in "${fpm_depends[@]}"; do
345     COMMAND_ARR+=('--depends' "$i")
346   done
347   for i in "${fpm_exclude[@]}"; do
348     COMMAND_ARR+=('--exclude' "$i")
349   done
350
351   # Append remaining function arguments directly to fpm's command line.
352   for i; do
353     COMMAND_ARR+=("$i")
354   done
355
356   COMMAND_ARR+=("${fpm_args[@]}")
357
358   COMMAND_ARR+=("$PACKAGE")
359
360   debug_echo -e "\n${COMMAND_ARR[@]}\n"
361
362   FPM_RESULTS=$("${COMMAND_ARR[@]}")
363   FPM_EXIT_CODE=$?
364
365   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
366 }
367
368 # verify build results
369 fpm_verify () {
370   FPM_EXIT_CODE=$1
371   shift
372   FPM_RESULTS=$@
373
374   FPM_PACKAGE_NAME=''
375   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
376     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
377   fi
378
379   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
380     EXITCODE=1
381     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
382     echo
383     echo $FPM_RESULTS
384     echo
385   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
386     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
387   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
388     echo "Error building package for $1:\n $FPM_RESULTS"
389   fi
390 }
391
392 install_package() {
393   PACKAGES=$@
394   if [[ "$FORMAT" == "deb" ]]; then
395     $SUDO apt-get install $PACKAGES --yes
396   elif [[ "$FORMAT" == "rpm" ]]; then
397     $SUDO yum -q -y install $PACKAGES
398   fi
399 }
400
401 title () {
402     txt="********** $1 **********"
403     printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
404 }
405
406 checkexit() {
407     if [[ "$1" != "0" ]]; then
408         title "!!!!!! $2 FAILED !!!!!!"
409         failures+=("$2 (`timer`)")
410     else
411         successes+=("$2 (`timer`)")
412     fi
413 }
414
415 timer_reset() {
416     t0=$SECONDS
417 }
418
419 timer() {
420     echo -n "$(($SECONDS - $t0))s"
421 }
422
423 report_outcomes() {
424     for x in "${successes[@]}"
425     do
426         echo "Pass: $x"
427     done
428
429     if [[ ${#failures[@]} == 0 ]]
430     then
431         echo "All test suites passed."
432     else
433         echo "Failures (${#failures[@]}):"
434         for x in "${failures[@]}"
435         do
436             echo "Fail: $x"
437         done
438     fi
439 }