diff --git a/pkg/runner/command.go b/pkg/runner/command.go index 75e9b8a..f230cac 100644 --- a/pkg/runner/command.go +++ b/pkg/runner/command.go @@ -6,6 +6,8 @@ import ( "strings" "github.com/nektos/act/pkg/common" + + "github.com/sirupsen/logrus" ) var commandPatternGA *regexp.Regexp @@ -41,11 +43,12 @@ func (rc *RunContext) commandHandler(ctx context.Context) common.LineHandler { } if resumeCommand != "" && command != resumeCommand { - logger.Infof(" \U00002699 %s", line) + logger.WithFields(logrus.Fields{"command": "ignored", "raw": line}).Infof(" \U00002699 %s", line) return false } arg = unescapeCommandData(arg) kvPairs = unescapeKvPairs(kvPairs) + defCommandLogger := logger.WithFields(logrus.Fields{"command": command, "kvPairs": kvPairs, "arg": arg, "raw": line}) switch command { case "set-env": rc.setEnv(ctx, kvPairs, arg) @@ -54,27 +57,27 @@ func (rc *RunContext) commandHandler(ctx context.Context) common.LineHandler { case "add-path": rc.addPath(ctx, arg) case "debug": - logger.Debugf(" \U0001F4AC %s", line) + defCommandLogger.Debugf(" \U0001F4AC %s", line) case "warning": - logger.Warnf(" \U0001F6A7 %s", line) + defCommandLogger.Warnf(" \U0001F6A7 %s", line) case "error": - logger.Errorf(" \U00002757 %s", line) + defCommandLogger.Errorf(" \U00002757 %s", line) case "add-mask": rc.AddMask(arg) - logger.Infof(" \U00002699 %s", "***") + defCommandLogger.Infof(" \U00002699 %s", "***") case "stop-commands": resumeCommand = arg - logger.Infof(" \U00002699 %s", line) + defCommandLogger.Infof(" \U00002699 %s", line) case resumeCommand: resumeCommand = "" - logger.Infof(" \U00002699 %s", line) + defCommandLogger.Infof(" \U00002699 %s", line) case "save-state": - logger.Infof(" \U0001f4be %s", line) + defCommandLogger.Infof(" \U0001f4be %s", line) rc.saveState(ctx, kvPairs, arg) case "add-matcher": - logger.Infof(" \U00002753 add-matcher %s", arg) + defCommandLogger.Infof(" \U00002753 add-matcher %s", arg) default: - logger.Infof(" \U00002753 %s", line) + defCommandLogger.Infof(" \U00002753 %s", line) } return false @@ -83,7 +86,7 @@ func (rc *RunContext) commandHandler(ctx context.Context) common.LineHandler { func (rc *RunContext) setEnv(ctx context.Context, kvPairs map[string]string, arg string) { name := kvPairs["name"] - common.Logger(ctx).Infof(" \U00002699 ::set-env:: %s=%s", name, arg) + common.Logger(ctx).WithFields(logrus.Fields{"command": "set-env", "name": name, "arg": arg}).Infof(" \U00002699 ::set-env:: %s=%s", name, arg) if rc.Env == nil { rc.Env = make(map[string]string) } @@ -115,11 +118,11 @@ func (rc *RunContext) setOutput(ctx context.Context, kvPairs map[string]string, return } - logger.Infof(" \U00002699 ::set-output:: %s=%s", outputName, arg) + logger.WithFields(logrus.Fields{"command": "set-output", "name": outputName, "arg": arg}).Infof(" \U00002699 ::set-output:: %s=%s", outputName, arg) result.Outputs[outputName] = arg } func (rc *RunContext) addPath(ctx context.Context, arg string) { - common.Logger(ctx).Infof(" \U00002699 ::add-path:: %s", arg) + common.Logger(ctx).WithFields(logrus.Fields{"command": "add-path", "arg": arg}).Infof(" \U00002699 ::add-path:: %s", arg) extraPath := []string{arg} for _, v := range rc.ExtraPath { if v != arg { diff --git a/pkg/runner/runner_test.go b/pkg/runner/runner_test.go index e34f65e..739086d 100644 --- a/pkg/runner/runner_test.go +++ b/pkg/runner/runner_test.go @@ -318,6 +318,8 @@ func TestRunEvent(t *testing.T) { {workdir, "set-env-step-env-override", "push", "", platforms, secrets}, {workdir, "set-env-new-env-file-per-step", "push", "", platforms, secrets}, {workdir, "no-panic-on-invalid-composite-action", "push", "jobs failed due to invalid action", platforms, secrets}, + // GITHUB_STEP_SUMMARY + {workdir, "stepsummary", "push", "", platforms, secrets}, // services {workdir, "services", "push", "", platforms, secrets}, diff --git a/pkg/runner/step.go b/pkg/runner/step.go index a70dacc..5ee0dbc 100644 --- a/pkg/runner/step.go +++ b/pkg/runner/step.go @@ -1,8 +1,11 @@ package runner import ( + "archive/tar" "context" + "errors" "fmt" + "io" "path" "strconv" "strings" @@ -50,6 +53,32 @@ func (s stepStage) String() string { return "Unknown" } +func processRunnerSummaryCommand(ctx context.Context, fileName string, rc *RunContext) error { + if common.Dryrun(ctx) { + return nil + } + pathTar, err := rc.JobContainer.GetContainerArchive(ctx, path.Join(rc.JobContainer.GetActPath(), fileName)) + if err != nil { + return err + } + defer pathTar.Close() + + reader := tar.NewReader(pathTar) + _, err = reader.Next() + if err != nil && err != io.EOF { + return err + } + summary, err := io.ReadAll(reader) + if err != nil { + return err + } + if len(summary) == 0 { + return nil + } + common.Logger(ctx).WithFields(logrus.Fields{"command": "summary", "content": string(summary)}).Infof(" \U00002699 Summary - %s", string(summary)) + return nil +} + func processRunnerEnvFileCommand(ctx context.Context, fileName string, rc *RunContext, setter func(context.Context, map[string]string, string)) error { env := map[string]string{} err := rc.JobContainer.UpdateFromEnv(path.Join(rc.JobContainer.GetActPath(), fileName), &env)(ctx) @@ -175,27 +204,13 @@ func runStepExecutor(step step, stage stepStage, executor common.Executor) commo logger.WithFields(logrus.Fields{"executionTime": executionTime, "stepResult": stepResult.Outcome}).Infof(" \u274C Failure - %s %s [%s]", stage, stepString, executionTime) } // Process Runner File Commands - orgerr := err - err = processRunnerEnvFileCommand(ctx, envFileCommand, rc, rc.setEnv) - if err != nil { - return err - } - err = processRunnerEnvFileCommand(ctx, stateFileCommand, rc, rc.saveState) - if err != nil { - return err - } - err = processRunnerEnvFileCommand(ctx, outputFileCommand, rc, rc.setOutput) - if err != nil { - return err - } - err = rc.UpdateExtraPath(ctx, path.Join(actPath, pathFileCommand)) - if err != nil { - return err - } - if orgerr != nil { - return orgerr - } - return err + ferrors := []error{err} + ferrors = append(ferrors, processRunnerEnvFileCommand(ctx, envFileCommand, rc, rc.setEnv)) + ferrors = append(ferrors, processRunnerEnvFileCommand(ctx, stateFileCommand, rc, rc.saveState)) + ferrors = append(ferrors, processRunnerEnvFileCommand(ctx, outputFileCommand, rc, rc.setOutput)) + ferrors = append(ferrors, processRunnerSummaryCommand(ctx, summaryFileCommand, rc)) + ferrors = append(ferrors, rc.UpdateExtraPath(ctx, path.Join(actPath, pathFileCommand))) + return errors.Join(ferrors...) } } diff --git a/pkg/runner/step_action_local_test.go b/pkg/runner/step_action_local_test.go index c7b2625..2fe84b0 100644 --- a/pkg/runner/step_action_local_test.go +++ b/pkg/runner/step_action_local_test.go @@ -85,6 +85,7 @@ func TestStepActionLocalTest(t *testing.T) { return nil }) + cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/SUMMARY.md").Return(io.NopCloser(&bytes.Buffer{}), nil) cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/pathcmd.txt").Return(io.NopCloser(&bytes.Buffer{}), nil) salm.On("runAction", sal, filepath.Clean("/tmp/path/to/action"), (*remoteAction)(nil)).Return(func(_ context.Context) error { @@ -281,6 +282,7 @@ func TestStepActionLocalPost(t *testing.T) { return nil }) + cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/SUMMARY.md").Return(io.NopCloser(&bytes.Buffer{}), nil) cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/pathcmd.txt").Return(io.NopCloser(&bytes.Buffer{}), nil) } diff --git a/pkg/runner/step_action_remote_test.go b/pkg/runner/step_action_remote_test.go index a21d244..ac46bee 100644 --- a/pkg/runner/step_action_remote_test.go +++ b/pkg/runner/step_action_remote_test.go @@ -187,6 +187,7 @@ func TestStepActionRemote(t *testing.T) { return nil }) + cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/SUMMARY.md").Return(io.NopCloser(&bytes.Buffer{}), nil) cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/pathcmd.txt").Return(io.NopCloser(&bytes.Buffer{}), nil) } @@ -195,9 +196,9 @@ func TestStepActionRemote(t *testing.T) { err = sar.main()(ctx) } - assert.Equal(t, tt.runError, err) + assert.ErrorIs(t, err, tt.runError) assert.Equal(t, tt.mocks.cloned, clonedAction) - assert.Equal(t, tt.result, sar.RunContext.StepResults["step"]) + assert.Equal(t, sar.RunContext.StepResults["step"], tt.result) sarm.AssertExpectations(t) cm.AssertExpectations(t) @@ -599,6 +600,7 @@ func TestStepActionRemotePost(t *testing.T) { return nil }) + cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/SUMMARY.md").Return(io.NopCloser(&bytes.Buffer{}), nil) cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/pathcmd.txt").Return(io.NopCloser(&bytes.Buffer{}), nil) } diff --git a/pkg/runner/step_docker_test.go b/pkg/runner/step_docker_test.go index 8753af5..7be62a9 100644 --- a/pkg/runner/step_docker_test.go +++ b/pkg/runner/step_docker_test.go @@ -93,6 +93,7 @@ func TestStepDockerMain(t *testing.T) { return nil }) + cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/SUMMARY.md").Return(io.NopCloser(&bytes.Buffer{}), nil) cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/pathcmd.txt").Return(io.NopCloser(&bytes.Buffer{}), nil) err := sd.main()(ctx) diff --git a/pkg/runner/step_run_test.go b/pkg/runner/step_run_test.go index 151c7ab..d49ac69 100644 --- a/pkg/runner/step_run_test.go +++ b/pkg/runner/step_run_test.go @@ -74,6 +74,7 @@ func TestStepRun(t *testing.T) { ctx := context.Background() + cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/SUMMARY.md").Return(io.NopCloser(&bytes.Buffer{}), nil) cm.On("GetContainerArchive", ctx, "/var/run/act/workflow/pathcmd.txt").Return(io.NopCloser(&bytes.Buffer{}), nil) err := sr.main()(ctx) diff --git a/pkg/runner/testdata/stepsummary/push.yml b/pkg/runner/testdata/stepsummary/push.yml new file mode 100644 index 0000000..42b78d1 --- /dev/null +++ b/pkg/runner/testdata/stepsummary/push.yml @@ -0,0 +1,27 @@ +name: Step Summary Example + +on: [push] + +jobs: + create_summary: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + # GITHUB_STEP_SUMMARY test + - name: Create Step Summary + uses: actions/github-script@v7 + with: + script: | + const summary = ` + ## Workflow Summary + - **Repository**: ${context.repo.owner}/${context.repo.repo} + - **Branch**: ${context.ref} + - **Commit SHA**: ${context.sha} + - **Event**: ${context.eventName} + `; + console.log('Summary:', summary); + await core.summary.addRaw(summary); + await core.summary.write(); + github-token: none