chore: add tests and fix bug

DanielleMaywood · DanielleMaywood · commit c3620e2fe3d9 · 2025-07-21T15:08:38.000Z
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -444,12 +444,25 @@ func (api *API) discoverDevcontainerProjects() error {
 }
 
 func (api *API) discoverDevcontainersInProject(projectPath string) error {
+	devcontainerConfigPaths := []string{
+		"/.devcontainer/devcontainer.json",
+		"/.devcontainer.json",
+	}
+
 	return afero.Walk(api.fs, projectPath, func(path string, info fs.FileInfo, err error) error {
-		if strings.HasSuffix(path, ".devcontainer/devcontainer.json") {
-			workspaceFolder := strings.TrimSuffix(path, ".devcontainer/devcontainer.json")
+		for _, relativeConfigPath := range devcontainerConfigPaths {
+			if !strings.HasSuffix(path, relativeConfigPath) {
+				continue
+			}
+
+			workspaceFolder := strings.TrimSuffix(path, relativeConfigPath)
+
+			api.logger.Debug(api.ctx, "discovered dev container project", slog.F("workspace_folder", workspaceFolder))
 
 			api.mu.Lock()
 			if _, found := api.knownDevcontainers[workspaceFolder]; !found {
+				api.logger.Debug(api.ctx, "adding dev container project", slog.F("workspace_folder", workspaceFolder))
+
 				dc := codersdk.WorkspaceAgentDevcontainer{
 					ID:              uuid.New(),
 					Name:            "", // Updated later based on container state.
diff --git a/agent/agentcontainers/api_test.go b/agent/agentcontainers/api_test.go
@@ -20,6 +20,7 @@ import (
 	"github.com/go-chi/chi/v5"
 	"github.com/google/uuid"
 	"github.com/lib/pq"
+	"github.com/spf13/afero"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/mock/gomock"
@@ -3189,3 +3190,234 @@ func TestWithDevcontainersNameGeneration(t *testing.T) {
 	assert.Equal(t, "bar-project", response.Devcontainers[0].Name, "second devcontainer should has a collision and uses the folder name with a prefix")
 	assert.Equal(t, "baz-project", response.Devcontainers[1].Name, "third devcontainer should use the folder name with a prefix since it collides with the first two")
 }
+
+func TestDevcontainerDiscovery(t *testing.T) {
+	t.Parallel()
+
+	// We discover dev container projects by searching
+	// for git repositories at the agent's directory,
+	// and then recursively walking through these git
+	// repositories to find any `.devcontainer/devcontainer.json`
+	// files. These tests are to validate that behavior.
+
+	tests := []struct {
+		name     string
+		agentDir string
+		fs       map[string]string
+		expected []codersdk.WorkspaceAgentDevcontainer
+	}{
+		{
+			name:     "GitProjectInRootDir/SingleProject",
+			agentDir: "/home/coder",
+			fs: map[string]string{
+				"/home/coder/.git/HEAD":                       "",
+				"/home/coder/.devcontainer/devcontainer.json": "",
+			},
+			expected: []codersdk.WorkspaceAgentDevcontainer{
+				{
+					WorkspaceFolder: "/home/coder",
+					ConfigPath:      "/home/coder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+			},
+		},
+		{
+			name:     "GitProjectInRootDir/MultipleProjects",
+			agentDir: "/home/coder",
+			fs: map[string]string{
+				"/home/coder/.git/HEAD":                            "",
+				"/home/coder/.devcontainer/devcontainer.json":      "",
+				"/home/coder/site/.devcontainer/devcontainer.json": "",
+			},
+			expected: []codersdk.WorkspaceAgentDevcontainer{
+				{
+					WorkspaceFolder: "/home/coder",
+					ConfigPath:      "/home/coder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+				{
+					WorkspaceFolder: "/home/coder/site",
+					ConfigPath:      "/home/coder/site/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+			},
+		},
+		{
+			name:     "GitProjectInChildDir/SingleProject",
+			agentDir: "/home/coder",
+			fs: map[string]string{
+				"/home/coder/coder/.git/HEAD":                       "",
+				"/home/coder/coder/.devcontainer/devcontainer.json": "",
+			},
+			expected: []codersdk.WorkspaceAgentDevcontainer{
+				{
+					WorkspaceFolder: "/home/coder/coder",
+					ConfigPath:      "/home/coder/coder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+			},
+		},
+		{
+			name:     "GitProjectInChildDir/MultipleProjects",
+			agentDir: "/home/coder",
+			fs: map[string]string{
+				"/home/coder/coder/.git/HEAD":                            "",
+				"/home/coder/coder/.devcontainer/devcontainer.json":      "",
+				"/home/coder/coder/site/.devcontainer/devcontainer.json": "",
+			},
+			expected: []codersdk.WorkspaceAgentDevcontainer{
+				{
+					WorkspaceFolder: "/home/coder/coder",
+					ConfigPath:      "/home/coder/coder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+				{
+					WorkspaceFolder: "/home/coder/coder/site",
+					ConfigPath:      "/home/coder/coder/site/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+			},
+		},
+		{
+			name:     "GitProjectInMultipleChildDirs/SingleProjectEach",
+			agentDir: "/home/coder",
+			fs: map[string]string{
+				"/home/coder/coder/.git/HEAD":                            "",
+				"/home/coder/coder/.devcontainer/devcontainer.json":      "",
+				"/home/coder/envbuilder/.git/HEAD":                       "",
+				"/home/coder/envbuilder/.devcontainer/devcontainer.json": "",
+			},
+			expected: []codersdk.WorkspaceAgentDevcontainer{
+				{
+					WorkspaceFolder: "/home/coder/coder",
+					ConfigPath:      "/home/coder/coder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+				{
+					WorkspaceFolder: "/home/coder/envbuilder",
+					ConfigPath:      "/home/coder/envbuilder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+			},
+		},
+		{
+			name:     "GitProjectInMultipleChildDirs/MultipleProjectEach",
+			agentDir: "/home/coder",
+			fs: map[string]string{
+				"/home/coder/coder/.git/HEAD":                              "",
+				"/home/coder/coder/.devcontainer/devcontainer.json":        "",
+				"/home/coder/coder/site/.devcontainer/devcontainer.json":   "",
+				"/home/coder/envbuilder/.git/HEAD":                         "",
+				"/home/coder/envbuilder/.devcontainer/devcontainer.json":   "",
+				"/home/coder/envbuilder/x/.devcontainer/devcontainer.json": "",
+			},
+			expected: []codersdk.WorkspaceAgentDevcontainer{
+				{
+					WorkspaceFolder: "/home/coder/coder",
+					ConfigPath:      "/home/coder/coder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+				{
+					WorkspaceFolder: "/home/coder/coder/site",
+					ConfigPath:      "/home/coder/coder/site/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+				{
+					WorkspaceFolder: "/home/coder/envbuilder",
+					ConfigPath:      "/home/coder/envbuilder/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+				{
+					WorkspaceFolder: "/home/coder/envbuilder/x",
+					ConfigPath:      "/home/coder/envbuilder/x/.devcontainer/devcontainer.json",
+					Status:          codersdk.WorkspaceAgentDevcontainerStatusStopped,
+				},
+			},
+		},
+	}
+
+	initFS := func(t *testing.T, files map[string]string) afero.Fs {
+		t.Helper()
+
+		fs := afero.NewMemMapFs()
+		for name, content := range files {
+			err := afero.WriteFile(fs, name, []byte(content+"\n"), 0o600)
+			require.NoError(t, err)
+		}
+		return fs
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			var (
+				ctx        = testutil.Context(t, testutil.WaitShort)
+				logger     = testutil.Logger(t)
+				mClock     = quartz.NewMock(t)
+				tickerTrap = mClock.Trap().TickerFunc("updaterLoop")
+
+				r = chi.NewRouter()
+			)
+
+			api := agentcontainers.NewAPI(logger,
+				agentcontainers.WithClock(mClock),
+				agentcontainers.WithWatcher(watcher.NewNoop()),
+				agentcontainers.WithFileSystem(initFS(t, tt.fs)),
+				agentcontainers.WithManifestInfo("owner", "workspace", "parent-agent", tt.agentDir),
+				agentcontainers.WithContainerCLI(&fakeContainerCLI{}),
+				agentcontainers.WithDevcontainerCLI(&fakeDevcontainerCLI{}),
+			)
+			api.Start()
+			defer api.Close()
+			r.Mount("/", api.Routes())
+
+			tickerTrap.MustWait(ctx).MustRelease(ctx)
+			tickerTrap.Close()
+
+			// Wait until all projects have been discovered
+			require.Eventuallyf(t, func() bool {
+				req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
+				rec := httptest.NewRecorder()
+				r.ServeHTTP(rec, req)
+
+				got := codersdk.WorkspaceAgentListContainersResponse{}
+				err := json.NewDecoder(rec.Body).Decode(&got)
+				require.NoError(t, err)
+
+				return len(got.Devcontainers) == len(tt.expected)
+			}, testutil.WaitShort, testutil.IntervalFast, "dev containers never found")
+
+			// Now projects have been discovered, we'll allow the updater loop
+			// to set the appropriate status for these containers.
+			_, aw := mClock.AdvanceNext()
+			aw.MustWait(ctx)
+
+			// Now we'll fetch the list of dev containers
+			req := httptest.NewRequest(http.MethodGet, "/", nil).WithContext(ctx)
+			rec := httptest.NewRecorder()
+			r.ServeHTTP(rec, req)
+
+			got := codersdk.WorkspaceAgentListContainersResponse{}
+			err := json.NewDecoder(rec.Body).Decode(&got)
+			require.NoError(t, err)
+
+			// We will set the IDs of each dev container to uuid.Nil to simplify
+			// this check.
+			for idx := range got.Devcontainers {
+				got.Devcontainers[idx].ID = uuid.Nil
+			}
+
+			// Sort the expected dev containers and got dev containers by their workspace folder.
+			// This helps ensure a deterministic test.
+			slices.SortFunc(tt.expected, func(a, b codersdk.WorkspaceAgentDevcontainer) int {
+				return strings.Compare(a.WorkspaceFolder, b.WorkspaceFolder)
+			})
+			slices.SortFunc(got.Devcontainers, func(a, b codersdk.WorkspaceAgentDevcontainer) int {
+				return strings.Compare(a.WorkspaceFolder, b.WorkspaceFolder)
+			})
+
+			require.Equal(t, tt.expected, got.Devcontainers)
+		})
+	}
+}
diff --git a/site/src/modules/resources/AgentDevcontainerCard.stories.tsx b/site/src/modules/resources/AgentDevcontainerCard.stories.tsx
@@ -91,6 +91,17 @@ export const Recreating: Story = {
 	},
 };
 
+export const NoContainerOrSubAgent: Story = {
+	args: {
+		devcontainer: {
+			...MockWorkspaceAgentDevcontainer,
+			container: undefined,
+			agent: undefined,
+		},
+		subAgents: [],
+	},
+};
+
 export const NoSubAgent: Story = {
 	args: {
 		devcontainer: {
diff --git a/site/src/modules/resources/AgentRow.tsx b/site/src/modules/resources/AgentRow.tsx
@@ -137,7 +137,16 @@ export const AgentRow: FC<AgentRowProps> = ({
 	const [showParentApps, setShowParentApps] = useState(false);
 
 	let shouldDisplayAppsSection = shouldDisplayAgentApps;
-	if (devcontainers && devcontainers.length > 0 && !showParentApps) {
+	if (
+		devcontainers &&
+		devcontainers.find(
+			// We only want to hide the parent apps by default when there are dev
+			// containers that are either starting or running. If they are all in
+			// the stopped state, it doesn't make sense to hide the parent apps.
+			(dc) => dc.status === "running" || dc.status === "starting",
+		) !== undefined &&
+		!showParentApps
+	) {
 		shouldDisplayAppsSection = false;
 	}
 
