Cli fix pipeline logs

cli/internal/util.go

@@ -161,3 +161,40 @@ func ParseKeyPair(p []string) map[string]string {
 	}
 	return params
 }
+
+/*
+ParseStep parses the step id form a string which may eigher be the step PID (step number) or a step name.
+These rules apply:
+
+  - Step PID take precedence over step name when searching for a match.
+  - First match is used, when there are multiple steps with the same name.
+
+Strictly speaking, this is not parsing, but a lookup.
+*/
+func ParseStep(client woodpecker.Client, repoID, number int64, stepArg string) (stepID int64, err error) {
+	pipeline, err := client.Pipeline(repoID, number)
+	if err != nil {
+		return 0, err
+	}
+
+	stepPID, err := strconv.ParseInt(stepArg, 10, 64)
+	if err == nil {
+		for _, wf := range pipeline.Workflows {
+			for _, step := range wf.Children {
+				if int64(step.PID) == stepPID {
+					return step.ID, nil
+				}
+			}
+		}
+	}
+
+	for _, wf := range pipeline.Workflows {
+		for _, step := range wf.Children {
+			if step.Name == stepArg {
+				return step.ID, nil
+			}
+		}
+	}
+
+	return 0, fmt.Errorf("no step with number or name '%s' found", stepArg)
+}

cli/pipeline/logs.go

@@ -16,17 +16,20 @@ package pipeline
 
 import (
 	"fmt"
+	"os"
 	"strconv"
+	"text/template"
 
 	"github.com/urfave/cli/v2"
 
 	"go.woodpecker-ci.org/woodpecker/v2/cli/internal"
+	"go.woodpecker-ci.org/woodpecker/v2/woodpecker-go/woodpecker"
 )
 
 var pipelineLogsCmd = &cli.Command{
 	Name:      "logs",
 	Usage:     "show pipeline logs",
-	ArgsUsage: "<repo-id|repo-full-name> [pipeline] [stepID]",
+	ArgsUsage: "<repo-id|repo-full-name> <pipeline> [step-number|step-name]",
 	Action:    pipelineLogs,
 }
 
@@ -36,31 +39,73 @@ func pipelineLogs(c *cli.Context) error {
 	if err != nil {
 		return err
 	}
+	if len(repoIDOrFullName) == 0 {
+		return fmt.Errorf("missing required argument repo-id / repo-full-name")
+	}
 	repoID, err := internal.ParseRepo(client, repoIDOrFullName)
 	if err != nil {
-		return err
+		return fmt.Errorf("invalid repo '%s': %w ", repoIDOrFullName, err)
+	}
+
+	pipelineArg := c.Args().Get(1)
+	if len(pipelineArg) == 0 {
+		return fmt.Errorf("missing required argument pipeline")
+	}
+	number, err := strconv.ParseInt(pipelineArg, 10, 64)
+	if err != nil {
+		return fmt.Errorf("invalid pipeline '%s': %w", pipelineArg, err)
+	}
+
+	stepArg := c.Args().Get(2)
+	if len(stepArg) == 0 {
+		return showPipelineLog(client, repoID, number)
+	}
+
+	step, err := internal.ParseStep(client, repoID, number, stepArg)
+	if err != nil {
+		return fmt.Errorf("invalid step '%s': %w", stepArg, err)
 	}
+	return showStepLog(client, repoID, number, step)
+}
 
