Skip to content

Commit

Permalink
Merge branch 'templates/docker-ctl-func'
Browse files Browse the repository at this point in the history
  • Loading branch information
@kilo52
kilo52 committed Jun 23, 2024
2 parents b0e24d6 + 2b218b3 commit 283917f
Show file tree
Hide file tree
Showing 14 changed files with 291 additions and 429 deletions.
72 changes: 33 additions & 39 deletions js/02_server-nodejs/source/.docker/controls.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,28 @@
# This shell script provides functions to handle isolated executions #
# via Docker. Users may source this file and call the provided functions to #
# run the underlying project inside a Docker container. #
# This can also be used to run arbitrary commands inside an isolated #
# container or to get an interactive shell. Some execution parameters #
# can be controlled by setting various PROJECT_CONTAINER_* variables. #
# #
###############################################################################

# The Dockerfile to be used for creating images for isolated runs
readonly CONTAINER_BUILD_DOCKERFILE="Dockerfile-run";
PROJECT_CONTAINER_BUILD_DOCKERFILE="Dockerfile-run";
# The name given to the image and container
readonly CONTAINER_BUILD_NAME="${{VAR_PROJECT_NAME_LOWER}}";
PROJECT_CONTAINER_BUILD_NAME="${{VAR_PROJECT_NAME_LOWER}}";
# The version tag given to the image and container
readonly CONTAINER_BUILD_VERSION="0.1";
PROJECT_CONTAINER_BUILD_VERSION="0.1";


