11459: Move RAILS_PACKAGE_ITERATION to run-library.
[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=7
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     if [[ -e "$complete_pkgname" ]]; then
230       echo "Package $complete_pkgname exists, not rebuilding!"
231       return 1
232     else
233       echo "Package $complete_pkgname not found, building"
234       return 0
235     fi
236 }
237
238 handle_rails_package() {
239     local pkgname="$1"; shift
240
241     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
242         return 0
243     fi
244     local srcdir="$1"; shift
245     local license_path="$1"; shift
246     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
247     local version_file="$(mktemp --tmpdir "$pkgname-XXXXXXXX.version")" && (
248         set -e
249         _build_rails_package_scripts "$pkgname" "$scripts_dir"
250         cd "$srcdir"
251         mkdir -p tmp
252         version_from_git >"$version_file"
253         git rev-parse HEAD >git-commit.version
254         bundle package --all
255     )
256     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
257         echo "ERROR: $pkgname package prep failed" >&2
258         rm -rf "$scripts_dir" "$version_file"
259         EXITCODE=1
260         return 1
261     fi
262     local railsdir="/var/www/${pkgname%-server}/current"
263     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir
264                        "$(cat "$version_file")")
265     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
266     local -a switches=(--iteration=$RAILS_PACKAGE_ITERATION
267                        --after-install "$scripts_dir/postinst"
268                        --before-remove "$scripts_dir/prerm"
269                        --after-remove "$scripts_dir/postrm")
270     # For some reason fpm excludes need to not start with /.
271     local exclude_root="${railsdir#/}"
272     # .git and packages are for the SSO server, which is built from its
273     # repository root.
274     local -a exclude_list=(.git packages tmp log coverage Capfile\* \
275                            config/deploy\* config/application.yml)
276     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
277     if  [[ "$pkgname" != "arvados-workbench" ]]; then
278       exclude_list+=('config/database.yml')
279     fi
280     for exclude in ${exclude_list[@]}; do
281         switches+=(-x "$exclude_root/$exclude")
282     done
283     fpm_build "${pos_args[@]}" "${switches[@]}" \
284               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
285     rm -rf "$scripts_dir" "$version_file"
286 }
287
288 # Build packages for everything
289 fpm_build () {
290   # The package source.  Depending on the source type, this can be a
291   # path, or the name of the package in an upstream repository (e.g.,
292   # pip).
293   PACKAGE=$1
294   shift
295   # The name of the package to build.
296   PACKAGE_NAME=$1
297   shift
298   # Optional: the vendor of the package.  Should be "Curoverse, Inc." for
299   # packages of our own software.  Passed to fpm --vendor.
300   VENDOR=$1
301   shift
302   # The type of source package.  Passed to fpm -s.  Default "python".
303   PACKAGE_TYPE=${1:-python}
304   shift
305   # Optional: the package version number.  Passed to fpm -v.
306   VERSION=$1
307   shift
308
309   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
310       return 0
311   fi
312
313   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
314
315   case "$PACKAGE_TYPE" in
316       python)
317           # All Arvados Python2 packages depend on Python 2.7.
318           # Make sure we build with that for consistency.
319           set -- "$@" --python-bin python2.7 \
320               --python-easyinstall "$EASY_INSTALL2" \
321               --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
322               --prefix "$PYTHON2_PREFIX" \
323               --python-install-lib "$PYTHON2_INSTALL_LIB" \
324               --python-install-data . \
325               --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
326               --depends "$PYTHON2_PACKAGE"
327           ;;
328       python3)
329           # fpm does not actually support a python3 package type.  Instead
330           # we recognize it as a convenience shortcut to add several
331           # necessary arguments to fpm's command line later, after we're
332           # done handling positional arguments.
333           PACKAGE_TYPE=python
334           set -- "$@" --python-bin python3 \
335               --python-easyinstall "$EASY_INSTALL3" \
336               --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
337               --prefix "$PYTHON3_PREFIX" \
338               --python-install-lib "$PYTHON3_INSTALL_LIB" \
339               --python-install-data . \
340               --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
341               --depends "$PYTHON3_PACKAGE"
342           ;;
343   esac
344
345   declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
346   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
347       # Dependencies are built from setup.py.  Since setup.py will never
348       # refer to Debian package iterations, it doesn't make sense to
349       # enforce those in the .deb dependencies.
350       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
351   fi
352
353   if [[ "${DEBUG:-0}" != "0" ]]; then
354     COMMAND_ARR+=('--verbose' '--log' 'info')
355   fi
356
357   if [[ -n "$PACKAGE_NAME" ]]; then
358     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
359   fi
360
361   if [[ "$VENDOR" != "" ]]; then
362     COMMAND_ARR+=('--vendor' "$VENDOR")
363   fi
364
365   if [[ "$VERSION" != "" ]]; then
366     COMMAND_ARR+=('-v' "$VERSION")
367   fi
368   # We can always add an --iteration here.  If another one is specified in $@,
369   # that will take precedence, as desired.
370   COMMAND_ARR+=(--iteration "$default_iteration_value")
371
372   if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
373   then
374       COMMAND_ARR+=(
375           --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
376           --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
377       )
378   fi
379
380   # Append --depends X and other arguments specified by fpm-info.sh in
381   # the package source dir. These are added last so they can override
382   # the arguments added by this script.
383   declare -a fpm_args=()
384   declare -a build_depends=()
385   declare -a fpm_depends=()
386   declare -a fpm_exclude=()
387   declare -a fpm_dirs=(
388       # source dir part of 'dir' package ("/source=/dest" => "/source"):
389       "${PACKAGE%%=/*}"
390       # backports ("llfuse>=1.0" => "backports/python-llfuse")
391       "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
392   if [[ -n "$PACKAGE_NAME" ]]; then
393       fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
394   fi
395   for pkgdir in "${fpm_dirs[@]}"; do
396       fpminfo="$pkgdir/fpm-info.sh"
397       if [[ -e "$fpminfo" ]]; then
398           debug_echo "Loading fpm overrides from $fpminfo"
399           source "$fpminfo"
400           break
401       fi
402   done
403   for pkg in "${build_depends[@]}"; do
404       if [[ $TARGET =~ debian|ubuntu ]]; then
405           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
406           if [[ -e $pkg_deb ]]; then
407               echo "Installing build_dep $pkg from $pkg_deb"
408               dpkg -i "$pkg_deb"
409           else
410               echo "Attemping to install build_dep $pkg using apt-get"
411               apt-get install -y "$pkg"
412           fi
413           apt-get -y -f install
414       else
415           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
416           if [[ -e $pkg_rpm ]]; then
417               echo "Installing build_dep $pkg from $pkg_rpm"
418               rpm -i "$pkg_rpm"
419           else
420               echo "Attemping to install build_dep $pkg"
421               rpm -i "$pkg"
422           fi
423       fi
424   done
425   for i in "${fpm_depends[@]}"; do
426     COMMAND_ARR+=('--depends' "$i")
427   done
428   for i in "${fpm_exclude[@]}"; do
429     COMMAND_ARR+=('--exclude' "$i")
430   done
431
432   # Append remaining function arguments directly to fpm's command line.
433   for i; do
434     COMMAND_ARR+=("$i")
435   done
436
437   COMMAND_ARR+=("${fpm_args[@]}")
438
439   COMMAND_ARR+=("$PACKAGE")
440
441   debug_echo -e "\n${COMMAND_ARR[@]}\n"
442
443   FPM_RESULTS=$("${COMMAND_ARR[@]}")
444   FPM_EXIT_CODE=$?
445
446   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
447
448   # if something went wrong and debug is off, print out the fpm command that errored
449   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
450     echo -e "\n${COMMAND_ARR[@]}\n"
451   fi
452 }
453
454 # verify build results
455 fpm_verify () {
456   FPM_EXIT_CODE=$1
457   shift
458   FPM_RESULTS=$@
459
460   FPM_PACKAGE_NAME=''
461   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
462     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
463   fi
464
465   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
466     EXITCODE=1
467     echo
468     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
469     echo
470     echo $FPM_RESULTS
471     echo
472     return 1
473   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
474     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
475     return 0
476   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
477     EXITCODE=1
478     echo "Error building package for $1:\n $FPM_RESULTS"
479     return 1
480   fi
481 }
482
483 install_package() {
484   PACKAGES=$@
485   if [[ "$FORMAT" == "deb" ]]; then
486     $SUDO apt-get install $PACKAGES --yes
487   elif [[ "$FORMAT" == "rpm" ]]; then
488     $SUDO yum -q -y install $PACKAGES
489   fi
490 }
491
492 title () {
493     txt="********** $1 **********"
494     printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
495 }
496
497 checkexit() {
498     if [[ "$1" != "0" ]]; then
499         title "!!!!!! $2 FAILED !!!!!!"
500         failures+=("$2 (`timer`)")
501     else
502         successes+=("$2 (`timer`)")
503     fi
504 }
505
506 timer_reset() {
507     t0=$SECONDS
508 }
509
510 timer() {
511     echo -n "$(($SECONDS - $t0))s"
512 }
513
514 report_outcomes() {
515     for x in "${successes[@]}"
516     do
517         echo "Pass: $x"
518     done
519
520     if [[ ${#failures[@]} == 0 ]]
521     then
522         echo "All test suites passed."
523     else
524         echo "Failures (${#failures[@]}):"
525         for x in "${failures[@]}"
526         do
527             echo "Fail: $x"
528         done
529     fi
530 }