mirror of
https://github.com/pkg/errors.git
synced 2025-05-03 05:59:44 +00:00
3cdd33210d
* Introduce Stacktrace and Frame This PR is a continuation of a series aimed at exposing the stack trace information embedded in each error value. The secondary effect is to deprecated the `Fprintf` helper. Taking cues from from @chrishines' `stack` package this PR introduces a new interface `Stacktrace() []Frame` and a `Frame` type, similar in function to the `runtime.Frame` type (although lacking its iterator type). Each `Frame` implemnts `fmt.Formatter` allowing it to print itself. The older `Location` interface is still supported but also deprecated.
164 lines
2.5 KiB
Go
164 lines
2.5 KiB
Go
package errors
|
|
|
|
import (
|
|
"fmt"
|
|
"runtime"
|
|
"testing"
|
|
)
|
|
|
|
var initpc, _, _, _ = runtime.Caller(0)
|
|
|
|
func TestFrameLine(t *testing.T) {
|
|
var tests = []struct {
|
|
Frame
|
|
want int
|
|
}{{
|
|
Frame(initpc),
|
|
9,
|
|
}, {
|
|
func() Frame {
|
|
var pc, _, _, _ = runtime.Caller(0)
|
|
return Frame(pc)
|
|
}(),
|
|
20,
|
|
}, {
|
|
func() Frame {
|
|
var pc, _, _, _ = runtime.Caller(1)
|
|
return Frame(pc)
|
|
}(),
|
|
28,
|
|
}, {
|
|
Frame(0), // invalid PC
|
|
0,
|
|
}}
|
|
|
|
for _, tt := range tests {
|
|
got := tt.Frame.line()
|
|
want := tt.want
|
|
if want != got {
|
|
t.Errorf("Frame(%v): want: %v, got: %v", uintptr(tt.Frame), want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestStackLocation(t *testing.T) {
|
|
st := func() *stack {
|
|
var pcs [32]uintptr
|
|
n := runtime.Callers(1, pcs[:])
|
|
var st stack = pcs[0:n]
|
|
return &st
|
|
}()
|
|
file, line := st.Location()
|
|
wfile, wline := "github.com/pkg/errors/stack_test.go", 47
|
|
if file != wfile || line != wline {
|
|
t.Errorf("stack.Location(): want %q %d, got %q %d", wfile, wline, file, line)
|
|
}
|
|
}
|
|
|
|
type X struct{}
|
|
|
|
func (x X) val() Frame {
|
|
var pc, _, _, _ = runtime.Caller(0)
|
|
return Frame(pc)
|
|
}
|
|
|
|
func (x *X) ptr() Frame {
|
|
var pc, _, _, _ = runtime.Caller(0)
|
|
return Frame(pc)
|
|
}
|
|
|
|
func TestFrameFormat(t *testing.T) {
|
|
var tests = []struct {
|
|
Frame
|
|
format string
|
|
want string
|
|
}{{
|
|
Frame(initpc),
|
|
"%s",
|
|
"stack_test.go",
|
|
}, {
|
|
Frame(initpc),
|
|
"%+s",
|
|
"github.com/pkg/errors/stack_test.go",
|
|
}, {
|
|
Frame(0),
|
|
"%s",
|
|
"unknown",
|
|
}, {
|
|
Frame(0),
|
|
"%+s",
|
|
"unknown",
|
|
}, {
|
|
Frame(initpc),
|
|
"%d",
|
|
"9",
|
|
}, {
|
|
Frame(0),
|
|
"%d",
|
|
"0",
|
|
}, {
|
|
Frame(initpc),
|
|
"%n",
|
|
"init",
|
|
}, {
|
|
func() Frame {
|
|
var x X
|
|
return x.ptr()
|
|
}(),
|
|
"%n",
|
|
"(*X).ptr",
|
|
}, {
|
|
func() Frame {
|
|
var x X
|
|
return x.val()
|
|
}(),
|
|
"%n",
|
|
"X.val",
|
|
}, {
|
|
Frame(0),
|
|
"%n",
|
|
"",
|
|
}, {
|
|
Frame(initpc),
|
|
"%v",
|
|
"stack_test.go:9",
|
|
}, {
|
|
Frame(initpc),
|
|
"%+v",
|
|
"github.com/pkg/errors/stack_test.go:9",
|
|
}, {
|
|
Frame(0),
|
|
"%v",
|
|
"unknown:0",
|
|
}}
|
|
|
|
for _, tt := range tests {
|
|
got := fmt.Sprintf(tt.format, tt.Frame)
|
|
want := tt.want
|
|
if want != got {
|
|
t.Errorf("%v %q: want: %q, got: %q", tt.Frame, tt.format, want, got)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestTrimGOPATH(t *testing.T) {
|
|
var tests = []struct {
|
|
Frame
|
|
want string
|
|
}{{
|
|
Frame(initpc),
|
|
"github.com/pkg/errors/stack_test.go",
|
|
}}
|
|
|
|
for _, tt := range tests {
|
|
pc := tt.Frame.pc()
|
|
fn := runtime.FuncForPC(pc)
|
|
file, _ := fn.FileLine(pc)
|
|
got := trimGOPATH(fn.Name(), file)
|
|
want := tt.want
|
|
if want != got {
|
|
t.Errorf("%v: want %q, got %q", tt.Frame, want, got)
|
|
}
|
|
}
|
|
}
|