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