File: logger_test.go

package info (click to toggle)
go-dlib 5.6.0.9%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,200 kB
  • sloc: ansic: 4,664; xml: 1,456; makefile: 20; sh: 15
file content (310 lines) | stat: -rw-r--r-- 9,113 bytes parent folder | download | duplicates (3)
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
/*
 * Copyright (C) 2014 ~ 2018 Deepin Technology Co., Ltd.
 *
 * Author:     jouyouyun <jouyouwen717@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package log

import (
	"fmt"
	"io"
	"io/ioutil"
	"os"
	"regexp"
	"testing"

	C "gopkg.in/check.v1"
)

var originStdout = os.Stdout
var redirectStdoutFile = "testdata/stdout"
var redirectStdout, _ = os.OpenFile(redirectStdoutFile, os.O_CREATE|os.O_RDWR, 0644)

func Test(t *testing.T) { C.TestingT(t) }

type testWrapper struct{}

func init() {
	DebugFile = "" // disable outside debug file
	testWrapper := &testWrapper{}
	C.Suite(testWrapper)
}

func redirectOutput() {
	os.Stdout = redirectStdout
}
func restoreOutput() {
	os.Stdout = originStdout
}
func resetOutput() {
	_ = redirectStdout.Truncate(0)
	_, _ = redirectStdout.Seek(0, io.SeekStart)
}
func readOutput() string {
	fileContent, err := ioutil.ReadFile(redirectStdoutFile)
	if err != nil {
		std.Println("read stdout file failed:", err)
	}
	return string(fileContent)
}
func checkOutput(c *C.C, regfmt string, preferResult bool) {
	output := readOutput()
	result, _ := regexp.MatchString(regfmt, output)
	if result != preferResult {
		c.Errorf("match output failed: `%s`, `%#v`", regfmt, output)
	}
}

func (*testWrapper) BenchmarkSyslog(c *C.C) {
	b := newBackendSyslog("benchSyslog")
	for i := 0; i < c.N; i++ {
		_ = b.log(LevelInfo, "test")
	}
}

func (*testWrapper) TestGeneral(c *C.C) {
	defer func() {
		if err := recover(); err != nil {
			std.Println("catch panic:", err)
		}
	}()

	redirectOutput()
	defer restoreOutput()
	defer resetOutput()

	logger := NewLogger("logger_test")
	logger.SetLogLevel(LevelDebug)

	resetOutput()
	logger.Debug("test debug")
	checkOutput(c, `^<debug> logger_test.go:\d+: test debug\n$`, true)

	resetOutput()
	logger.Info("test info")
	checkOutput(c, `^<info> logger_test.go:\d+: test info\n$`, true)

	resetOutput()
	logger.Info("test info multi-lines\n\nthe thread line and following two empty lines\n\n")
	checkOutput(c, `^<info> logger_test.go:\d+: test info multi-lines\n\nthe thread line and following two empty lines\n\n\n$`, true)

	resetOutput()
	logger.Warning("test warning:", fmt.Errorf("error message"), "append string")
	checkOutput(c, `^<warning> logger_test.go:\d+: test warning: error message append string\n$`, true)

	resetOutput()
	logger.Warning("test warning:", fmt.Errorf("error message"))
	checkOutput(c, `^<warning> logger_test.go:\d+: test warning: error message\n$`, true)

	resetOutput()
	logger.Warningf("test warningf: %v", fmt.Errorf("error message"))
	checkOutput(c, `^<warning> logger_test.go:\d+: test warningf: error message\n$`, true)

	resetOutput()
	logger.Error("test error:", fmt.Errorf("error message"))
	checkOutput(c, `^<error> logger_test.go:\d+: test error: error message\n(  ->  \w+\.\w+:\d+\n)+$`, true)

	resetOutput()
	logger.Errorf("test errorf: %v", fmt.Errorf("error message"))
	checkOutput(c, `^<error> logger_test.go:\d+: test errorf: error message\n(  ->  \w+\.\w+:\d+\n)+$`, true)

	testPanicFunc := func() {
		defer func() {
			if err := recover(); err != nil {
				logger.Info("got panic")
			}
		}()
		logger.Panic("test panic")
	}
	resetOutput()
	testPanicFunc()
	checkOutput(c, `^<error> logger_test.go:\d+: test panic\n(  ->  \w+\.\w+:\d+\n)+<info> logger_test.go:\d+: got panic\n$`, true)
}

// TODO: remove
func (*testWrapper) TestFuncTracing(c *C.C) {
	defer func() {
		if err := recover(); err != nil {
			std.Println("catch error:", err)
		}
	}()

	logger := NewLogger("logger_test")

	logger.BeginTracing()
	defer logger.EndTracing()
	defer func() {
		logger.EndTracing()
	}()
	logger.EndTracing()

	subFunc := func() {
		logger.BeginTracing()
		logger.EndTracing()
	}
	go subFunc()

	panic("test panic")
}

func (*testWrapper) TestIsNeedLog(c *C.C) {
	logger := &Logger{}
	logger.SetLogLevel(LevelInfo)
	c.Check(logger.isNeedLog(LevelDebug), C.Equals, false)
	c.Check(logger.isNeedLog(LevelInfo), C.Equals, true)
	c.Check(logger.isNeedLog(LevelWarning), C.Equals, true)
	c.Check(logger.isNeedLog(LevelError), C.Equals, true)
	c.Check(logger.isNeedLog(LevelPanic), C.Equals, true)
	c.Check(logger.isNeedLog(LevelFatal), C.Equals, true)
	logger.SetLogLevel(LevelDebug)
	c.Check(logger.isNeedLog(LevelDebug), C.Equals, true)
	c.Check(logger.isNeedLog(LevelInfo), C.Equals, true)
	c.Check(logger.isNeedLog(LevelWarning), C.Equals, true)
	c.Check(logger.isNeedLog(LevelError), C.Equals, true)
	c.Check(logger.isNeedLog(LevelPanic), C.Equals, true)
	c.Check(logger.isNeedLog(LevelFatal), C.Equals, true)
}

func (*testWrapper) TestIsNeedTraceMore(c *C.C) {
	logger := &Logger{}
	logger.SetLogLevel(LevelInfo)
	c.Check(logger.isNeedTraceMore(LevelDebug), C.Equals, false)
	c.Check(logger.isNeedTraceMore(LevelInfo), C.Equals, false)
	c.Check(logger.isNeedTraceMore(LevelWarning), C.Equals, false)
	c.Check(logger.isNeedTraceMore(LevelError), C.Equals, true)
	c.Check(logger.isNeedTraceMore(LevelPanic), C.Equals, true)
	c.Check(logger.isNeedTraceMore(LevelFatal), C.Equals, true)
}

func (*testWrapper) TestAddRemoveBackend(c *C.C) {
	logger := &Logger{}

	var backendNull Backend
	logger.AddBackend(backendNull)
	c.Check(len(logger.backends), C.Equals, 0)
	var backendConsoleNull *backendConsole
	logger.AddBackend(backendConsoleNull)
	c.Check(len(logger.backends), C.Equals, 0)
	logger.ResetBackends()

	logger.AddBackendConsole()
	c.Check(len(logger.backends), C.Equals, 1)
	logger.AddBackendConsole()
	c.Check(len(logger.backends), C.Equals, 2)
	logger.RemoveBackendConsole()
	c.Check(len(logger.backends), C.Equals, 0)
}

func (*testWrapper) TestDebugFile(c *C.C) {
	oldDebugFile := DebugFile
	DebugFile = "testdata/dde_debug"
	defer func() { DebugFile = oldDebugFile }()

	os.Clearenv()
	defer os.Clearenv()

	_ = os.Remove(DebugFile)
	c.Check(getDefaultLogLevel("test_debug_file"), C.Equals, LevelInfo)

	_, _ =os.Create(DebugFile)
	c.Check(getDefaultLogLevel("test_debug_file"), C.Equals, LevelDebug)
}

func (*testWrapper) TestDebugEnv(c *C.C) {
	os.Clearenv()
	defer os.Clearenv()

	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelInfo)

	os.Clearenv()
	_ = os.Setenv("DDE_DEBUG", "")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelDebug)

	os.Clearenv()
	_ = os.Setenv("DDE_DEBUG", "1")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelDebug)
}

func (*testWrapper) TestDebugLevelEnv(c *C.C) {
	os.Clearenv()
	defer os.Clearenv()

	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelInfo)

	_ = os.Setenv("DDE_DEBUG_LEVEL", "debug")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelDebug)

	_ = os.Setenv("DDE_DEBUG_LEVEL", "warning")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelWarning)
}

func (*testWrapper) TestDebugMatchEnv(c *C.C) {
	os.Clearenv()
	defer os.Clearenv()

	_ = os.Setenv("DDE_DEBUG_MATCH", "test1")
	c.Check(getDefaultLogLevel("test1"), C.Equals, LevelDebug)
	c.Check(getDefaultLogLevel("test2"), C.Equals, LevelDisable)

	_ = os.Setenv("DDE_DEBUG_MATCH", "test1|test2")
	c.Check(getDefaultLogLevel("test1"), C.Equals, LevelDebug)
	c.Check(getDefaultLogLevel("test2"), C.Equals, LevelDebug)

	_ = os.Setenv("DDE_DEBUG_MATCH", "not match")
	c.Check(getDefaultLogLevel("test1"), C.Equals, LevelDisable)
	c.Check(getDefaultLogLevel("test2"), C.Equals, LevelDisable)
}

func (*testWrapper) TestDebugMixEnv(c *C.C) {
	os.Clearenv()
	defer os.Clearenv()

	_ = os.Setenv("DDE_DEBUG", "1")
	_ = os.Setenv("DDE_DEBUG_LEVEL", "warning")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelWarning)

	os.Clearenv()
	_ = os.Setenv("DDE_DEBUG_LEVEL", "error")
	_ = os.Setenv("DDE_DEBUG_MATCH", "test_env")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelError)

	os.Clearenv()
	_ = os.Setenv("DDE_DEBUG_LEVEL", "error")
	_ = os.Setenv("DDE_DEBUG_MATCH", "not match")
	c.Check(getDefaultLogLevel("test_env"), C.Equals, LevelDisable)
}

func (*testWrapper) TestDebugConsoleEnv(c *C.C) {
	os.Clearenv()
	defer os.Clearenv()

	_ = os.Setenv("DDE_DEBUG_CONSOLE", "1")
	console := newBackendConsole("test-console")
	c.Check(console.syslogMode, C.Equals, true)

	redirectOutput()
	defer restoreOutput()
	resetOutput()
	_ = console.log(LevelInfo, "this line shows as syslog format in console")
	checkOutput(c, `\w+ \d+ \d{2}:\d{2}:\d{2} .* test-console\[\d+\]: <info> this line shows as syslog format in console\n$`, true)
}

func (*testWrapper) TestFmtSprint(c *C.C) {
	c.Check(fmtSprint(""), C.Equals, "")
	c.Check(fmtSprint("a", "b", "c"), C.Equals, "a b c")
	c.Check(fmtSprint("a\n", "b\n", "c\n"), C.Equals, "a\n b\n c\n")
}