Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Fixed #102, a message formatting bug. #114

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fixed #102, a message formatting bug. #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a77ef41
Fixed #102, a message formatting bug.
mrhwick May 4, 2017
d0d25f6
Merge branch 'master' into message-formatting
mrhwick Apr 17, 2019
8125352
Fix the format tests that require a specific line number
mrhwick Apr 17, 2019
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
29 changes: 19 additions & 10 deletions errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,9 @@ func Wrap(err error, message string) error {
return nil
}
err = &withMessage{
cause: err,
msg: message,
cause: err,
msg: message,
stackedOnWithStack: true,
}
return &withStack{
err,
Expand All @@ -200,8 +201,9 @@ func Wrapf(err error, format string, args ...interface{}) error {
return nil
}
err = &withMessage{
cause: err,
msg: fmt.Sprintf(format, args...),
cause: err,
msg: fmt.Sprintf(format, args...),
stackedOnWithStack: true,
}
return &withStack{
err,
Expand All @@ -216,8 +218,9 @@ func WithMessage(err error, message string) error {
return nil
}
return &withMessage{
cause: err,
msg: message,
cause: err,
msg: message,
stackedOnWithStack: false,
}
}

Expand All @@ -234,8 +237,9 @@ func WithMessagef(err error, format string, args ...interface{}) error {
}

type withMessage struct {
cause error
msg string
cause error
msg string
stackedOnWithStack bool
}

func (w *withMessage) Error() string { return w.msg + ": " + w.cause.Error() }
Expand All @@ -245,8 +249,13 @@ func (w *withMessage) Format(s fmt.State, verb rune) {
switch verb {
case 'v':
if s.Flag('+') {
fmt.Fprintf(s, "%+v\n", w.Cause())
io.WriteString(s, w.msg)
if w.stackedOnWithStack {
fmt.Fprintf(s, "%+v\n", w.Cause())
io.WriteString(s, w.msg)
} else {
io.WriteString(s, w.msg+": ")
fmt.Fprintf(s, "%+v", w.Cause())
}
return
}
fallthrough
Expand Down
47 changes: 23 additions & 24 deletions format_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,10 +244,9 @@ func TestFormatWithMessage(t *testing.T) {
WithMessage(New("error"), "error2"),
"%+v",
[]string{
"error",
"error2: error",
"github.com/pkg/errors.TestFormatWithMessage\n" +
"\t.+/github.com/pkg/errors/format_test.go:244",
"error2"},
"\t.+/github.com/pkg/errors/format_test.go:244"},
}, {
WithMessage(io.EOF, "addition1"),
"%s",
Expand All @@ -259,47 +258,45 @@ func TestFormatWithMessage(t *testing.T) {
}, {
WithMessage(io.EOF, "addition1"),
"%+v",
[]string{"EOF", "addition1"},
[]string{"addition1: EOF"},
}, {
WithMessage(WithMessage(io.EOF, "addition1"), "addition2"),
"%v",
[]string{"addition2: addition1: EOF"},
}, {
WithMessage(WithMessage(io.EOF, "addition1"), "addition2"),
"%+v",
[]string{"EOF", "addition1", "addition2"},
[]string{"addition2: addition1: EOF"},
}, {
Wrap(WithMessage(io.EOF, "error1"), "error2"),
"%+v",
[]string{"EOF", "error1", "error2",
[]string{"error1: EOF",
"error2",
"github.com/pkg/errors.TestFormatWithMessage\n" +
"\t.+/github.com/pkg/errors/format_test.go:272"},
"\t.+/github.com/pkg/errors/format_test.go:271"},
}, {
WithMessage(Errorf("error%d", 1), "error2"),
"%+v",
[]string{"error1",
[]string{"error2: error1",
"github.com/pkg/errors.TestFormatWithMessage\n" +
"\t.+/github.com/pkg/errors/format_test.go:278",
"error2"},
"\t.+/github.com/pkg/errors/format_test.go:278"},
}, {
WithMessage(WithStack(io.EOF), "error"),
"%+v",
[]string{
"EOF",
"error: EOF",
"github.com/pkg/errors.TestFormatWithMessage\n" +
"\t.+/github.com/pkg/errors/format_test.go:285",
"error"},
"\t.+/github.com/pkg/errors/format_test.go:284"},
}, {
WithMessage(Wrap(WithStack(io.EOF), "inside-error"), "outside-error"),
"%+v",
[]string{
"EOF",
"outside-error: EOF",
"github.com/pkg/errors.TestFormatWithMessage\n" +
"\t.+/github.com/pkg/errors/format_test.go:293",
"\t.+/github.com/pkg/errors/format_test.go:291",
"inside-error",
"github.com/pkg/errors.TestFormatWithMessage\n" +
"\t.+/github.com/pkg/errors/format_test.go:293",
"outside-error"},
"\t.+/github.com/pkg/errors/format_test.go:291"},
}}

