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

1 files changed, 154 insertions, 0 deletions

diff --git a/modules/log/log_test.go b/modules/log/log_test.go
new file mode 100644
index 0000000000..9e3d7527b2
--- /dev/null
+++ b/modules/log/log_test.go
@@ -0,0 +1,154 @@
+// 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"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func baseConsoleTest(t *testing.T, logger *Logger) (chan []byte, chan bool) {
+	written := make(chan []byte)
+	closed := make(chan bool)
+
+	c := CallbackWriteCloser{
+		callback: func(p []byte, close bool) {
+			written <- p
+			closed <- close
+		},
+	}
+	m := logger.MultiChannelledLog
+
+	channelledLog := m.GetEventLogger("console")
+	assert.NotEmpty(t, channelledLog)
+	realChanLog, ok := channelledLog.(*ChannelledLog)
+	assert.Equal(t, true, ok)
+	realCL, ok := realChanLog.loggerProvider.(*ConsoleLogger)
+	assert.Equal(t, true, ok)
+	assert.Equal(t, INFO, realCL.Level)
+	realCL.out = c
+
+	format := "test: %s"
+	args := []interface{}{"A"}
+
+	logger.Log(0, INFO, format, args...)
+	line := <-written
+	assert.Contains(t, string(line), fmt.Sprintf(format, args...))
+	assert.Equal(t, false, <-closed)
+
+	format = "test2: %s"
+	logger.Warn(format, args...)
+	line = <-written
+
+	assert.Contains(t, string(line), fmt.Sprintf(format, args...))
+	assert.Equal(t, false, <-closed)
+
+	format = "testerror: %s"
+	logger.Error(format, args...)
+	line = <-written
+	assert.Contains(t, string(line), fmt.Sprintf(format, args...))
+	assert.Equal(t, false, <-closed)
+	return written, closed
+}
+
+func TestNewLoggerUnexported(t *testing.T) {
+	level := INFO
+	logger := newLogger("UNEXPORTED", 0)
+	err := logger.SetLogger("console", "console", fmt.Sprintf(`{"level":"%s"}`, level.String()))
+	assert.NoError(t, err)
+	out := logger.MultiChannelledLog.GetEventLogger("console")
+	assert.NotEmpty(t, out)
+	chanlog, ok := out.(*ChannelledLog)
+	assert.Equal(t, true, ok)
+	assert.Equal(t, "console", chanlog.provider)
+	assert.Equal(t, INFO, logger.GetLevel())
+	baseConsoleTest(t, logger)
+}
+
+func TestNewLoggger(t *testing.T) {
+	level := INFO
+	logger := NewLogger(0, "console", "console", fmt.Sprintf(`{"level":"%s"}`, level.String()))
+
+	assert.Equal(t, INFO, GetLevel())
+	assert.Equal(t, false, IsTrace())
+	assert.Equal(t, false, IsDebug())
+	assert.Equal(t, true, IsInfo())
+	assert.Equal(t, true, IsWarn())
+	assert.Equal(t, true, IsError())
+
+	written, closed := baseConsoleTest(t, logger)
+
+	format := "test: %s"
+	args := []interface{}{"A"}
+
+	Log(0, INFO, format, args...)
+	line := <-written
+	assert.Contains(t, string(line), fmt.Sprintf(format, args...))
+	assert.Equal(t, false, <-closed)
+
+	Info(format, args...)
+	line = <-written
+	assert.Contains(t, string(line), fmt.Sprintf(format, args...))
+	assert.Equal(t, false, <-closed)
+
+	go DelLogger("console")
+	line = <-written
+	assert.Equal(t, "", string(line))
+	assert.Equal(t, true, <-closed)
+}
+
+func TestNewLogggerRecreate(t *testing.T) {
+	level := INFO
+	NewLogger(0, "console", "console", fmt.Sprintf(`{"level":"%s"}`, level.String()))
+
+	assert.Equal(t, INFO, GetLevel())
+	assert.Equal(t, false, IsTrace())
+	assert.Equal(t, false, IsDebug())
+	assert.Equal(t, true, IsInfo())
+	assert.Equal(t, true, IsWarn())
+	assert.Equal(t, true, IsError())
+
+	format := "test: %s"
+	args := []interface{}{"A"}
+
+	Log(0, INFO, format, args...)
+
+	NewLogger(0, "console", "console", fmt.Sprintf(`{"level":"%s"}`, level.String()))
+
+	assert.Equal(t, INFO, GetLevel())
+	assert.Equal(t, false, IsTrace())
+	assert.Equal(t, false, IsDebug())
+	assert.Equal(t, true, IsInfo())
+	assert.Equal(t, true, IsWarn())
+	assert.Equal(t, true, IsError())
+
+	Log(0, INFO, format, args...)
+
+	assert.Panics(t, func() {
+		NewLogger(0, "console", "console", fmt.Sprintf(`{"level":"%s"`, level.String()))
+	})
+
+	go DelLogger("console")
+
+	// We should be able to redelete without a problem
+	go DelLogger("console")
+
+}
+
+func TestNewNamedLogger(t *testing.T) {
+	level := INFO
+	err := NewNamedLogger("test", 0, "console", "console", fmt.Sprintf(`{"level":"%s"}`, level.String()))
+	assert.NoError(t, err)
+	logger := NamedLoggers["test"]
+	assert.Equal(t, level, logger.GetLevel())
+
+	written, closed := baseConsoleTest(t, logger)
+	go DelNamedLogger("test")
+	line := <-written
+	assert.Equal(t, "", string(line))
+	assert.Equal(t, true, <-closed)
+}