devcontainer improvements (#260)

- use initializeComment to make sure environment files and maven cache
  bind mounts are present
- support building docker containers inside devcontainer

Author: bpkroth

.devcontainer/devcontainer.json

@@ -1,45 +1,56 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
-// https://github.com/microsoft/vscode-dev-containers/tree/v0.231.6/containers/docker-existing-dockerfile
+// For format details, see https://aka.ms/devcontainer.json.
 {
     "name": "Workspace Dockerfile",
-
     // We have no context for the devcontainer.
     "context": ".",
-
     // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
     "dockerFile": "../docker/benchbase/devcontainer/Dockerfile",
     "build": {
         "args": {
+            "http_proxy": "${localEnv:http_proxy}",
+            "https_proxy": "${localEnv:https_proxy}",
+            "no_proxy": "${localEnv:no_proxy}",
             "--tag": "benchbase-dev:latest"
         },
         "cacheFrom": "benchbase.azurecr.io/benchbase-dev"
     },
-
-    // Set *default* container specific settings.json values on container create.
-    "settings": {},
-
-    // Add the IDs of extensions you want installed when the container is created.
-    "extensions": [
-        "vscjava.vscode-java-pack",
-        "EditorConfig.EditorConfig"
+    "initializeCommand": [
+        ".devcontainer/scripts/initializeCommand"
+    ],
+    "runArgs": [
+        // Secret injection as environment variables
+        // https://code.visualstudio.com/remote/advancedcontainers/environment-variables#_option-2-use-an-env-file
+        "--env-file=.env"
     ],
-
+    "features": {
+        "ghcr.io/devcontainers/features/docker-outside-of-docker": {},
+        "ghcr.io/stuartleeks/dev-container-features/shell-history": {}
+    },
+    "containerEnv": {
+        "http_proxy": "${localEnv:http_proxy}",
+        "https_proxy": "${localEnv:https_proxy}",
+        "no_proxy": "${localEnv:no_proxy}",
+        "MAVEN_CONFIG": "${localEnv:HOME}/.m2",
+        "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}",
+        "CONTAINER_WORKSPACE_FOLDER": "${containerWorkspaceFolder}",
+    },
+    // Set *default* container specific settings.json values on container create.
+    "customizations": {
+        "vscode": {
+            "settings": {},
+            // Add the IDs of extensions you want installed when the container is created.
+            "extensions": [
+                "vscjava.vscode-java-pack",
+                "EditorConfig.EditorConfig"
+            ]
+        }
+    },
     // Use 'forwardPorts' to make a list of ports inside the container available locally.
     // "forwardPorts": [],
-
-    // Uncomment the next line to run commands after the container is created - for example installing curl.
-    // "postCreateCommand": "apt-get update && apt-get install -y curl",
-
-    // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
-    // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
-
-    // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
-    // "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ],
     // Use the local maven cache.
     "mounts": [
         "source=${localEnv:HOME}${localEnv:USERPROFILE}/.m2,target=/home/containeruser/.m2,type=bind,consistency=cached"
     ],
-
-    // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
-    "remoteUser": "containeruser"
-}
+    "remoteUser": "containeruser",
+    "containerUser": "containeruser"
+}

.devcontainer/scripts/.gitattributes

@@ -0,0 +1,3 @@
+initializeCommand text eol=lf
+initializeCommand.cmd text eol=crlf
+initializeCommand.ps1 text eol=crlf

.devcontainer/scripts/initializeCommand

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+set -eu
+
+set -x
+
+scriptdir=$(dirname "$(readlink -f "$0")")
+# Start in the root of the repository.
+cd "$scriptdir/../../"
+
+# Make sure the .env file exists for the devcontainer to load.
+if [ ! -f .env ]; then
+    echo "Creating empty .env file for devcontainer."
+    touch .env
+fi
+# Attempt to pre-create the maven cache directory for bind mounting into the devcontainer.
+mkdir -p ~/.m2 || true

.devcontainer/scripts/initializeCommand.cmd

@@ -0,0 +1,2 @@
+cd %~dp0/../../
+powershell.exe -Version 3.0 -NoProfile .devcontainer/scripts/initializeCommand.ps1

.devcontainer/scripts/initializeCommand.ps1

@@ -0,0 +1,16 @@
+# Requires -Version 3.0
+# A script to prepare the build/run environment for the devcontainer.
+
+$ErrorActionPreference = 'Stop'
+
+# Make sure we're in the root of the repository.
+Set-Location "$PSScriptRoot/../../"
+
+# Make sure the .env file exists for the devcontainer to load.
+if (!(Test-Path -PathType Leaf '.env')) {
+    Write-Host "Creating empty .env file for devcontainer."
+    New-Item -ErrorAction SilentlyContinue -Type File -Name '.env'
+}
+
+# Attempt to pre-create the maven cache directory for bind mounting into the devcontainer.
+New-Item -ErrorAction SilentlyContinue -Type Directory -Name ~/.m2

.gitignore

@@ -54,3 +54,5 @@ build/
 
 # vim swap files
 .*.swp
+
+.env

docker/benchbase/devcontainer/Dockerfile

@@ -5,15 +5,20 @@ FROM maven:3.8.5-eclipse-temurin-17 AS devcontainer
 LABEL org.opencontainers.image.source = "https://github.com/cmu-db/benchbase/"
 
 # Make sure the image is patched and up to date.
-RUN apt update && apt -y upgrade && apt clean && rm -rf /var/lib/apt/lists/*
+# Also add a few nice cli tools.
+RUN apt-get update \
+    && apt-get -y upgrade \
+    && apt-get -y install --no-install-recommends sudo vim-nox neovim less bash-completion colordiff git \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
 
 # Add a containeruser that allows vscode/codespaces to map the local host user
 # (often uid 1000) to some non-root user inside the container.
 ARG CONTAINERUSER_UID=1000
 ARG CONTAINERUSER_GID=1000
 RUN groupadd --non-unique --gid ${CONTAINERUSER_GID} containergroup \
     && useradd --non-unique --create-home --no-user-group --comment 'Container User' \
-        --uid ${CONTAINERUSER_UID} --gid ${CONTAINERUSER_GID} containeruser
+        --uid ${CONTAINERUSER_UID} --gid ${CONTAINERUSER_GID} containeruser \
+    && echo 'containeruser ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
 RUN mkdir -p /benchbase/results && chown -R containeruser:containergroup /benchbase/
 USER containeruser
 ENV MAVEN_CONFIG=/home/containeruser/.m2

docker/benchbase/run-dev-image.sh

@@ -27,8 +27,9 @@ fi
 
 cd "$rootdir"
 MAVEN_CONFIG="${MAVEN_CONFIG:-$HOME/.m2}"
-mkdir -p "$MAVEN_CONFIG"
+mkdir -p "$MAVEN_CONFIG" || true
 set -x
+SRC_DIR="${LOCAL_WORKSPACE_FOLDER:-$PWD}"
 docker run ${INTERACTIVE_ARGS:-} --rm \
     --env=http_proxy="${http_proxy:-}" --env=https_proxy="${https_proxy:-}" --env=no_proxy="${no_proxy:-}" \
     --env MAVEN_OPTS="-Dhttp.proxyHost=${http_proxy_host} -Dhttp.proxyPort=${http_proxy_port} -Dhttps.proxyHost=${https_proxy_host} -Dhttps.proxyPort=${https_proxy_port}" \
@@ -37,5 +38,5 @@ docker run ${INTERACTIVE_ARGS:-} --rm \
     --env SKIP_TESTS="$SKIP_TESTS" \
     --user "$CONTAINERUSER_UID:$CONTAINERUSER_GID" \
     -v "$MAVEN_CONFIG:/home/containeruser/.m2" \
-    -v "$PWD:/benchbase" benchbase-dev:latest $*
+    -v "$SRC_DIR:/benchbase" benchbase-dev:latest $*
 set +x