Skip to content
2 changes: 2 additions & 0 deletions pkg/devcontainer/capabilities_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@ func TestImageRunValidationPreservesContainerBeforeRecreate(t *testing.T) {
r.workspaceConfig.Workspace = &provider.Workspace{ID: r.id, UID: workspaceUid}
r.imageBackend = &separateImages{details: &config.ImageDetails{ID: imageValue}}
r.reporter = status.Nop()
r.localWorkspaceFolder = t.TempDir()
p := recreateResolveParams()
p.parsedConfig.Config.Image = alpine
p.parsedConfig.Raw = config.CloneDevContainerConfig(p.parsedConfig.Config)
Expand All @@ -283,6 +284,7 @@ func TestImageRunValidationPreservesContainerBeforeRecreate(t *testing.T) {
}
require.NotNil(t, d.validationParams)
require.Equal(t, r.id, d.validationParams.WorkspaceID)
require.Equal(t, r.localWorkspaceFolder, d.validationParams.LocalWorkspaceFolder)
require.NotEmpty(t, d.validationParams.Options.Image)
assert.Equal(t, !reject, d.stopCalled)
assert.False(t, d.deleteCalled)
Expand Down
5 changes: 4 additions & 1 deletion pkg/devcontainer/single.go
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,10 @@ func (r *runner) validateImageRun(
}
return validator.ValidateRunImageDevContainer(
&driver.RunImageDevContainerParams{
WorkspaceID: r.id, Options: options, ParsedConfig: parsedConfig,
WorkspaceID: r.id,
Options: options,
ParsedConfig: parsedConfig,
LocalWorkspaceFolder: r.localWorkspaceFolder,
},
)
}
Expand Down
5 changes: 3 additions & 2 deletions pkg/driver/apple/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ var (
_ driver.RecreatePolicyDriver = (*appleDriver)(nil)
_ driver.WorkspaceChowner = (*appleDriver)(nil)

_ driver.ImageDriver = (*appleDriver)(nil)
_ driver.Preflighter = (*appleDriver)(nil)
_ driver.ImageDriver = (*appleDriver)(nil)
_ driver.Preflighter = (*appleDriver)(nil)
_ driver.ImageRunValidator = (*appleDriver)(nil)
)

// NewAppleDriver verifies the host is supported and constructs the driver;
Expand Down
15 changes: 15 additions & 0 deletions pkg/driver/apple/lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"github.com/devsy-org/devsy/pkg/apple"
"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/driver"
"github.com/devsy-org/devsy/pkg/driver/runargs"
"github.com/devsy-org/devsy/pkg/log"
)

Expand Down Expand Up @@ -146,10 +147,24 @@ func (d *appleDriver) TagDevContainer(ctx context.Context, image, tag string) er
return nil
}

func (d *appleDriver) ValidateRunImageDevContainer(
params *driver.RunImageDevContainerParams,
) error {
return runargs.Validate(
runargs.AppleContainer,
params.ParsedConfig.RunArgs,
params.LocalWorkspaceFolder,
)
}

