Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions e2e/tests/up-docker-compose/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,85 @@ var _ = ginkgo.Describe(
framework.ExpectNoError(err)
}, ginkgo.SpecTimeout(framework.TimeoutLong()))

ginkgo.It(
"legacy devcontainer selection drift warns and supports explicit adoption",
func(ctx context.Context) {
tempDir, err := setupWorkspace(
"tests/up-docker-compose/testdata/devcontainer-selection-drift",
tc.initialDir,
tc.f,
)
framework.ExpectNoError(err)

err = tc.f.DevsyUp(ctx, tempDir)
framework.ExpectNoError(err)

workspace, err := tc.f.FindWorkspace(ctx, tempDir)
framework.ExpectNoError(err)
err = tc.f.DevsyWorkspaceStop(ctx, tempDir)
framework.ExpectNoError(err)

rootConfig := filepath.Join(tempDir, ".devcontainer", "devcontainer.json")
err = os.WriteFile(rootConfig, []byte(`{
"name": "root",
"image": "ghcr.io/devsy-org/test-images/go:1",
"containerEnv": {"SELECTION_MARKER": "root"}
}`), 0o600)
framework.ExpectNoError(err)

stdout, _, err := tc.f.ExecCommandCapture(ctx, []string{
cmdWorkspace, "up", flagDebug, flagIDE, ideNone, tempDir,
})
framework.ExpectNoError(err)
gomega.Expect(stdout).To(
gomega.ContainSubstring(
`"warnings":["This existing workspace is continuing to use \".devcontainer/legacy/devcontainer.json\"`,
),
)
gomega.Expect(stdout).To(
gomega.ContainSubstring(
`Current project discovery would select \".devcontainer/devcontainer.json\"`,
),
)

assertSelectionMarker := func(want string) {
err := tc.f.ExecCommand(
ctx,
true,
true,
"["+want+"]",
[]string{
cmdWorkspace, cmdSSH, flagCommand,
"echo \"[$SELECTION_MARKER]\"", workspace.ID,
},
)
framework.ExpectNoError(err)
}
assertSelectionMarker("legacy")

err = tc.f.DevsyWorkspaceStop(ctx, tempDir)
framework.ExpectNoError(err)
err = tc.f.DevsyUpRecreate(
ctx,
names.Flag(names.DevContainer),
".devcontainer/devcontainer.json",
tempDir,
)
framework.ExpectNoError(err)
assertSelectionMarker("root")

err = tc.f.DevsyWorkspaceStop(ctx, tempDir)
framework.ExpectNoError(err)
err = tc.f.DevsyUp(ctx, tempDir)
framework.ExpectNoError(err)
assertSelectionMarker("root")

err = tc.f.DevsyWorkspaceDelete(ctx, tempDir)
framework.ExpectNoError(err)
},
ginkgo.SpecTimeout(framework.TimeoutLong()),
)

