Skip to content

chore: skip timing-sensistive AgentMetadata test in the standard suite #7237

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

Merged
merged 7 commits into from
May 2, 2023
Merged

chore: skip timing-sensistive AgentMetadata test in the standard suite #7237

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ca0125e
chore: skip timing-sensistive AgentMetadata test in the standard suite
ammario Apr 20, 2023
ba6f151
Add test-timing target
ammario Apr 21, 2023
56a45cc
fix windows?
ammario Apr 21, 2023
cae381f
Works on my Windows desktop?
ammario Apr 22, 2023
05127e6
Use tag system
ammario Apr 22, 2023
8d710fb
fixup! Use tag system
ammario Apr 24, 2023
8a7ad50
Merge remote-tracking branch 'origin/main' into agent-metadata-timings
ammario May 2, 2023
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
Prev Previous commit
Next Next commit
Works on my Windows desktop?
  • Loading branch information
@ammario
ammario committed Apr 22, 2023
commit cae381f88aeaccde5f65dd23bed7b348d6dfba4c
49 changes: 22 additions & 27 deletions agent/agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"os/user"
"path/filepath"
"reflect"
"runtime"
"regexp"
"sort"
"strconv"
"strings"
Expand Down Expand Up @@ -205,9 +205,17 @@ func (a *agent) runLoop(ctx context.Context) {
}
}

var (
isCmdExeRe = regexp.MustCompile(`^(cmd|cmd\.exe)$`)
)

func createMetadataCommand(ctx context.Context, script string) (*exec.Cmd, error) {
// This is largely copied from agentssh, but for some reason the command
// generated there always returns exit status 1 in Windows.
// generated there always returns exit status 1 in Windows powershell.
//
// This function puts special PowerShell branching in place that fixes the issue,
// but I'm hesitant on porting it to agentssh before understanding exactly what's
// happening.
currentUser, err := user.Current()
if err != nil {
return nil, xerrors.Errorf("get current user: %w", err)
Expand All @@ -218,31 +226,28 @@ func createMetadataCommand(ctx context.Context, script string) (*exec.Cmd, error
if err != nil {
return nil, xerrors.Errorf("get user shell: %w", err)
}
shellBase := filepath.Base(shell)

var caller string
var args []string
switch {
case filepath.Base(shell) == "pwsh.exe":
caller = "-Command"
case runtime.GOOS == "windows":
caller = "/c"
case isCmdExeRe.MatchString(shellBase):
args = append(args, "/c")
default:
caller = "-c"
// -c works for powershell and sh variants.
args = append(args, "-c")
}
// args := []string{caller, "Get-Process"}
args := []string{"-NoProfile", "-NonInteractive"}
_ = caller
return exec.CommandContext(ctx, "powershell", args...), nil
args = append(args, script)
return exec.CommandContext(ctx, shell, args...), nil
}

func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMetadataDescription) *codersdk.WorkspaceAgentMetadataResult {
var out bytes.Buffer
result := &codersdk.WorkspaceAgentMetadataResult{
// CollectedAt is set here for testing purposes and overrode by
// the server to the time the server received the result to protect
// against clock skew.
// coderd to the time of server receipt to solve clock skew.
//
// In the future, the server may accept the timestamp from the agent
// if it is certain the clocks are in sync.
// if it can guarantee the clocks are synchronized.
CollectedAt: time.Now(),
}
cmd, err := createMetadataCommand(ctx, md.Script)
Expand All @@ -251,19 +256,11 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
return result
}

// execPath, err := exec.LookPath("cmd.exe")
// if err != nil {
// result.Error = fmt.Sprintf("look path: %+v", err)
// return result
// }

// cmd = exec.CommandContext(ctx, execPath, "/c", "echo hello")

cmd.Stdout = &out
cmd.Stderr = &out
cmd.Stdin = io.LimitReader(nil, 0)

// We split up Start and Wait so that we can return a more useful error.
// We split up Start and Wait instead of calling Run so that we can return a more precise error.
err = cmd.Start()
if err != nil {
result.Error = fmt.Sprintf("start cmd: %+v", err)
Expand All @@ -281,10 +278,8 @@ func (*agent) collectMetadata(ctx context.Context, md codersdk.WorkspaceAgentMet
out.Truncate(bufLimit)
}

fmt.Printf("ran %+v %+q: %v\n", cmd.Path, cmd.Args, err)

if err != nil {
result.Error = fmt.Sprintf("run cmd: %+v", err)
result.Error = fmt.Sprintf("run cmd (shell %v): %+v", cmd.Path, err)
}
result.Value = out.String()
return result
Expand Down
9 changes: 3 additions & 6 deletions agent/agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,10 +976,7 @@ func TestAgent_StartupScript(t *testing.T) {
func TestAgent_Metadata(t *testing.T) {
t.Parallel()

echoHello := "echo hello"
if runtime.GOOS == "windows" {
echoHello = "echo 'hello'"
}
echoHello := "echo 'hello'"

t.Run("Once", func(t *testing.T) {
t.Parallel()
Expand Down Expand Up @@ -1031,8 +1028,8 @@ func TestAgent_Metadata(t *testing.T) {
}, testutil.WaitShort, testutil.IntervalMedium)

collectedAt1 := gotMd["greeting"].CollectedAt
if !assert.Equal(t, "hello\n", gotMd["greeting"].Value) {
t.Logf("got: %+v", gotMd)
if !assert.Equal(t, "hello", strings.TrimSpace(gotMd["greeting"].Value)) {
t.Errorf("got: %+v", gotMd)
}

if !assert.Eventually(t, func() bool {
Expand Down