Skip to content

fix: enable logging for setup script when not a tty (#402) #422

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.

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 1 commit into from
Dec 2, 2024
Merged
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
30 changes: 19 additions & 11 deletions envbuilder.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package envbuilder

import (
"bufio"
"bytes"
"context"
"encoding/base64"
Expand Down Expand Up @@ -885,16 +884,8 @@ func run(ctx context.Context, opts options.Options, execArgs *execArgsInfo) erro
cmd.Stderr = os.Stderr
cmd.Stdin = os.Stdin
} else {
var buf bytes.Buffer
go func() {
scanner := bufio.NewScanner(&buf)
for scanner.Scan() {
opts.Logger(log.LevelInfo, "%s", scanner.Text())
}
}()

cmd.Stdout = &buf
cmd.Stderr = &buf
cmd.Stdout = newWriteLogger(opts.Logger, log.LevelInfo)
cmd.Stderr = newWriteLogger(opts.Logger, log.LevelError)
}
err = cmd.Run()
if err != nil {
Expand Down Expand Up @@ -1814,6 +1805,23 @@ func onceErrFunc(f func() error) func() error {
}
}

type writeLogger struct {
logf log.Func
level log.Level
}

func newWriteLogger(logf log.Func, level log.Level) io.Writer {
return writeLogger{logf: logf, level: level}
}

func (l writeLogger) Write(p []byte) (n int, err error) {
lines := bytes.Split(p, []byte("\n"))
for _, line := range lines {
l.logf(l.level, "%s", line)
}
return len(p), nil
}

// Allows quick testing of layer caching using a local directory!
func serveLocalRegistry(ctx context.Context, logf log.Func, layerCacheDir string) (string, func(), error) {
noop := func() {}
Expand Down
3 changes: 3 additions & 0 deletions integration/integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ func TestLogs(t *testing.T) {
envbuilderEnv("GIT_URL", srv.URL),
"CODER_AGENT_URL=" + logSrv.URL,
"CODER_AGENT_TOKEN=" + token,
"ENVBUILDER_SETUP_SCRIPT=/bin/sh -c 'echo MY${NO_MATCH_ENV}_SETUP_SCRIPT_OUT; echo MY${NO_MATCH_ENV}_SETUP_SCRIPT_ERR' 1>&2",
"ENVBUILDER_INIT_SCRIPT=env",
}})
require.NoError(t, err)
Expand Down Expand Up @@ -159,6 +160,8 @@ func TestLogs(t *testing.T) {
require.NoError(t, err)
logs := string(logBytes)
require.Contains(t, logs, "CODER_AGENT_SUBSYSTEM=envbuilder")
require.Contains(t, logs, "MY_SETUP_SCRIPT_OUT")
require.Contains(t, logs, "MY_SETUP_SCRIPT_ERR")
}

func TestInitScriptInitCommand(t *testing.T) {
Expand Down