From 6c7754928a993d98c43f8955b10580c8f39701c4 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Wed, 4 Nov 2026 14:47:31 -0600 Subject: [PATCH] fix(provider): run machine provider lifecycle through the workspace tunnel --- cmd/provider/configure_shared.go | 1 + cmd/provider/init_environment_test.go | 48 ++++++++++++++++++++ pkg/devcontainer/sshtunnel/sshtunnel.go | 5 +- pkg/devcontainer/sshtunnel/sshtunnel_test.go | 25 ++++++++++ pkg/ssh/server/exit.go | 5 ++ pkg/workspace/exec_tunnel.go | 6 ++- pkg/workspace/exec_tunnel_test.go | 21 ++++++--- 7 files changed, 101 insertions(+), 10 deletions(-) create mode 100644 cmd/provider/init_environment_test.go diff --git a/cmd/provider/configure_shared.go b/cmd/provider/configure_shared.go index 41ced50911..f5d452e5ce 100644 --- a/cmd/provider/configure_shared.go +++ b/cmd/provider/configure_shared.go @@ -288,6 +288,7 @@ func initProvider( WorkspaceContextName: contextName, Options: providerOptions, Config: provider, + ExtraEnv: provider2.GetBaseEnvironment(contextName, provider.Name), Stdout: io2.stdout, Stderr: io2.stderr, }, diff --git a/cmd/provider/init_environment_test.go b/cmd/provider/init_environment_test.go new file mode 100644 index 0000000000..5ae74f4f12 --- /dev/null +++ b/cmd/provider/init_environment_test.go @@ -0,0 +1,48 @@ +package provider + +import ( + "context" + "io" + "os" + "path/filepath" + "testing" + + "github.com/devsy-org/devsy/pkg/config" + provider2 "github.com/devsy-org/devsy/pkg/provider" + "github.com/devsy-org/devsy/pkg/workspace" + "github.com/stretchr/testify/require" + "sigs.k8s.io/yaml" +) + +func TestInitProviderReceivesBaseEnvironment(t *testing.T) { + t.Setenv(config.EnvHome, t.TempDir()) + cfg := setupProviderOperationTest(t) + captured := filepath.Join(t.TempDir(), "captured") + definition := &provider2.ProviderConfig{ + Name: testProviderFoo, + Version: "3.1.4", + Exec: provider2.ProviderCommands{ + Command: []string{"unused-command"}, + Init: []string{ + `printf '%s\n%s' "$DEVSY" "$PROVIDER_ID" > '` + filepath.ToSlash(captured) + `'`, + }, + }, + } + raw, err := yaml.Marshal(definition) + require.NoError(t, err) + source := filepath.Join(t.TempDir(), "provider.yaml") + require.NoError(t, os.WriteFile(source, raw, 0o600)) + installed, err := workspace.AddProvider(context.Background(), cfg, testProviderFoo, source) + require.NoError(t, err) + + require.NoError(t, initProvider( + context.Background(), cfg, installed, initIO{stdout: io.Discard, stderr: io.Discard}, + )) + + executable, err := os.Executable() + require.NoError(t, err) + // #nosec G304 -- captured is created by the init command in this isolated fixture. + got, err := os.ReadFile(captured) + require.NoError(t, err) + require.Equal(t, filepath.ToSlash(executable)+"\n"+testProviderFoo, string(got)) +} diff --git a/pkg/devcontainer/sshtunnel/sshtunnel.go b/pkg/devcontainer/sshtunnel/sshtunnel.go index fff92500ea..5712903344 100644 --- a/pkg/devcontainer/sshtunnel/sshtunnel.go +++ b/pkg/devcontainer/sshtunnel/sshtunnel.go @@ -62,7 +62,10 @@ func ExecuteCommand(ctx context.Context, opts ExecuteCommandOptions) (*config2.R if err != nil { return nil, err } - defer func() { _ = conn.Close() }() + defer func() { + _ = conn.Close() + _ = conn.Wait() + }() if opts.AddPrivateKeys { addPrivateKeys(ctx) } diff --git a/pkg/devcontainer/sshtunnel/sshtunnel_test.go b/pkg/devcontainer/sshtunnel/sshtunnel_test.go index a281cc8901..b3c437967e 100644 --- a/pkg/devcontainer/sshtunnel/sshtunnel_test.go +++ b/pkg/devcontainer/sshtunnel/sshtunnel_test.go @@ -5,7 +5,9 @@ import ( "errors" "fmt" "io" + "sync/atomic" "testing" + "time" "github.com/devsy-org/devsy/pkg/agent" config2 "github.com/devsy-org/devsy/pkg/devcontainer/config" @@ -224,6 +226,29 @@ func TestExecuteCommand_PipeBridgeIntegration(t *testing.T) { // and may return nil or a wrapped error. Either way, no hang. _ = err }) + + t.Run("returns only after the helper command finishes", func(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + var finished atomic.Bool + + _, _ = ExecuteCommand(ctx, ExecuteCommandOptions{ + AgentInject: func(ctx context.Context, _ string, _ io.Reader, _ io.Writer, _ io.WriteCloser) error { + cancel() + <-ctx.Done() + time.Sleep(300 * time.Millisecond) + finished.Store(true) + return ctx.Err() + }, + SSHCommand: "slow-ssh", + Command: "slow-cmd", + TunnelServerFunc: func(_ context.Context, _ io.WriteCloser, _ io.Reader) (*config2.Result, error) { + return nil, nil + }, + }) + + assert.True(t, finished.Load()) + }) } func TestExecuteCommand_NoPipePairOrTimerTypes(t *testing.T) { diff --git a/pkg/ssh/server/exit.go b/pkg/ssh/server/exit.go index 294c895851..6d57711a40 100644 --- a/pkg/ssh/server/exit.go +++ b/pkg/ssh/server/exit.go @@ -2,6 +2,7 @@ package server import ( "errors" + "io" "os/exec" "strings" @@ -23,6 +24,10 @@ func exitWithError(sess ssh.Session, err error) { // always exit session err = sess.Exit(exitCode(err)) if err != nil { + if errors.Is(err, io.EOF) { + log.Debugf("session closed before exit status: %v", err) + return + } log.Errorf("session failed to exit: %v", err) } } diff --git a/pkg/workspace/exec_tunnel.go b/pkg/workspace/exec_tunnel.go index ea45a02350..46762788cd 100644 --- a/pkg/workspace/exec_tunnel.go +++ b/pkg/workspace/exec_tunnel.go @@ -31,8 +31,10 @@ func NewWorkspaceRuntime( if err != nil { return nil, err } - switch info.Agent.Driver { - case provider.ExternalDriver, provider.MicrosandboxDriver: + switch { + case info.Agent.Driver == provider.ExternalDriver, + info.Agent.Driver == provider.MicrosandboxDriver, + info.Agent.Driver == provider.DockerDriver && info.Agent.Local == "false": if override != "" { return nil, errors.New("--docker-path cannot override an agent-side runtime") } diff --git a/pkg/workspace/exec_tunnel_test.go b/pkg/workspace/exec_tunnel_test.go index 422b9541d0..297be1556f 100644 --- a/pkg/workspace/exec_tunnel_test.go +++ b/pkg/workspace/exec_tunnel_test.go @@ -18,6 +18,7 @@ import ( "github.com/devsy-org/devsy/pkg/config" devcconfig "github.com/devsy-org/devsy/pkg/devcontainer/config" "github.com/devsy-org/devsy/pkg/provider" + "github.com/devsy-org/devsy/pkg/types" "github.com/stretchr/testify/require" "github.com/stretchr/testify/suite" "golang.org/x/crypto/ssh" @@ -54,7 +55,11 @@ func (c *tunnelWorkspaceClient) Status( } func (s *tunnelExecSuite) TestRoutesAgentRuntimesWithoutLocalExecutable() { - for _, driver := range []string{provider.ExternalDriver, provider.MicrosandboxDriver} { + for _, driver := range []string{ + provider.ExternalDriver, + provider.MicrosandboxDriver, + provider.DockerDriver, + } { s.Run(driver, func() { c := &tunnelWorkspaceClient{ workspace: &provider.Workspace{ID: "remote"}, @@ -67,13 +72,15 @@ func (s *tunnelExecSuite) TestRoutesAgentRuntimesWithoutLocalExecutable() { s.ErrorContains(err, "cannot override") }) } - c := &tunnelWorkspaceClient{ - workspace: &provider.Workspace{}, - info: provider.ProviderAgentConfig{}, + for _, local := range []types.StrBool{"", types.StrBool(config.BoolTrue)} { + c := &tunnelWorkspaceClient{ + workspace: &provider.Workspace{}, + info: provider.ProviderAgentConfig{Local: local}, + } + resolved, err := NewWorkspaceRuntime(&config.Config{}, c, "") + s.Require().NoError(err) + s.IsType(&DockerRuntime{}, resolved) } - resolved, err := NewWorkspaceRuntime(&config.Config{}, c, "") - s.Require().NoError(err) - s.IsType(&DockerRuntime{}, resolved) } func (s *tunnelExecSuite) TestFindRequiresRunningOwnedWorkspaceAndMetadata() {