Adopt modern arg passing for build process of both docker and singularity

Author: Tom-Notch

docker-compose.yml

@@ -2,6 +2,11 @@ services:
     todo-service-name:
         build:
             dockerfile: ./docker/${IMAGE_TAG}/Dockerfile
+            args:
+                BASE_IMAGE: ${BASE_IMAGE}
+                IMAGE_USER: ${IMAGE_USER}
+                HOME_FOLDER: ${HOME_FOLDER}
+                TIME_ZONE: ${TIME_ZONE}
             x-bake:
                 contexts:
                     home-folder-config: ./docker/build-context/home-folder-config

docker/latest/Dockerfile

@@ -1,5 +1,11 @@
 # Do not add --platform=linux/blabla since this is intended for multiplatform builds
+ARG BASE_IMAGE=ubuntu
 FROM ${BASE_IMAGE}
+
+ARG IMAGE_USER
+ARG HOME_FOLDER
+ARG TIME_ZONE
+
 ENV HOME=${HOME_FOLDER}
 WORKDIR ${HOME_FOLDER}/
 
@@ -106,7 +112,7 @@ RUN wget "https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-$(uname -m
     rm ~/miniconda.sh
 
 # Add conda to PATH
-ENV PATH=${PATH}:/opt/conda/bin
+ENV PATH=/opt/conda/bin:${PATH}
 
 # Init conda for zsh
 RUN conda init zsh

scripts/build_docker_image.sh

@@ -10,32 +10,10 @@
 
 set -euo pipefail
 
-before_env="$(mktemp)"
-after_env="$(mktemp)"
-tmp_dockerfile="$(mktemp)"
-cleanup() { rm -f "${before_env}" "${after_env}" "${tmp_dockerfile}"; }
-trap cleanup EXIT
-
-env | sort >"${before_env}"
-
 set -a
 . "$(dirname "$0")"/variables.sh
 set +a
 
-env | sort >"${after_env}"
-
-diff_env="$(
-	awk -F= '
-    NR==FNR { before[$1]=$0; next }
-    {
-      name=$1
-      if (!(name in before) || before[name] != $0)
-        printf " ${%s}", name
-    }
-  ' "${before_env}" "${after_env}"
-)"
-diff_env="${diff_env# }" # trim leading space
-
 # Determine the local platform
 if [[ "$(uname -m)" == "x86_64" ]]; then
 	LOCAL_PLATFORM="linux/amd64"
@@ -58,13 +36,5 @@ else
 	docker buildx use "${BUILDER}"
 fi
 
-# environment variable substitution trick
-envsubst "${diff_env}" <"$(dirname "$0")/../docker/${IMAGE_TAG}/Dockerfile" >"${tmp_dockerfile}"
-
-echo ">>> Substituted dockerfile:"
-echo "----------------------------------------"
-cat "${tmp_dockerfile}"
-echo "----------------------------------------"
-
 # Build the Docker image for only the local platform, push.sh will push multi-platform version
-docker buildx bake --file "$(dirname "$0")"/../docker-compose.yml --load --set "*.platform=${LOCAL_PLATFORM}" --set "*.dockerfile=${tmp_dockerfile}"
+docker buildx bake --file "$(dirname "$0")"/../docker-compose.yml --load --set "*.platform=${LOCAL_PLATFORM}"

scripts/pull_singularity_image.sh

@@ -10,42 +10,19 @@
 
 set -euo pipefail
 
-before_env="$(mktemp)"
-after_env="$(mktemp)"
-tmp_def="$(mktemp)"
-cleanup() { rm -f "${before_env}" "${after_env}" "${tmp_def}"; }
-trap cleanup EXIT
-
-env | sort >"${before_env}"
-
 set -a
 . "$(dirname "$0")"/variables.sh
 set +a
 
-after_env="$(mktemp)"
-trap 'rm -f "$after_env"' RETURN
-env | sort >"${after_env}"
-
-diff_env="$(
-	awk -F= '
-    NR==FNR { before[$1]=$0; next }
-    {
-      name=$1
-      if (!(name in before) || before[name] != $0)
-        printf " ${%s}", name
-    }
-  ' "${before_env}" "${after_env}"
-)"
-diff_env="${diff_env# }" # trim leading space
-
-envsubst "${diff_env}" <"$(dirname "$0")/../singularity/default.def" >"${tmp_def}"
-
-echo ">>> Substituted def file:"
-echo "----------------------------------------"
-cat "${tmp_def}"
-echo "----------------------------------------"
-
 singularity build \
 	--fix-perms \
