Skip to content

Commit

Permalink
Pipeline: Add 'Log' operation
Browse files Browse the repository at this point in the history
This allows arbitrary messages to be logged during pipeline execution
  • Loading branch information
rkosegi committed Aug 13, 2024
1 parent 3803ae8 commit e80da16
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
41 changes: 41 additions & 0 deletions pipeline/log_op.go
Original file line number Diff line number Diff line change
@@ -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()),
}
}
39 changes: 39 additions & 0 deletions pipeline/log_op_test.go
Original file line number Diff line number Diff line change
@@ -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)
}

0 comments on commit e80da16

Please sign in to comment.