Skip to content
Open
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
8 changes: 8 additions & 0 deletions hack/ci/suites.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,14 @@ unit:
run: '^(TestInvocationSuite|TestProviderDaemonOverrides.*|TestStdioTransportSuite|TestLaunch.*|TestEnvBlock.*)$'
args: [-race, -count=1, -v, -timeout=5m]

- name: windows-provider-launch
description: native Windows provider executable launch and launch failure reporting
os: [windows]
packages: [./pkg/shell, ./pkg/client/clientimplementation]
run: '^(TestExecutablePathTestSuite|TestProviderCommandErrorTestSuite)$'
require_tests: [TestExecutablePathTestSuite, TestProviderCommandErrorTestSuite]
args: [-race, -count=1, -v, -timeout=5m]

- name: windows-wslg-boundaries
description: WSLg preflight, discovery and Compose environment boundaries on native Windows
os: [windows]
Expand Down
7 changes: 7 additions & 0 deletions pkg/client/clientimplementation/process_other.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
//go:build !windows

package clientimplementation

func isInvalidProcessParameter(error) bool {
return false
}
17 changes: 17 additions & 0 deletions pkg/client/clientimplementation/process_windows.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
//go:build windows

package clientimplementation

import (
"errors"
"io/fs"

"golang.org/x/sys/windows"
)

func isInvalidProcessParameter(err error) bool {
var pathErr *fs.PathError
return errors.As(err, &pathErr) &&
pathErr.Op == "fork/exec" &&
errors.Is(pathErr.Err, windows.ERROR_INVALID_PARAMETER)
}
45 changes: 45 additions & 0 deletions pkg/client/clientimplementation/provider_command_error_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package clientimplementation

import (
"errors"
"io/fs"
"testing"

"github.com/devsy-org/devsy/pkg/provider"
"github.com/stretchr/testify/suite"
)

type ProviderCommandErrorTestSuite struct {
suite.Suite
}

func TestProviderCommandErrorTestSuite(t *testing.T) {
suite.Run(t, new(ProviderCommandErrorTestSuite))
}

func (s *ProviderCommandErrorTestSuite) TestOmitsEmptyAction() {
cause := errors.New("exit status 255")

err := providerCommandError("${SSH_PROVIDER} init", nil, cause)

s.Equal(`run provider command "${SSH_PROVIDER} init": exit status 255`, err.Error())
s.ErrorIs(err, cause)
}

func (s *ProviderCommandErrorTestSuite) TestIncludesAction() {
cause := errors.New("exit status 1")
environ := []string{"UNRELATED=value", provider.CommandEnv + "=ls"}

err := providerCommandError("${SSH_PROVIDER} command", environ, cause)

s.Equal(`run provider command "${SSH_PROVIDER} command" (ls): exit status 1`, err.Error())
}

func (s *ProviderCommandErrorTestSuite) TestPlainStartFailureHasNoWindowsHint() {
cause := &fs.PathError{Op: "fork/exec", Path: "provider", Err: fs.ErrPermission}

err := providerCommandError("provider", nil, cause)

s.NotContains(err.Error(), "ERROR_INVALID_PARAMETER")
s.ErrorIs(err, fs.ErrPermission)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
//go:build windows

package clientimplementation

import (
"io/fs"
"os"
"os/exec"
"syscall"

"golang.org/x/sys/windows"
)

func (s *ProviderCommandErrorTestSuite) TestRealInvalidParameterStartFailureGetsHint() {
self, err := os.Executable()
s.Require().NoError(err)
cmd := exec.Command(self)
cmd.SysProcAttr = &syscall.SysProcAttr{
CreationFlags: windows.DETACHED_PROCESS | windows.CREATE_NEW_CONSOLE,
}
startErr := cmd.Start()
s.Require().ErrorIs(startErr, windows.ERROR_INVALID_PARAMETER)

err = providerCommandError(self, nil, startErr)

s.ErrorIs(err, windows.ERROR_INVALID_PARAMETER)
s.Contains(err.Error(), invalidProcessParameterHint)
s.Contains(err.Error(), "The parameter is incorrect")
}

func (s *ProviderCommandErrorTestSuite) TestInvalidParameterFromOutputWriterGetsNoHint() {
writeErr := &fs.PathError{Op: "write", Path: "stdout", Err: windows.ERROR_INVALID_PARAMETER}

err := providerCommandError("provider", nil, writeErr)

s.ErrorIs(err, windows.ERROR_INVALID_PARAMETER)
s.NotContains(err.Error(), invalidProcessParameterHint)
}
105 changes: 69 additions & 36 deletions pkg/client/clientimplementation/workspace_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -245,12 +245,13 @@ func (s *workspaceClient) Command(ctx context.Context, opt client.CommandOptions
}

return RunCommand(ctx, RunCommandOptions{
Command: s.providerConfig.Exec.Command,
Environ: environ,
Stdin: opt.Stdin,
Stdout: opt.Stdout,
Stderr: opt.Stderr,
RawStdout: opt.RawStdout,
Command: s.providerConfig.Exec.Command,
Environ: environ,
ProviderBinaries: s.providerConfig.Binaries,
Stdin: opt.Stdin,
Stdout: opt.Stdout,
Stderr: opt.Stderr,
RawStdout: opt.RawStdout,
})
}

