fix(agent/agentcontainers): generate devcontainer metadata from schema

johnstcn · johnstcn · commit 075d291d1255 · 2025-03-12T16:02:12.000Z
diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,6 @@
 # Generated files
 agent/agentcontainers/acmock/acmock.go linguist-generated=true
+agent/agentcontainers/dcspec/dcspec_gen.go linguist-generated=true
 coderd/apidoc/docs.go linguist-generated=true
 docs/reference/api/*.md linguist-generated=true
 docs/reference/cli/*.md linguist-generated=true
diff --git a/Makefile b/Makefile
@@ -634,6 +634,9 @@ coderd/database/pubsub/psmock/psmock.go: coderd/database/pubsub/pubsub.go
 agent/agentcontainers/acmock/acmock.go: agent/agentcontainers/containers.go
 	go generate ./agent/agentcontainers/acmock/
 
+agent/agentcontainers/dcspec/dcspec_gen.go:
+	go generate ./agent/agentcontainers/dcspec/
+
 $(TAILNETTEST_MOCKS): tailnet/coordinator.go tailnet/service.go
 	go generate ./tailnet/tailnettest/
 
diff --git a/agent/agentcontainers/containers_dockercli.go b/agent/agentcontainers/containers_dockercli.go
@@ -13,6 +13,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/coder/coder/v2/agent/agentcontainers/dcspec"
 	"github.com/coder/coder/v2/agent/agentexec"
 	"github.com/coder/coder/v2/agent/usershell"
 	"github.com/coder/coder/v2/codersdk"
@@ -183,7 +184,7 @@ func devcontainerEnv(ctx context.Context, execer agentexec.Execer, container str
 		return nil, nil
 	}
 
-	meta := make([]DevContainerMeta, 0)
+	meta := make([]dcspec.DevContainer, 0)
 	if err := json.Unmarshal([]byte(rawMeta), &meta); err != nil {
 		return nil, xerrors.Errorf("unmarshal devcontainer.metadata: %w", err)
 	}
@@ -192,7 +193,10 @@ func devcontainerEnv(ctx context.Context, execer agentexec.Execer, container str
 	env := make([]string, 0)
 	for _, m := range meta {
 		for k, v := range m.RemoteEnv {
-			env = append(env, fmt.Sprintf("%s=%s", k, v))
+			if v == nil { // *string per spec
+				continue
+			}
+			env = append(env, fmt.Sprintf("%s=%s", k, *v))
 		}
 	}
 	slices.Sort(env)
@@ -276,7 +280,7 @@ func (dcl *DockerCLILister) List(ctx context.Context) (codersdk.WorkspaceAgentLi
 	// log this error, but I'm not sure it's worth it.
 	ins, dockerInspectStderr, err := runDockerInspect(ctx, dcl.execer, ids...)
 	if err != nil {
-		return codersdk.WorkspaceAgentListContainersResponse{}, xerrors.Errorf("run docker inspect: %w", err)
+		return codersdk.WorkspaceAgentListContainersResponse{}, xerrors.Errorf("run docker inspect: %w: %s", err, dockerInspectStderr)
 	}
 
 	for _, in := range ins {
diff --git a/agent/agentcontainers/containers_internal_test.go b/agent/agentcontainers/containers_internal_test.go
@@ -34,8 +34,9 @@ import (
 // It can be run manually as follows:
 //
 // CODER_TEST_USE_DOCKER=1 go test ./agent/agentcontainers -run TestDockerCLIContainerLister
+//
+//nolint:paralleltest // This test tends to flake when lots of containers start and stop in parallel.
 func TestIntegrationDocker(t *testing.T) {
-	t.Parallel()
 	if ctud, ok := os.LookupEnv("CODER_TEST_USE_DOCKER"); !ok || ctud != "1" {
 		t.Skip("Set CODER_TEST_USE_DOCKER=1 to run this test")
 	}
@@ -418,8 +419,9 @@ func TestConvertDockerVolume(t *testing.T) {
 // It can be run manually as follows:
 //
 // CODER_TEST_USE_DOCKER=1 go test ./agent/agentcontainers -run TestDockerEnvInfoer
+//
+//nolint:paralleltest // This test tends to flake when lots of containers start and stop in parallel.
 func TestDockerEnvInfoer(t *testing.T) {
-	t.Parallel()
 	if ctud, ok := os.LookupEnv("CODER_TEST_USE_DOCKER"); !ok || ctud != "1" {
 		t.Skip("Set CODER_TEST_USE_DOCKER=1 to run this test")
 	}
@@ -483,9 +485,8 @@ func TestDockerEnvInfoer(t *testing.T) {
 			expectedUserShell: "/bin/bash",
 		},
 	} {
+		//nolint:paralleltest // variable recapture no longer required
 		t.Run(fmt.Sprintf("#%d", idx), func(t *testing.T) {
-			t.Parallel()
-
 			// Start a container with the given image
 			// and environment variables
 			image := strings.Split(tt.image, ":")[0]
diff --git a/agent/agentcontainers/dcspec/dcspec_gen.go b/agent/agentcontainers/dcspec/dcspec_gen.go
diff --git a/agent/agentcontainers/dcspec/doc.go b/agent/agentcontainers/dcspec/doc.go
@@ -0,0 +1,3 @@
+package dcspec
+
+//go:generate ./gen.sh
diff --git a/agent/agentcontainers/dcspec/gen.sh b/agent/agentcontainers/dcspec/gen.sh
@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# This script requires quicktype to be installed.
+if ! command -v quicktype &>/dev/null; then
+	echo "quicktype could not be found. Please install it to use this script:"
+	echo ">>> npm install -g quicktype"
+	exit 1
+fi
+
+DEST_FILENAME="dcspec_gen.go"
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+DEST_PATH="${SCRIPT_DIR}/${DEST_FILENAME}"
+SCHEMA_SRC="https://raw.githubusercontent.com/devcontainers/spec/refs/heads/main/schemas/devContainer.base.schema.json"
+
+# Location of the JSON schema for the devcontainer specification.
+TMPDIR=$(mktemp -d)
+trap 'rm -rfv "$TMPDIR"' EXIT
+curl --fail --silent --show-error --location --output "${TMPDIR}/schema.json" "${SCHEMA_SRC}"
+rm -f "${DEST_PATH}"
+quicktype \
+	--src-lang schema \
+	--lang go \
+	--just-types-and-package \
+	--top-level "DevContainer" \
+	--out "${DEST_PATH}" \
+	--package "dcspec" \
+	"${TMPDIR}/schema.json"
+
+# Add a header so that Go recognizes this as a generated file.
+sed -i '1s/^/\/\/ Code generated by quicktype. DO NOT EDIT.\n/' "${DEST_PATH}"
diff --git a/agent/agentcontainers/devcontainer_meta.go b/agent/agentcontainers/devcontainer_meta.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package dcspec`
	`2`	`+`
	`3`	`+//go:generate ./gen.sh`