2 # Copyright (C) The Arvados Authors. All rights reserved.
4 # SPDX-License-Identifier: AGPL-3.0
6 # A library of functions shared by the various scripts in this directory.
8 # This is the timestamp about when we merged changed to include licenses
9 # with Arvados packages. We use it as a heuristic to add revisions for
11 LICENSE_PACKAGE_TS=20151208015500
13 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
14 RAILS_PACKAGE_ITERATION=8
16 RAILS_PACKAGE_ITERATION="$ARVADOS_BUILDING_ITERATION"
20 echo "$@" >"$STDOUT_IF_DEBUG"
24 for version_suffix in "$@"; do
25 if "easy_install$version_suffix" --version >/dev/null 2>&1; then
26 echo "easy_install$version_suffix"
33 Error: easy_install$1 (from Python setuptools module) not found
39 format_last_commit_here() {
40 local format="$1"; shift
41 TZ=UTC git log -n1 --first-parent "--format=format:$format" .
45 # Output the version being built, or if we're building a
46 # dev/prerelease, output a version number based on the git log for
47 # the current working directory.
48 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
49 echo "$ARVADOS_BUILDING_VERSION"
53 local git_ts git_hash prefix
54 if [[ -n "$1" ]] ; then
60 declare $(format_last_commit_here "git_ts=%ct git_hash=%h")
61 ARVADOS_BUILDING_VERSION="$(git describe --abbrev=0).$(date -ud "@$git_ts" +%Y%m%d%H%M%S)"
62 echo "$ARVADOS_BUILDING_VERSION"
65 nohash_version_from_git() {
66 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
67 echo "$ARVADOS_BUILDING_VERSION"
70 version_from_git $1 | cut -d. -f1-4
73 timestamp_from_git() {
74 format_last_commit_here "%ct"
77 handle_python_package () {
78 # This function assumes the current working directory is the python package directory
79 if [ -n "$(find dist -name "*-$(nohash_version_from_git).tar.gz" -print -quit)" ]; then
80 # This package doesn't need rebuilding.
83 # Make sure only to use sdist - that's the only format pip can deal with (sigh)
84 python setup.py $DASHQ_UNLESS_DEBUG sdist
88 local gem_name="$1"; shift
89 local gem_version="$(nohash_version_from_git)"
90 local gem_src_dir="$(pwd)"
92 if [[ -n "$ONLY_BUILD" ]] && [[ "$gem_name" != "$ONLY_BUILD" ]] ; then
96 if ! [[ -e "${gem_name}-${gem_version}.gem" ]]; then
97 find -maxdepth 1 -name "${gem_name}-*.gem" -delete
99 # -q appears to be broken in gem version 2.2.2
100 $GEM build "$gem_name.gemspec" $DASHQ_UNLESS_DEBUG >"$STDOUT_IF_DEBUG" 2>"$STDERR_IF_DEBUG"
104 # Usage: package_go_binary services/foo arvados-foo "Compute foo to arbitrary precision"
105 package_go_binary() {
106 local src_path="$1"; shift
107 local prog="$1"; shift
108 local description="$1"; shift
109 local license_file="${1:-agpl-3.0.txt}"; shift
111 if [[ -n "$ONLY_BUILD" ]] && [[ "$prog" != "$ONLY_BUILD" ]] ; then
115 debug_echo "package_go_binary $src_path as $prog"
117 local basename="${src_path##*/}"
119 mkdir -p "$GOPATH/src/git.curoverse.com"
120 ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git"
121 (cd "$GOPATH/src/git.curoverse.com/arvados.git" && "$GOPATH/bin/govendor" sync -v)
123 cd "$GOPATH/src/git.curoverse.com/arvados.git/$src_path"
124 local version="$(version_from_git)"
125 local timestamp="$(timestamp_from_git)"
127 # Update the version number and build a new package if the vendor
128 # bundle has changed, or the command imports anything from the
129 # Arvados SDK and the SDK has changed.
130 declare -a checkdirs=(vendor)
131 if grep -qr git.curoverse.com/arvados .; then
132 checkdirs+=(sdk/go lib)
134 for dir in ${checkdirs[@]}; do
135 cd "$GOPATH/src/git.curoverse.com/arvados.git/$dir"
136 ts="$(timestamp_from_git)"
137 if [[ "$ts" -gt "$timestamp" ]]; then
138 version=$(version_from_git)
143 cd $WORKSPACE/packages/$TARGET
144 test_package_presence $prog $version go
146 if [[ "$?" != "0" ]]; then
150 go get -ldflags "-X main.version=${version}" "git.curoverse.com/arvados.git/$src_path"
153 systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
154 if [[ -e "${systemd_unit}" ]]; then
156 --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
157 --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
158 "${systemd_unit}=/lib/systemd/system/${prog}.service")
160 switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
162 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[@]}"
165 default_iteration() {
166 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
167 echo "$ARVADOS_BUILDING_ITERATION"
170 local package_name="$1"; shift
171 local package_version="$1"; shift
172 local package_type="$1"; shift
174 if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
175 [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
178 if [[ $package_type =~ ^python ]]; then
179 # Fix --iteration for #9242.
185 _build_rails_package_scripts() {
186 local pkgname="$1"; shift
187 local destdir="$1"; shift
188 local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
189 for scriptname in postinst prerm postrm; do
190 cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
191 >"$destdir/$scriptname" || return $?
195 test_rails_package_presence() {
196 local pkgname="$1"; shift
197 local srcdir="$1"; shift
199 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
207 local version="$(version_from_git)"
211 test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
214 test_package_presence() {
215 local pkgname="$1"; shift
216 local version="$1"; shift
217 local pkgtype="$1"; shift
218 local iteration="$1"; shift
219 local arch="$1"; shift
221 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
225 if [[ "$iteration" == "" ]]; then
226 iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
229 if [[ "$arch" == "" ]]; then
230 rpm_architecture="x86_64"
231 deb_architecture="amd64"
233 if [[ "$pkgtype" =~ ^(python|python3)$ ]]; then
234 rpm_architecture="noarch"
235 deb_architecture="all"
238 if [[ "$pkgtype" =~ ^(src)$ ]]; then
239 rpm_architecture="noarch"
240 deb_architecture="all"
243 # These python packages have binary components
244 if [[ "$pkgname" =~ (ruamel|ciso|pycrypto|pyyaml) ]]; then
245 rpm_architecture="x86_64"
246 deb_architecture="amd64"
249 rpm_architecture=$arch
250 deb_architecture=$arch
253 if [[ "$FORMAT" == "deb" ]]; then
254 local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
256 # rpm packages get iteration 1 if we don't supply one
257 iteration=${iteration:-1}
258 local complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
261 # See if we can skip building the package, only if it already exists in the
262 # processed/ directory. If so, move it back to the packages directory to make
263 # sure it gets picked up by the test and/or upload steps.
264 # Get the list of packages from the repos
266 if [[ "$FORMAT" == "deb" ]]; then
267 debian_distros="jessie precise stretch trusty wheezy xenial"
269 for D in ${debian_distros}; do
270 if [ ${pkgname:0:3} = "lib" ]; then
271 repo_subdir=${pkgname:0:4}
273 repo_subdir=${pkgname:0:1}
276 repo_pkg_list=$(curl -s -o - http://apt.arvados.org/pool/${D}/main/${repo_subdir}/)
277 echo ${repo_pkg_list} |grep -q ${complete_pkgname}
278 if [ $? -eq 0 ] ; then
279 echo "Package $complete_pkgname exists, not rebuilding!"
280 curl -o ./${complete_pkgname} http://apt.arvados.org/pool/${D}/main/${repo_subdir}/${complete_pkgname}
282 elif test -f "$WORKSPACE/packages/$TARGET/processed/${complete_pkgname}" ; then
283 echo "Package $complete_pkgname exists, not rebuilding!"
286 echo "Package $complete_pkgname not found, building"
291 centos_repo="http://rpm.arvados.org/CentOS/7/dev/x86_64/"
293 repo_pkg_list=$(curl -o - ${centos_repo})
294 echo ${repo_pkg_list} |grep -q ${complete_pkgname}
295 if [ $? -eq 0 ]; then
296 echo "Package $complete_pkgname exists, not rebuilding!"
297 curl -o ./${complete_pkgname} ${centos_repo}${complete_pkgname}
300 echo "Package $complete_pkgname not found, building"
306 handle_rails_package() {
307 local pkgname="$1"; shift
309 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
312 local srcdir="$1"; shift
314 local license_path="$1"; shift
315 local version="$(version_from_git)"
316 echo "$version" >package-build.version
317 local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
320 _build_rails_package_scripts "$pkgname" "$scripts_dir"
323 git rev-parse HEAD >git-commit.version
326 if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
327 echo "ERROR: $pkgname package prep failed" >&2
328 rm -rf "$scripts_dir"
332 local railsdir="/var/www/${pkgname%-server}/current"
333 local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir "$version")
334 local license_arg="$license_path=$railsdir/$(basename "$license_path")"
335 local -a switches=(--after-install "$scripts_dir/postinst"
336 --before-remove "$scripts_dir/prerm"
337 --after-remove "$scripts_dir/postrm")
338 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
339 switches+=(--iteration $RAILS_PACKAGE_ITERATION)
341 # For some reason fpm excludes need to not start with /.
342 local exclude_root="${railsdir#/}"
343 # .git and packages are for the SSO server, which is built from its
345 local -a exclude_list=(.git packages tmp log coverage Capfile\* \
346 config/deploy\* config/application.yml)
347 # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
348 if [[ "$pkgname" != "arvados-workbench" ]]; then
349 exclude_list+=('config/database.yml')
351 for exclude in ${exclude_list[@]}; do
352 switches+=(-x "$exclude_root/$exclude")
354 fpm_build "${pos_args[@]}" "${switches[@]}" \
355 -x "$exclude_root/vendor/cache-*" \
356 -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
357 rm -rf "$scripts_dir"
360 # Build packages for everything
362 # The package source. Depending on the source type, this can be a
363 # path, or the name of the package in an upstream repository (e.g.,
367 # The name of the package to build.
370 # Optional: the vendor of the package. Should be "Curoverse, Inc." for
371 # packages of our own software. Passed to fpm --vendor.
374 # The type of source package. Passed to fpm -s. Default "python".
375 PACKAGE_TYPE=${1:-python}
377 # Optional: the package version number. Passed to fpm -v.
381 if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
385 local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
388 case "$PACKAGE_TYPE" in
390 # All Arvados Python2 packages depend on Python 2.7.
391 # Make sure we build with that for consistency.
393 set -- "$@" --python-bin python2.7 \
394 --python-easyinstall "$EASY_INSTALL2" \
395 --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
396 --prefix "$PYTHON2_PREFIX" \
397 --python-install-lib "$PYTHON2_INSTALL_LIB" \
398 --python-install-data . \
399 --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
400 --depends "$PYTHON2_PACKAGE"
403 # fpm does not actually support a python3 package type. Instead
404 # we recognize it as a convenience shortcut to add several
405 # necessary arguments to fpm's command line later, after we're
406 # done handling positional arguments.
409 set -- "$@" --python-bin python3 \
410 --python-easyinstall "$EASY_INSTALL3" \
411 --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
412 --prefix "$PYTHON3_PREFIX" \
413 --python-install-lib "$PYTHON3_INSTALL_LIB" \
414 --python-install-data . \
415 --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
416 --depends "$PYTHON3_PACKAGE"
420 declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
421 if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
422 # Dependencies are built from setup.py. Since setup.py will never
423 # refer to Debian package iterations, it doesn't make sense to
424 # enforce those in the .deb dependencies.
425 COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
428 # 12271 - As FPM-generated packages don't include scripts by default, the
429 # packages cleanup on upgrade depends on files being listed on the %files
430 # section in the generated SPEC files. To remove DIRECTORIES, they need to
431 # be listed in that sectiontoo, so we need to add this parameter to properly
432 # remove lingering dirs. But this only works for python2: if used on
433 # python33, it includes dirs like /opt/rh/python33 that belong to
435 if [[ "$FORMAT" = rpm ]] && [[ "$python" = python2.7 ]]; then
436 COMMAND_ARR+=('--rpm-auto-add-directories')
439 if [[ "${DEBUG:-0}" != "0" ]]; then
440 COMMAND_ARR+=('--verbose' '--log' 'info')
443 if [[ -n "$PACKAGE_NAME" ]]; then
444 COMMAND_ARR+=('-n' "$PACKAGE_NAME")
447 if [[ "$VENDOR" != "" ]]; then
448 COMMAND_ARR+=('--vendor' "$VENDOR")
451 if [[ "$VERSION" != "" ]]; then
452 COMMAND_ARR+=('-v' "$VERSION")
454 if [[ -n "$default_iteration_value" ]]; then
455 # We can always add an --iteration here. If another one is specified in $@,
456 # that will take precedence, as desired.
457 COMMAND_ARR+=(--iteration "$default_iteration_value")
460 if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
463 --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
464 --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
468 # Append --depends X and other arguments specified by fpm-info.sh in
469 # the package source dir. These are added last so they can override
470 # the arguments added by this script.
471 declare -a fpm_args=()
472 declare -a build_depends=()
473 declare -a fpm_depends=()
474 declare -a fpm_exclude=()
475 declare -a fpm_dirs=(
476 # source dir part of 'dir' package ("/source=/dest" => "/source"):
478 # backports ("llfuse>=1.0" => "backports/python-llfuse")
479 "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
480 if [[ -n "$PACKAGE_NAME" ]]; then
481 fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
483 for pkgdir in "${fpm_dirs[@]}"; do
484 fpminfo="$pkgdir/fpm-info.sh"
485 if [[ -e "$fpminfo" ]]; then
486 debug_echo "Loading fpm overrides from $fpminfo"
491 for pkg in "${build_depends[@]}"; do
492 if [[ $TARGET =~ debian|ubuntu ]]; then
493 pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
494 if [[ -e $pkg_deb ]]; then
495 echo "Installing build_dep $pkg from $pkg_deb"
498 echo "Attemping to install build_dep $pkg using apt-get"
499 apt-get install -y "$pkg"
501 apt-get -y -f install
503 pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
504 if [[ -e $pkg_rpm ]]; then
505 echo "Installing build_dep $pkg from $pkg_rpm"
508 echo "Attemping to install build_dep $pkg"
513 for i in "${fpm_depends[@]}"; do
514 COMMAND_ARR+=('--depends' "$i")
516 for i in "${fpm_exclude[@]}"; do
517 COMMAND_ARR+=('--exclude' "$i")
520 # Append remaining function arguments directly to fpm's command line.
525 COMMAND_ARR+=("${fpm_args[@]}")
527 COMMAND_ARR+=("$PACKAGE")
529 debug_echo -e "\n${COMMAND_ARR[@]}\n"
531 FPM_RESULTS=$("${COMMAND_ARR[@]}")
534 fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
536 # if something went wrong and debug is off, print out the fpm command that errored
537 if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
538 echo -e "\n${COMMAND_ARR[@]}\n"
542 # verify build results
549 if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
550 FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
553 if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
556 echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
561 elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
562 echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
564 elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
566 echo "Error building package for $1:\n $FPM_RESULTS"
573 if [[ "$FORMAT" == "deb" ]]; then
574 $SUDO apt-get install $PACKAGES --yes
575 elif [[ "$FORMAT" == "rpm" ]]; then
576 $SUDO yum -q -y install $PACKAGES
581 txt="********** $1 **********"
582 printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
586 if [[ "$1" != "0" ]]; then
587 title "!!!!!! $2 FAILED !!!!!!"
588 failures+=("$2 (`timer`)")
590 successes+=("$2 (`timer`)")
599 echo -n "$(($SECONDS - $t0))s"
603 for x in "${successes[@]}"
608 if [[ ${#failures[@]} == 0 ]]
610 echo "All test suites passed."
612 echo "Failures (${#failures[@]}):"
613 for x in "${failures[@]}"