Files
galaxy/scripts/common_startup_functions.sh
T
mvdbeek a05c2c22d4 Resolve conditional dependencies from tool_shed.yml for the Tool Shed
common_startup.sh resolved only galaxy.yml, so a Tool Shed deployment
installed nothing from conditional-requirements.txt. That is why the
sentry-sdk>=2.63.0 pin never reached toolshed.test, which kept an older
sentry-sdk and hit the FastAPI >= 0.137 wrapper-loop crash: sentry
re-wraps dependant.call on every request there, and inspect.unwrap
raises once the chain passes the recursion limit.

Move the machinery and the app-agnostic checks into
BaseConditionalDependencies so the Tool Shed evaluates the database
driver and sentry-sdk checks against its own config section, and let
run_tool_shed.sh select it with GALAXY_CONDITIONAL_DEPENDENCIES_APP.
Galaxy-only checks stay on ConditionalDependencies, where check() keeps
treating a missing check_<name> method as "not needed".
2026-07-30 12:45:42 +02:00

272 lines
10 KiB
Bash

#!/bin/sh
__CONDA_INFO=
parse_common_args() {
INITIALIZE_TOOL_DEPENDENCIES=1
# Pop args meant for common_startup.sh
add_pid_arg=0
add_log_arg=0
while :
do
case "$1" in
--skip-eggs|--skip-wheels|--skip-samples|--dev-wheels|--no-create-venv|--skip-client-build)
common_startup_args="$common_startup_args $1"
shift
;;
--skip-tool-dependency-initialization)
INITIALIZE_TOOL_DEPENDENCIES=0
shift
;;
--skip-venv)
skip_venv=1
common_startup_args="$common_startup_args $1"
shift
;;
--stop-daemon|stop)
common_startup_args="$common_startup_args --stop-daemon"
gravity_args="stop"
paster_args="$paster_args --stop-daemon"
add_pid_arg=1
stop_daemon_arg_set=1
shift
;;
--restart|restart)
gravity_args="restart"
paster_args="$paster_args restart"
add_pid_arg=1
add_log_arg=1
restart_arg_set=1
daemon_or_restart_arg_set=1
shift
;;
--daemon|start)
gravity_args="start"
paster_args="$paster_args --daemon"
gunicorn_args="$gunicorn_args --daemon --capture-output"
add_pid_arg=1
add_log_arg=1
# --daemonize2 waits until after the application has loaded
# to daemonize, thus it stops if any errors are found
daemon_or_restart_arg_set=1
shift
;;
--status|status)
gravity_args="status"
paster_args="$paster_args $1"
add_pid_arg=1
shift
;;
--no-replace-pip|--replace-pip)
# Deprecated options
shift
;;
"")
break
;;
*)
paster_args="$paster_args $1"
shift
;;
esac
done
}
run_common_start_up() {
./scripts/common_startup.sh $common_startup_args || exit 1
}
conda_activate() {
: ${GALAXY_CONDA_ENV:="_galaxy_"}
echo "Activating Conda environment: $GALAXY_CONDA_ENV"
# Dash is actually supported by 4.4, but not with `. /path/to/activate`, only `conda activate`, which we
# can't load unless we know the path to <conda_root>/etc/profile.d/conda.sh
if ! command -v source >/dev/null; then
echo "WARNING: Your shell is not supported with Conda, attempting to use Conda env"
echo " '$GALAXY_CONDA_ENV' with manual environment setup. To avoid this"
echo " message, use a supported shell or activate the environment before"
echo " starting Galaxy."
PATH="$(get_conda_env_path $GALAXY_CONDA_ENV)/bin:$PATH"
CONDA_DEFAULT_ENV="$GALAXY_CONDA_ENV"
CONDA_PREFIX="$(get_conda_active_prefix)"
else
source "$(get_conda_root_prefix)"/bin/activate "$GALAXY_CONDA_ENV"
fi
}
find_python_command() {
if [ -z "$GALAXY_PYTHON" ]; then
if command -v python3 >/dev/null; then
GALAXY_PYTHON=python3
else
GALAXY_PYTHON=python
fi
fi
}
setup_python() {
# If there is a .venv/ directory, assume it contains a virtualenv that we
# should run this instance in.
: ${GALAXY_VIRTUAL_ENV:=.venv}
# $GALAXY_CONDA_ENV isn't set here to avoid running the version check if not using Conda
# if conda and the galaxy conda environment (_galaxy_) are available then init it
if [ -z "$skip_venv" ]; then
set_conda_exe
if [ -n "$CONDA_EXE" ] && \
check_conda_env ${GALAXY_CONDA_ENV:="_galaxy_"}; then
[ -n "$PYTHONPATH" ] && { echo 'Unsetting $PYTHONPATH'; unset PYTHONPATH; }
if [ "$CONDA_DEFAULT_ENV" != "$GALAXY_CONDA_ENV" ]; then
conda_activate
fi
if [ "$CONDA_DEFAULT_ENV" = "base" ] || [ "$CONDA_DEFAULT_ENV" = "root" ]; then
echo "ERROR: Conda is in 'base' environment, refusing to continue"
exit 1
fi
fi
fi
if [ -d "$GALAXY_VIRTUAL_ENV" ] && [ -z "$skip_venv" ]; then
[ -n "$PYTHONPATH" ] && { echo 'Unsetting $PYTHONPATH'; unset PYTHONPATH; }
echo "Activating virtualenv at $GALAXY_VIRTUAL_ENV"
. "$GALAXY_VIRTUAL_ENV/bin/activate"
fi
# If you are using --skip-venv we assume you know what you are doing but warn
# in case you don't.
[ -n "$PYTHONPATH" ] && echo 'WARNING: $PYTHONPATH is set, this can cause problems importing Galaxy dependencies'
find_python_command
"$GALAXY_PYTHON" ./scripts/check_python.py || exit 1
}
set_galaxy_config_file_var() {
if [ -z "$GALAXY_CONFIG_FILE" ]; then
GALAXY_CONFIG_FILE=$(PYTHONPATH=lib python -c "from __future__ import print_function; from galaxy.util.properties import find_config_file; print(find_config_file(['galaxy', 'universe_wsgi']) or '')")
export GALAXY_CONFIG_FILE
fi
}
set_tool_shed_config_file_var() {
if [ -z "$TOOL_SHED_CONFIG_FILE" ]; then
TOOL_SHED_CONFIG_FILE=$(PYTHONPATH=lib python -c "from __future__ import print_function; from galaxy.util.properties import find_config_file; print(find_config_file(['tool_shed', 'tool_shed_wsgi'], include_samples=True) or '')")
export TOOL_SHED_CONFIG_FILE
fi
}
find_server() {
server_config=$1
server_app=$2
arg_getter_args=
default_webserver="gunicorn"
default_gunicorn_worker="uvicorn.workers.UvicornWorker"
case "$server_app" in
galaxy)
default_webserver="gravity"
gunicorn_worker="galaxy.webapps.galaxy.workers.Worker"
;;
reports)
# TODO: is this really the only way to configure the port?
GUNICORN_CMD_ARGS=${GUNICORN_CMD_ARGS:-"--bind=localhost:9001 --config lib/galaxy/web_stack/gunicorn_config.py"}
;;
tool_shed)
GUNICORN_CMD_ARGS=${GUNICORN_CMD_ARGS:-"--bind=localhost:9009 --config lib/galaxy/web_stack/gunicorn_config.py"}
esac
APP_WEBSERVER=${APP_WEBSERVER:-$default_webserver}
if [ "$APP_WEBSERVER" = "gunicorn" ]; then
run_server="gunicorn"
export GUNICORN_CMD_ARGS
if [ "$server_app" = "tool_shed" ]; then
server_args="'${server_app}.webapp.fast_factory:factory()' --pythonpath lib -k ${gunicorn_worker:-$default_gunicorn_worker} $gunicorn_args"
else
server_args="'galaxy.webapps.${server_app}.fast_factory:factory()' --pythonpath lib -k ${gunicorn_worker:-$default_gunicorn_worker} $gunicorn_args"
fi
if [ "$add_pid_arg" -eq 1 ]; then
server_args="$server_args --pid \"$PID_FILE\""
fi
if [ "$add_log_arg" -eq 1 ]; then
server_args="$server_args --log-file \"$LOG_FILE\""
fi
else
if [ "$add_log_arg" -eq 1 ]; then
GALAXY_DAEMON_LOG="${GALAXY_LOG:-galaxy.log}"
export GALAXY_DAEMON_LOG
fi
if [ -n "$gravity_args" ]; then
run_server="galaxyctl"
server_args="$gravity_args"
else
galaxyctl update --force
run_server="galaxy"
server_args=
fi
fi
}
# Prior to Conda 4.4, the setup method was to add <conda_root>/bin to $PATH. Beginning with 4.4, that method is still
# possible, but the preferred method is to source <conda_root>/etc/profile.d/conda.sh. If the new method is used, the
# base environment will *not* be on $PATH, unlike previous versions, and `conda` is a shell function not available to
# subshells (e.g. scripts). Additionally, in Conda >= 4.4 (and sometimes in Conda < 4.4 due to bugs), an activated
# non-root/base environment will not have a symlink to `conda`. Beginning with 4.5, $CONDA_EXE will be set to the path
# to the `conda` script in the base environment. Thus in Conda 4.4, it may not be possible to locate `conda` even if you
# are using Conda.
set_conda_exe() {
[ -n "$CONDA_EXE" ] || [ -n "$_CONDA_EXE_SET" ] && return 0
if python -V 2>&1 | grep -q -e 'Anaconda' -e 'Continuum Analytics' || \
python -c 'import sys; print(sys.version.replace("\n", " "))' 2>/dev/null | grep -q -e 'packaged by conda-forge' ; then
CONDA_EXE=$(command -v conda)
if [ -z "$CONDA_EXE" ]; then
echo "WARNING: \`python\` is from conda, but the \`conda\` command cannot be found."
pydir="$(dirname "$(command -v python)")"
for CONDA_EXE in $pydir/conda $pydir/../../../bin/conda; do
[ -x "$CONDA_EXE" ] && break || unset CONDA_EXE
done
if [ -z "$CONDA_EXE" ]; then
echo "WARNING: Unable to guess conda location, if you are using Conda 4.4, upgrade to"
echo " Conda 4.5 or activate the base environment prior to starting Galaxy:"
echo " $ conda activate base"
else
echo "Guessed conda location: $CONDA_EXE"
PATH="$(dirname "$CONDA_EXE"):$PATH"
fi
else
echo "Found conda at: $CONDA_EXE"
fi
_CONDA_EXE_SET=1
fi
}
set_conda_info() {
# cache conda info to avoid the cost of running it multiple times
if [ -z "$__CONDA_INFO" ]; then
__CONDA_INFO="$(${CONDA_EXE:-conda} info --json)"
fi
}
get_conda_active_prefix() {
set_conda_info
printf "%s" "$__CONDA_INFO" \
| python -c "import json, sys; print(json.load(sys.stdin)['active_prefix'])"
}
get_conda_root_prefix() {
set_conda_info
printf "%s" "$__CONDA_INFO" \
| python -c "import json, sys; print(json.load(sys.stdin)['root_prefix'])"
}
check_conda_env() {
# envs listed in ~/.conda/environments.txt show up in envs.txt but can't be activated by name. =/
set_conda_info
printf "%s" "$__CONDA_INFO" \
| python -c "import json, os.path, sys; info = json.load(sys.stdin); sys.exit(0 if '$1' in [os.path.basename(p) for p in info['envs'] if os.path.dirname(p) in info['envs_dirs']] else 1)"
}
get_conda_env_path() {
set_conda_info
printf "%s" "$__CONDA_INFO" \
| python -c "import json, os.path, sys; info = json.load(sys.stdin); print([p for p in info['envs'] if os.path.basename(p) == '$1' and os.path.dirname(p) in info['envs_dirs']][0])"
}