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=1
16 RAILS_PACKAGE_ITERATION="$ARVADOS_BUILDING_ITERATION"
20 echo "$@" >"$STDOUT_IF_DEBUG"
23 find_python_program() {
27 if "$prog" --version >/dev/null 2>&1; then
35 Error: $prog (from Python setuptools module) not found
41 format_last_commit_here() {
42 local format="$1"; shift
43 local dir="${1:-.}"; shift
44 TZ=UTC git log -n1 --first-parent "--format=format:$format" "$dir"
48 # Output the version being built, or if we're building a
49 # dev/prerelease, output a version number based on the git log for
51 local subdir="$1"; shift
52 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
53 echo "$ARVADOS_BUILDING_VERSION"
58 declare $(format_last_commit_here "git_ts=%ct git_hash=%h" "$subdir")
59 ARVADOS_BUILDING_VERSION="$($WORKSPACE/build/version-at-commit.sh $git_hash)"
60 echo "$ARVADOS_BUILDING_VERSION"
63 nohash_version_from_git() {
64 local subdir="$1"; shift
65 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
66 echo "$ARVADOS_BUILDING_VERSION"
69 version_from_git $subdir | cut -d. -f1-4
72 timestamp_from_git() {
73 local subdir="$1"; shift
74 format_last_commit_here "%ct" "$subdir"
77 calculate_python_sdk_cwl_package_versions() {
78 python_sdk_version=$(cd sdk/python && python3 arvados_version.py)
79 cwl_runner_version=$(cd sdk/cwl && python3 arvados_version.py)
82 # Usage: get_native_arch
84 # Only amd64 and aarch64 are supported at the moment
94 echo "Error: architecture not supported"
102 local gem_name="$1"; shift
103 local gem_version="$(nohash_version_from_git)"
104 local gem_src_dir="$(pwd)"
106 if [[ -n "$ONLY_BUILD" ]] && [[ "$gem_name" != "$ONLY_BUILD" ]] ; then
110 if ! [[ -e "${gem_name}-${gem_version}.gem" ]]; then
111 find -maxdepth 1 -name "${gem_name}-*.gem" -delete
113 # -q appears to be broken in gem version 2.2.2
114 $GEM build "$gem_name.gemspec" $DASHQ_UNLESS_DEBUG >"$STDOUT_IF_DEBUG" 2>"$STDERR_IF_DEBUG"
118 # Usage: package_workbench2
119 package_workbench2() {
120 local pkgname=arvados-workbench2
121 local src=services/workbench2
122 local dst=/var/www/arvados-workbench2/workbench2
123 local description="Arvados Workbench 2"
124 local version="$(version_from_git)"
127 VERSION="$VERSION" BUILD_NUMBER="$(default_iteration "$pkgname" "$version" yarn)" GIT_COMMIT="$(git rev-parse HEAD | head -c9)" yarn build
128 cd "$WORKSPACE/packages/$TARGET"
129 fpm_build "${WORKSPACE}/$src" "${WORKSPACE}/$src/build/=$dst" "$pkgname" dir "$version" \
130 --license="GNU Affero General Public License, version 3.0" \
131 --description="${description}" \
132 --config-files="/etc/arvados/$pkgname/workbench2.example.json" \
133 "$WORKSPACE/services/workbench2/etc/arvados/workbench2/workbench2.example.json=/etc/arvados/$pkgname/workbench2.example.json"
136 calculate_go_package_version() {
137 # $__returnvar has the nameref attribute set, which means it is a reference
138 # to another variable that is passed in as the first argument to this function.
139 # see https://www.gnu.org/software/bash/manual/html_node/Shell-Parameters.html
140 local -n __returnvar="$1"; shift
146 # Update the version number and build a new package if the vendor
147 # bundle has changed, or the command imports anything from the
148 # Arvados SDK and the SDK has changed.
149 declare -a checkdirs=(go.mod go.sum)
150 while [ -n "$1" ]; do
154 # Even our rails packages (version calculation happens here!) depend on a go component (arvados-server)
155 # Everything depends on the build directory.
156 checkdirs+=(sdk/go lib build)
158 for dir in ${checkdirs[@]}; do
160 ts="$(timestamp_from_git "$dir")"
161 if [[ "$ts" -gt "$timestamp" ]]; then
162 version=$(version_from_git "$dir")
167 __returnvar="$version"
170 # Usage: package_go_binary services/foo arvados-foo [deb|rpm] [amd64|arm64] "Compute foo to arbitrary precision" [apache-2.0.txt]
171 package_go_binary() {
172 local src_path="$1"; shift
173 local prog="$1"; shift
174 local package_format="$1"; shift
175 local target_arch="$1"; shift
176 local description="$1"; shift
177 local license_file="${1:-agpl-3.0.txt}"; shift
179 if [[ -n "$ONLY_BUILD" ]] && [[ "$prog" != "$ONLY_BUILD" ]]; then
180 debug_echo -e "Skipping build of $prog package."
184 native_arch=$(get_native_arch)
186 if [[ "$native_arch" != "amd64" ]] && [[ -n "$target_arch" ]] && [[ "$native_arch" != "$target_arch" ]]; then
187 echo "Error: no cross compilation support for Go on $native_arch, can not build $prog for $target_arch"
191 case "$package_format-$TARGET" in
192 # Older Debian/Ubuntu do not support cross compilation because the
193 # libfuse package does not support multiarch. See
194 # <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=983477>.
195 # Red Hat-based distributions do not support native cross compilation at
196 # all (they use a qemu-based solution we haven't implemented yet).
197 deb-debian10|deb-ubuntu1804|deb-ubuntu2004|rpm-*)
199 if [[ "$native_arch" == "amd64" ]] && [[ -n "$target_arch" ]] && [[ "$native_arch" != "$target_arch" ]]; then
200 echo "Error: no cross compilation support for Go on $native_arch for $TARGET, can not build $prog for $target_arch"
209 if [[ -n "$target_arch" ]]; then
212 # No target architecture specified, default to native target. When on amd64
213 # also crosscompile arm64 (when supported).
215 if [[ $cross_compilation -ne 0 ]]; then
220 for ta in ${archs[@]}; do
221 package_go_binary_worker "$src_path" "$prog" "$package_format" "$description" "$native_arch" "$ta" "$license_file"
223 if [[ $retval -ne 0 ]]; then
229 # Usage: package_go_binary services/foo arvados-foo deb "Compute foo to arbitrary precision" [amd64/arm64] [amd64/arm64] [apache-2.0.txt]
230 package_go_binary_worker() {
231 local src_path="$1"; shift
232 local prog="$1"; shift
233 local package_format="$1"; shift
234 local description="$1"; shift
235 local native_arch="${1:-amd64}"; shift
236 local target_arch="${1:-amd64}"; shift
237 local license_file="${1:-agpl-3.0.txt}"; shift
239 debug_echo "package_go_binary $src_path as $prog (native arch: $native_arch, target arch: $target_arch)"
240 local basename="${src_path##*/}"
241 calculate_go_package_version go_package_version $src_path
243 cd $WORKSPACE/packages/$TARGET
244 test_package_presence "$prog" "$go_package_version" "go" "" "$target_arch"
245 if [[ $? -ne 0 ]]; then
249 echo "Building $package_format ($target_arch) package for $prog from $src_path"
250 if [[ "$native_arch" == "amd64" ]] && [[ "$target_arch" == "arm64" ]]; then
251 CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc GOARCH=${target_arch} go install -ldflags "-X git.arvados.org/arvados.git/lib/cmd.version=${go_package_version} -X main.version=${go_package_version}" "git.arvados.org/arvados.git/$src_path"
253 GOARCH=${arch} go install -ldflags "-X git.arvados.org/arvados.git/lib/cmd.version=${go_package_version} -X main.version=${go_package_version}" "git.arvados.org/arvados.git/$src_path"
258 binpath=$GOPATH/bin/${basename}
259 if [[ "${target_arch}" != "${native_arch}" ]]; then
260 switches+=("-a${target_arch}")
261 binpath="$GOPATH/bin/linux_${target_arch}/${basename}"
264 systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
265 if [[ -e "${systemd_unit}" ]]; then
267 --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
268 --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
269 "${systemd_unit}=/lib/systemd/system/${prog}.service")
271 switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
273 fpm_build "${WORKSPACE}/${src_path}" "$binpath=/usr/bin/${prog}" "${prog}" dir "${go_package_version}" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=${description}" "${switches[@]}"
276 # Usage: package_go_so lib/foo arvados_foo.so arvados-foo deb amd64 "Arvados foo library"
278 local src_path="$1"; shift
279 local sofile="$1"; shift
280 local pkg="$1"; shift
281 local package_format="$1"; shift
282 local target_arch="$1"; shift # supported: amd64, arm64
283 local description="$1"; shift
285 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkg" != "$ONLY_BUILD" ]]; then
286 debug_echo -e "Skipping build of $pkg package."
290 debug_echo "package_go_so $src_path as $pkg"
292 calculate_go_package_version go_package_version $src_path
293 cd $WORKSPACE/packages/$TARGET
294 test_package_presence $pkg $go_package_version go || return 1
295 cd $WORKSPACE/$src_path
296 go build -buildmode=c-shared -o ${GOPATH}/bin/${sofile}
297 cd $WORKSPACE/packages/$TARGET
299 "--url=https://arvados.org"
300 "--license=Apache License, Version 2.0"
301 "--description=${description}"
302 "$WORKSPACE/apache-2.0.txt=/usr/share/doc/$pkg/apache-2.0.txt"
304 if [[ -e "$WORKSPACE/$src_path/pam-configs-arvados" ]]; then
305 fpmargs+=("$WORKSPACE/$src_path/pam-configs-arvados=/usr/share/doc/$pkg/pam-configs-arvados-go")
307 if [[ -e "$WORKSPACE/$src_path/README" ]]; then
308 fpmargs+=("$WORKSPACE/$src_path/README=/usr/share/doc/$pkg/README")
310 fpm_build "${WORKSPACE}/${src_path}" "$GOPATH/bin/${sofile}=/usr/lib/${sofile}" "${pkg}" dir "${go_package_version}" "${fpmargs[@]}"
313 default_iteration() {
314 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
315 echo "$ARVADOS_BUILDING_ITERATION"
318 local package_name="$1"; shift
319 local package_version="$1"; shift
320 local package_type="$1"; shift
322 if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
323 [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
329 _build_rails_package_scripts() {
330 local pkgname="$1"; shift
331 local destdir="$1"; shift
332 local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
333 for scriptname in postinst prerm postrm; do
334 cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
335 >"$destdir/$scriptname" || return $?
339 rails_package_version() {
340 local pkgname="$1"; shift
341 local srcdir="$1"; shift
342 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
343 echo "$ARVADOS_BUILDING_VERSION"
346 local version="$(version_from_git)"
347 if [ $pkgname = "arvados-api-server" ] ; then
348 calculate_go_package_version version cmd/arvados-server "$srcdir"
353 test_rails_package_presence() {
354 local pkgname="$1"; shift
355 local srcdir="$1"; shift
357 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
365 local version="$(rails_package_version "$pkgname" "$srcdir")"
369 test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
372 get_complete_package_name() {
373 # if the errexit flag is set, unset it until this function returns
374 # otherwise, the shift calls below will abort the program if optional arguments are not supplied
375 if [ -o errexit ]; then
379 # $__returnvar has the nameref attribute set, which means it is a reference
380 # to another variable that is passed in as the first argument to this function.
381 # see https://www.gnu.org/software/bash/manual/html_node/Shell-Parameters.html
382 local -n __returnvar="$1"; shift
383 local pkgname="$1"; shift
384 local version="$1"; shift
385 local pkgtype="$1"; shift
386 local iteration="$1"; shift
387 local arch="$1"; shift
388 if [[ "$iteration" == "" ]]; then
389 iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
392 if [[ "$arch" == "" ]]; then
393 native_arch=$(get_native_arch)
394 rpm_native_arch="x86_64"
395 if [[ "$HOSTTYPE" == "aarch64" ]]; then
396 rpm_native_arch="arm64"
398 rpm_architecture="$rpm_native_arch"
399 deb_architecture="$native_arch"
401 if [[ "$pkgtype" =~ ^(src)$ ]]; then
402 rpm_architecture="noarch"
403 deb_architecture="all"
406 rpm_architecture=$arch
407 deb_architecture=$arch
410 local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
411 if [[ "$FORMAT" == "rpm" ]]; then
412 # rpm packages get iteration 1 if we don't supply one
413 iteration=${iteration:-1}
414 complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
416 __returnvar=${complete_pkgname}
419 # Test if the package already exists, if not return 0, if it does return 1
420 test_package_presence() {
421 local pkgname="$1"; shift
422 local version="$1"; shift
423 local pkgtype="$1"; shift
424 local iteration="$1"; shift
425 local arch="$1"; shift
426 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
431 get_complete_package_name full_pkgname "$pkgname" "$version" "$pkgtype" "$iteration" "$arch"
433 # See if we can skip building the package, only if it already exists in the
434 # processed/ directory. If so, move it back to the packages directory to make
435 # sure it gets picked up by the test and/or upload steps.
436 # Get the list of packages from the repos
438 if [[ "$FORCE_BUILD" == "1" ]]; then
439 echo "Package $full_pkgname build forced with --force-build, building"
440 elif [[ "$FORMAT" == "deb" ]]; then
443 dd[debian11]=bullseye
444 dd[ubuntu1804]=bionic
447 if [ ${pkgname:0:3} = "lib" ]; then
448 repo_subdir=${pkgname:0:4}
450 repo_subdir=${pkgname:0:1}
453 repo_pkg_list=$(curl -s -o - http://apt.arvados.org/${D}/pool/main/${repo_subdir}/${pkgname}/)
454 echo "${repo_pkg_list}" |grep -q ${full_pkgname}
455 if [ $? -eq 0 ] ; then
456 echo "Package $full_pkgname exists upstream, not rebuilding, downloading instead!"
457 curl -s -o "$WORKSPACE/packages/$TARGET/${full_pkgname}" http://apt.arvados.org/${D}/pool/main/${repo_subdir}/${pkgname}/${full_pkgname}
459 elif test -f "$WORKSPACE/packages/$TARGET/processed/${full_pkgname}" ; then
460 echo "Package $full_pkgname exists, not rebuilding!"
463 echo "Package $full_pkgname not found, building"
469 centos7) rpm_root="CentOS/7/dev" ;;
470 rocky8) rpm_root="CentOS/8/dev" ;;
472 echo "FIXME: Don't know RPM URL path for $TARGET, building"
476 local rpm_url="http://rpm.arvados.org/$rpm_root/$arch/$full_pkgname"
478 if curl -fs -o "$WORKSPACE/packages/$TARGET/$full_pkgname" "$rpm_url"; then
479 echo "Package $full_pkgname exists upstream, not rebuilding, downloading instead!"
481 elif [[ -f "$WORKSPACE/packages/$TARGET/processed/$full_pkgname" ]]; then
482 echo "Package $full_pkgname exists, not rebuilding!"
485 echo "Package $full_pkgname not found, building"
491 handle_rails_package() {
492 local pkgname="$1"; shift
494 if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
497 local srcdir="$1"; shift
499 local license_path="$1"; shift
500 local version="$(rails_package_version "$pkgname" "$srcdir")"
501 echo "$version" >package-build.version
502 local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
505 _build_rails_package_scripts "$pkgname" "$scripts_dir"
508 git rev-parse HEAD >git-commit.version
509 bundle config set cache_all true
512 if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
513 echo "ERROR: $pkgname package prep failed" >&2
514 rm -rf "$scripts_dir"
518 local railsdir="/var/www/${pkgname%-server}/current"
519 local -a pos_args=("$srcdir/=$railsdir" "$pkgname" dir "$version")
520 local license_arg="$license_path=$railsdir/$(basename "$license_path")"
521 local -a switches=(--after-install "$scripts_dir/postinst"
522 --before-remove "$scripts_dir/prerm"
523 --after-remove "$scripts_dir/postrm")
524 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
525 switches+=(--iteration $RAILS_PACKAGE_ITERATION)
527 # For some reason fpm excludes need to not start with /.
528 local exclude_root="${railsdir#/}"
529 for exclude in tmp log coverage Capfile\* \
531 config/application.yml \
532 config/database.yml; do
533 switches+=(-x "$exclude_root/$exclude")
535 fpm_build "${srcdir}" "${pos_args[@]}" "${switches[@]}" \
536 -x "$exclude_root/vendor/cache-*" \
537 -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
538 rm -rf "$scripts_dir"
541 # Usage: handle_api_server [amd64|arm64]
542 handle_api_server () {
543 local target_arch="${1:-amd64}"; shift
545 if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "arvados-api-server" ]] ; then
546 debug_echo -e "Skipping build of arvados-api-server package."
550 native_arch=$(get_native_arch)
551 if [[ "$target_arch" != "$native_arch" ]]; then
552 echo "Error: no cross compilation support for Rails yet, can not build arvados-api-server for $ARCH"
557 # Build the API server package
558 test_rails_package_presence arvados-api-server "$WORKSPACE/services/api"
559 if [[ "$?" == "0" ]]; then
560 calculate_go_package_version arvados_server_version cmd/arvados-server
561 arvados_server_iteration=$(default_iteration "arvados-server" "$arvados_server_version" "go")
562 handle_rails_package arvados-api-server "$WORKSPACE/services/api" \
563 "$WORKSPACE/agpl-3.0.txt" --url="https://arvados.org" \
564 --description="Arvados API server - Arvados is a free and open source platform for big data science." \
565 --license="GNU Affero General Public License, version 3.0" --depends "arvados-server = ${arvados_server_version}-${arvados_server_iteration}"
569 # Usage: handle_cwltest [deb|rpm] [amd64|arm64]
571 local package_format="$1"; shift
572 local target_arch="${1:-amd64}"; shift
574 if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "python3-cwltest" ]] ; then
575 debug_echo -e "Skipping build of cwltest package."
579 if [[ -e "$WORKSPACE/cwltest" ]]; then
580 rm -rf "$WORKSPACE/cwltest"
582 git clone https://github.com/common-workflow-language/cwltest.git
584 # The subsequent release of cwltest confirms that files exist on disk, since
585 # our files are in Keep, all the tests fail.
586 # We should add [optional] Arvados support to cwltest so it can access
587 # Keep but for the time being just package the last working version.
588 (cd cwltest && git checkout 2.3.20230108193615)
590 # signal to our build script that we want a cwltest executable installed in /usr/bin/
591 mkdir cwltest/bin && touch cwltest/bin/cwltest
592 fpm_build_virtualenv "cwltest" "cwltest" "$package_format" "$target_arch"
593 # The python->python3 metapackage
594 build_metapackage "cwltest" "cwltest"
596 rm -rf "$WORKSPACE/cwltest"
599 # Usage: handle_arvados_src
600 handle_arvados_src () {
601 if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "arvados-src" ]] ; then
602 debug_echo -e "Skipping build of arvados-src package."
608 COMMIT_HASH=$(format_last_commit_here "%H")
609 arvados_src_version="$(version_from_git)"
611 cd $WORKSPACE/packages/$TARGET
612 test_package_presence arvados-src "$arvados_src_version" src ""
614 if [[ "$?" == "0" ]]; then
616 SRC_BUILD_DIR=$(mktemp -d)
617 # mktemp creates the directory with 0700 permissions by default
618 chmod 755 $SRC_BUILD_DIR
619 git clone $DASHQ_UNLESS_DEBUG "$WORKSPACE/.git" "$SRC_BUILD_DIR"
622 # go into detached-head state
623 git checkout $DASHQ_UNLESS_DEBUG "$COMMIT_HASH"
624 echo "$COMMIT_HASH" >git-commit.version
626 cd $WORKSPACE/packages/$TARGET
627 fpm_build "$WORKSPACE" $SRC_BUILD_DIR/=/usr/local/arvados/src arvados-src 'dir' "$arvados_src_version" "--exclude=usr/local/arvados/src/.git" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=The Arvados source code" "--architecture=all"
629 rm -rf "$SRC_BUILD_DIR"
634 # Build python packages with a virtualenv built-in
635 # Usage: fpm_build_virtualenv arvados-python-client sdk/python [deb|rpm] [amd64|arm64]
636 fpm_build_virtualenv () {
638 local pkg_dir=$1; shift
639 local package_format="$1"; shift
640 local target_arch="${1:-amd64}"; shift
642 native_arch=$(get_native_arch)
644 if [[ "$pkg" != "arvados-docker-cleaner" ]]; then
645 PYTHON_PKG=$PYTHON3_PKG_PREFIX-$pkg
647 # Exception to our package naming convention
651 if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]]; then
652 # arvados-python-client sdist should always be built if we are building a
654 if [[ "$ONLY_BUILD" != "python3-arvados-cwl-runner" ]] &&
655 [[ "$ONLY_BUILD" != "python3-arvados-fuse" ]] &&
656 [[ "$ONLY_BUILD" != "python3-crunchstat-summary" ]] &&
657 [[ "$ONLY_BUILD" != "arvados-docker-cleaner" ]] &&
658 [[ "$ONLY_BUILD" != "python3-arvados-user-activity" ]]; then
659 debug_echo -e "Skipping build of $pkg package."
664 if [[ -n "$target_arch" ]] && [[ "$native_arch" == "$target_arch" ]]; then
665 fpm_build_virtualenv_worker "$pkg" "$pkg_dir" "$package_format" "$native_arch" "$target_arch"
666 elif [[ -z "$target_arch" ]]; then
667 fpm_build_virtualenv_worker "$pkg" "$pkg_dir" "$package_format" "$native_arch" "$native_arch"
669 echo "Error: no cross compilation support for Python yet, can not build $pkg for $target_arch"
674 # Build python packages with a virtualenv built-in
675 # Usage: fpm_build_virtualenv_worker arvados-python-client sdk/python python3 [deb|rpm] [amd64|arm64] [amd64|arm64]
676 fpm_build_virtualenv_worker () {
679 local package_format="$1"; shift
680 local native_arch="${1:-amd64}"; shift
681 local target_arch=${1:-amd64}; shift
684 STDOUT_IF_DEBUG=/dev/null
685 STDERR_IF_DEBUG=/dev/null
686 DASHQ_UNLESS_DEBUG=-q
687 if [[ "$DEBUG" != "0" ]]; then
688 STDOUT_IF_DEBUG=/dev/stdout
689 STDERR_IF_DEBUG=/dev/stderr
692 if [[ "$ARVADOS_BUILDING_ITERATION" == "" ]]; then
693 ARVADOS_BUILDING_ITERATION=1
696 local python=$PYTHON3_EXECUTABLE
698 PACKAGE_PREFIX=$PYTHON3_PKG_PREFIX
700 if [[ "$PKG" != "arvados-docker-cleaner" ]]; then
701 PYTHON_PKG=$PACKAGE_PREFIX-$PKG
703 # Exception to our package naming convention
707 cd $WORKSPACE/$PKG_DIR
711 # Get the latest setuptools
712 if ! $pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
713 echo "Error, unable to upgrade setuptools with"
714 echo " $pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
717 # filter a useless warning (when building the cwltest package) from the stderr output
718 if ! $python setup.py $DASHQ_UNLESS_DEBUG sdist 2> >(grep -v 'warning: no previously-included files matching'); then
719 echo "Error, unable to run $python setup.py sdist for $PKG"
723 PACKAGE_PATH=`(cd dist; ls *tar.gz)`
725 if [[ "arvados-python-client" == "$PKG" ]]; then
726 PYSDK_PATH="-f $(pwd)/dist/"
729 if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]] && [[ "$PKG" != "$ONLY_BUILD" ]]; then
733 # Determine the package version from the generated sdist archive
734 if [[ -n "$ARVADOS_BUILDING_VERSION" ]] ; then
735 UNFILTERED_PYTHON_VERSION=$ARVADOS_BUILDING_VERSION
736 PYTHON_VERSION=$(echo -n $ARVADOS_BUILDING_VERSION | sed s/~dev/.dev/g | sed s/~rc/rc/g)
738 PYTHON_VERSION=$(awk '($1 == "Version:"){print $2}' *.egg-info/PKG-INFO)
739 UNFILTERED_PYTHON_VERSION=$(echo -n $PYTHON_VERSION | sed s/\.dev/~dev/g |sed 's/\([0-9]\)rc/\1~rc/g')
742 # See if we actually need to build this package; does it exist already?
743 # We can't do this earlier than here, because we need PYTHON_VERSION...
744 # This isn't so bad; the sdist call above is pretty quick compared to
745 # the invocation of virtualenv and fpm, below.
746 if ! test_package_presence "$PYTHON_PKG" "$UNFILTERED_PYTHON_VERSION" "$python" "$ARVADOS_BUILDING_ITERATION" "$target_arch"; then
750 echo "Building $package_format ($target_arch) package for $PKG from $PKG_DIR"
752 # Package the sdist in a virtualenv
753 echo "Creating virtualenv..."
758 rm -f $PYTHON_PKG*deb
759 echo "virtualenv version: `virtualenv --version`"
760 virtualenv_command="virtualenv --python `which $python` $DASHQ_UNLESS_DEBUG build/usr/share/$python/dist/$PYTHON_PKG"
762 if ! $virtualenv_command; then
763 echo "Error, unable to run"
764 echo " $virtualenv_command"
768 if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U pip; then
769 echo "Error, unable to upgrade pip with"
770 echo " build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U pip"
773 echo "pip version: `build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip --version`"
775 if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
776 echo "Error, unable to upgrade setuptools with"
777 echo " build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
780 echo "setuptools version: `build/usr/share/$python/dist/$PYTHON_PKG/bin/$python -c 'import setuptools; print(setuptools.__version__)'`"
782 if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U wheel; then
783 echo "Error, unable to upgrade wheel with"
784 echo " build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U wheel"
787 echo "wheel version: `build/usr/share/$python/dist/$PYTHON_PKG/bin/wheel version`"
789 if [[ "$TARGET" != "centos7" ]] || [[ "$PYTHON_PKG" != "python-arvados-fuse" ]]; then
790 build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG $PYSDK_PATH $PACKAGE_PATH
792 # centos7 needs these special tweaks to install python-arvados-fuse
793 build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG docutils
794 PYCURL_SSL_LIBRARY=nss build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG $PYSDK_PATH $PACKAGE_PATH
797 if [[ "$?" != "0" ]]; then
798 echo "Error, unable to run"
799 echo " build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG $PYSDK_PATH $PACKAGE_PATH"
803 cd build/usr/share/$python/dist/$PYTHON_PKG/
805 # Replace the shebang lines in all python scripts, and handle the activate
806 # scripts too. This is a functional replacement of the 237 line
807 # virtualenv_tools.py script that doesn't work in python3 without serious
808 # patching, minus the parts we don't need (modifying pyc files, etc).
809 for binfile in `ls bin/`; do
810 if ! file --mime bin/$binfile |grep -q binary; then
812 if [[ "$binfile" =~ ^activate(.csh|.fish|)$ ]]; then
813 # these 'activate' scripts need special treatment
814 sed -i "s/VIRTUAL_ENV=\".*\"/VIRTUAL_ENV=\"\/usr\/share\/$python\/dist\/$PYTHON_PKG\"/" bin/$binfile
815 sed -i "s/VIRTUAL_ENV \".*\"/VIRTUAL_ENV \"\/usr\/share\/$python\/dist\/$PYTHON_PKG\"/" bin/$binfile
817 if grep -q -E '^#!.*/bin/python\d?' bin/$binfile; then
818 # Replace shebang line
819 sed -i "1 s/^.*$/#!\/usr\/share\/$python\/dist\/$PYTHON_PKG\/bin\/python/" bin/$binfile
825 cd - >$STDOUT_IF_DEBUG
827 find build -iname '*.pyc' -exec rm {} \;
828 find build -iname '*.pyo' -exec rm {} \;
830 # Finally, generate the package
831 echo "Creating package..."
833 declare -a COMMAND_ARR=("fpm" "-s" "dir" "-t" "$package_format")
835 if [[ -n "$target_arch" ]] && [[ "$target_arch" != "amd64" ]]; then
836 COMMAND_ARR+=("-a$target_arch")
839 if [[ "$MAINTAINER" != "" ]]; then
840 COMMAND_ARR+=('--maintainer' "$MAINTAINER")
843 if [[ "$VENDOR" != "" ]]; then
844 COMMAND_ARR+=('--vendor' "$VENDOR")
847 COMMAND_ARR+=('--url' 'https://arvados.org')
850 DESCRIPTION=`grep '\sdescription' $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
851 COMMAND_ARR+=('--description' "$DESCRIPTION")
854 LICENSE_STRING=`grep license $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
855 COMMAND_ARR+=('--license' "$LICENSE_STRING")
857 if [[ "$DEBUG" != "0" ]]; then
858 COMMAND_ARR+=('--verbose' '--log' 'info')
861 COMMAND_ARR+=('-v' $(echo -n "$PYTHON_VERSION" | sed s/.dev/~dev/g | sed s/rc/~rc/g))
862 COMMAND_ARR+=('--iteration' "$ARVADOS_BUILDING_ITERATION")
863 COMMAND_ARR+=('-n' "$PYTHON_PKG")
864 COMMAND_ARR+=('-C' "build")
866 systemd_unit="$WORKSPACE/$PKG_DIR/$PKG.service"
867 if [[ -e "${systemd_unit}" ]]; then
868 COMMAND_ARR+=('--after-install' "${WORKSPACE}/build/go-python-package-scripts/postinst")
869 COMMAND_ARR+=('--before-remove' "${WORKSPACE}/build/go-python-package-scripts/prerm")
872 COMMAND_ARR+=('--depends' "$PYTHON3_PACKAGE")
873 case "$package_format" in
877 --deb-no-default-config-files
881 # Conflict with older packages we used to publish
882 --conflicts "rh-python36-python-$PKG"
883 # Do not generate /usr/lib/.build-id links on RH8+
884 # (otherwise our packages conflict with platform-python)
885 --rpm-rpmbuild-define "_build_id_links none"
889 # Append --depends X and other arguments specified by fpm-info.sh in
890 # the package source dir. These are added last so they can override
891 # the arguments added by this script.
892 declare -a fpm_args=()
893 declare -a fpm_depends=()
895 fpminfo="$WORKSPACE/$PKG_DIR/fpm-info.sh"
896 if [[ -e "$fpminfo" ]]; then
897 echo "Loading fpm overrides from $fpminfo"
898 if ! source "$fpminfo"; then
899 echo "Error, unable to source $WORKSPACE/$PKG_DIR/fpm-info.sh for $PKG"
904 for i in "${fpm_depends[@]}"; do
905 COMMAND_ARR+=('--depends' "$i")
908 for i in "${fpm_depends[@]}"; do
909 COMMAND_ARR+=('--replaces' "python-$PKG")
912 # make sure the systemd service file ends up in the right place
913 # used by arvados-docker-cleaner
914 if [[ -e "${systemd_unit}" ]]; then
915 COMMAND_ARR+=("usr/share/$python/dist/$PKG/share/doc/$PKG/$PKG.service=/lib/systemd/system/$PKG.service")
918 COMMAND_ARR+=("${fpm_args[@]}")
920 # Make sure to install all our package binaries in /usr/bin.
921 # We have to walk $WORKSPACE/$PKG_DIR/bin rather than
922 # $WORKSPACE/build/usr/share/$python/dist/$PYTHON_PKG/bin/ to get the list
923 # because the latter also includes all the python binaries for the virtualenv.
924 # We have to take the copies of our binaries from the latter directory, though,
925 # because those are the ones we rewrote the shebang line of, above.
926 if [[ -e "$WORKSPACE/$PKG_DIR/bin" ]]; then
927 for binary in `ls $WORKSPACE/$PKG_DIR/bin`; do
928 COMMAND_ARR+=("usr/share/$python/dist/$PYTHON_PKG/bin/$binary=/usr/bin/")
932 # the python3-arvados-cwl-runner package comes with cwltool, expose that version
933 if [[ -e "$WORKSPACE/$PKG_DIR/dist/build/usr/share/$python/dist/$PYTHON_PKG/bin/cwltool" ]]; then
934 COMMAND_ARR+=("usr/share/$python/dist/$PYTHON_PKG/bin/cwltool=/usr/bin/")
939 debug_echo -e "\n${COMMAND_ARR[@]}\n"
941 FPM_RESULTS=$("${COMMAND_ARR[@]}")
944 # if something went wrong and debug is off, print out the fpm command that errored
945 if ! fpm_verify $FPM_EXIT_CODE $FPM_RESULTS && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
946 echo "fpm returned an error executing the command:"
948 echo -e "\n${COMMAND_ARR[@]}\n"
950 echo `ls *$package_format`
951 mv $WORKSPACE/$PKG_DIR/dist/*$package_format $WORKSPACE/packages/$TARGET/
956 # build_metapackage builds meta packages that help with the python to python 3 package migration
957 build_metapackage() {
958 # base package name (e.g. arvados-python-client)
964 if [[ -n "$ONLY_BUILD" ]] && [[ "python-$BASE_NAME" != "$ONLY_BUILD" ]]; then
968 if [[ "$ARVADOS_BUILDING_ITERATION" == "" ]]; then
969 ARVADOS_BUILDING_ITERATION=1
972 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
973 cd $WORKSPACE/$PKG_DIR
977 # Get the latest setuptools
978 if ! pip3 install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
979 echo "Error, unable to upgrade setuptools with XY"
980 echo " pip3 install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
983 # filter a useless warning (when building the cwltest package) from the stderr output
984 if ! python3 setup.py $DASHQ_UNLESS_DEBUG sdist 2> >(grep -v 'warning: no previously-included files matching'); then
985 echo "Error, unable to run python3 setup.py sdist for $PKG"
989 PYTHON_VERSION=$(awk '($1 == "Version:"){print $2}' *.egg-info/PKG-INFO)
990 UNFILTERED_PYTHON_VERSION=$(echo -n $PYTHON_VERSION | sed s/\.dev/~dev/g |sed 's/\([0-9]\)rc/\1~rc/g')
993 UNFILTERED_PYTHON_VERSION=$ARVADOS_BUILDING_VERSION
994 PYTHON_VERSION=$(echo -n $ARVADOS_BUILDING_VERSION | sed s/~dev/.dev/g | sed s/~rc/rc/g)
997 cd - >$STDOUT_IF_DEBUG
998 if [[ -d "$BASE_NAME" ]]; then
1004 if [[ "$FORMAT" == "deb" ]]; then
1005 cat >ns-control <<EOF
1008 Standards-Version: 3.9.2
1010 Package: python-${BASE_NAME}
1011 Version: ${PYTHON_VERSION}-${ARVADOS_BUILDING_ITERATION}
1012 Maintainer: Arvados Package Maintainers <packaging@arvados.org>
1013 Depends: python3-${BASE_NAME}
1014 Description: metapackage to ease the upgrade to the Pyhon 3 version of ${BASE_NAME}
1015 This package is a metapackage that will automatically install the new version of
1016 ${BASE_NAME} which is Python 3 based and has a different name.
1019 /usr/bin/equivs-build ns-control
1020 if [[ $? -ne 0 ]]; then
1021 echo "Error running 'equivs-build ns-control', is the 'equivs' package installed?"
1024 elif [[ "$FORMAT" == "rpm" ]]; then
1025 cat >meta.spec <<EOF
1026 Summary: metapackage to ease the upgrade to the Python 3 version of ${BASE_NAME}
1027 Name: python-${BASE_NAME}
1028 Version: ${PYTHON_VERSION}
1029 Release: ${ARVADOS_BUILDING_ITERATION}
1030 License: distributable
1032 Requires: python3-${BASE_NAME}
1035 This package is a metapackage that will automatically install the new version of
1036 python-${BASE_NAME} which is Python 3 based and has a different name.
1052 * Mon Apr 12 2021 Arvados Package Maintainers <packaging@arvados.org>
1056 /usr/bin/rpmbuild -ba meta.spec
1057 if [[ $? -ne 0 ]]; then
1058 echo "Error running 'rpmbuild -ba meta.spec', is the 'rpm-build' package installed?"
1061 mv /root/rpmbuild/RPMS/x86_64/python-${BASE_NAME}*.${FORMAT} .
1062 if [[ $? -ne 0 ]]; then
1063 echo "Error finding rpm file output of 'rpmbuild -ba meta.spec'"
1068 echo "Unknown format"
1072 if [[ $EXITCODE -ne 0 ]]; then
1076 mv *$FORMAT $WORKSPACE/packages/$TARGET/
1080 cd - >$STDOUT_IF_DEBUG
1081 if [[ -d "$BASE_NAME" ]]; then
1086 # Build packages for everything
1088 # Source dir where fpm-info.sh (if any) will be found.
1091 # The package source. Depending on the source type, this can be a
1092 # path, or the name of the package in an upstream repository (e.g.,
1096 # The name of the package to build.
1099 # The type of source package. Passed to fpm -s. Default "dir".
1100 PACKAGE_TYPE=${1:-dir}
1102 # Optional: the package version number. Passed to fpm -v.
1106 if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
1110 local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
1112 declare -a COMMAND_ARR=("fpm" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
1113 if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
1114 # Dependencies are built from setup.py. Since setup.py will never
1115 # refer to Debian package iterations, it doesn't make sense to
1116 # enforce those in the .deb dependencies.
1117 COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
1120 if [[ "$DEBUG" != "0" ]]; then
1121 COMMAND_ARR+=('--verbose' '--log' 'info')
1124 if [[ -n "$PACKAGE_NAME" ]]; then
1125 COMMAND_ARR+=('-n' "$PACKAGE_NAME")
1128 if [[ "$MAINTAINER" != "" ]]; then
1129 COMMAND_ARR+=('--maintainer' "$MAINTAINER")
1132 if [[ "$VENDOR" != "" ]]; then
1133 COMMAND_ARR+=('--vendor' "$VENDOR")
1136 if [[ "$VERSION" != "" ]]; then
1137 COMMAND_ARR+=('-v' "$VERSION")
1139 if [[ -n "$default_iteration_value" ]]; then
1140 # We can always add an --iteration here. If another one is specified in $@,
1141 # that will take precedence, as desired.
1142 COMMAND_ARR+=(--iteration "$default_iteration_value")
1145 # Append --depends X and other arguments specified by fpm-info.sh in
1146 # the package source dir. These are added last so they can override
1147 # the arguments added by this script.
1148 declare -a fpm_args=()
1149 declare -a build_depends=()
1150 declare -a fpm_depends=()
1151 declare -a fpm_conflicts=()
1152 declare -a fpm_exclude=()
1153 if [[ ! -d "$SRC_DIR" ]]; then
1154 echo >&2 "BUG: looking in wrong dir for fpm-info.sh: $pkgdir"
1157 fpminfo="${SRC_DIR}/fpm-info.sh"
1158 if [[ -e "$fpminfo" ]]; then
1159 debug_echo "Loading fpm overrides from $fpminfo"
1162 for pkg in "${build_depends[@]}"; do
1163 if [[ $TARGET =~ debian|ubuntu ]]; then
1164 pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
1165 if [[ -e $pkg_deb ]]; then
1166 echo "Installing build_dep $pkg from $pkg_deb"
1169 echo "Attemping to install build_dep $pkg using apt-get"
1170 apt-get install -y "$pkg"
1172 apt-get -y -f install
1174 pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
1175 if [[ -e $pkg_rpm ]]; then
1176 echo "Installing build_dep $pkg from $pkg_rpm"
1179 echo "Attemping to install build_dep $pkg"
1184 for i in "${fpm_depends[@]}"; do
1185 COMMAND_ARR+=('--depends' "$i")
1187 for i in "${fpm_conflicts[@]}"; do
1188 COMMAND_ARR+=('--conflicts' "$i")
1190 for i in "${fpm_exclude[@]}"; do
1191 COMMAND_ARR+=('--exclude' "$i")
1194 COMMAND_ARR+=("${fpm_args[@]}")
1196 # Append remaining function arguments directly to fpm's command line.
1201 COMMAND_ARR+=("$PACKAGE")
1203 debug_echo -e "\n${COMMAND_ARR[@]}\n"
1205 FPM_RESULTS=$("${COMMAND_ARR[@]}")
1208 fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
1210 # if something went wrong and debug is off, print out the fpm command that errored
1211 if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
1212 echo -e "\n${COMMAND_ARR[@]}\n"
1216 # verify build results
1223 if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
1224 FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
1227 if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
1230 echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
1235 elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
1236 echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
1238 elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
1240 echo "Error building package for $1:\n $FPM_RESULTS"
1247 if [[ "$FORMAT" == "deb" ]]; then
1248 $SUDO apt-get install $PACKAGES --yes
1249 elif [[ "$FORMAT" == "rpm" ]]; then
1250 $SUDO yum -q -y install $PACKAGES
1255 printf '%s %s\n' "=======" "$1"
1259 if [[ "$1" != "0" ]]; then
1260 title "$2 -- FAILED"
1261 failures+=("$2 (`timer`)")
1263 successes+=("$2 (`timer`)")
1272 if [[ -n "$t0" ]]; then
1273 echo -n "$(($SECONDS - $t0))s"
1278 for x in "${successes[@]}"
1283 if [[ ${#failures[@]} == 0 ]]
1285 if [[ ${#successes[@]} != 0 ]]; then
1286 echo "All test suites passed."
1289 echo "Failures (${#failures[@]}):"
1290 for x in "${failures[@]}"