# Executes an isolated command inside a Docker container.
#
# This function builds the image, creates a container from it
# and then runs that container. The container is removed after
# the execution has completed
# the execution has completed.
#
# The building of the Docker image can be suppressed by setting the
# environment variable PROJECT_CONTAINER_IMAGE_BUILD to the value "0".
#
# Args:
# $@ - The arguments to be passed to the container's entrypoint.
Expand All @@ -30,12 +36,16 @@ readonly CONTAINER_BUILD_VERSION="0.1";
# Either the exit status of the Docker-related commands, if unsuccessful,
# or the exit status of the specified command.
#
function _run_isolated() {
local run_type="$1";
function project_run_isolated() {
local isolated_command="$1";
shift;
if [ -z "$isolated_command" ]; then
echo "ERROR: Must provide a command to run in isolation";
return 1;
fi
if ! command -v "docker" &> /dev/null; then
echo "ERROR: Could not find the 'docker' executable.";
echo "If you want the $run_type to be executed in an isolated environment,";
echo "If you want a command to be executed in an isolated environment,";
echo "please make sure that Docker is correctly installed ";
return 1;
fi
Expand All @@ -55,49 +65,33 @@ function _run_isolated() {
gid=$(id -g);
workdir="/home/user/${workdir_name}";
fi
echo "Building Docker image";
docker build --build-arg UID=${uid} \
--build-arg GID=${gid} \
--build-arg DWORKDIR="${workdir}" \
--tag ${CONTAINER_BUILD_NAME}:${CONTAINER_BUILD_VERSION} \
--file .docker/${CONTAINER_BUILD_DOCKERFILE} .
local name_tag="${PROJECT_CONTAINER_BUILD_NAME}:${PROJECT_CONTAINER_BUILD_VERSION}";
if [[ "$PROJECT_CONTAINER_IMAGE_BUILD" != "0" ]]; then
echo "Building Docker image";
docker build --build-arg UID=${uid} \
--build-arg GID=${gid} \
--build-arg DWORKDIR="${workdir}" \
--tag "$name_tag" \
--file .docker/${PROJECT_CONTAINER_BUILD_DOCKERFILE} .

if (( $? != 0 )); then
return $?;
local docker_status=$?;
if (( docker_status != 0 )); then
return $docker_status;
fi
fi

echo "Executing isolated $run_type";
docker run --name ${CONTAINER_BUILD_NAME} \
echo "Executing isolated $isolated_command";
docker run --name ${PROJECT_CONTAINER_BUILD_NAME} \
--interactive \
--tty \
--init \
--mount type=bind,source="${PWD}",target="${workdir}" \
--user ${uid}:${gid} \
--rm \
--publish 8080:8080 \
${CONTAINER_BUILD_NAME}:${CONTAINER_BUILD_VERSION} \
"$run_type" \
"$name_tag" \
"$isolated_command" \
"$@";

return $?;
}

# Executes the application in an isolated process inside a Docker container.
#
# This function executes a 'docker build' followed by a 'docker run' command.
# Returns the exit status of 'docker build', if it was not successful,
# otherwise returns the exit status of 'docker run'.
#
# Args:
# $@ - Arguments to be passed to the project's run.sh script
# to customise the execution.
#
# Returns:
# The exit status of the Docker-related commands. If the Docker commands are
# all successful, then the exit status of the executed run.sh script
# is returned instead.
#
function run_isolated_app() {
_run_isolated "app" "$@";
return $?;
}
2 changes: 1 addition & 1 deletion js/var/script_run_isolated_main
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
if [[ $ARG_ISOLATED == true ]]; then
source ".docker/controls.sh";
run_isolated_app "${ARGS_ISOLATED[@]}";
project_run_isolated app "${ARGS_ISOLATED[@]}";
exit $?;
fi
85 changes: 39 additions & 46 deletions python/06_server-cherrypy/source/.docker/controls.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,20 @@
# This shell script provides functions to handle isolated executions #
# via Docker. Users may source this file and call the provided functions to #
# either build or test the underlying project inside a Docker container. #
# This can also be used to run arbitrary commands inside an isolated #
# container or to get an interactive shell. Some execution parameters #
# can be controlled by setting various PROJECT_CONTAINER_* variables. #
# #
###############################################################################

# The Dockerfile to be used for creating images for isolated builds
readonly CONTAINER_BUILD_DOCKERFILE="Dockerfile-build";
PROJECT_CONTAINER_BUILD_DOCKERFILE="Dockerfile-build";
# The name given to the image and container
readonly CONTAINER_BUILD_NAME="${{VAR_PROJECT_NAME_LOWER}}-build";
PROJECT_CONTAINER_BUILD_NAME="${{VAR_PROJECT_NAME_LOWER}}-build";
# The version tag given to the image and container
readonly CONTAINER_BUILD_VERSION="0.1";
PROJECT_CONTAINER_BUILD_VERSION="0.1";
# The project name inside the container
readonly CONTAINER_PROJECT_NAME="${{VAR_PROJECT_NAME_LOWER}}";
PROJECT_CONTAINER_PROJECT_NAME="${{VAR_PROJECT_NAME_LOWER}}";


# Checks that the docker command is available.
Expand All @@ -41,13 +44,19 @@ function _check_docker() {

# Builds the Docker image.
#
# The building of the Docker image can be suppressed by setting the
# environment variable PROJECT_CONTAINER_IMAGE_BUILD to the value "0".
#
# Returns:
# The exit status of the docker build command.
#
function _docker_build() {
if [[ "$PROJECT_CONTAINER_IMAGE_BUILD" == "0" ]]; then
return 0;
fi
local uid=0;
local gid=0;
local workdir="/root/${CONTAINER_PROJECT_NAME}";
local workdir="/root/${PROJECT_CONTAINER_PROJECT_NAME}";
# When using non-rootless Docker, the user inside the container should be a
# regular user. We assign him the same UID and GID as the underlying host
# user so that there are no conflicts when bind-mounting the source tree.
Expand All @@ -57,14 +66,15 @@ function _docker_build() {
if ! docker info 2>/dev/null |grep -q "rootless"; then
uid=$(id -u);
gid=$(id -g);
workdir="/home/user/${CONTAINER_PROJECT_NAME}";
workdir="/home/user/${PROJECT_CONTAINER_PROJECT_NAME}";
fi
local name_tag="${PROJECT_CONTAINER_BUILD_NAME}:${PROJECT_CONTAINER_BUILD_VERSION}";
logI "Building Docker image";
docker build --build-arg UID=${uid} \
--build-arg GID=${gid} \
--build-arg DWORKDIR="${workdir}" \
--tag ${CONTAINER_BUILD_NAME}:${CONTAINER_BUILD_VERSION} \
--file .docker/${CONTAINER_BUILD_DOCKERFILE} .
docker build --build-arg UID=${uid} \
--build-arg GID=${gid} \
--build-arg DWORKDIR="${workdir}" \
--tag "${name_tag}" \
--file .docker/${PROJECT_CONTAINER_BUILD_DOCKERFILE} .

return $?;
}
Expand All @@ -82,10 +92,10 @@ function _docker_build() {
# Either the exit status of the Docker-related commands, if unsuccessful,
# or the exit status of the specified command.
#
function _run_isolated() {
local run_type="$1";
function project_run_isolated() {
local isolated_command="$1";
shift;
if ! _check_docker "If you want the $run_type to be executed in an isolated environment," \
if ! _check_docker "If you want a command to be executed in an isolated environment," \
"please make sure that Docker is correctly installed."; then
return 1;
fi
Expand All @@ -96,20 +106,22 @@ function _run_isolated() {

local uid=0;
local gid=0;
local workdir="/root/${CONTAINER_PROJECT_NAME}";
local workdir="/root/${PROJECT_CONTAINER_PROJECT_NAME}";
if ! docker info 2>/dev/null |grep -q "rootless"; then
uid=$(id -u);
gid=$(id -g);
workdir="/home/user/${CONTAINER_PROJECT_NAME}";
workdir="/home/user/${PROJECT_CONTAINER_PROJECT_NAME}";
fi
logI "Executing isolated $run_type";
docker run --name ${CONTAINER_BUILD_NAME} \
local name_tag="${PROJECT_CONTAINER_BUILD_NAME}:${PROJECT_CONTAINER_BUILD_VERSION}";
logI "Executing isolated $isolated_command";
docker run --name ${PROJECT_CONTAINER_BUILD_NAME} \
--mount type=bind,source="${PWD}",target="${workdir}" \
--user ${uid}:${gid} \
--rm \
--tty \
${CONTAINER_BUILD_NAME}:${CONTAINER_BUILD_VERSION} \
"$run_type" \
--interactive \
"$name_tag" \
"$isolated_command" \
"$@";

return $?;
Expand Down Expand Up @@ -141,48 +153,29 @@ function _start_interactive_isolated_tests() {

local uid=0;
local gid=0;
local workdir="/root/${CONTAINER_PROJECT_NAME}";
local workdir="/root/${PROJECT_CONTAINER_PROJECT_NAME}";
if ! docker info 2>/dev/null |grep -q "rootless"; then
uid=$(id -u);
gid=$(id -g);
workdir="/home/user/${CONTAINER_PROJECT_NAME}";
workdir="/home/user/${PROJECT_CONTAINER_PROJECT_NAME}";
fi
local name_tag="${PROJECT_CONTAINER_BUILD_NAME}:${PROJECT_CONTAINER_BUILD_VERSION}";
logI "Starting isolated Docker container for interactive testing";
docker run --name ${CONTAINER_BUILD_NAME} \
docker run --name ${PROJECT_CONTAINER_BUILD_NAME} \
--interactive \
--tty \
--init \
--mount type=bind,source="${PWD}",target="${workdir}" \
--user ${uid}:${gid} \
--rm \
--publish 8080:8080 \
${CONTAINER_BUILD_NAME}:${CONTAINER_BUILD_VERSION} \
"$name_tag" \
"tests" \
"$@";

return $?;
}

# Executes an isolated build process inside a Docker container.
#
# This function executes a 'docker build' followed by a 'docker run' command.
# Returns the exit status of 'docker build', if it was not successful,
# otherwise returns the exit status of 'docker run'.
#
# Args:
# $@ - Arguments to be passed to the project's build.sh script
# to customise the build.
#
# Returns:
# The exit status of the Docker-related commands. If the Docker commands are
# all successful, then the exit status of the executed build.sh script
# is returned instead.
#
function run_isolated_build() {
_run_isolated "build" "$@";
return $?;
}

# Executes an isolated test process inside a Docker container.
#
# This function is used for two purposes. It either executes a 'docker build'
Expand All @@ -207,7 +200,7 @@ function run_isolated_build() {
# Returns the exit status of the server application process when using an
# interactive test session.
#
function run_isolated_tests() {
function project_run_isolated_tests() {
local arg="";
local run_interactive_session=false;
for arg in "$@"; do
Expand All @@ -220,7 +213,7 @@ function run_isolated_tests() {
if [[ $run_interactive_session == true ]]; then
_start_interactive_isolated_tests "$@";
else
_run_isolated "tests" "$@";
project_run_isolated "tests" "$@";
fi
return $?;
}
5 changes: 5 additions & 0 deletions python/06_server-cherrypy/var/script_test_isolated_main
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
if [[ $ARG_ISOLATED == true ]]; then
source ".docker/controls.sh";
project_run_isolated_tests "${ARGS_ISOLATED[@]}";
exit $?;
fi
Loading

0 comments on commit 283917f

Please sign in to comment.