Skip to content

fix(agent/agentscripts): create script log directories #25545

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

Closed
puneetdixit200 wants to merge 1 commit into from
Closed

fix(agent/agentscripts): create script log directories #25545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions agent/agentscripts/agentscripts.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,11 @@ func (r *Runner) run(ctx context.Context, script codersdk.WorkspaceAgentScript,
if err != nil {
return xerrors.Errorf("%s script: create script temp dir: %w", scriptDataDir, err)
}
logDir := filepath.Dir(logPath)
err = r.Filesystem.MkdirAll(logDir, 0o700)
if err != nil {
return xerrors.Errorf("%s script: create script log dir: %w", logDir, err)
}

logger := r.Logger.With(
slog.F("log_source_id", script.LogSourceID),
Expand Down
42 changes: 39 additions & 3 deletions agent/agentscripts/agentscripts_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,32 @@ func TestExecuteBasic(t *testing.T) {
require.Equal(t, "hello", log.Output)
}

func TestExecuteCreatesLogPathParents(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitShort)
fLogger := newFakeScriptLogger()
runner := setupWithFilesystem(t, afero.NewOsFs(), t.TempDir(), t.TempDir(), func(uuid.UUID) agentscripts.ScriptLogger {
return fLogger
})
defer runner.Close()

logPath := filepath.Join("nested", "install.log")
aAPI := agenttest.NewFakeAgentAPI(t, testutil.Logger(t), nil, nil)
err := runner.Init([]codersdk.WorkspaceAgentScript{{
LogSourceID: uuid.New(),
LogPath: logPath,
Script: "echo hello",
}}, aAPI.ScriptCompleted)
require.NoError(t, err)
require.NoError(t, runner.Execute(context.Background(), agentscripts.ExecuteAllScripts))

log := testutil.TryReceive(ctx, t, fLogger.logs)
require.Equal(t, "hello", log.Output)

_, err = runner.Filesystem.Stat(filepath.Join(runner.LogDir, logPath))
require.NoError(t, err)
}

func TestEnv(t *testing.T) {
t.Parallel()
fLogger := newFakeScriptLogger()
Expand Down Expand Up @@ -298,23 +324,33 @@ func (*executeOptionTestLogger) Flush(context.Context) error {
}

func setup(t *testing.T, getScriptLogger func(logSourceID uuid.UUID) agentscripts.ScriptLogger) *agentscripts.Runner {
t.Helper()
return setupWithFilesystem(t, afero.NewMemMapFs(), t.TempDir(), t.TempDir(), getScriptLogger)
}

func setupWithFilesystem(
t *testing.T,
fs afero.Fs,
logDir string,
dataDirBase string,
getScriptLogger func(logSourceID uuid.UUID) agentscripts.ScriptLogger,
) *agentscripts.Runner {
t.Helper()
if getScriptLogger == nil {
// noop
getScriptLogger = func(uuid.UUID) agentscripts.ScriptLogger {
return noopScriptLogger{}
}
}
fs := afero.NewMemMapFs()
logger := testutil.Logger(t)
s, err := agentssh.NewServer(context.Background(), logger, prometheus.NewRegistry(), fs, agentexec.DefaultExecer, nil)
require.NoError(t, err)
t.Cleanup(func() {
_ = s.Close()
})
return agentscripts.New(agentscripts.Options{
LogDir: t.TempDir(),
DataDirBase: t.TempDir(),
LogDir: logDir,
DataDirBase: dataDirBase,
Logger: logger,
SSHServer: s,
Filesystem: fs,
Expand Down
Loading