Add option to set UID & GID env vars (#102)

Author: matiboux

docker/Dockerfile

@@ -6,14 +6,43 @@
 # --
 # Upstream images
 
-FROM alpine:3.19 AS alpine_upstream
 FROM python:3.11-slim AS python_upstream
 
 
+# --
+# Python + Docker image
+
+FROM python_upstream AS python_docker
+
+# Install Docker CLI
+RUN --mount=type=cache,target=/var/cache/apt \
+	--mount=type=cache,target=/var/lib/apt \
+	apt-get update && \
+	apt-get install -y \
+		ca-certificates \
+		curl \
+		&& \
+	install -m 0755 -d /etc/apt/keyrings && \
+	curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc && \
+	chmod a+r /etc/apt/keyrings/docker.asc && \
+	echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] \
+		https://download.docker.com/linux/debian \
+		$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+		tee /etc/apt/sources.list.d/docker.list > /dev/null \
+		&& \
+	apt-get update && \
+	apt-get install -y \
+		docker-ce \
+		docker-ce-cli \
+		containerd.io \
+		docker-buildx-plugin \
+		docker-compose-plugin
+
+
 # --
 # Base image
 
-FROM python_upstream AS app_base
+FROM python_docker AS app_base
 
 # Set app directory
 WORKDIR /app

dockerc

@@ -50,6 +50,12 @@ while true; do
 				shift
 				;;
 
+			'--uid' | '-u' )
+				# Set user & group id environment variable
+				DOCKERC_UID='true'
+				shift
+				;;
+
 			'--update' )
 				# Update DockerC
 				DOCKERC_UPDATE='true'
@@ -199,6 +205,7 @@ if [ "$DOCKERC_DEBUG_ARGS" = 'true' ]; then
 	echo "DOCKERC_FORCE: $DOCKERC_FORCE"
 	echo "DOCKERC_DRY_RUN: $DOCKERC_DRY_RUN"
 	echo "DOCKERC_QUIET: $DOCKERC_QUIET"
+	echo "DOCKERC_UID: $DOCKERC_UID"
 	echo "DOCKERC_UPDATE: $DOCKERC_UPDATE"
 	echo "DOCKERC_INSTALL_DIR: $DOCKERC_INSTALL_DIR"
 	echo "DOCKERC_CONTEXT: $DOCKERC_CONTEXT"
@@ -225,6 +232,12 @@ if [ -n "$DOCKERC_QUIET" ]; then
 	QUIET="$DOCKERC_QUIET"
 fi
 
+SET_UID='false'
+if [ -n "$DOCKERC_UID" ]; then
+	# Use from argument or environment variable
+	SET_UID="$DOCKERC_UID"
+fi
+
 UPDATE='false'
 if [ -n "$DOCKERC_UPDATE" ]; then
 	# Use from argument or environment variable
@@ -547,6 +560,12 @@ if [ "$UPDATE" = 'true' ]; then
 	exit ${ERROR_CODE:-0}
 fi
 
+# Set user & group id environment variable
+if [ "$SET_UID" = 'true' ]; then
+	export UID="$(id -u)"
+	export GID="$(id -g)"
+fi
+
 # Handle docker presets
 if [ -n "$DOCKER_PRESET" ]; then
 

test/src/RunDockerc.py

@@ -9,6 +9,7 @@ def __init__(
         cwd: str,
         context: str | None = None,
         env: dict[str, str] | None = None,
+        dry_run: bool = True,
     ):
         self.dockerc_path = dockerc_path
         self.dockerc_args = dockerc_args
@@ -21,11 +22,12 @@ def __init__(
             None
         )
         self.env = env
+        self.dry_run = dry_run
 
         self.proc = subprocess.Popen(
             [
                 self.dockerc_path,
-                '-n',
+                *(['-n'] if self.dry_run else []),
                 *self.dockerc_args,
             ],
             cwd = self.cwd,

test/src/TestDirContext.py

@@ -29,10 +29,12 @@ def run_dockerc(
         *args: list[str],
         cwd: str | None = None,
         env: dict[str, str] | None = None,
+        dry_run: bool = True,
     ) -> RunDockerc:
         return RunDockerc(
             self.dockerc_path,
             dockerc_args = args,
             cwd = cwd or self.cwd,
             env = env,
+            dry_run = dry_run,
         )

test/test/uid/__init__.py

@@ -0,0 +1,4 @@
+services:
+  app:
+    image: app:latest
+    user: ${UID:-1001}

test/test/uid/cwd/docker-compose-base.yml

@@ -0,0 +1,68 @@
+from test.src.format_dockerc_stdout import format_dockerc_stdout
+from test.src.TestDirContext import TestDirContext
+
+def test_dry_run(file = __file__):
+    with TestDirContext(file) as ctx:
+        dockerc = ctx.run_dockerc(
+            'base', 'config',
+        )
+        dockerc.assert_context_ok(
+            format_dockerc_stdout(
+                b'docker compose'
+                b' -f ./docker-compose-base.yml'
+                b' config'
+            ),
+        )
+
+def test_no_uid(file = __file__):
+    with TestDirContext(file) as ctx:
+        dockerc = ctx.run_dockerc(
+            'base', 'config',
+            dry_run = False,
+        )
+        dockerc.assert_context_ok(
+            format_dockerc_stdout(
+                b'docker compose'
+                b' -f ./docker-compose-base.yml'
+                b' config'
+            ) +
+            b'name: cwd\n'
+            b'services:\n'
+            b'  app:\n'
+            b'    image: app:latest\n'
+            b'    networks:\n'
+            b'      default: null\n'
+            b'    user: "1001"\n'
+            b'networks:\n'
+            b'  default:\n'
+            b'    name: cwd_default\n'
+        )
+
+def test_uid_shell(shell):
+    ret = shell.run("sh", "-c", "exit $(id -u)")
+    assert ret.returncode == 0
+
+def test_uid(file = __file__):
+    with TestDirContext(file) as ctx:
+        dockerc = ctx.run_dockerc(
+            '-u',
+            'base', 'config',
+            dry_run = False,
+        )
+        dockerc.assert_context_ok(
+            format_dockerc_stdout(
+                b'docker compose'
+                b' -f ./docker-compose-base.yml'
+                b' config'
+            ) +
+            b'name: cwd\n'
+            b'services:\n'
+            b'  app:\n'
+            b'    image: app:latest\n'
+            b'    networks:\n'
+            b'      default: null\n'
+            b'    user: "0"\n'
+            b'networks:\n'
+            b'  default:\n'
+            b'    name: cwd_default\n'
+        )