ginkgo.It("environment variables", func(ctx context.Context) {
_, workspace, err := tc.setupAndStartWorkspace(
ctx,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "legacy",
"image": "ghcr.io/devsy-org/test-images/go:1",
"containerEnv": {
"SELECTION_MARKER": "legacy"
}
}
36 changes: 29 additions & 7 deletions pkg/devcontainer/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,18 @@ type devContainerSelection struct {
source string
path string
id string
origin devContainerSelectionOrigin
}

type devContainerSelectionOrigin uint8

const (
selectionNone devContainerSelectionOrigin = iota
selectionCLI
selectionPersistedWorkspace
selectionLastResolvedCompatibility
)

// effectiveDevContainerSelection returns the one effective selector for this
// operation. Current CLI input wins over persisted workspace state, followed
// by the last resolved path for compatibility with older workspaces.
Expand Down Expand Up @@ -113,7 +123,10 @@ func (r *runner) lastConfigPathSelection() (devContainerSelection, bool) {
if !devContainerConfigExists(r.workspaceFolder(), relativePath) {
return devContainerSelection{}, false
}
return devContainerSelection{path: relativePath}, true
return devContainerSelection{
path: relativePath,
origin: selectionLastResolvedCompatibility,
}, true
}

func devContainerConfigExists(workspaceFolder, relativePath string) bool {
Expand All @@ -129,14 +142,23 @@ func (r *runner) persistedDevContainerSelection() (devContainerSelection, bool)
workspace := r.workspaceConfig.Workspace
switch {
case workspace.DevContainerSource != "":
return devContainerSelection{source: workspace.DevContainerSource}, true
return devContainerSelection{
source: workspace.DevContainerSource,
origin: selectionPersistedWorkspace,
}, true
case workspace.DevContainerConfig != nil:
// Preserve pre-persistence precedence for embedded configs.
return devContainerSelection{}, false
case workspace.DevContainerPath != "":
return devContainerSelection{path: workspace.DevContainerPath}, true
return devContainerSelection{
path: workspace.DevContainerPath,
origin: selectionPersistedWorkspace,
}, true
case workspace.DevContainerID != "":
return devContainerSelection{id: workspace.DevContainerID}, true
return devContainerSelection{
id: workspace.DevContainerID,
origin: selectionPersistedWorkspace,
}, true
default:
return devContainerSelection{}, false
}
Expand Down Expand Up @@ -182,11 +204,11 @@ func (r *runner) workspaceFolder() string {
func newDevContainerSelection(source, path, id string) (devContainerSelection, bool) {
switch {
case source != "":
return devContainerSelection{source: source}, true
return devContainerSelection{source: source, origin: selectionCLI}, true
case path != "":
return devContainerSelection{path: path}, true
return devContainerSelection{path: path, origin: selectionCLI}, true
case id != "":
return devContainerSelection{id: id}, true
return devContainerSelection{id: id, origin: selectionCLI}, true
default:
return devContainerSelection{}, false
}
Expand Down
6 changes: 6 additions & 0 deletions pkg/devcontainer/config/discover.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ const devcontainerDirName = ".devcontainer"
// contains more than one configuration (or when selection is forced).
type ConfigSelector func(candidates []string) (string, error)

// DiscoverDevContainerPath returns the config a new workspace would select.
// It returns an empty path when no config exists.
func DiscoverDevContainerPath(folder string) (string, error) {
return resolveDevContainerPath(folder, "", SelectSingle(folder), false)
}

// SelectByID returns a selector that picks the config whose parent directory
// name matches id (the devcontainer id, e.g. ".devcontainer/<id>/devcontainer.json").
func SelectByID(id string) ConfigSelector {
Expand Down
83 changes: 83 additions & 0 deletions pkg/devcontainer/config/discover_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
package config

import (
"os"
"path/filepath"
"strings"
"testing"
)

const rootConfigFilePath = ".devcontainer.json"

func TestDiscoverDevContainerPathDirectoryRootPrecedence(t *testing.T) {
folder := t.TempDir()
seedDiscoveryConfigs(
t,
folder,
".devcontainer/devcontainer.json",
rootConfigFilePath,
".devcontainer/profile/devcontainer.json",
)
assertDiscoveredPath(t, folder, ".devcontainer/devcontainer.json")
}

func TestDiscoverDevContainerPathRootFilePrecedence(t *testing.T) {
folder := t.TempDir()
seedDiscoveryConfigs(t, folder, rootConfigFilePath, ".devcontainer/profile/devcontainer.json")
assertDiscoveredPath(t, folder, rootConfigFilePath)
}

func TestDiscoverDevContainerPathSingleNested(t *testing.T) {
folder := t.TempDir()
seedDiscoveryConfigs(t, folder, ".devcontainer/profile/devcontainer.json")
assertDiscoveredPath(t, folder, ".devcontainer/profile/devcontainer.json")
}

func TestDiscoverDevContainerPathAmbiguousNested(t *testing.T) {
folder := t.TempDir()
seedDiscoveryConfigs(
t,
folder,
".devcontainer/one/devcontainer.json",
".devcontainer/two/devcontainer.json",
)
path, err := DiscoverDevContainerPath(folder)
if err == nil || !strings.Contains(err.Error(), "multiple devcontainer configurations found") {
t.Fatalf("DiscoverDevContainerPath() = %q, %v, want ambiguity error", path, err)
}
}

func TestDiscoverDevContainerPathNoConfig(t *testing.T) {
assertDiscoveredPath(t, t.TempDir(), "")
}

func seedDiscoveryConfigs(t *testing.T, folder string, paths ...string) {
t.Helper()
for _, relativePath := range paths {
file := filepath.Join(folder, filepath.FromSlash(relativePath))
if err := os.MkdirAll(filepath.Dir(file), 0o750); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(file, []byte(`{"image":"test"}`), 0o600); err != nil {
t.Fatal(err)
}
}
}

func assertDiscoveredPath(t *testing.T, folder, want string) {
t.Helper()
got, err := DiscoverDevContainerPath(folder)
if err != nil {
t.Fatalf("DiscoverDevContainerPath(): %v", err)
}
if want == "" {
if got != "" {
t.Fatalf("DiscoverDevContainerPath() = %q, want empty", got)
}
return
}
wantPath := filepath.Join(folder, filepath.FromSlash(want))
if got != wantPath {
t.Fatalf("DiscoverDevContainerPath() = %q, want %q", got, wantPath)
}
}
79 changes: 79 additions & 0 deletions pkg/devcontainer/config_selection.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
package devcontainer

import (
"fmt"
"path/filepath"

"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/log"
)

type devContainerSelectionDrift struct {
pinnedPath string
discoveredPath string
}

func (r *runner) compatibilitySelectionWarning(
selection devContainerSelection,
) string {
drift, err := r.compatibilitySelectionDrift(selection)
if err != nil {
log.Debugf("could not check devcontainer selection drift: %v", err)
return ""
}
if drift == nil {
return ""
}

return fmt.Sprintf(
"This existing workspace is continuing to use %q, its previously resolved devcontainer configuration. "+
"Current project discovery would select %q. Devsy does not switch an existing workspace implicitly; "+
"run workspace up --recreate --devcontainer %q to adopt it explicitly.",
drift.pinnedPath,
drift.discoveredPath,
drift.discoveredPath,
)
}

func (r *runner) compatibilitySelectionDrift(
selection devContainerSelection,
) (*devContainerSelectionDrift, error) {
if selection.origin != selectionLastResolvedCompatibility || selection.path == "" {
return nil, nil
}

folder := r.workspaceFolder()
discoveredPath, err := config.DiscoverDevContainerPath(folder)
if err != nil || discoveredPath == "" {
return nil, err
}

pinnedPath, err := workspaceRelativePath(folder, selection.path)
if err != nil {
return nil, err
}
discoveredRelativePath, err := workspaceRelativePath(folder, discoveredPath)
if err != nil {
return nil, err
}
if pinnedPath == discoveredRelativePath {
return nil, nil
}

return &devContainerSelectionDrift{
pinnedPath: pinnedPath,
discoveredPath: discoveredRelativePath,
}, nil
}

func workspaceRelativePath(folder, value string) (string, error) {
path := filepath.FromSlash(value)
if !filepath.IsAbs(path) {
path = filepath.Join(folder, path)
}
relativePath, err := filepath.Rel(folder, path)
if err != nil {
return "", err
}
return filepath.ToSlash(filepath.Clean(relativePath)), nil
}
Loading
Loading