GOMODULES/errors
1
0
Fork 0
mirror of https://github.com/pkg/errors.git synced 2025-05-31 11:42:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix %q format for wrapped errors (#58)

Browse Source 
Not handling the %q format causes logrus to log empty error strings for
wrapped errors where x.Error() contains spaces or other quoteworthy
characters.

For reference, the logrus formatter does this:
https://github.com/Sirupsen/logrus/blob/master/text_formatter.go#L154
This commit is contained in:
Darshan Shaligram 2016-06-21 21:00:19 -04:00 committed by Dave Cheney
parent 0bc61eb85b
commit cbd18b5440
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
errors.go
View File

@ -152,6 +152,8 @@ func (w wrapper) Format(s fmt.State, verb rune) {
fallthrough fallthrough
case 's': case 's':
io.WriteString(s, w.Error()) io.WriteString(s, w.Error())
case 'q':
fmt.Fprintf(s, "%q", w.Error())
} }
} }

10
format_test.go
View File

@ -83,6 +83,10 @@ func TestFormatWrap(t *testing.T) {
Wrap(io.EOF, "error"), Wrap(io.EOF, "error"),
"%s", "%s",
"error: EOF", "error: EOF",
}, {
Wrap(New("error with space"), "context"),
"%q",
`"context: error with space"`,
}} }}
for _, tt := range tests { for _, tt := range tests {
@ -109,7 +113,7 @@ func TestFormatWrapf(t *testing.T) {
"EOF\n" + "EOF\n" +
"error\n" + "error\n" +
"github.com/pkg/errors.TestFormatWrapf\n" + "github.com/pkg/errors.TestFormatWrapf\n" +
"\t.+/github.com/pkg/errors/format_test.go:107", "\t.+/github.com/pkg/errors/format_test.go:111",
}, { }, {
Wrapf(New("error"), "error%d", 2), Wrapf(New("error"), "error%d", 2),
"%v", "%v",
@ -119,14 +123,14 @@ func TestFormatWrapf(t *testing.T) {
"%+v", "%+v",
"error\n" + "error\n" +
"github.com/pkg/errors.TestFormatWrapf\n" + "github.com/pkg/errors.TestFormatWrapf\n" +
"\t.+/github.com/pkg/errors/format_test.go:118", "\t.+/github.com/pkg/errors/format_test.go:122",
}, { }, {
Wrap(Wrap(io.EOF, "error1"), "error2"), Wrap(Wrap(io.EOF, "error1"), "error2"),
"%+v", "%+v",
"EOF\n" + "EOF\n" +
"error1\n" + "error1\n" +
"github.com/pkg/errors.TestFormatWrapf\n" + "github.com/pkg/errors.TestFormatWrapf\n" +
"\t.+/github.com/pkg/errors/format_test.go:124\n", "\t.+/github.com/pkg/errors/format_test.go:128\n",
}} }}
for _, tt := range tests { for _, tt := range tests {