Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use correct ref and path for features when useBuildContexts is true #205

Merged
merged 2 commits into from
May 27, 2024
Merged

fix: use correct ref and path for features when useBuildContexts is true #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
741e7d4
fix: use correct ref and path for features when useBuildContexts is true
mafredri May 22, 2024
6d06a74
Merge branch 'main' into mafredri/fix-feature-use-build-contexts
mafredri May 27, 2024
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
2 changes: 1 addition & 1 deletion devcontainer/devcontainer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ func (s *Spec) compileFeatures(fs billy.Filesystem, devcontainerDir, scratchDir
if err != nil {
return "", nil, fmt.Errorf("extract feature %s: %w", featureRefRaw, err)
}
fromDirective, directive, err := spec.Compile(featureName, containerUser, remoteUser, useBuildContexts, featureOpts)
fromDirective, directive, err := spec.Compile(featureRef, featureName, featureDir, containerUser, remoteUser, useBuildContexts, featureOpts)
if err != nil {
return "", nil, fmt.Errorf("compile feature %s: %w", featureRefRaw, err)
}
Expand Down
15 changes: 4 additions & 11 deletions devcontainer/features/features.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,6 @@ func Extract(fs billy.Filesystem, devcontainerDir, directory, reference string)
return nil, errors.New(`devcontainer-feature.json: name is required`)
}

spec.Directory = directory
return spec, nil
}

Expand All @@ -188,13 +187,11 @@ type Spec struct {
Keywords []string `json:"keywords"`
Options map[string]Option `json:"options"`
ContainerEnv map[string]string `json:"containerEnv"`

Directory string `json:"-"`
}

// Extract unpacks the feature from the image and returns a set of lines
// that should be appended to a Dockerfile to install the feature.
func (s *Spec) Compile(featureName, containerUser, remoteUser string, useBuildContexts bool, options map[string]any) (string, string, error) {
func (s *Spec) Compile(featureRef, featureName, featureDir, containerUser, remoteUser string, useBuildContexts bool, options map[string]any) (string, string, error) {
// TODO not sure how we figure out _(REMOTE|CONTAINER)_USER_HOME
// as per the feature spec.
// See https://containers.dev/implementors/features/#user-env-var
Expand All @@ -221,8 +218,8 @@ func (s *Spec) Compile(featureName, containerUser, remoteUser string, useBuildCo
sort.Strings(runDirective)
// See https://containers.dev/implementors/features/#invoking-installsh
if useBuildContexts {
fromDirective = "FROM scratch AS envbuilder_feature_" + featureName + "\nCOPY --from=" + featureName + " / /\n"
runDirective = append([]string{"RUN", "--mount=type=bind,from=envbuilder_feature_" + featureName + ",target=/envbuilder-features/" + featureName + ",rw"}, runDirective...)
fromDirective = "FROM scratch AS envbuilder_feature_" + featureName + "\nCOPY --from=" + featureRef + " / /\n"
runDirective = append([]string{"RUN", "--mount=type=bind,from=envbuilder_feature_" + featureName + ",target=" + featureDir + ",rw"}, runDirective...)
} else {
runDirective = append([]string{"RUN"}, runDirective...)
}
Expand All @@ -242,11 +239,7 @@ func (s *Spec) Compile(featureName, containerUser, remoteUser string, useBuildCo
if comment != "" {
lines = append(lines, comment)
}
if useBuildContexts {
lines = append(lines, "WORKDIR /envbuilder-features/"+featureName)
} else {
lines = append(lines, "WORKDIR "+s.Directory)
}
lines = append(lines, "WORKDIR "+featureDir)
envKeys := make([]string, 0, len(s.ContainerEnv))
for key := range s.ContainerEnv {
envKeys = append(envKeys, key)
Expand Down
24 changes: 9 additions & 15 deletions devcontainer/features/features_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,54 +73,48 @@ func TestCompile(t *testing.T) {
t.Run("UnknownOption", func(t *testing.T) {
t.Parallel()
spec := &features.Spec{}
_, _, err := spec.Compile("test", "containerUser", "remoteUser", false, map[string]any{
_, _, err := spec.Compile("coder/test:latest", "test", "", "containerUser", "remoteUser", false, map[string]any{
"unknown": "value",
})
require.ErrorContains(t, err, "unknown option")
})
t.Run("Basic", func(t *testing.T) {
t.Parallel()
spec := &features.Spec{
Directory: "/",
}
_, directive, err := spec.Compile("test", "containerUser", "remoteUser", false, nil)
spec := &features.Spec{}
_, directive, err := spec.Compile("coder/test:latest", "test", "/", "containerUser", "remoteUser", false, nil)
require.NoError(t, err)
require.Equal(t, "WORKDIR /\nRUN _CONTAINER_USER=\"containerUser\" _REMOTE_USER=\"remoteUser\" ./install.sh", strings.TrimSpace(directive))
})
t.Run("ContainerEnv", func(t *testing.T) {
t.Parallel()
spec := &features.Spec{
Directory: "/",
ContainerEnv: map[string]string{
"FOO": "bar",
},
}
_, directive, err := spec.Compile("test", "containerUser", "remoteUser", false, nil)
_, directive, err := spec.Compile("coder/test:latest", "test", "/", "containerUser", "remoteUser", false, nil)
require.NoError(t, err)
require.Equal(t, "WORKDIR /\nENV FOO=bar\nRUN _CONTAINER_USER=\"containerUser\" _REMOTE_USER=\"remoteUser\" ./install.sh", strings.TrimSpace(directive))
})
t.Run("OptionsEnv", func(t *testing.T) {
t.Parallel()
spec := &features.Spec{
Directory: "/",
Options: map[string]features.Option{
"foo": {
Default: "bar",
},
},
}
_, directive, err := spec.Compile("test", "containerUser", "remoteUser", false, nil)
_, directive, err := spec.Compile("coder/test:latest", "test", "/", "containerUser", "remoteUser", false, nil)
require.NoError(t, err)
require.Equal(t, "WORKDIR /\nRUN FOO=\"bar\" _CONTAINER_USER=\"containerUser\" _REMOTE_USER=\"remoteUser\" ./install.sh", strings.TrimSpace(directive))
})
t.Run("BuildContext", func(t *testing.T) {
t.Parallel()
spec := &features.Spec{
Directory: "/",
}
fromDirective, runDirective, err := spec.Compile("test", "containerUser", "remoteUser", true, nil)
spec := &features.Spec{}
fromDirective, runDirective, err := spec.Compile("coder/test:latest", "test", "/.envbuilder/feature/test-d8e8fc", "containerUser", "remoteUser", true, nil)
require.NoError(t, err)
require.Equal(t, "FROM scratch AS envbuilder_feature_test\nCOPY --from=test / /", strings.TrimSpace(fromDirective))
require.Equal(t, "WORKDIR /envbuilder-features/test\nRUN --mount=type=bind,from=envbuilder_feature_test,target=/envbuilder-features/test,rw _CONTAINER_USER=\"containerUser\" _REMOTE_USER=\"remoteUser\" ./install.sh", strings.TrimSpace(runDirective))
require.Equal(t, "FROM scratch AS envbuilder_feature_test\nCOPY --from=coder/test:latest / /", strings.TrimSpace(fromDirective))
require.Equal(t, "WORKDIR /.envbuilder/feature/test-d8e8fc\nRUN --mount=type=bind,from=envbuilder_feature_test,target=/.envbuilder/feature/test-d8e8fc,rw _CONTAINER_USER=\"containerUser\" _REMOTE_USER=\"remoteUser\" ./install.sh", strings.TrimSpace(runDirective))
})
}