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