Better logging (#6038) (#6095)

* Panic don't fatal on create new logger Fixes #5854 Signed-off-by: Andrew Thornton <art27@cantab.net> * partial broken * Update the logging infrastrcture Signed-off-by: Andrew Thornton <art27@cantab.net> * Reset the skip levels for Fatal and Error Signed-off-by: Andrew Thornton <art27@cantab.net> * broken ncsa * More log.Error fixes Signed-off-by: Andrew Thornton <art27@cantab.net> * Remove nal * set log-levels to lowercase * Make console_test test all levels * switch to lowercased levels * OK now working * Fix vetting issues * Fix lint * Fix tests * change default logging to match current gitea * Improve log testing Signed-off-by: Andrew Thornton <art27@cantab.net> * reset error skip levels to 0 * Update documentation and access logger configuration * Redirect the router log back to gitea if redirect macaron log but also allow setting the log level - i.e. TRACE * Fix broken level caching * Refactor the router log * Add Router logger * Add colorizing options * Adjust router colors * Only create logger if they will be used * update app.ini.sample * rename Attribute ColorAttribute * Change from white to green for function * Set fatal/error levels * Restore initial trace logger * Fix Trace arguments in modules/auth/auth.go * Properly handle XORMLogger * Improve admin/config page * fix fmt * Add auto-compression of old logs * Update error log levels * Remove the unnecessary skip argument from Error, Fatal and Critical * Add stacktrace support * Fix tests * Remove x/sync from vendors? * Add stderr option to console logger * Use filepath.ToSlash to protect against Windows in tests * Remove prefixed underscores from names in colors.go * Remove not implemented database logger This was removed from Gogs on 4 Mar 2016 but left in the configuration since then. * Ensure that log paths are relative to ROOT_PATH * use path.Join * rename jsonConfig to logConfig * Rename "config" to "jsonConfig" to make it clearer * Requested changes * Requested changes: XormLogger * Try to color the windows terminal If successful default to colorizing the console logs * fixup * Colorize initially too * update vendor * Colorize logs on default and remove if this is not a colorizing logger * Fix documentation * fix test * Use go-isatty to detect if on windows we are on msys or cygwin * Fix spelling mistake * Add missing vendors * More changes * Rationalise the ANSI writer protection * Adjust colors on advice from @0x5c * Make Flags a comma separated list * Move to use the windows constant for ENABLE_VIRTUAL_TERMINAL_PROCESSING * Ensure matching is done on the non-colored message - to simpify EXPRESSION
2025-10-31 21:28:11 +09:00 · 2019-04-02 08:48:31 +01:00
parent ef2a343e27
commit 704da08fdc
301 changed files with 36993 additions and 8244 deletions
--- a/modules/log/console_test.go
+++ b/modules/log/console_test.go
@@ -0,0 +1,137 @@
+// Copyright 2019 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package log
+
+import (
+	"fmt"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestConsoleLoggerBadConfig(t *testing.T) {
+	logger := NewConsoleLogger()
+
+	err := logger.Init("{")
+	assert.Equal(t, "unexpected end of JSON input", err.Error())
+	logger.Close()
+}
+
+func TestConsoleLoggerMinimalConfig(t *testing.T) {
+	for _, level := range Levels() {
+		var written []byte
+		var closed bool
+
+		c := CallbackWriteCloser{
+			callback: func(p []byte, close bool) {
+				written = p
+				closed = close
+			},
+		}
+		prefix := ""
+		flags := LstdFlags
+
+		cw := NewConsoleLogger()
+		realCW := cw.(*ConsoleLogger)
+		cw.Init(fmt.Sprintf("{\"level\":\"%s\"}", level))
+		nwc := realCW.out.(*nopWriteCloser)
+		nwc.w = c
+
+		assert.Equal(t, flags, realCW.Flags)
+		assert.Equal(t, FromString(level), realCW.Level)
+		assert.Equal(t, FromString(level), cw.GetLevel())
+		assert.Equal(t, prefix, realCW.Prefix)
+		assert.Equal(t, "", string(written))
+		cw.Close()
+		assert.Equal(t, false, closed)
+
+	}
+}
+
+func TestConsoleLogger(t *testing.T) {
+	var written []byte
+	var closed bool
+
+	c := CallbackWriteCloser{
+		callback: func(p []byte, close bool) {
+			written = p
+			closed = close
+		},
+	}
+	prefix := "TestPrefix "
+	level := INFO
+	flags := LstdFlags | LUTC | Lfuncname
+
+	cw := NewConsoleLogger()
+	realCW := cw.(*ConsoleLogger)
+	realCW.Colorize = false
+	nwc := realCW.out.(*nopWriteCloser)
+	nwc.w = c
+
+	cw.Init(fmt.Sprintf("{\"expression\":\"FILENAME\",\"prefix\":\"%s\",\"level\":\"%s\",\"flags\":%d}", prefix, level.String(), flags))
+
+	assert.Equal(t, flags, realCW.Flags)
+	assert.Equal(t, level, realCW.Level)
+	assert.Equal(t, level, cw.GetLevel())
+
+	location, _ := time.LoadLocation("EST")
+
+	date := time.Date(2019, time.January, 13, 22, 3, 30, 15, location)
+
+	dateString := date.UTC().Format("2006/01/02 15:04:05")
+
+	event := Event{
+		level:    INFO,
+		msg:      "TEST MSG",
+		caller:   "CALLER",
+		filename: "FULL/FILENAME",
+		line:     1,
+		time:     date,
+	}
+
+	expected := fmt.Sprintf("%s%s %s:%d:%s [%c] %s\n", prefix, dateString, event.filename, event.line, event.caller, strings.ToUpper(event.level.String())[0], event.msg)
+	cw.LogEvent(&event)
+	assert.Equal(t, expected, string(written))
+	assert.Equal(t, false, closed)
+	written = written[:0]
+
+	event.level = DEBUG
+	expected = ""
+	cw.LogEvent(&event)
+	assert.Equal(t, expected, string(written))
+	assert.Equal(t, false, closed)
+
+	event.level = TRACE
+	expected = ""
+	cw.LogEvent(&event)
+	assert.Equal(t, expected, string(written))
+	assert.Equal(t, false, closed)
+
+	nonMatchEvent := Event{
+		level:    INFO,
+		msg:      "TEST MSG",
+		caller:   "CALLER",
+		filename: "FULL/FI_LENAME",
+		line:     1,
+		time:     date,
+	}
+	event.level = INFO
+	expected = ""
+	cw.LogEvent(&nonMatchEvent)
+	assert.Equal(t, expected, string(written))
+	assert.Equal(t, false, closed)
+
+	event.level = WARN
+	expected = fmt.Sprintf("%s%s %s:%d:%s [%c] %s\n", prefix, dateString, event.filename, event.line, event.caller, strings.ToUpper(event.level.String())[0], event.msg)
+	cw.LogEvent(&event)
+	assert.Equal(t, expected, string(written))
+	assert.Equal(t, false, closed)
+	written = written[:0]
+
+	cw.Close()
+	assert.Equal(t, false, closed)
+}