leandron commented on a change in pull request #8670:
URL: https://github.com/apache/tvm/pull/8670#discussion_r683603063
##########
File path: docker/bash.sh
##########
@@ -30,112 +30,274 @@
# With -i, execute interactively.
#
-set -e
+set -euo pipefail
+
+function show_usage() {
+ cat <<EOF
+Usage: docker/bash.sh [-i|--interactive] [--net=host]
+ [--mount MOUNT_DIR] [--dry-run]
+ <DOCKER_IMAGE_NAME> [COMMAND]
+
+-h, --help
+
+ Display this help message.
+
+-i, --interactive
+
+ Start the docker session in interactive mode.
+
+--net=host
+
+ Expose servers run into the container to the host, passing the
+ "--net=host" argument through to docker. On MacOS, this is
+ instead passed as "-p 8888:8888" since the host networking driver
+ isn't supported and the .
+
+--mount MOUNT_DIR
+
+ Expose MOUNT_DIR as an additional mount point inside the docker
+ container. The mount point inside the container is the same as
+ the folder location outside the container. This option can be
+ specified multiple times.
+
+--dry-run
+
+ Print the docker command to be run, but do not execute it.
+
+DOCKER_IMAGE_NAME
+
+ The name of the docker container to be run. This can be an
+ explicit name of a docker image (e.g. "tlcpack/ci-gpu:v0.76") or
+ can be a shortcut as defined in the TVM Jenkinsfile
+ (e.g. "ci_gpu").
+
+COMMAND
+
+ The command to be run inside the docker container. If this is set
+ to "bash", both the --interactive and --net=host flags are set.
+ If no command is specified, defaults to "bash".
+
+EOF
+}
-source "$(dirname $0)/dev_common.sh" || exit 2
-interactive=0
-if [ "$1" == "-i" ]; then
- interactive=1
+#################################
+### Start of argument parsing ###
+#################################
+
+DRY_RUN=false
+INTERACTIVE=false
+USE_NET_HOST=false
+DOCKER_IMAGE_NAME=
+COMMAND=bash
+MOUNT_DIRS=( )
+
+trap "show_usage >&2" ERR
+args=$(getopt \
+ --name bash.sh \
+ --options "ih" \
+ --longoptions "interactive,net=host,mount,dry-run" \
+ --longoptions "help" \
+ --unquoted \
+ -- "$@")
+trap - ERR
+set -- $args
+
+while (( $# )); do
+ case "$1" in
+ -h|--help)
+ show_usage
+ exit 0
+ ;;
+
+ -i|--interactive)
+ INTERACTIVE=true
+ shift
+ ;;
+
+ --net=host)
+ USE_NET_HOST=true
+ shift
+ ;;
+
+ --mount)
+ MOUNT_DIRS+=($2)
+ shift
+ shift
+ ;;
+
+ --dry-run)
+ DRY_RUN=true
+ shift
+ ;;
+
+ --)
+ shift
+ break
+ ;;
+
+ -*|--*)
+ echo "Error: Unknown flag: $1" >&2
+ show_usage >&2
+ exit 1
+ ;;
+
+ *)
+ echo "Internal Error: getopt should output -- before positional"
>&2
+ exit 2
+ ;;
+ esac
+done
+
+if (( $# )); then
+ DOCKER_IMAGE_NAME=$1
shift
+else
+ echo "Error: Missing DOCKER_IMAGE_NAME" >&2
+ show_usage >&2
fi
-CI_DOCKER_EXTRA_PARAMS=( )
-if [[ "$1" == "--net=host" ]]; then
- CI_DOCKER_EXTRA_PARAMS+=('--net=host')
- shift 1
+if (( $# )); then
+ COMMAND="$@"
fi
-# Mount external directory to the docker
-CI_DOCKER_MOUNT_CMD=( )
-if [ "$1" == "--mount" ]; then
- shift 1
- CI_DOCKER_MOUNT_CMD=( -v "$1:$1" )
- shift 1
-fi
-if [ "$#" -lt 1 ]; then
- echo "Usage: docker/bash.sh [-i] [--net=host] <CONTAINER_NAME> [COMMAND]"
- exit -1
+if [[ "${COMMAND}" = bash ]]; then
+ INTERACTIVE=true
+ USE_NET_HOST=true
fi
-DOCKER_IMAGE_NAME=$(lookup_image_spec "$1")
-if [ -z "${DOCKER_IMAGE_NAME}" ]; then
- DOCKER_IMAGE_NAME=("$1")
+###############################
+### End of argument parsing ###
+###############################
+
+source "$(dirname $0)/dev_common.sh" || exit 2
+
+DOCKER_FLAGS=( )
+DOCKER_ENV=( )
+DOCKER_MOUNT=( )
+DOCKER_DEVICES=( )
+
+
+# If the user gave a shortcut defined in the Jenkinsfile, use it.
+EXPANDED_SHORTCUT=$(lookup_image_spec "${DOCKER_IMAGE_NAME}")
+if [ -n "${EXPANDED_SHORTCUT}" ]; then
+ DOCKER_IMAGE_NAME="${EXPANDED_SHORTCUT}"
fi
-if [ "$#" -eq 1 ]; then
- COMMAND="bash"
- interactive=1
+# Set up working directories
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
+WORKSPACE="$(dirname "${SCRIPT_DIR}")"
+DOCKER_FLAGS+=( --workdir /workspace )
+DOCKER_MOUNT+=( --volume "${WORKSPACE}":/workspace
+ --volume "${SCRIPT_DIR}":/docker
+ )
+
+# Set up CI-specific environment variables
+DOCKER_ENV+=( --env CI_BUILD_HOME=/workspace
+ --env CI_BUILD_USER="$(id -u -n)"
+ --env CI_BUILD_UID="$(id -u)"
+ --env CI_BUILD_GROUP="$(id -g -n)"
+ --env CI_BUILD_GID="$(id -g)"
+ --env CI_PYTEST_ADD_OPTIONS="${CI_PYTEST_ADD_OPTIONS:-}"
+ --env CI_IMAGE_NAME="${DOCKER_IMAGE_NAME}"
+ )
+
+
+# Pass tvm test data folder through to the docker container, to avoid
+# repeated downloads.
+TEST_DATA_PATH="${TVM_DATA_ROOT_PATH:-${HOME}/.tvm_test_data}"
+DOCKER_MOUNT+=( --volume "${TEST_DATA_PATH}":/workspace/.tvm_test_data )
+
+
+# Remove the container once it finishes running (--rm) and share the
+# PID namespace (--pid=host). The process inside does not have pid 1
+# and SIGKILL is propagated to the process inside, allowing jenkins to
+# kill it if needed.
+DOCKER_FLAGS+=( --rm --pid=host)
+
+# Expose services running in container to the host.
+if $USE_NET_HOST; then
if [[ $(uname) == "Darwin" ]]; then
# Docker's host networking driver isn't supported on macOS.
# Use default bridge network and expose port for jupyter notebook.
- CI_DOCKER_EXTRA_PARAMS+=( "${CI_DOCKER_EXTRA_PARAMS[@]}" "-p
8888:8888" )
+ DOCKER_FLAGS+=( "-p 8888:8888" )
else
- CI_DOCKER_EXTRA_PARAMS+=( "${CI_DOCKER_EXTRA_PARAMS[@]}" "--net=host" )
+ DOCKER_FLAGS+=('--net=host')
Review comment:
nit to make it similar to the previous one?
```suggestion
DOCKER_FLAGS+=( "--net=host" )
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