for i, tt := range tests {
Expand All @@ -315,11 +312,11 @@ func TestFormatGeneric(t *testing.T) {
{New("new-error"), []string{
"new-error",
"github.com/pkg/errors.TestFormatGeneric\n" +
"\t.+/github.com/pkg/errors/format_test.go:315"},
"\t.+/github.com/pkg/errors/format_test.go:312"},
}, {Errorf("errorf-error"), []string{
"errorf-error",
"github.com/pkg/errors.TestFormatGeneric\n" +
"\t.+/github.com/pkg/errors/format_test.go:319"},
"\t.+/github.com/pkg/errors/format_test.go:316"},
}, {errors.New("errors-new-error"), []string{
"errors-new-error"},
},
Expand All @@ -333,21 +330,21 @@ func TestFormatGeneric(t *testing.T) {
func(err error) error { return WithStack(err) },
[]string{
"github.com/pkg/errors.(func·002|TestFormatGeneric.func2)\n\t" +
".+/github.com/pkg/errors/format_test.go:333",
".+/github.com/pkg/errors/format_test.go:330",
},
}, {
func(err error) error { return Wrap(err, "wrap-error") },
[]string{
"wrap-error",
"github.com/pkg/errors.(func·003|TestFormatGeneric.func3)\n\t" +
".+/github.com/pkg/errors/format_test.go:339",
".+/github.com/pkg/errors/format_test.go:336",
},
}, {
func(err error) error { return Wrapf(err, "wrapf-error%d", 1) },
[]string{
"wrapf-error1",
"github.com/pkg/errors.(func·004|TestFormatGeneric.func4)\n\t" +
".+/github.com/pkg/errors/format_test.go:346",
".+/github.com/pkg/errors/format_test.go:343",
},
},
}
Expand All @@ -374,9 +371,9 @@ func TestFormatWrappedNew(t *testing.T) {
"%+v",
"error\n" +
"github.com/pkg/errors.wrappedNew\n" +
"\t.+/github.com/pkg/errors/format_test.go:364\n" +
"\t.+/github.com/pkg/errors/format_test.go:361\n" +
"github.com/pkg/errors.TestFormatWrappedNew\n" +
"\t.+/github.com/pkg/errors/format_test.go:373",
"\t.+/github.com/pkg/errors/format_test.go:370",
}}

for i, tt := range tests {
Expand Down Expand Up @@ -548,6 +545,8 @@ func testGenericRecursive(t *testing.T, beforeErr error, beforeWant []string, li
// Merge two stacks behind each other.
if strings.ContainsAny(beforeWant[last], "\n") && strings.ContainsAny(w.want[0], "\n") {
want = append(beforeWant[:last], append([]string{beforeWant[last] + "((?s).*)" + w.want[0]}, w.want[1:]...)...)
} else if len(w.want) == 1 && !strings.ContainsAny(w.want[0], "\n") {
want = append([]string{w.want[0] + ": " + beforeWant[0]}, beforeWant[1:]...)
} else {
want = append(beforeWant, w.want...)
}
Expand Down