Skip to content

output: always return data in String even with error #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhchabran merged 2 commits into from
Jun 1, 2022
Merged

output: always return data in String even with error #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d133aab
output: always return data in String even with error
bobheadxi Jun 1, 2022
7a44ebb
test error scenario
bobheadxi Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 41 additions & 18 deletions command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ import (
"github.com/sourcegraph/run"
)

var outputTests = []func(c *qt.C, out run.Output, expect string){
func(c *qt.C, out run.Output, expect string) {
var outputTests = []func(c *qt.C, out run.Output, expect string, expectError bool){
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("Stream", func(c *qt.C) {
var b bytes.Buffer
err := out.Stream(&b)
c.Assert(err, qt.IsNil)
c.Assert(b.String(), qt.Equals, fmt.Sprintf("%s\n", expect))
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("StreamLines", func(c *qt.C) {
linesC := make(chan []byte, 10)
err := out.StreamLines(func(line []byte) {
Expand All @@ -39,30 +39,40 @@ var outputTests = []func(c *qt.C, out run.Output, expect string){
c.Assert(string(lines[0]), qt.Equals, expect)
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("Lines", func(c *qt.C) {
lines, err := out.Lines()
c.Assert(err, qt.IsNil)
if !expectError {
c.Assert(err, qt.IsNil)
}
c.Assert(len(lines), qt.Equals, 1)
c.Assert(lines[0], qt.Equals, expect)
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("String", func(c *qt.C) {
str, err := out.String()
c.Assert(err, qt.IsNil)
if !expectError {
c.Assert(err, qt.IsNil)
}
c.Assert(str, qt.Equals, expect)
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("Read: fixed bytes", func(c *qt.C) {
b := make([]byte, 100)
n, err := out.Read(b)
c.Assert(err, qt.IsNil)
if !expectError {
c.Assert(err, qt.IsNil)
}
c.Assert(string(b[0:n]), qt.Equals, fmt.Sprintf("%s\n", expect))
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
if expectError {
return // not applicable
}

c.Run("Read: exactly length of output", func(c *qt.C) {
// Read exactly the amount of output
b := make([]byte, len(expect)+1)
Expand All @@ -76,17 +86,21 @@ var outputTests = []func(c *qt.C, out run.Output, expect string){
c.Assert(err, qt.Equals, io.EOF)
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("Read: io.ReadAll", func(c *qt.C) {
b, err := io.ReadAll(out)
c.Assert(err, qt.IsNil)
if !expectError {
c.Assert(err, qt.IsNil)
}
c.Assert(string(b), qt.Equals, fmt.Sprintf("%s\n", expect))
})
},
func(c *qt.C, out run.Output, expect string) {
func(c *qt.C, out run.Output, expect string, expectError bool) {
c.Run("Wait", func(c *qt.C) {
err := out.Wait()
c.Assert(err, qt.IsNil)
if !expectError {
c.Assert(err, qt.IsNil)
}
})
},
}
Expand All @@ -98,9 +112,10 @@ func TestRunAndAggregate(t *testing.T) {
command := `echo "hello world"`

type testCase struct {
name string
output func() run.Output
expect string
name string
output func() run.Output
expect string
expectError bool
}
for _, tc := range []testCase{
{
Expand All @@ -110,6 +125,14 @@ func TestRunAndAggregate(t *testing.T) {
},
expect: "hello world",
},
{
name: "plain output and exit with error",
output: func() run.Output {
return run.Cmd(ctx, command, "; exit 1").Run()
},
expect: "hello world ; exit 1",
expectError: true,
},
{
name: "mapped output",
output: func() run.Output {
Expand All @@ -136,7 +159,7 @@ func TestRunAndAggregate(t *testing.T) {
} {
c.Run(tc.name, func(c *qt.C) {
for _, test := range outputTests {
test(c, tc.output(), tc.expect)
test(c, tc.output(), tc.expect, tc.expectError)
}
})
}
Expand Down
5 changes: 4 additions & 1 deletion output.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ type Output interface {
//
// It only handles piping output and configuration - aggregation is handled by the embedded
// aggregator.
//
// All aggregation functions should take care that all output collected is returned,
// regardless of whether read operations return errors.
type commandOutput struct {
ctx context.Context

Expand Down Expand Up @@ -186,7 +189,7 @@ func (o *commandOutput) JQ(query string) ([]byte, error) {
func (o *commandOutput) String() (string, error) {
var sb strings.Builder
if err := o.Stream(&sb); err != nil {
return "", err
return sb.String(), err
}
return strings.TrimSuffix(sb.String(), "\n"), nil
}
Expand Down