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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
package golog
import (
"bytes"
"io"
"io/ioutil"
"os"
"regexp"
"strings"
"sync"
"testing"
"time"
"github.com/getlantern/errors"
"github.com/getlantern/ops"
"github.com/stretchr/testify/assert"
)
var (
expectedLog = "SEVERITY myprefix: golog_test.go:999 Hello world\nSEVERITY myprefix: golog_test.go:999 Hello true [cvarA=a cvarB=b op=name root_op=name]\n"
expectedErrorLog = `ERROR myprefix: golog_test.go:999 Hello world [cvarC=c cvarD=d error=Hello %v error_location=github.com/getlantern/golog.TestError (golog_test.go:999) error_text=Hello world error_type=errors.Error op=name root_op=name]
ERROR myprefix: golog_test.go:999 at github.com/getlantern/golog.TestError (golog_test.go:999)
ERROR myprefix: golog_test.go:999 at testing.tRunner (testing.go:999)
ERROR myprefix: golog_test.go:999 at runtime.goexit (asm_amd999.s:999)
ERROR myprefix: golog_test.go:999 Caused by: world
ERROR myprefix: golog_test.go:999 at github.com/getlantern/golog.errorReturner (golog_test.go:999)
ERROR myprefix: golog_test.go:999 at github.com/getlantern/golog.TestError (golog_test.go:999)
ERROR myprefix: golog_test.go:999 at testing.tRunner (testing.go:999)
ERROR myprefix: golog_test.go:999 at runtime.goexit (asm_amd999.s:999)
ERROR myprefix: golog_test.go:999 Hello true [cvarA=a cvarB=b cvarC=c error=%v %v error_location=github.com/getlantern/golog.TestError (golog_test.go:999) error_text=Hello true error_type=errors.Error op=name999 root_op=name999]
ERROR myprefix: golog_test.go:999 at github.com/getlantern/golog.TestError (golog_test.go:999)
ERROR myprefix: golog_test.go:999 at testing.tRunner (testing.go:999)
ERROR myprefix: golog_test.go:999 at runtime.goexit (asm_amd999.s:999)
ERROR myprefix: golog_test.go:999 Caused by: Hello
ERROR myprefix: golog_test.go:999 at github.com/getlantern/golog.TestError (golog_test.go:999)
ERROR myprefix: golog_test.go:999 at testing.tRunner (testing.go:999)
ERROR myprefix: golog_test.go:999 at runtime.goexit (asm_amd999.s:999)
`
expectedTraceLog = "TRACE myprefix: golog_test.go:999 Hello world\nTRACE myprefix: golog_test.go:999 Hello true\nTRACE myprefix: golog_test.go:999 Gravy\nTRACE myprefix: golog_test.go:999 TraceWriter closed due to unexpected error: EOF\n"
expectedStdLog = expectedLog
)
var (
replaceNumbers = regexp.MustCompile("[0-9]+")
)
func init() {
ops.SetGlobal("global", "shouldn't show up")
}
func expected(severity string, log string) string {
return strings.Replace(log, "SEVERITY", severity, -1)
}
func normalized(log string) string {
return replaceNumbers.ReplaceAllString(log, "999")
}
func TestReport(t *testing.T) {
SetOutputs(ioutil.Discard, ioutil.Discard)
OnFatal(func(err error) {
// ignore (prevents test from exiting)
})
errors := 0
fatals := 0
RegisterReporter(func(err error, linePrefix string, severity Severity, ctx map[string]interface{}) {
switch severity {
case ERROR:
errors++
case FATAL:
fatals++
}
})
l := LoggerFor("reporting")
l.Error("Some error")
l.Fatal("Fatal error")
assert.Equal(t, 1, errors)
assert.Equal(t, 1, fatals)
}
func TestDebug(t *testing.T) {
out := newBuffer()
SetOutputs(ioutil.Discard, out)
l := LoggerFor("myprefix")
l.Debug("Hello world")
defer ops.Begin("name").Set("cvarA", "a").Set("cvarB", "b").End()
l.Debugf("Hello %v", true)
assert.Equal(t, expected("DEBUG", expectedLog), out.String())
}
func TestError(t *testing.T) {
out := newBuffer()
SetOutputs(out, ioutil.Discard)
l := LoggerFor("myprefix")
ctx := ops.Begin("name").Set("cvarC", "c")
err := errorReturner()
err1 := errors.New("Hello %v", err)
err2 := errors.New("Hello")
ctx.End()
l.Error(err1)
defer ops.Begin("name2").Set("cvarA", "a").Set("cvarB", "b").End()
l.Errorf("%v %v", err2, true)
t.Log(out.String())
assert.Equal(t, expectedErrorLog, out.String())
}
func errorReturner() error {
defer ops.Begin("name").Set("cvarD", "d").End()
return errors.New("world")
}
func TestTraceEnabled(t *testing.T) {
originalTrace := os.Getenv("TRACE")
err := os.Setenv("TRACE", "true")
if err != nil {
t.Fatalf("Unable to set trace to true")
}
defer func() {
if err := os.Setenv("TRACE", originalTrace); err != nil {
t.Fatalf("Unable to set TRACE environment variable: %v", err)
}
}()
out := newBuffer()
SetOutputs(ioutil.Discard, out)
l := LoggerFor("myprefix")
l.Trace("Hello world")
l.Tracef("Hello %v", true)
tw := l.TraceOut()
if _, err := tw.Write([]byte("Gravy\n")); err != nil {
t.Fatalf("Unable to write: %v", err)
}
if err := tw.(io.Closer).Close(); err != nil {
t.Fatalf("Unable to close: %v", err)
}
// Give trace writer a moment to catch up
time.Sleep(50 * time.Millisecond)
assert.Regexp(t, expected("TRACE", expectedTraceLog), out.String())
}
func TestTraceDisabled(t *testing.T) {
originalTrace := os.Getenv("TRACE")
err := os.Setenv("TRACE", "false")
if err != nil {
t.Fatalf("Unable to set trace to false")
}
defer func() {
if err := os.Setenv("TRACE", originalTrace); err != nil {
t.Fatalf("Unable to set TRACE environment variable: %v", err)
}
}()
out := newBuffer()
SetOutputs(ioutil.Discard, out)
l := LoggerFor("myprefix")
l.Trace("Hello world")
l.Tracef("Hello %v", true)
if _, err := l.TraceOut().Write([]byte("Gravy\n")); err != nil {
t.Fatalf("Unable to write: %v", err)
}
// Give trace writer a moment to catch up
time.Sleep(50 * time.Millisecond)
assert.Equal(t, "", out.String(), "Nothing should have been logged")
}
func TestAsStdLogger(t *testing.T) {
out := newBuffer()
SetOutputs(out, ioutil.Discard)
l := LoggerFor("myprefix")
stdlog := l.AsStdLogger()
stdlog.Print("Hello world")
defer ops.Begin("name").Set("cvarA", "a").Set("cvarB", "b").End()
stdlog.Printf("Hello %v", true)
assert.Equal(t, expected("ERROR", expectedStdLog), out.String())
}
// TODO: TraceWriter appears to have been broken since we added line numbers
// func TestTraceWriter(t *testing.T) {
// originalTrace := os.Getenv("TRACE")
// err := os.Setenv("TRACE", "true")
// if err != nil {
// t.Fatalf("Unable to set trace to true")
// }
// defer func() {
// if err := os.Setenv("TRACE", originalTrace); err != nil {
// t.Fatalf("Unable to set TRACE environment variable: %v", err)
// }
// }()
//
// out := newBuffer()
// SetOutputs(ioutil.Discard, out)
// l := LoggerFor("myprefix")
// trace := l.TraceOut()
// trace.Write([]byte("Hello world\n"))
// defer ops.Begin().Set("cvarA", "a").Set("cvarB", "b").End()
// trace.Write([]byte("Hello true\n"))
// assert.Equal(t, expected("TRACE", expectedStdLog), out.String())
// }
func newBuffer() *synchronizedbuffer {
return &synchronizedbuffer{orig: &bytes.Buffer{}}
}
type synchronizedbuffer struct {
orig *bytes.Buffer
mutex sync.RWMutex
}
func (buf *synchronizedbuffer) Write(p []byte) (int, error) {
buf.mutex.Lock()
defer buf.mutex.Unlock()
return buf.orig.Write(p)
}
func (buf *synchronizedbuffer) String() string {
buf.mutex.RLock()
defer buf.mutex.RUnlock()
return normalized(buf.orig.String())
}
|
