Skip to content

fix(clitest): use slogtest for logging stdin and stdout #7828

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 2 commits into from
Jun 2, 2023
Merged

fix(clitest): use slogtest for logging stdin and stdout #7828

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1460bb6
fix(clitest): use `slogtest` for logging stdin/stdout
coadler Jun 2, 2023
bec5c96
fixup! fix(clitest): use `slogtest` for logging stdin/stdout
coadler Jun 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
Next Next commit
fix(clitest): use slogtest for logging stdin/stdout 
https://github.com/coder/coder/actions/runs/5159866775/jobs/9295338703?pr=7824#step:5:1109

`slogtest` has already mitigated the race condition above, so just use
that directly instead.
  • Loading branch information
@coadler
coadler committed Jun 2, 2023
commit 1460bb6495835ceb6e579878454ed6fc476beaf7
15 changes: 10 additions & 5 deletions cli/clitest/clitest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"cdr.dev/slog"
"cdr.dev/slog/sloggers/slogtest"

"github.com/coder/coder/cli"
"github.com/coder/coder/cli/clibase"
"github.com/coder/coder/cli/config"
Expand All @@ -39,16 +42,17 @@ func New(t *testing.T, args ...string) (*clibase.Invocation, config.Root) {

type logWriter struct {
prefix string
t *testing.T
log slog.Logger
}

func (l *logWriter) Write(p []byte) (n int, err error) {
trimmed := strings.TrimSpace(string(p))
if trimmed == "" {
return len(p), nil
}
l.t.Log(
l.prefix + ": " + trimmed,
l.log.Info(
context.Background(),
l.prefix+": "+trimmed,
)
return len(p), nil
}
Expand All @@ -57,12 +61,13 @@ func NewWithCommand(
t *testing.T, cmd *clibase.Cmd, args ...string,
) (*clibase.Invocation, config.Root) {
configDir := config.Root(t.TempDir())
logger := slogtest.Make(t, nil)
i := &clibase.Invocation{
Command: cmd,
Args: append([]string{"--global-config", string(configDir)}, args...),
Stdin: io.LimitReader(nil, 0),
Stdout: (&logWriter{prefix: "stdout", t: t}),
Stderr: (&logWriter{prefix: "stderr", t: t}),
Stdout: (&logWriter{prefix: "stdout", log: logger}),
Stderr: (&logWriter{prefix: "stderr", log: logger}),
}
t.Logf("invoking command: %s %s", cmd.Name(), strings.Join(i.Args, " "))

Expand Down