kumquat-buildroot/utils/docker-run

#!/usr/bin/env bash
set -o errexit -o pipefail
DIR=$(dirname "${0}")
MAIN_DIR=$(readlink -f "${DIR}/..")
# GIT_DIR to support workdirs/worktrees
GIT_DIR="$(dirname "$(realpath "${MAIN_DIR}/.git/config")")"
# shellcheck disable=SC2016
IMAGE=$(grep ^image: "${MAIN_DIR}/.gitlab-ci.yml" | \
        sed -e 's,^image: ,,g' | sed -e 's,\$CI_REGISTRY,registry.gitlab.com,g')

declare -a docker_opts=(
    -i
    --rm
    --user "$(id -u):$(id -g)"
    --mount "type=bind,src=${MAIN_DIR},dst=${MAIN_DIR}"
    --mount "type=bind,src=${GIT_DIR},dst=${GIT_DIR}"
    --workdir "${MAIN_DIR}"
)
if tty -s; then
    docker_opts+=( -t )
fi

exec docker run "${docker_opts[@]}" "${IMAGE}" "${@}"
utils/docker-run: use portable bash shebang /usr/bin/bash does not exist on Ubuntu 2018.04. Use the more portable alternative "#!/usr/bin/env bash" which we are already using in quite a few scripts. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Fixes: 242e9d72e7d2 ("utils/docker-run: new script") [yann.morin.1998@free.fr: use "#!/usr/bin/env bash", not "@!/bin/bash"] Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> 2022-02-14 17:24:12 +01:00			`#!/usr/bin/env bash`
utils/docker-run: new script Add a small script to run commands in the same docker image used in the GitLab CI. For instance, one can run check-package unit tests without installing pytest directly in the host: $ ./utils/docker-run python3 -m pytest -v utils/checkpackagelib/ Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> [Arnout: fix shellcheck errors; add exec] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> 2022-01-23 17:08:46 +01:00			`set -o errexit -o pipefail`
			`DIR=$(dirname "${0}")`
			`MAIN_DIR=$(readlink -f "${DIR}/..")`
utils/docker-run: make it work in workdirs/woktrees It is quite customary to use a single repository with multiple workdirs, one for each active branch, with either the aging 'git new-workdir' or the more recent 'git worktree'. However, in a workdir/worktree, most entries in .git/ are only symlinks to the actual files in the main repository. Currently, utils/docker-run only bind-mounts the current working copy. If that is a workdir/worktree, then it is going to be missing the actual git data, resulting in errors like: $ ./utils/docker-run make check-package fatal: not a git repository (or any parent up to mount point [....]/buildroot) Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set). No files to check style make: *** [Makefile:1257: check-package] Error 1 So, we also bind-mount the actual git directory. If that is a subdir of the current working copy, then it is already mounted and thus the bind-mount is superfluous but harmless; for simplicity, we mount it unconditionally. Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> Cc: Ricardo Martincoski <ricardo.martincoski@datacom.com.br> 2023-05-06 23:46:18 +02:00			`# GIT_DIR to support workdirs/worktrees`
			`GIT_DIR="$(dirname "$(realpath "${MAIN_DIR}/.git/config")")"`
utils/docker-run: new script Add a small script to run commands in the same docker image used in the GitLab CI. For instance, one can run check-package unit tests without installing pytest directly in the host: $ ./utils/docker-run python3 -m pytest -v utils/checkpackagelib/ Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com> [Arnout: fix shellcheck errors; add exec] Signed-off-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be> 2022-01-23 17:08:46 +01:00			`# shellcheck disable=SC2016`
			`IMAGE=$(grep ^image: "${MAIN_DIR}/.gitlab-ci.yml" \| \`
			`sed -e 's,^image: ,,g' \| sed -e 's,\$CI_REGISTRY,registry.gitlab.com,g')`

utils/docker-run: allow running without a tty Currently, utils/docker-run spawns a container with a tty, so that he user can interact properly in the container. However, that requires a tty when calling docker-run, which is not always guaranteed, e.g. if called from a git hook. Since the script is a bash script already, we can use an array to store options passed to docker, and only add the -t option when there is actually a tty available. Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> Cc: Ricardo Martincoski <ricardo.martincoski@gmail.com> 2023-04-15 21:43:41 +02:00			`declare -a docker_opts=(`
			`-i`
			`--rm`
			`--user "$(id -u):$(id -g)"`
			`--mount "type=bind,src=${MAIN_DIR},dst=${MAIN_DIR}"`
utils/docker-run: make it work in workdirs/woktrees It is quite customary to use a single repository with multiple workdirs, one for each active branch, with either the aging 'git new-workdir' or the more recent 'git worktree'. However, in a workdir/worktree, most entries in .git/ are only symlinks to the actual files in the main repository. Currently, utils/docker-run only bind-mounts the current working copy. If that is a workdir/worktree, then it is going to be missing the actual git data, resulting in errors like: $ ./utils/docker-run make check-package fatal: not a git repository (or any parent up to mount point [....]/buildroot) Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set). No files to check style make: *** [Makefile:1257: check-package] Error 1 So, we also bind-mount the actual git directory. If that is a subdir of the current working copy, then it is already mounted and thus the bind-mount is superfluous but harmless; for simplicity, we mount it unconditionally. Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> Cc: Ricardo Martincoski <ricardo.martincoski@datacom.com.br> 2023-05-06 23:46:18 +02:00			`--mount "type=bind,src=${GIT_DIR},dst=${GIT_DIR}"`
utils/docker-run: allow running without a tty Currently, utils/docker-run spawns a container with a tty, so that he user can interact properly in the container. However, that requires a tty when calling docker-run, which is not always guaranteed, e.g. if called from a git hook. Since the script is a bash script already, we can use an array to store options passed to docker, and only add the -t option when there is actually a tty available. Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr> Cc: Ricardo Martincoski <ricardo.martincoski@gmail.com> 2023-04-15 21:43:41 +02:00			`--workdir "${MAIN_DIR}"`
			`)`
			`if tty -s; then`
			`docker_opts+=( -t )`
			`fi`

			`exec docker run "${docker_opts[@]}" "${IMAGE}" "${@}"`