1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
package raven
import (
"fmt"
"go/build"
"io/ioutil"
"os"
"path/filepath"
"runtime"
"strings"
"testing"
)
func init() {
thisFile, thisPackage = derivePackage()
functionNameTests = []FunctionNameTest{
{0, thisPackage, "TestFunctionName"},
{1, "testing", "tRunner"},
{2, "runtime", "goexit"},
{100, "", ""},
}
}
type FunctionNameTest struct {
skip int
pack string
name string
}
var (
thisFile string
thisPackage string
functionNameTests []FunctionNameTest
)
func TestFunctionName(t *testing.T) {
for _, test := range functionNameTests {
pc, _, _, _ := runtime.Caller(test.skip)
pack, name := functionName(runtime.FuncForPC(pc).Name())
if pack != test.pack {
t.Errorf("incorrect package; got %s, want %s", pack, test.pack)
}
if name != test.name {
t.Errorf("incorrect function; got %s, want %s", name, test.name)
}
}
}
func TestStacktrace(t *testing.T) {
st := trace()
if st == nil {
t.Error("got nil stacktrace")
}
if len(st.Frames) == 0 {
t.Error("got zero frames")
}
f := st.Frames[len(st.Frames)-1]
if f.Filename != thisFile {
t.Errorf("incorrect Filename; got %s, want %s", f.Filename, thisFile)
}
if !strings.HasSuffix(f.AbsolutePath, thisFile) {
t.Error("incorrect AbsolutePath:", f.AbsolutePath)
}
if f.Function != "trace" {
t.Error("incorrect Function:", f.Function)
}
if f.Module != thisPackage {
t.Error("incorrect Module:", f.Module)
}
if f.Lineno != 97 {
t.Error("incorrect Lineno:", f.Lineno)
}
if f.ContextLine != "\treturn NewStacktrace(0, 2, []string{thisPackage})" {
t.Errorf("incorrect ContextLine: %#v", f.ContextLine)
}
if len(f.PreContext) != 2 || f.PreContext[0] != "// a" || f.PreContext[1] != "func trace() *Stacktrace {" {
t.Errorf("incorrect PreContext %#v", f.PreContext)
}
if len(f.PostContext) != 2 || f.PostContext[0] != "\t// b" || f.PostContext[1] != "}" {
t.Errorf("incorrect PostContext %#v", f.PostContext)
}
_, filename, _, _ := runtime.Caller(0)
runningInVendored := strings.Contains(filename, "vendor")
if f.InApp != !runningInVendored {
t.Error("expected InApp to be true")
}
if f.InApp && st.Culprit() != fmt.Sprintf("%s.trace", thisPackage) {
t.Error("incorrect Culprit:", st.Culprit())
}
}
// a
func trace() *Stacktrace {
return NewStacktrace(0, 2, []string{thisPackage})
// b
}
func derivePackage() (file, pack string) {
// Get file name by seeking caller's file name.
_, callerFile, _, ok := runtime.Caller(1)
if !ok {
return
}
// Trim file name
file = callerFile
for _, dir := range build.Default.SrcDirs() {
dir := dir + string(filepath.Separator)
if trimmed := strings.TrimPrefix(callerFile, dir); len(trimmed) < len(file) {
file = trimmed
}
}
// Now derive package name
dir := filepath.Dir(callerFile)
dirPkg, err := build.ImportDir(dir, build.AllowBinary)
if err != nil {
return
}
pack = dirPkg.ImportPath
return
}
// TestNewStacktrace_outOfBounds verifies that a context exceeding the number
// of lines in a file does not cause a panic.
func TestNewStacktrace_outOfBounds(t *testing.T) {
st := NewStacktrace(0, 1000000, []string{thisPackage})
f := st.Frames[len(st.Frames)-1]
if f.ContextLine != "\tst := NewStacktrace(0, 1000000, []string{thisPackage})" {
t.Errorf("incorrect ContextLine: %#v", f.ContextLine)
}
}
func TestNewStacktrace_noFrames(t *testing.T) {
st := NewStacktrace(999999999, 0, []string{})
if st != nil {
t.Errorf("expected st.Frames to be nil: %v", st)
}
}
func TestFileContext(t *testing.T) {
// reset the cache
loader := &fsLoader{cache: make(map[string][][]byte)}
tempdir, err := ioutil.TempDir("", "")
if err != nil {
t.Fatal("failed to create temporary directory:", err)
}
defer os.RemoveAll(tempdir)
okPath := filepath.Join(tempdir, "ok")
missingPath := filepath.Join(tempdir, "missing")
noPermissionPath := filepath.Join(tempdir, "noperms")
err = ioutil.WriteFile(okPath, []byte("hello\nworld\n"), 0600)
if err != nil {
t.Fatal("failed writing file:", err)
}
err = ioutil.WriteFile(noPermissionPath, []byte("no access\n"), 0000)
if err != nil {
t.Fatal("failed writing file:", err)
}
tests := []struct {
path string
expectedLines int
expectedIndex int
}{
{okPath, 1, 0},
{missingPath, 0, 0},
{noPermissionPath, 0, 0},
}
for i, test := range tests {
lines, index := loader.Load(test.path, 1, 0)
if !(len(lines) == test.expectedLines && index == test.expectedIndex) {
t.Errorf("%d: fileContext(%#v, 1, 0) = %v, %v; expected len()=%d, %d",
i, test.path, lines, index, test.expectedLines, test.expectedIndex)
}
cacheLen := len(loader.cache)
if cacheLen != i+1 {
t.Errorf("%d: result was not cached; len=%d", i, cacheLen)
}
}
}
|