-	numberArgIndex := 1
-	number, err := strconv.ParseInt(c.Args().Get(numberArgIndex), 10, 64)
+func showPipelineLog(client woodpecker.Client, repoID, number int64) error {
+	pipeline, err := client.Pipeline(repoID, number)
 	if err != nil {
 		return err
 	}
 
-	stepArgIndex := 2
-	step, err := strconv.ParseInt(c.Args().Get(stepArgIndex), 10, 64)
+	tmpl, err := template.New("_").Parse(tmplPipelineLogs + "\n")
 	if err != nil {
 		return err
 	}
 
+	for _, workflow := range pipeline.Workflows {
+		for _, step := range workflow.Children {
+			if err := tmpl.Execute(os.Stdout, workflowStep{workflow, step}); err != nil {
+				return err
+			}
+			err := showStepLog(client, repoID, number, step.ID)
+			if err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}
+
+func showStepLog(client woodpecker.Client, repoID, number, step int64) error {
 	logs, err := client.StepLogEntries(repoID, number, step)
 	if err != nil {
 		return err
 	}
 
 	for _, log := range logs {
-		fmt.Print(string(log.Data))
+		fmt.Println(string(log.Data))
 	}
 
 	return nil
 }
+
+// template for pipeline ps information
+var tmplPipelineLogs = "\x1b[33m{{ .Workflow.Name }} > {{ .Step.Name }} (#{{ .Step.PID }}):\x1b[0m"

cli/pipeline/ps.go

@@ -15,6 +15,7 @@
 package pipeline
 
 import (
+	"fmt"
 	"os"
 	"strconv"
 	"text/template"
@@ -23,12 +24,18 @@ import (
 
 	"go.woodpecker-ci.org/woodpecker/v2/cli/common"
 	"go.woodpecker-ci.org/woodpecker/v2/cli/internal"
+	"go.woodpecker-ci.org/woodpecker/v2/woodpecker-go/woodpecker"
 )
 
+type workflowStep struct {
+	Workflow *woodpecker.Workflow
+	Step     *woodpecker.Step
+}
+
 var pipelinePsCmd = &cli.Command{
 	Name:      "ps",
 	Usage:     "show pipeline steps",
-	ArgsUsage: "<repo-id|repo-full-name> [pipeline]",
+	ArgsUsage: "<repo-id|repo-full-name> <pipeline>",
 	Action:    pipelinePs,
 	Flags:     []cli.Flag{common.FormatFlag(tmplPipelinePs)},
 }
@@ -41,7 +48,7 @@ func pipelinePs(c *cli.Context) error {
 	}
 	repoID, err := internal.ParseRepo(client, repoIDOrFullName)
 	if err != nil {
-		return err
+		return fmt.Errorf("invalid repo '%s': %w", repoIDOrFullName, err)
 	}
 
 	pipelineArg := c.Args().Get(1)
@@ -58,7 +65,7 @@ func pipelinePs(c *cli.Context) error {
 	} else {
 		number, err = strconv.ParseInt(pipelineArg, 10, 64)
 		if err != nil {
-			return err
+			return fmt.Errorf("invalid pipeline '%s': %w", pipelineArg, err)
 		}
 	}
 
@@ -72,9 +79,9 @@ func pipelinePs(c *cli.Context) error {
 		return err
 	}
 
-	for _, step := range pipeline.Workflows {
-		for _, child := range step.Children {
-			if err := tmpl.Execute(os.Stdout, child); err != nil {
+	for _, workflow := range pipeline.Workflows {
+		for _, step := range workflow.Children {
+			if err := tmpl.Execute(os.Stdout, workflowStep{workflow, step}); err != nil {
 				return err
 			}
 		}
@@ -83,8 +90,11 @@ func pipelinePs(c *cli.Context) error {
 	return nil
 }
 
-// Template for pipeline ps information.
-var tmplPipelinePs = "\x1b[33mStep #{{ .PID }} \x1b[0m" + `
-Step: {{ .Name }}
-State: {{ .State }}
+// template for pipeline ps information
+var tmplPipelinePs = "\x1b[33m{{ .Workflow.Name }} > {{ .Step.Name }} (#{{ .Step.PID }}):\x1b[0m" + `
+Step: {{ .Step.Name }}
+Started: {{ .Step.Started }}
+Stopped: {{ .Step.Stopped }}
+Type: {{ .Step.Type }}
+State: {{ .Step.State }}
 `