Merge pull request #109 from Synicix/worktree-docker-patch

Update gpu/docker to include new git version to support git worktree

Author: guzman-raphael

.devcontainer/gpu/Dockerfile

@@ -10,13 +10,16 @@ RUN \
     echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null && \
     apt-get update && \
     apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y && \
-    usermod -aG docker root && \
-    apt-get clean
+    usermod -aG docker root
+
+RUN apt-get install software-properties-common -y && \
+    apt-add-repository ppa:git-core/ppa && \
+    apt-get install git -y
 
 RUN \
     # dev setup
     apt update && \
-    apt-get install build-essential sudo jq git bash-completion graphviz rsync -y && \
+    apt-get install build-essential sudo jq bash-completion graphviz rsync software-properties-common -y && \
     echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers && \
     echo '. /etc/bash_completion' >> /root/.bashrc && \
     echo 'export PS1="\[\e[32;1m\]\u\[\e[m\]@\[\e[34;1m\]\H\[\e[m\]:\[\e[33;1m\]\w\[\e[m\]$ "' >> /root/.bashrc && \

.devcontainer/gpu/devcontainer.json

@@ -1,30 +1,15 @@
 {
-	"name": "Development (GPU)",
-	"build": {
-		"dockerfile": "Dockerfile",
-		"context": "../.."
-	},
-	"overrideCommand": false,
+	"name": "Development-GPU",
+	"dockerComposeFile": "./docker-compose.yaml",
+	"service": "ide",
 	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
-	"mounts": [
-		"source=${localWorkspaceFolderBasename}_devcontainer_docker_data,target=/var/lib/docker,type=volume"
-	],
-	"remoteEnv": {
-		"LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}",
-		"RUST_BACKTRACE": "1"
-	},
+	"initializeCommand": ".devcontainer/gpu/make_env_file.py ${localWorkspaceFolder}",
 	"postStartCommand": "mkdir -p tests/.tmp && docker system prune -fa && docker volume prune -f",
 	"hostRequirements": {
 		"cpus": 2,
 		"memory": "8gb",
 		"storage": "32gb"
 	},
-	"runArgs": [
-		"--name=${localWorkspaceFolderBasename}_devcontainer",
-		"--gpus=all",
-		"--privileged",
-		"--cgroupns=host"
-	],
 	"customizations": {
 		"vscode": {
 			"extensions": [

.devcontainer/gpu/docker-compose.yaml

@@ -0,0 +1,22 @@
+services:
+  ide:
+    build:
+      context: ..
+      dockerfile: ./gpu/Dockerfile
+    privileged: true   # Docker-in-Docker needs this
+    cgroup: host       # Allow setting resource constraints (e.g. memory, cpu) for containers
+    environment:
+    - RUST_BACKTRACE=1 # Display error trace on errors/panics
+    volumes:
+    - ${LOCAL_WORKSPACE_PATH}:${ENV_WORKSPACE_PATH} # source
+    - docker_data:/var/lib/docker                   # Docker image cache
+    - ${LOCAL_GIT_PATH}:${ENV_GIT_PATH}             # Base Git worktree history
+    deploy:
+      resources:
+        reservations:
+          devices:
+            - driver: nvidia
+              count: all
+              capabilities: [gpu]
+volumes:
+  docker_data:

.devcontainer/gpu/make_env_file.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+#
+# assumes git worktree was made using relative paths e.g.
+# git worktree add ../dir-name branch-name --relative-paths
+import sys
+from pathlib import Path
+from textwrap import dedent
+import subprocess
+from os.path import relpath
+
+
+def make_config(local_workspace_path: Path):
+    env_workspace_path = Path(f"/workspaces/{local_workspace_path.name}")
+    local_git_path = Path(
+        subprocess.run(
+            "git rev-parse --path-format=absolute --git-common-dir".split(" "),
+            capture_output=True,
+            text=True,
+        ).stdout.strip()
+    )
+    env_git_path = (
+        env_workspace_path / ".git"
+        if local_workspace_path / ".git" == local_git_path
+        else (
+            env_workspace_path
+            / relpath(local_git_path.parent, local_workspace_path)
+            / ".git"
+        ).resolve()
+    )
+
+    return dedent(
+        f"""
+        LOCAL_WORKSPACE_PATH={local_workspace_path}
+        ENV_WORKSPACE_PATH={env_workspace_path}
+        LOCAL_GIT_PATH={local_git_path}
+        ENV_GIT_PATH={env_git_path}
+        """
+    ).strip()
+
+
+if __name__ == "__main__":
+    local_workspace_path = Path(sys.argv[1])
+
+    with open(Path(__file__).absolute().parent / ".env", "w") as f:
+        f.write(make_config(local_workspace_path))