chore: Add non-root user and install pre-commit in the image. (seriou…

…s-scaffold#267)

.devcontainer/prebuild/.devcontainer/Dockerfile

@@ -7,17 +7,39 @@ ARG PYTHON_VERSION=3.12
 FROM python:${PYTHON_VERSION} as dev
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
-#   To install Python applications.
+#   pipx: To install Python applications.
     pipx \
+#   sudo: To add sudo support to non-root user.
+    sudo \
     && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
 # Config pipx
 ENV PIPX_HOME=/usr/local/pipx
 ENV PIPX_BIN_DIR=/usr/local/bin
+ENV PIPX_DEFAULT_PYTHON=/usr/local/bin/python
 
 # Install pdm
 RUN pipx install pdm
 
+# Install pre-commit
+RUN pipx install pre-commit
+
+# Create a non-root user with sudo permission
+ARG USERNAME=ss-python
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+
+RUN groupadd --gid $USER_GID $USERNAME \
+    && useradd --create-home --uid $USER_UID --gid $USER_GID $USERNAME \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+# Set permission for related folders
+RUN chown -R $USER_UID:$USER_GID $PIPX_HOME $PIPX_BIN_DIR
+
+# Set the default user
+User ss-python
+
 ########################################################################################
 # Build image is an intermediate image used for building the project.
 ########################################################################################

.devcontainer/prebuild/.devcontainer/devcontainer.json

@@ -1,11 +1,11 @@
 {
-    "build": {
-        "args": {
-            "PYTHON_VERSION": "${localEnv:PYTHON_VERSION}"
-        },
-        "cacheFrom": "ghcr.io/serious-scaffold/ss-python:dev-py${localEnv:PYTHON_VERSION}",
-        "context": "../../..",
-        "dockerfile": "Dockerfile",
-        "target": "dev"
-    }
+  "build": {
+    "args": {
+      "PYTHON_VERSION": "${localEnv:PYTHON_VERSION}"
+    },
+    "cacheFrom": "ghcr.io/serious-scaffold/ss-python:dev-py${localEnv:PYTHON_VERSION}",
+    "context": "../../..",
+    "dockerfile": "Dockerfile",
+    "target": "dev"
+  }
 }

template/.devcontainer/prebuild/.devcontainer/Dockerfile.jinja

@@ -7,17 +7,39 @@ ARG PYTHON_VERSION={{ default_py }}
 FROM python:${PYTHON_VERSION} as dev
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
-#   To install Python applications.
+#   pipx: To install Python applications.
     pipx \
+#   sudo: To add sudo support to non-root user.
+    sudo \
     && apt-get clean -y && rm -rf /var/lib/apt/lists/*
 
 # Config pipx
 ENV PIPX_HOME=/usr/local/pipx
 ENV PIPX_BIN_DIR=/usr/local/bin
+ENV PIPX_DEFAULT_PYTHON=/usr/local/bin/python
 
 # Install pdm
 RUN pipx install pdm
 
+# Install pre-commit
+RUN pipx install pre-commit
+
+# Create a non-root user with sudo permission
+ARG USERNAME={{ repo_name }}
+ARG USER_UID=1000
+ARG USER_GID=$USER_UID
+
+RUN groupadd --gid $USER_GID $USERNAME \
+    && useradd --create-home --uid $USER_UID --gid $USER_GID $USERNAME \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+# Set permission for related folders
+RUN chown -R $USER_UID:$USER_GID $PIPX_HOME $PIPX_BIN_DIR
+
+# Set the default user
+User {{ repo_name }}
+
 ########################################################################################
 # Build image is an intermediate image used for building the project.
 ########################################################################################

template/.devcontainer/prebuild/.devcontainer/devcontainer.json

@@ -1,11 +1,11 @@
 {
-    "build": {
-        "args": {
-            "PYTHON_VERSION": "${localEnv:PYTHON_VERSION}"
-        },
-        "cacheFrom": "ghcr.io/serious-scaffold/ss-python:dev-py${localEnv:PYTHON_VERSION}",
-        "context": "../../..",
-        "dockerfile": "Dockerfile",
-        "target": "dev"
-    }
+  "build": {
+    "args": {
+      "PYTHON_VERSION": "${localEnv:PYTHON_VERSION}"
+    },
+    "cacheFrom": "ghcr.io/serious-scaffold/ss-python:dev-py${localEnv:PYTHON_VERSION}",
+    "context": "../../..",
+    "dockerfile": "Dockerfile",
+    "target": "dev"
+  }
 }