build/run-build-packages.sh

   1 #!/bin/bash
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: AGPL-3.0
   5
   6 . "$(dirname "$(readlink -f "$0")")"/run-library.sh || exit 1
   7
   8 read -rd "\000" helpmessage <<EOF
   9 $(basename "$0"): Build Arvados packages
  10
  11 Syntax:
  12         WORKSPACE=/path/to/arvados $(basename "$0") --target <target> [options]
  13
  14 Options:
  15
  16 --build-bundle-packages  (default: false)
  17     Build api server package with vendor/bundle included
  18 --debug
  19     Output debug information (default: false)
  20 --target <target>
  21     Distribution to build packages for
  22 --only-build <package>
  23     Build only a specific package (or ONLY_BUILD from environment)
  24 --arch <arch>
  25     Build a specific architecture (or ARCH from environment, defaults to native architecture)
  26 --force-build
  27     Build even if the package exists upstream or if it has already been
  28     built locally
  29 --command
  30     Build command to execute (defaults to the run command defined in the
  31     Docker image)
  32
  33 WORKSPACE=path         Path to the Arvados source tree to build packages from
  34
  35 EOF
  36
  37 # Begin of user configuration
  38
  39 # set to --no-cache-dir to disable pip caching
  40 CACHE_FLAG=
  41
  42 MAINTAINER="Arvados Package Maintainers <packaging@arvados.org>"
  43 VENDOR="The Arvados Project"
  44
  45 # End of user configuration
  46
  47 DEBUG=${ARVADOS_DEBUG:-0}
  48 FORCE_BUILD=${FORCE_BUILD:-0}
  49 EXITCODE=0
  50 COMMAND=
  51 TARGET=
  52
  53 PARSEDOPTS=$(getopt --name "$0" --longoptions \
  54     help,build-bundle-packages,debug,target:,only-build:,arch:,force-build \
  55     -- "" "$@")
  56 if [ $? -ne 0 ]; then
  57     exit 1
  58 fi
  59
  60 eval set -- "$PARSEDOPTS"
  61 while [ $# -gt 0 ]; do
  62     case "$1" in
  63         --help)
  64             echo >&2 "$helpmessage"
  65             echo >&2
  66             exit 1
  67             ;;
  68         --target)
  69             TARGET="$2"; shift
  70             ;;
  71         --only-build)
  72             ONLY_BUILD="$2"; shift
  73             ;;
  74         --force-build)
  75             FORCE_BUILD=1
  76             ;;
  77         --arch)
  78             ARCH="$2"; shift
  79             ;;
  80         --debug)
  81             DEBUG=1
  82             ;;
  83         --command)
  84             COMMAND="$2"; shift
  85             ;;
  86         --)
  87             if [ $# -gt 1 ]; then
  88                 echo >&2 "$0: unrecognized argument '$2'. Try: $0 --help"
  89                 exit 1
  90             fi
  91             ;;
  92     esac
  93     shift
  94 done
  95
  96 if [[ -z "$TARGET" ]]; then
  97     echo "FATAL: --target must be specified" >&2
  98     exit 2
  99 elif [[ ! -d "$WORKSPACE/build/package-build-dockerfiles/$TARGET" ]]; then
 100     echo "FATAL: unknown build target '$TARGET'" >&2
 101     exit 2
 102 fi
 103
 104 if [[ "$COMMAND" != "" ]]; then
 105   COMMAND="bash /jenkins/$COMMAND --target $TARGET"
 106 fi
 107
 108 STDOUT_IF_DEBUG=/dev/null
 109 STDERR_IF_DEBUG=/dev/null
 110 DASHQ_UNLESS_DEBUG=-q
 111 if [[ "$DEBUG" != 0 ]]; then
 112     STDOUT_IF_DEBUG=/dev/stdout
 113     STDERR_IF_DEBUG=/dev/stderr
 114     DASHQ_UNLESS_DEBUG=
 115 fi
 116
 117 # The next section defines a bunch of constants used to build distro packages
 118 # for our Python tools. Because those packages include C extensions, they need
 119 # to depend on and refer to a specific minor version of Python 3. The logic
 120 # below should Just Work for most cases, but you can override variables for a
 121 # specific distro if you need to to do something weird.
 122 # * PYTHON3_VERSION: The major+minor version of Python we build against
 123 #   (e.g., "3.11")
 124 # * PYTHON3_EXECUTABLE: The command to run that version of Python,
 125 #   either a full path or something in $PATH (e.g., "python3.11")
 126 # * PYTHON3_PACKAGE: The name of the distro package that provides
 127 #   $PYTHON3_EXECUTABLE. Our Python packages will all depend on this.
 128 # * PYTHON3_PKG_PREFIX: The prefix used in the names of all of our Python
 129 #   packages. This should match distro convention.
 130 PYTHON3_PKG_PREFIX=python3
 131 case "$TARGET" in
 132     rocky9)
 133         FORMAT=rpm
 134         PYTHON3_VERSION=3.11
 135         ;;
 136     centos*|rocky*)
 137         FORMAT=rpm
 138         ;;
 139     debian*|ubuntu*)
 140         FORMAT=deb
 141         ;;
 142     *)
 143         echo -e "$0: Unknown target '$TARGET'.\n" >&2
 144         exit 1
 145         ;;
 146 esac
 147 : "${PYTHON3_VERSION:=$("${PYTHON3_EXECUTABLE:-python3}" -c 'import sys; print("{v.major}.{v.minor}".format(v=sys.version_info))')}"
 148 : "${PYTHON3_EXECUTABLE:=python$PYTHON3_VERSION}"
 149 case "$FORMAT" in
 150     deb)
 151         : "${PYTHON3_PACKAGE:=python$PYTHON3_VERSION}"
 152         ;;
 153     rpm)
 154         : "${PYTHON3_PACKAGE:=$(rpm -qf "$(command -v "$PYTHON3_EXECUTABLE")" --queryformat '%{NAME}\n')}"
 155         ;;
 156 esac
 157
 158 if [[ -z "$WORKSPACE" ]]; then
 159   echo >&2 "$helpmessage"
 160   echo >&2
 161   echo >&2 "Error: WORKSPACE environment variable not set"
 162   echo >&2
 163   exit 1
 164 fi
 165
 166 # Test for fpm
 167 fpm --version >/dev/null 2>&1
 168
 169 if [[ $? -ne 0 ]]; then
 170   echo >&2 "$helpmessage"
 171   echo >&2
 172   echo >&2 "Error: fpm not found"
 173   echo >&2
 174   exit 1
 175 fi
 176
 177 RUN_BUILD_PACKAGES_PATH="$(dirname "$0")"
 178 RUN_BUILD_PACKAGES_PATH="$(cd "$RUN_BUILD_PACKAGES_PATH" && pwd)"  # absolutized and normalized
 179 if [ -z "$RUN_BUILD_PACKAGES_PATH" ] ; then
 180   # error; for some reason, the path is not accessible
 181   # to the script (e.g. permissions re-evaled after suid)
 182   exit 1  # fail
 183 fi
 184
 185 debug_echo "$0 is running from $RUN_BUILD_PACKAGES_PATH"
 186 debug_echo "Workspace is $WORKSPACE"
 187
 188 # Make all files world-readable -- jenkins runs with umask 027, and has checked
 189 # out our git tree here
 190 chmod o+r "$WORKSPACE" -R
 191
 192 # More cleanup - make sure all executables that we'll package are 755
 193 cd "$WORKSPACE" || exit 1
 194 find . -type d -name 'bin' -print0 |xargs -0 -I {} find {} -type f -print0 |xargs -0 -I {} chmod 755 {}
 195
 196 # Now fix our umask to something better suited to building and publishing
 197 # gems and packages
 198 umask 0022
 199
 200 debug_echo "umask is" "$(umask)"
 201
 202 if [[ ! -d "$WORKSPACE/packages/$TARGET" ]]; then
 203   mkdir -p "$WORKSPACE/packages/$TARGET"
 204   chown --reference="$WORKSPACE" "$WORKSPACE/packages/$TARGET"
 205 fi
 206
 207 # Required due to CVE-2022-24765
 208 git config --global --add safe.directory /arvados
 209
 210 # Ruby gems
 211 debug_echo -e "\nRuby gems\n"
 212
 213 FPM_GEM_PREFIX=$(gem environment gemdir)
 214
 215 cd "$WORKSPACE/sdk/ruby" || exit 1
 216 handle_ruby_gem arvados
 217
 218 cd "$WORKSPACE/sdk/cli" || exit 1
 219 handle_ruby_gem arvados-cli
 220
 221 cd "$WORKSPACE/services/login-sync" || exit 1
 222 handle_ruby_gem arvados-login-sync
 223
 224 # arvados-src
 225 handle_arvados_src
 226
 227 # Go packages
 228 debug_echo -e "\nGo packages\n"
 229
 230 # Go binaries
 231 export GOPATH=~/go
 232 package_go_binary cmd/arvados-client arvados-client "$FORMAT" "$ARCH" \
 233     "Arvados command line tool (beta)"
 234 package_go_binary cmd/arvados-server arvados-server "$FORMAT" "$ARCH" \
 235     "Arvados server daemons"
 236 package_go_binary cmd/arvados-server arvados-controller "$FORMAT" "$ARCH" \
 237     "Arvados cluster controller daemon"
 238 package_go_binary cmd/arvados-server arvados-dispatch-cloud "$FORMAT" "$ARCH" \
 239     "Arvados cluster cloud dispatch"
 240 package_go_binary cmd/arvados-server arvados-dispatch-lsf "$FORMAT" "$ARCH" \
 241     "Dispatch Arvados containers to an LSF cluster"
 242 package_go_binary services/crunch-dispatch-local crunch-dispatch-local "$FORMAT" "$ARCH" \
 243     "Dispatch Crunch containers on the local system"
 244 package_go_binary cmd/arvados-server crunch-dispatch-slurm "$FORMAT" "$ARCH" \
 245     "Dispatch Crunch containers to a SLURM cluster"
 246 package_go_binary cmd/arvados-server crunch-run "$FORMAT" "$ARCH" \
 247     "Supervise a single Crunch container"
 248 package_go_binary cmd/arvados-server arvados-health "$FORMAT" "$ARCH" \
 249     "Check health of all Arvados cluster services"
 250 package_go_binary cmd/arvados-server keep-balance "$FORMAT" "$ARCH" \
 251     "Rebalance and garbage-collect data blocks stored in Arvados Keep"
 252 package_go_binary cmd/arvados-server keepproxy "$FORMAT" "$ARCH" \
 253     "Make a Keep cluster accessible to clients that are not on the LAN"
 254 package_go_binary cmd/arvados-server keepstore "$FORMAT" "$ARCH" \
 255     "Keep storage daemon, accessible to clients on the LAN"
 256 package_go_binary cmd/arvados-server keep-web "$FORMAT" "$ARCH" \
 257     "Static web hosting service for user data stored in Arvados Keep"
 258 package_go_binary cmd/arvados-server arvados-ws "$FORMAT" "$ARCH" \
 259     "Arvados Websocket server"
 260 package_go_binary tools/sync-groups arvados-sync-groups "$FORMAT" "$ARCH" \
 261     "Synchronize remote groups into Arvados from an external source"
 262 package_go_binary tools/sync-users arvados-sync-users "$FORMAT" "$ARCH" \
 263     "Synchronize remote users into Arvados from an external source"
 264 package_go_binary tools/keep-block-check keep-block-check "$FORMAT" "$ARCH" \
 265     "Verify that all data from one set of Keep servers to another was copied"
 266 package_go_binary tools/keep-rsync keep-rsync "$FORMAT" "$ARCH" \
 267     "Copy all data from one set of Keep servers to another"
 268 package_go_binary tools/keep-exercise keep-exercise "$FORMAT" "$ARCH" \
 269     "Performance testing tool for Arvados Keep"
 270 package_go_so lib/pam pam_arvados.so libpam-arvados-go "$FORMAT" "$ARCH" \
 271     "Arvados PAM authentication module"
 272
 273 # Python packages
 274 debug_echo -e "\nPython packages\n"
 275
 276 # Before a Python package can be built, its dependencies must already be built.
 277 # This list is ordered accordingly.
 278 setup_build_virtualenv
 279 fpm_build_virtualenv "arvados-python-client" "sdk/python" "$FORMAT" "$ARCH"
 280 fpm_build_virtualenv "crunchstat-summary" "tools/crunchstat-summary" "$FORMAT" "$ARCH"
 281 fpm_build_virtualenv "arvados-cwl-runner" "sdk/cwl" "$FORMAT" "$ARCH"
 282 fpm_build_virtualenv "arvados-docker-cleaner" "services/dockercleaner" "$FORMAT" "$ARCH"
 283 fpm_build_virtualenv "arvados-fuse" "services/fuse" "$FORMAT" "$ARCH"
 284 fpm_build_virtualenv "arvados-user-activity" "tools/user-activity" "$FORMAT" "$ARCH"
 285 fpm_build_virtualenv "arvados-cluster-activity" "tools/cluster-activity" "$FORMAT" "$ARCH"
 286
 287 # Workbench2
 288 package_workbench2
 289
 290 # Rails packages
 291 debug_echo -e "\nRails packages\n"
 292
 293 # The rails api server package
 294 handle_api_server "$ARCH"
 295
 296 # clean up temporary GOPATH
 297 rm -rf "$GOPATH"
 298
 299 exit $EXITCODE