Pipeline: Add 'Log' operation

This allows arbitrary messages to be logged during pipeline execution

Signed-off-by: Richard Kosegi <richard.kosegi@gmail.com>

Author: rkosegi

pipeline/foreach_op_test.go

@@ -51,6 +51,9 @@ func TestForeachStringItem(t *testing.T) {
 				Program: "sh",
 				Args:    &[]string{"-c", "rm /tmp/a-{{ .forEach }}.yaml"},
 			},
+			Log: &LogOp{
+				Message: "Hi {{ .forEach }}",
+			},
 		},
 	}
 	d := b.Container()

pipeline/log_op.go

@@ -0,0 +1,41 @@
+/*
+Copyright 2024 Richard Kosegi
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package pipeline
+
+import (
+	"fmt"
+)
+
+// LogOp just logs message to logger
+type LogOp struct {
+	Message string `yaml:"message"`
+}
+
+func (lo *LogOp) Do(ctx ActionContext) error {
+	ctx.Logger().Log(ctx.TemplateEngine().RenderLenient(lo.Message, ctx.Snapshot()))
+	return nil
+}
+
+func (lo *LogOp) String() string {
+	return fmt.Sprintf("Log[message=%s]", lo.Message)
+}
+
+func (lo *LogOp) CloneWith(ctx ActionContext) Action {
+	return &LogOp{
+		Message: ctx.TemplateEngine().RenderLenient(lo.Message, ctx.Snapshot()),
+	}
+}

pipeline/log_op_test.go

@@ -0,0 +1,39 @@
+/*
+Copyright 2024 Richard Kosegi
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package pipeline
+
+import (
+	"github.com/rkosegi/yaml-toolkit/dom"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestLogOpDo(t *testing.T) {
+	eo := &LogOp{}
+	assert.NoError(t, eo.Do(mockEmptyActCtx()))
+}
+
+func TestLogOpCloneWith(t *testing.T) {
+	eo := &LogOp{
+		Message: "Output format: {{ .Format }}",
+	}
+	assert.Contains(t, eo.String(), "Log[")
+	d := b.Container()
+	d.AddValue("Format", dom.LeafNode("toml"))
+	eo = eo.CloneWith(mockActCtx(d)).(*LogOp)
+	assert.Equal(t, "Output format: toml", eo.Message)
+}

pipeline/op_spec.go

@@ -46,6 +46,9 @@ type OpSpec struct {
 	// ForEach execute same operation in a loop for every configured item
 	ForEach *ForEachOp `yaml:"forEach,omitempty"`
 
+	// Log logs arbitrary message to logger
+	Log *LogOp `yaml:"log,omitempty"`
+
 	// Abort is able to signal error, so that pipeline can abort execution
 	Abort *AbortOp `yaml:"abort,omitempty"`
 }
@@ -76,6 +79,9 @@ func (as OpSpec) toList() []Action {
 	if as.ForEach != nil {
 		actions = append(actions, as.ForEach)
 	}
+	if as.Log != nil {
+		actions = append(actions, as.Log)
+	}
 	if as.Abort != nil {
 		actions = append(actions, as.Abort)
 	}
@@ -118,6 +124,9 @@ func (as OpSpec) CloneWith(ctx ActionContext) Action {
 	if as.Exec != nil {
 		r.Exec = as.Exec.CloneWith(ctx).(*ExecOp)
 	}
+	if as.Log != nil {
+		r.Log = as.Log.CloneWith(ctx).(*LogOp)
+	}
 	if as.Abort != nil {
 		r.Abort = as.Abort.CloneWith(ctx).(*AbortOp)
 	}
@@ -146,6 +155,9 @@ func (as OpSpec) String() string {
 	if as.Import != nil {
 		parts = append(parts, fmt.Sprintf("Import=%v", as.Import.String()))
 	}
+	if as.Log != nil {
+		parts = append(parts, fmt.Sprintf("Log=%v", as.Log.String()))
+	}
 	if as.Patch != nil {
 		parts = append(parts, fmt.Sprintf("Patch=%v", as.Patch.String()))
 	}

pipeline/op_spec_test.go

@@ -54,6 +54,9 @@ func TestOpSpecCloneWith(t *testing.T) {
 			Path:   "{{ .Path }}",
 			Format: OutputFormatYaml,
 		},
+		Log: &LogOp{
+			Message: "Path: {{ .Path }}",
+		},
 		Abort: &AbortOp{
 			Message: "abort",
 		},