Function TestDevcontainerDiscovery

agent/agentcontainers/api_test.go:4365–4999

(t *testing.T)

}

func TestDevcontainerDiscovery(t *testing.T) {
	t.Parallel()

	if runtime.GOOS == "windows" {
		t.Skip("Dev Container tests are not supported on Windows")
	}

	// 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.

	homeDir, err := os.UserHomeDir()
	require.NoError(t, err)

	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,
				},
			},
		},