19164: rework the help text for all the options of the compute image
[arvados.git] / 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") [options]
13
14 Options:
15
16 --build-bundle-packages  (default: false)
17     Build api server and workbench packages with vendor/bundle included
18 --debug
19     Output debug information (default: false)
20 --target <target>
21     Distribution to build packages for (default: debian10)
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 TARGET=debian10
51 COMMAND=
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 [[ "$COMMAND" != "" ]]; then
97   COMMAND="/usr/local/rvm/bin/rvm-exec default bash /jenkins/$COMMAND --target $TARGET"
98 fi
99
100 STDOUT_IF_DEBUG=/dev/null
101 STDERR_IF_DEBUG=/dev/null
102 DASHQ_UNLESS_DEBUG=-q
103 if [[ "$DEBUG" != 0 ]]; then
104     STDOUT_IF_DEBUG=/dev/stdout
105     STDERR_IF_DEBUG=/dev/stderr
106     DASHQ_UNLESS_DEBUG=
107 fi
108
109 declare -a PYTHON3_BACKPORTS
110
111 PYTHON3_EXECUTABLE=python3
112 PYTHON3_VERSION=$($PYTHON3_EXECUTABLE -c 'import sys; print("{v.major}.{v.minor}".format(v=sys.version_info))')
113
114 ## These defaults are suitable for any Debian-based distribution.
115 # You can customize them as needed in distro sections below.
116 PYTHON3_PACKAGE=python$PYTHON3_VERSION
117 PYTHON3_PKG_PREFIX=python3
118 PYTHON3_PREFIX=/usr
119 PYTHON3_INSTALL_LIB=lib/python$PYTHON3_VERSION/dist-packages
120 ## End Debian Python defaults.
121
122 case "$TARGET" in
123     debian*)
124         FORMAT=deb
125         ;;
126     ubuntu1804)
127         FORMAT=deb
128         PYTHON3_EXECUTABLE=python3.8
129         PYTHON3_VERSION=$($PYTHON3_EXECUTABLE -c 'import sys; print("{v.major}.{v.minor}".format(v=sys.version_info))')
130         PYTHON3_PACKAGE=python$PYTHON3_VERSION
131         PYTHON3_INSTALL_LIB=lib/python$PYTHON3_VERSION/dist-packages
132         ;;
133     ubuntu*)
134         FORMAT=deb
135         ;;
136     centos*)
137         FORMAT=rpm
138         PYTHON3_PACKAGE=$(rpm -qf "$(which python"$PYTHON3_VERSION")" --queryformat '%{NAME}\n')
139         PYTHON3_PKG_PREFIX=$PYTHON3_PACKAGE
140         PYTHON3_PREFIX=/usr
141         PYTHON3_INSTALL_LIB=lib/python$PYTHON3_VERSION/site-packages
142         export PYCURL_SSL_LIBRARY=nss
143         ;;
144     *)
145         echo -e "$0: Unknown target '$TARGET'.\n" >&2
146         exit 1
147         ;;
148 esac
149
150
151 if [[ -z "$WORKSPACE" ]]; then
152   echo >&2 "$helpmessage"
153   echo >&2
154   echo >&2 "Error: WORKSPACE environment variable not set"
155   echo >&2
156   exit 1
157 fi
158
159 # Test for fpm
160 fpm --version >/dev/null 2>&1
161
162 if [[ $? -ne 0 ]]; then
163   echo >&2 "$helpmessage"
164   echo >&2
165   echo >&2 "Error: fpm not found"
166   echo >&2
167   exit 1
168 fi
169
170 RUN_BUILD_PACKAGES_PATH="$(dirname "$0")"
171 RUN_BUILD_PACKAGES_PATH="$(cd "$RUN_BUILD_PACKAGES_PATH" && pwd)"  # absolutized and normalized
172 if [ -z "$RUN_BUILD_PACKAGES_PATH" ] ; then
173   # error; for some reason, the path is not accessible
174   # to the script (e.g. permissions re-evaled after suid)
175   exit 1  # fail
176 fi
177
178 debug_echo "$0 is running from $RUN_BUILD_PACKAGES_PATH"
179 debug_echo "Workspace is $WORKSPACE"
180
181 if [[ -f /etc/profile.d/rvm.sh ]]; then
182     source /etc/profile.d/rvm.sh
183     GEM="rvm-exec default gem"
184 else
185     GEM=gem
186 fi
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 # Perl packages
211 debug_echo -e "\nPerl packages\n"
212
213 handle_libarvados_perl
214
215 # Ruby gems
216 debug_echo -e "\nRuby gems\n"
217
218 FPM_GEM_PREFIX=$($GEM environment gemdir)
219
220 cd "$WORKSPACE/sdk/ruby" || exit 1
221 handle_ruby_gem arvados
222
223 cd "$WORKSPACE/sdk/cli" || exit 1
224 handle_ruby_gem arvados-cli
225
226 cd "$WORKSPACE/services/login-sync" || exit 1
227 handle_ruby_gem arvados-login-sync
228
229 # arvados-src
230 handle_arvados_src
231
232 # Go packages
233 debug_echo -e "\nGo packages\n"
234
235 # Go binaries
236 export GOPATH=~/go
237 package_go_binary cmd/arvados-client arvados-client "$FORMAT" "$ARCH" \
238     "Arvados command line tool (beta)"
239 package_go_binary cmd/arvados-server arvados-server "$FORMAT" "$ARCH" \
240     "Arvados server daemons"
241 package_go_binary cmd/arvados-server arvados-controller "$FORMAT" "$ARCH" \
242     "Arvados cluster controller daemon"
243 package_go_binary cmd/arvados-server arvados-dispatch-cloud "$FORMAT" "$ARCH" \
244     "Arvados cluster cloud dispatch"
245 package_go_binary cmd/arvados-server arvados-dispatch-lsf "$FORMAT" "$ARCH" \
246     "Dispatch Arvados containers to an LSF cluster"
247 package_go_binary cmd/arvados-server arvados-git-httpd "$FORMAT" "$ARCH" \
248     "Provide authenticated http access to Arvados-hosted git repositories"
249 package_go_binary services/crunch-dispatch-local crunch-dispatch-local "$FORMAT" "$ARCH" \
250     "Dispatch Crunch containers on the local system"
251 package_go_binary cmd/arvados-server crunch-dispatch-slurm "$FORMAT" "$ARCH" \
252     "Dispatch Crunch containers to a SLURM cluster"
253 package_go_binary cmd/arvados-server crunch-run "$FORMAT" "$ARCH" \
254     "Supervise a single Crunch container"
255 package_go_binary services/crunchstat crunchstat "$FORMAT" "$ARCH" \
256     "Gather cpu/memory/network statistics of running Crunch jobs"
257 package_go_binary cmd/arvados-server arvados-health "$FORMAT" "$ARCH" \
258     "Check health of all Arvados cluster services"
259 package_go_binary cmd/arvados-server keep-balance "$FORMAT" "$ARCH" \
260     "Rebalance and garbage-collect data blocks stored in Arvados Keep"
261 package_go_binary cmd/arvados-server keepproxy "$FORMAT" "$ARCH" \
262     "Make a Keep cluster accessible to clients that are not on the LAN"
263 package_go_binary cmd/arvados-server keepstore "$FORMAT" "$ARCH" \
264     "Keep storage daemon, accessible to clients on the LAN"
265 package_go_binary cmd/arvados-server keep-web "$FORMAT" "$ARCH" \
266     "Static web hosting service for user data stored in Arvados Keep"
267 package_go_binary cmd/arvados-server arvados-ws "$FORMAT" "$ARCH" \
268     "Arvados Websocket server"
269 package_go_binary tools/sync-groups arvados-sync-groups "$FORMAT" "$ARCH" \
270     "Synchronize remote groups into Arvados from an external source"
271 package_go_binary tools/keep-block-check keep-block-check "$FORMAT" "$ARCH" \
272     "Verify that all data from one set of Keep servers to another was copied"
273 package_go_binary tools/keep-rsync keep-rsync "$FORMAT" "$ARCH" \
274     "Copy all data from one set of Keep servers to another"
275 package_go_binary tools/keep-exercise keep-exercise "$FORMAT" "$ARCH" \
276     "Performance testing tool for Arvados Keep"
277 package_go_so lib/pam pam_arvados.so libpam-arvados-go "$FORMAT" "$ARCH" \
278     "Arvados PAM authentication module"
279
280 # Python packages
281 debug_echo -e "\nPython packages\n"
282
283 # The Python SDK - Python3 package
284 fpm_build_virtualenv "arvados-python-client" "sdk/python" "$FORMAT" "$ARCH"
285
286 # Arvados cwl runner - Python3 package
287 fpm_build_virtualenv "arvados-cwl-runner" "sdk/cwl" "$FORMAT" "$ARCH"
288
289 # The FUSE driver - Python3 package
290 fpm_build_virtualenv "arvados-fuse" "services/fuse" "$FORMAT" "$ARCH"
291
292 # The Arvados crunchstat-summary tool
293 fpm_build_virtualenv "crunchstat-summary" "tools/crunchstat-summary" "$FORMAT" "$ARCH"
294
295 # The Docker image cleaner
296 fpm_build_virtualenv "arvados-docker-cleaner" "services/dockercleaner" "$FORMAT" "$ARCH"
297
298 # The Arvados user activity tool
299 fpm_build_virtualenv "arvados-user-activity" "tools/user-activity" "$FORMAT" "$ARCH"
300
301 # The python->python3 metapackages
302 build_metapackage "arvados-fuse" "services/fuse"
303 build_metapackage "arvados-python-client" "services/fuse"
304 build_metapackage "arvados-cwl-runner" "sdk/cwl"
305 build_metapackage "crunchstat-summary" "tools/crunchstat-summary"
306 build_metapackage "arvados-docker-cleaner" "services/dockercleaner"
307 build_metapackage "arvados-user-activity" "tools/user-activity"
308
309 # The cwltest package, which lives out of tree
310 handle_cwltest "$FORMAT" "$ARCH"
311
312 # Rails packages
313 debug_echo -e "\nRails packages\n"
314
315 # The rails api server package
316 handle_api_server "$ARCH"
317 # The rails workbench package
318 handle_workbench "$ARCH"
319
320 # clean up temporary GOPATH
321 rm -rf "$GOPATH"
322
323 exit $EXITCODE