mirror of
https://github.com/go-task/task.git
synced 2026-06-23 20:55:52 +00:00
74f5cf8f29
Fixes #647 This allows CI systems that support grouping (such as with [GitHub Actions's `::group::` command](https://docs.github.com/en/actions/learn-github-actions/workflow-commands-for-github-actions#grouping-log-lines) and [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#formatting-commands)) to collapse all of the logs for a single task, to improve readability of logs ## Example The following Taskfile ``` # Taskfile.yml version: 3 output: group: begin: "::group::{{ .TASK }}" end: "::endgroup::" tasks: default: cmds: - "echo 'Hello, World!'" ``` Results in the following output ```bash $ task task: [default] echo 'Hello, World!' ::group::default Hello, World! ::endgroup:: ``` See [this GitHub Actions job](https://github.com/janslow/task/runs/4811059609?check_suite_focus=true) for a full example <img width="771" alt="image" src="https://user-images.githubusercontent.com/1253367/149429832-6cb0c1b5-0758-442e-9375-c4daa65771bc.png"> <img width="394" alt="image" src="https://user-images.githubusercontent.com/1253367/149429851-1d5d2ab5-9095-4795-9b57-f91750720d40.png">
99 lines
2.4 KiB
Go
99 lines
2.4 KiB
Go
package output_test
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/go-task/task/v3/internal/templater"
|
|
"github.com/go-task/task/v3/taskfile"
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"github.com/go-task/task/v3/internal/output"
|
|
)
|
|
|
|
func TestInterleaved(t *testing.T) {
|
|
var b bytes.Buffer
|
|
var o output.Output = output.Interleaved{}
|
|
var w = o.WrapWriter(&b, "", nil)
|
|
|
|
fmt.Fprintln(w, "foo\nbar")
|
|
assert.Equal(t, "foo\nbar\n", b.String())
|
|
fmt.Fprintln(w, "baz")
|
|
assert.Equal(t, "foo\nbar\nbaz\n", b.String())
|
|
}
|
|
|
|
func TestGroup(t *testing.T) {
|
|
var b bytes.Buffer
|
|
var o output.Output = output.Group{}
|
|
var w = o.WrapWriter(&b, "", nil).(io.WriteCloser)
|
|
|
|
fmt.Fprintln(w, "foo\nbar")
|
|
assert.Equal(t, "", b.String())
|
|
fmt.Fprintln(w, "baz")
|
|
assert.Equal(t, "", b.String())
|
|
assert.NoError(t, w.Close())
|
|
assert.Equal(t, "foo\nbar\nbaz\n", b.String())
|
|
}
|
|
|
|
func TestGroupWithBeginEnd(t *testing.T) {
|
|
tmpl := templater.Templater{
|
|
Vars: &taskfile.Vars{
|
|
Keys: []string{"VAR1"},
|
|
Mapping: map[string]taskfile.Var{
|
|
"VAR1": {Static: "example-value"},
|
|
},
|
|
},
|
|
}
|
|
|
|
var o output.Output = output.Group{
|
|
Begin: "::group::{{ .VAR1 }}",
|
|
End: "::endgroup::",
|
|
}
|
|
t.Run("simple", func(t *testing.T) {
|
|
var b bytes.Buffer
|
|
var w = o.WrapWriter(&b, "", &tmpl).(io.WriteCloser)
|
|
|
|
fmt.Fprintln(w, "foo\nbar")
|
|
assert.Equal(t, "", b.String())
|
|
fmt.Fprintln(w, "baz")
|
|
assert.Equal(t, "", b.String())
|
|
assert.NoError(t, w.Close())
|
|
assert.Equal(t, "::group::example-value\nfoo\nbar\nbaz\n::endgroup::\n", b.String())
|
|
})
|
|
t.Run("no output", func(t *testing.T) {
|
|
var b bytes.Buffer
|
|
var w = o.WrapWriter(&b, "", &tmpl).(io.WriteCloser)
|
|
assert.NoError(t, w.Close())
|
|
assert.Equal(t, "", b.String())
|
|
})
|
|
}
|
|
|
|
func TestPrefixed(t *testing.T) {
|
|
var b bytes.Buffer
|
|
var o output.Output = output.Prefixed{}
|
|
var w = o.WrapWriter(&b, "prefix", nil).(io.WriteCloser)
|
|
|
|
t.Run("simple use cases", func(t *testing.T) {
|
|
b.Reset()
|
|
|
|
fmt.Fprintln(w, "foo\nbar")
|
|
assert.Equal(t, "[prefix] foo\n[prefix] bar\n", b.String())
|
|
fmt.Fprintln(w, "baz")
|
|
assert.Equal(t, "[prefix] foo\n[prefix] bar\n[prefix] baz\n", b.String())
|
|
})
|
|
|
|
t.Run("multiple writes for a single line", func(t *testing.T) {
|
|
b.Reset()
|
|
|
|
for _, char := range []string{"T", "e", "s", "t", "!"} {
|
|
fmt.Fprint(w, char)
|
|
assert.Equal(t, "", b.String())
|
|
}
|
|
|
|
assert.NoError(t, w.Close())
|
|
assert.Equal(t, "[prefix] Test!\n", b.String())
|
|
})
|
|
}
|