+	--warn-unused-build-args \
+	--build-arg DOCKER_USER="${DOCKER_USER}" \
+	--build-arg IMAGE_NAME="${IMAGE_NAME}" \
+	--build-arg IMAGE_USER="${IMAGE_USER}" \
+	--build-arg IMAGE_TAG="${IMAGE_TAG}" \
+	--build-arg HOME_FOLDER="${HOME_FOLDER}" \
+	--build-arg CODE_FOLDER="${CODE_FOLDER}" \
+	--build-arg TIME_ZONE="${TIME_ZONE}" \
 	"$(dirname "$0")/../${IMAGE_NAME}_${IMAGE_TAG}.sif" \
-	"${tmp_def}"
+	"$(dirname "$0")/../singularity/default.def"

scripts/push_docker_image.sh

@@ -10,32 +10,10 @@
 
 set -euo pipefail
 
-before_env="$(mktemp)"
-after_env="$(mktemp)"
-tmp_dockerfile="$(mktemp)"
-cleanup() { rm -f "${before_env}" "${after_env}" "${tmp_dockerfile}"; }
-trap cleanup EXIT
-
-env | sort >"${before_env}"
-
 set -a
 . "$(dirname "$0")"/variables.sh
 set +a
 
-env | sort >"${after_env}"
-
-diff_env="$(
-	awk -F= '
-    NR==FNR { before[$1]=$0; next }
-    {
-      name=$1
-      if (!(name in before) || before[name] != $0)
-        printf " ${%s}", name
-    }
-  ' "${before_env}" "${after_env}"
-)"
-diff_env="${diff_env# }" # trim leading space
-
 # Check if the builder already exists
 if ! docker buildx inspect "${BUILDER}" &>/dev/null; then
 	echo "Creating Docker Buildx builder '${BUILDER}'..."
@@ -48,14 +26,6 @@ else
 	docker buildx use "${BUILDER}"
 fi
 
-# environment variable substitution trick
-envsubst "${diff_env}" <"$(dirname "$0")/../docker/${IMAGE_TAG}/Dockerfile" >"${tmp_dockerfile}"
-
-echo ">>> Substituted dockerfile:"
-echo "----------------------------------------"
-cat "${tmp_dockerfile}"
-echo "----------------------------------------"
-
 # docker push "${DOCKER_USER}"/"${IMAGE_NAME}":"${IMAGE_TAG}"
 
-docker buildx bake --file "$(dirname "$0")"/../docker-compose.yml --push --set "*.dockerfile=${tmp_dockerfile}"
+docker buildx bake --file "$(dirname "$0")"/../docker-compose.yml --push

singularity/default.def

@@ -1,21 +1,19 @@
 Bootstrap: docker
-From: ${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_TAG}
+From: {{DOCKER_USER}}/{{IMAGE_NAME}}:{{IMAGE_TAG}}
 
 %labels
-    Image       ${IMAGE_NAME}:${IMAGE_TAG}
-    Source      docker://${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_TAG}
+    Image       {{IMAGE_NAME}}:{{IMAGE_TAG}}
+    Source      docker://{{DOCKER_USER}}/{{IMAGE_NAME}}:{{IMAGE_TAG}}
 
 %environment
-    # ---- Runtime env (applies inside the container at exec/start) ----
-    export HOME="${HOME_FOLDER}"
-    export DEBIAN_FRONTEND=noninteractive
+    # ---- Runtime env (applies inside the instance at start/exec) ----
+    export HOME={{HOME_FOLDER}}
 
 %runscript
-    # Default behavior: pass through to the invoked command
-    exec "$@"
+    # works only when starting with 'singularity run ...'
+    # Source zshrc if it exists
+    [ -f ~/.zshrc ] && source ~/.zshrc
+
+    cd "{{HOME_FOLDER}}/{{CODE_FOLDER}}" 2>/dev/null || cd "{{HOME_FOLDER}}" || true
 
-%startscript
-    # When `instance start` runs, ensure HOME is correct and cd to project if present
-    export HOME="${HOME_FOLDER}"
-    cd "${HOME_FOLDER}/${CODE_FOLDER}" 2>/dev/null || cd "${HOME_FOLDER}" || true
     exec "$@"