Refactor pipeline engine

agent/logger.go

@@ -23,11 +23,12 @@ import (
 	"go.woodpecker-ci.org/woodpecker/v3/agent/log"
 	"go.woodpecker-ci.org/woodpecker/v3/pipeline"
 	backend "go.woodpecker-ci.org/woodpecker/v3/pipeline/backend/types"
+	"go.woodpecker-ci.org/woodpecker/v3/pipeline/logging"
 	pipeline_utils "go.woodpecker-ci.org/woodpecker/v3/pipeline/utils"
 	"go.woodpecker-ci.org/woodpecker/v3/rpc"
 )
 
-func (r *Runner) createLogger(_logger zerolog.Logger, uploads *sync.WaitGroup, workflow *rpc.Workflow) pipeline.Logger {
+func (r *Runner) createLogger(_logger zerolog.Logger, uploads *sync.WaitGroup, workflow *rpc.Workflow) logging.Logger {
 	return func(step *backend.Step, rc io.ReadCloser) error {
 		defer rc.Close()
 

agent/runner.go

@@ -25,8 +25,9 @@ import (
 	"github.com/rs/zerolog/log"
 	"google.golang.org/grpc/metadata"
 
-	"go.woodpecker-ci.org/woodpecker/v3/pipeline"
 	backend "go.woodpecker-ci.org/woodpecker/v3/pipeline/backend/types"
+	pipeline_errors "go.woodpecker-ci.org/woodpecker/v3/pipeline/errors"
+	pipeline_runtime "go.woodpecker-ci.org/woodpecker/v3/pipeline/runtime"
 	"go.woodpecker-ci.org/woodpecker/v3/rpc"
 	"go.woodpecker-ci.org/woodpecker/v3/shared/constant"
 	"go.woodpecker-ci.org/woodpecker/v3/shared/utils"
@@ -99,7 +100,7 @@ func (r *Runner) Run(runnerCtx, shutdownCtx context.Context) error {
 	workflowCtx = utils.WithContextSigtermCallback(workflowCtx, func() {
 		logger.Error().Msg("received sigterm termination signal")
 		// WithContextSigtermCallback would cancel the context too, but  we want our own custom error
-		cancelWorkflowCtx(pipeline.ErrCancel)
+		cancelWorkflowCtx(pipeline_errors.ErrCancel)
 	})
 
 	// Listen for remote cancel events (UI / API).
@@ -114,7 +115,7 @@ func (r *Runner) Run(runnerCtx, shutdownCtx context.Context) error {
 		} else {
 			if canceled {
 				logger.Debug().Err(err).Msg("server side cancel signal received")
-				cancelWorkflowCtx(pipeline.ErrCancel)
+				cancelWorkflowCtx(pipeline_errors.ErrCancel)
 			}
 			// Wait returned without error, meaning the workflow finished normally
 			logger.Debug().Msg("cancel listener exited normally")
@@ -153,14 +154,14 @@ func (r *Runner) Run(runnerCtx, shutdownCtx context.Context) error {
 	var uploads sync.WaitGroup
 
 	// Run pipeline
-	err = pipeline.New(
+	err = pipeline_runtime.New(
 		workflow.Config,
-		pipeline.WithContext(workflowCtx),
-		pipeline.WithTaskUUID(fmt.Sprint(workflow.ID)),
-		pipeline.WithLogger(r.createLogger(logger, &uploads, workflow)),
-		pipeline.WithTracer(r.createTracer(ctxMeta, &uploads, logger, workflow)),
-		pipeline.WithBackend(*r.backend),
-		pipeline.WithDescription(map[string]string{
+		pipeline_runtime.WithContext(workflowCtx),
+		pipeline_runtime.WithTaskUUID(fmt.Sprint(workflow.ID)),
+		pipeline_runtime.WithLogger(r.createLogger(logger, &uploads, workflow)),
+		pipeline_runtime.WithTracer(r.createTracer(ctxMeta, &uploads, logger, workflow)),
+		pipeline_runtime.WithBackend(*r.backend),
+		pipeline_runtime.WithDescription(map[string]string{
 			"workflow_id":     workflow.ID,
 			"repo":            repoName,
 			"pipeline_number": pipelineNumber,
@@ -171,10 +172,10 @@ func (r *Runner) Run(runnerCtx, shutdownCtx context.Context) error {
 
 	if err != nil {
 		state.Error = err.Error()
-		if errors.Is(err, pipeline.ErrCancel) {
+		if errors.Is(err, pipeline_errors.ErrCancel) {
 			state.Canceled = true
 			// cleanup joined error messages
-			state.Error = pipeline.ErrCancel.Error()
+			state.Error = pipeline_errors.ErrCancel.Error()
 		}
 	}
 

agent/tracer.go

@@ -24,12 +24,14 @@ import (
 
 	"github.com/rs/zerolog"
 
-	"go.woodpecker-ci.org/woodpecker/v3/pipeline"
+	pipeline_errors "go.woodpecker-ci.org/woodpecker/v3/pipeline/errors"
+	"go.woodpecker-ci.org/woodpecker/v3/pipeline/state"
+	"go.woodpecker-ci.org/woodpecker/v3/pipeline/tracing"
 	"go.woodpecker-ci.org/woodpecker/v3/rpc"
 )
 
-func (r *Runner) createTracer(ctxMeta context.Context, uploads *sync.WaitGroup, logger zerolog.Logger, workflow *rpc.Workflow) pipeline.TraceFunc {
-	return func(state *pipeline.State) error {
+func (r *Runner) createTracer(ctxMeta context.Context, uploads *sync.WaitGroup, logger zerolog.Logger, workflow *rpc.Workflow) tracing.TraceFunc {
+	return func(state *state.State) error {
 		uploads.Add(1)
 		defer uploads.Done()
 
@@ -46,7 +48,7 @@ func (r *Runner) createTracer(ctxMeta context.Context, uploads *sync.WaitGroup,
 			Exited:   state.Process.Exited,
 			ExitCode: state.Process.ExitCode,
 			Started:  state.Process.Started,
-			Canceled: errors.Is(state.Process.Error, pipeline.ErrCancel),
+			Canceled: errors.Is(state.Process.Error, pipeline_errors.ErrCancel),
 		}
 		if state.Process.Error != nil {
 			stepState.Error = state.Process.Error.Error()

cli/exec/exec.go

@@ -45,6 +45,9 @@ import (
 	"go.woodpecker-ci.org/woodpecker/v3/pipeline/frontend/yaml/compiler"
 	"go.woodpecker-ci.org/woodpecker/v3/pipeline/frontend/yaml/linter"
 	"go.woodpecker-ci.org/woodpecker/v3/pipeline/frontend/yaml/matrix"
+	"go.woodpecker-ci.org/woodpecker/v3/pipeline/logging"
+	pipeline_runtime "go.woodpecker-ci.org/woodpecker/v3/pipeline/runtime"
+	"go.woodpecker-ci.org/woodpecker/v3/pipeline/tracing"
 	pipeline_utils "go.woodpecker-ci.org/woodpecker/v3/pipeline/utils"
 	"go.woodpecker-ci.org/woodpecker/v3/shared/constant"
 	"go.woodpecker-ci.org/woodpecker/v3/shared/utils"
@@ -318,12 +321,12 @@ func execWithAxis(ctx context.Context, c *cli.Command, file, repoPath string, ax
 		fmt.Printf("ctrl+c received, terminating current pipeline '%s'\n", confStr)
 	})
 
-	return pipeline.New(compiled,
-		pipeline.WithContext(pipelineCtx), //nolint:contextcheck
-		pipeline.WithTracer(pipeline.DefaultTracer),
-		pipeline.WithLogger(defaultLogger),
-		pipeline.WithBackend(backendEngine),
-		pipeline.WithDescription(map[string]string{
+	return pipeline_runtime.New(compiled,
+		pipeline_runtime.WithContext(pipelineCtx), //nolint:contextcheck
+		pipeline_runtime.WithTracer(tracing.DefaultTracer),
+		pipeline_runtime.WithLogger(defaultLogger),
+		pipeline_runtime.WithBackend(backendEngine),
+		pipeline_runtime.WithDescription(map[string]string{
 			"CLI": "exec",
 		}),
 	).Run(ctx)
@@ -348,7 +351,7 @@ func convertPathForWindows(path string) string {
 	return filepath.ToSlash(path)
 }
 
-var defaultLogger = pipeline.Logger(func(step *backend_types.Step, rc io.ReadCloser) error {
+var defaultLogger = logging.Logger(func(step *backend_types.Step, rc io.ReadCloser) error {
 	logWriter := NewLineWriter(step.Name, step.UUID)
 	return pipeline_utils.CopyLineByLine(logWriter, rc, pipeline.MaxLogLineLength)
 })

cmd/server/openapi/docs.go

@@ -5017,7 +5017,7 @@ const docTemplate = `{
                 "errors": {
                     "type": "array",
                     "items": {
-                        "$ref": "#/definitions/types.PipelineError"
+                        "$ref": "#/definitions/errors.PipelineError"
                     }
                 },
                 "event": {
@@ -5736,6 +5736,52 @@ const docTemplate = `{
                 "EventManual"
             ]
         },
+        "errors.PipelineError": {
+            "type": "object",
+            "properties": {
+                "data": {},
+                "is_warning": {
+                    "type": "boolean"
+                },
+                "message": {
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/errors.PipelineErrorType"
+                }
+            }
+        },
+        "errors.PipelineErrorType": {
+            "type": "string",
+            "enum": [
+                "linter",
+                "deprecation",
+                "compiler",
+                "generic",
+                "bad_habit"
+            ],
+            "x-enum-comments": {
+                "PipelineErrorTypeBadHabit": "some bad-habit error",
+                "PipelineErrorTypeCompiler": "some error with the config semantics",
+                "PipelineErrorTypeDeprecation": "using some deprecated feature",
+                "PipelineErrorTypeGeneric": "some generic error",
+                "PipelineErrorTypeLinter": "some error with the config syntax"
+            },
+            "x-enum-descriptions": [
+                "some error with the config syntax",
+                "using some deprecated feature",
+                "some error with the config semantics",
+                "some generic error",
+                "some bad-habit error"
+            ],
+            "x-enum-varnames": [
+                "PipelineErrorTypeLinter",
+                "PipelineErrorTypeDeprecation",
+                "PipelineErrorTypeCompiler",
+                "PipelineErrorTypeGeneric",
+                "PipelineErrorTypeBadHabit"
+            ]
+        },
         "metadata.Author": {
             "type": "object",
             "properties": {
@@ -6156,52 +6202,6 @@ const docTemplate = `{
                     "$ref": "#/definitions/StatusValue"
                 }
             }
-        },
-        "types.PipelineError": {
-            "type": "object",
-            "properties": {
-                "data": {},
-                "is_warning": {
-                    "type": "boolean"
-                },
-                "message": {
-                    "type": "string"
-                },
-                "type": {
-                    "$ref": "#/definitions/types.PipelineErrorType"
-                }
-            }
-        },
-        "types.PipelineErrorType": {
-            "type": "string",
-            "enum": [
-                "linter",
-                "deprecation",
-                "compiler",
-                "generic",
-                "bad_habit"
-            ],
-            "x-enum-comments": {
-                "PipelineErrorTypeBadHabit": "some bad-habit error",
-                "PipelineErrorTypeCompiler": "some error with the config semantics",
-                "PipelineErrorTypeDeprecation": "using some deprecated feature",
-                "PipelineErrorTypeGeneric": "some generic error",
-                "PipelineErrorTypeLinter": "some error with the config syntax"
-            },
-            "x-enum-descriptions": [
-                "some error with the config syntax",
-                "using some deprecated feature",
-                "some error with the config semantics",
-                "some generic error",
-                "some bad-habit error"
-            ],
-            "x-enum-varnames": [
-                "PipelineErrorTypeLinter",
-                "PipelineErrorTypeDeprecation",
-                "PipelineErrorTypeCompiler",
-                "PipelineErrorTypeGeneric",
-                "PipelineErrorTypeBadHabit"
-            ]
         }
     }
 }`