Expand All @@ -266,9 +267,10 @@ func (s *workspaceClient) OpenCommandTransport(
ctx,
func(ctx context.Context, stdin io.Reader, stdout io.Writer) error {
return RunCommand(ctx, RunCommandOptions{
Command: s.providerConfig.Exec.Command,
Environ: environ,
Stdin: stdin, Stdout: stdout, Stderr: opt.Stderr,
Command: s.providerConfig.Exec.Command,
Environ: environ,
ProviderBinaries: s.providerConfig.Binaries,
Stdin: stdin, Stdout: stdout, Stderr: opt.Stderr,
RawStdout: true,
})
},
Expand Down Expand Up @@ -810,22 +812,41 @@ func RunCommandWithBinaries(ctx context.Context, cfg WorkspaceCommandConfig) err
}

return RunCommand(ctx, RunCommandOptions{
Command: cfg.Command,
Environ: environ,
Stdin: cfg.Stdin,
Stdout: cfg.Stdout,
Stderr: cfg.Stderr,
RawStdout: cfg.RawStdout,
Command: cfg.Command,
Environ: environ,
ProviderBinaries: cfg.Config.Binaries,
Stdin: cfg.Stdin,
Stdout: cfg.Stdout,
Stderr: cfg.Stderr,
RawStdout: cfg.RawStdout,
})
}

type RunCommandOptions struct {
Command types.StrArray
Environ []string
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
RawStdout bool
Command types.StrArray
Environ []string
ProviderBinaries map[string][]*provider.ProviderBinary
Stdin io.Reader
Stdout io.Writer
Stderr io.Writer
RawStdout bool
}

func providerBinaryPaths(
environ []string,
binaries map[string][]*provider.ProviderBinary,
) map[string]string {
if len(binaries) == 0 {
return nil
}
paths := make(map[string]string, len(binaries))
for _, entry := range environ {
name, value, ok := strings.Cut(entry, "=")
if _, exists := binaries[name]; ok && exists {
paths[name] = value
}
}
return paths
}

func RunCommand(ctx context.Context, opts RunCommandOptions) (retErr error) {
Expand Down Expand Up @@ -857,18 +878,14 @@ func RunCommand(ctx context.Context, opts RunCommandOptions) (retErr error) {

if len(opts.Command) == 1 {
if err := shell.RunEmulatedShell(ctx, &shell.CommandRunner{
Command: opts.Command[0],
Stdin: opts.Stdin,
Stdout: stdout,
Stderr: stderr,
Environ: opts.Environ,
Command: opts.Command[0],
Stdin: opts.Stdin,
Stdout: stdout,
Stderr: stderr,
Environ: opts.Environ,
ExecutablePaths: providerBinaryPaths(opts.Environ, opts.ProviderBinaries),
}); err != nil {
return fmt.Errorf(
"run provider command %q (%s): %w",
opts.Command[0],
providerAction(opts.Environ),
err,
)
return providerCommandError(opts.Command[0], opts.Environ, err)
}
return nil
}
Expand All @@ -879,10 +896,7 @@ func RunCommand(ctx context.Context, opts RunCommandOptions) (retErr error) {
cmd.Stderr = stderr
cmd.Env = opts.Environ
if err := cmd.Run(); err != nil {
return fmt.Errorf(
"run provider command %q (%s): %w",
strings.Join(opts.Command, " "), providerAction(opts.Environ), err,
)
return providerCommandError(strings.Join(opts.Command, " "), opts.Environ, err)
}
return nil
}
Expand All @@ -901,6 +915,25 @@ func flushCommandOutput(stdout, stderr *subprocess.StreamingRedactingWriter) err
return errors.Join(stdoutErr, stderrErr)
}

const invalidProcessParameterHint = "Windows rejected starting the provider executable " +
"(ERROR_INVALID_PARAMETER) before it ran, so this is a local process-launch failure " +
"rather than a remote host error; the cause is unconfirmed, so please report the Windows " +
"version and whether running the executable directly from a terminal works"

func providerCommandError(command string, environ []string, err error) error {
action := ""
if name := providerAction(environ); name != "" {
action = fmt.Sprintf(" (%s)", name)
}
if isInvalidProcessParameter(err) {
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
return fmt.Errorf(
"run provider command %q%s: %w; %s",
command, action, err, invalidProcessParameterHint,
)
}
return fmt.Errorf("run provider command %q%s: %w", command, action, err)
}

// providerAction extracts the provider action from the environment variables.
func providerAction(environ []string) string {
for _, kv := range environ {
Expand Down
Loading
Loading