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