func (d *appleDriver) RunImageDevContainer(
ctx context.Context,
params *driver.RunImageDevContainerParams,
) error {
if err := d.ValidateRunImageDevContainer(params); err != nil {
return err
}

if err := d.EnsureImage(ctx, params.Options); err != nil {
return err
}
Expand Down
126 changes: 126 additions & 0 deletions pkg/driver/apple/native_runargs_integration_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
package apple

import (
"bytes"
"context"
"fmt"
"os"
"slices"
"strings"
"testing"
"time"

"github.com/devsy-org/devsy/pkg/apple"
"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/driver"
"github.com/stretchr/testify/suite"
)

const (
nativeIntendedImage = "alpine:3.22"
nativePositionalImage = "busybox:1"
nativeEntrypoint = "/bin/sh"
)

type NativeRunArgsSuite struct {
suite.Suite
helper *apple.AppleHelper
}

func TestNativeRunArgsSuite(t *testing.T) {
suite.Run(t, new(NativeRunArgsSuite))
}

func (s *NativeRunArgsSuite) SetupTest() {
if os.Getenv("DEVSY_APPLE_E2E") != "1" {
s.T().Skip("set DEVSY_APPLE_E2E=1 to run against a real container CLI")
}
s.helper = &apple.AppleHelper{Command: "container"}
}

func (s *NativeRunArgsSuite) TestPositionalImageIsRejected() {
name := s.containerName("positional")
err := s.runDevContainer(name, "--name", name, "--read-only", nativePositionalImage, "echo")
s.T().Logf("RunImageDevContainer error: %v", err)
s.assertNoContainer(name)
s.Require().ErrorContains(err, "the runtime would read it as the image")
}

func (s *NativeRunArgsSuite) TestReservedLabelIsRejected() {
name := s.containerName("reserved")
err := s.runDevContainer(
name, "--name", name, "--label", "sh.devsy.recovery=fixture-private-value",
)
s.T().Logf("RunImageDevContainer error: %v", err)
s.assertNoContainer(name)
s.Require().ErrorContains(err, `label "sh.devsy.recovery" is reserved by Devsy`)
s.NotContains(err.Error(), "fixture-private-value")
}

func (s *NativeRunArgsSuite) TestOrdinaryLabelStarts() {
name := s.containerName("ordinary")
s.Require().NoError(s.runDevContainer(name, "--name", name, "--label", "team=a"))
s.Require().NoError(s.helper.WaitContainerRunning(context.Background(), name))

details, err := s.helper.InspectContainers(context.Background(), []string{name})
s.Require().NoError(err)
s.Require().Len(details, 1)
s.Equal("a", details[0].Config.Labels["team"])
s.Equal("root", details[0].Config.Labels[config.UserLabel])
}

func (s *NativeRunArgsSuite) containerName(kind string) string {
name := fmt.Sprintf("devsy-runargs-%s-%d", kind, time.Now().UnixNano())
s.T().Cleanup(func() {
ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
defer cancel()
_ = s.helper.Stop(ctx, name)
_ = s.helper.Remove(ctx, name)
})
return name
}

func (s *NativeRunArgsSuite) runDevContainer(name string, runArgs ...string) error {
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
defer cancel()
return (&appleDriver{Apple: s.helper}).RunImageDevContainer(
ctx,
&driver.RunImageDevContainerParams{
WorkspaceID: name,
ParsedConfig: &config.DevContainerConfig{
NonComposeBase: config.NonComposeBase{RunArgs: runArgs},
},
Options: &driver.RunOptions{
Image: nativeIntendedImage,
Labels: []string{config.UserLabel + "=root"},
Entrypoint: nativeEntrypoint,
Cmd: []string{"-c", "sleep 120"},
},
},
)
}

func (s *NativeRunArgsSuite) assertNoContainer(name string) {
var out bytes.Buffer
err := s.helper.Run(
context.Background(),
[]string{"list", "--all", "--quiet"},
apple.Streams{Stdout: &out},
)
s.Require().NoError(err)
if !slices.Contains(strings.Fields(out.String()), name) {
s.T().Logf("%s: no container", name)
return
}
details, err := s.helper.InspectContainers(context.Background(), []string{name})
s.Require().NoError(err)
s.Require().NotEmpty(details)
s.Failf(
"container was created",
"%s: status=%s image=%s labels=%v",
name,
details[0].State.Status,
details[0].Config.LegacyImage,
details[0].Config.Labels,
)
}
67 changes: 67 additions & 0 deletions pkg/driver/apple/runargs_validation_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package apple

import (
"context"
"errors"
"testing"

"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/driver"
"github.com/stretchr/testify/suite"
)

const runCall = "run"

type RunArgsValidationSuite struct {
suite.Suite
client *mockClient
driver *appleDriver
}

func TestRunArgsValidationSuite(t *testing.T) {
suite.Run(t, new(RunArgsValidationSuite))
}

func (s *RunArgsValidationSuite) SetupTest() {
s.client = &mockClient{inspectErr: errors.New("image missing")}
s.driver = &appleDriver{Apple: s.client}
}

func (s *RunArgsValidationSuite) TestRejectsBeforeAnyRuntimeCall() {
s.ErrorContains(s.run("--rm", "busybox"), "the runtime would read it as the image")
s.EqualError(
s.run("--label", "sh.devsy.recovery=true"),
`runArgs: label "sh.devsy.recovery" is reserved by Devsy; remove the user-supplied label`,
)
s.Empty(s.client.calls)
s.Empty(s.client.ranArgs)
}

func (s *RunArgsValidationSuite) TestValidatesBeforeRecreateRemovesTheContainer() {
err := s.driver.ValidateRunImageDevContainer(&driver.RunImageDevContainerParams{
ParsedConfig: &config.DevContainerConfig{
NonComposeBase: config.NonComposeBase{RunArgs: []string{"-l", "devsy.user=root"}},
},
})
s.EqualError(
err,
`runArgs: label "devsy.user" is reserved by Devsy; remove the user-supplied label`,
)
s.Empty(s.client.calls)
}

func (s *RunArgsValidationSuite) TestOrdinaryRunArgsReachTheRuntime() {
s.Require().NoError(s.run("--label", "team=a"))
s.Equal([]string{"pull", runCall}, s.client.calls)
s.Require().Len(s.client.ranArgs, 1)
s.Contains(s.client.ranArgs[0], "team=a")
}

func (s *RunArgsValidationSuite) run(runArgs ...string) error {
return s.driver.RunImageDevContainer(context.Background(), &driver.RunImageDevContainerParams{
ParsedConfig: &config.DevContainerConfig{
NonComposeBase: config.NonComposeBase{RunArgs: runArgs},
},
Options: &driver.RunOptions{Image: testImageRef},
})
}
1 change: 1 addition & 0 deletions pkg/driver/docker/docker.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ var (
_ driver.DockerHelperProvider = (*dockerDriver)(nil)
_ driver.SnapshotCapableDriver = (*dockerDriver)(nil)
_ driver.Preflighter = (*dockerDriver)(nil)
_ driver.ImageRunValidator = (*dockerDriver)(nil)
)

// Preflight checks the runtime binary is installed and its daemon reachable,
Expand Down
15 changes: 15 additions & 0 deletions pkg/driver/docker/lifecycle.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/devsy-org/devsy/pkg/devcontainer/config"
"github.com/devsy-org/devsy/pkg/docker"
"github.com/devsy-org/devsy/pkg/driver"
"github.com/devsy-org/devsy/pkg/driver/runargs"
"github.com/devsy-org/devsy/pkg/log"
"github.com/devsy-org/devsy/pkg/secrets"
"github.com/devsy-org/devsy/pkg/subprocess"
Expand Down Expand Up @@ -313,10 +314,24 @@ func (d *dockerDriver) GetDevContainerLogs(
return d.Docker.GetContainerLogs(ctx, container.ID, stdout, stderr)
}

func (d *dockerDriver) ValidateRunImageDevContainer(
params *driver.RunImageDevContainerParams,
) error {
return runargs.Validate(
runargs.DockerCompatible,
params.ParsedConfig.RunArgs,
params.LocalWorkspaceFolder,
)
}

func (d *dockerDriver) RunImageDevContainer(
ctx context.Context,
params *driver.RunImageDevContainerParams,
) error {
if err := d.ValidateRunImageDevContainer(params); err != nil {
return err
}

if err := d.EnsureImage(ctx, params.Options); err != nil {
return err
}
Expand Down
Loading
Loading