Improve test logger (#24235)

Before, there was a `log/buffer.go`, but that design is not general, and
it introduces a lot of irrelevant `Content() (string, error) ` and
`return "", fmt.Errorf("not supported")` .


And the old `log/buffer.go` is difficult to use, developers have to
write a lot of `Contains` and `Sleep` code.


The new `LogChecker` is designed to be a general approach to help to
assert some messages appearing or not appearing in logs.

modules/log/buffer.go

@@ -1,71 +0,0 @@
-// Copyright 2022 The Gitea Authors. All rights reserved.
-// SPDX-License-Identifier: MIT
-
-package log
-
-import (
-	"bytes"
-	"sync"
-)
-
-type bufferWriteCloser struct {
-	mu     sync.Mutex
-	buffer bytes.Buffer
-}
-
-func (b *bufferWriteCloser) Write(p []byte) (int, error) {
-	b.mu.Lock()
-	defer b.mu.Unlock()
-	return b.buffer.Write(p)
-}
-
-func (b *bufferWriteCloser) Close() error {
-	return nil
-}
-
-func (b *bufferWriteCloser) String() string {
-	b.mu.Lock()
-	defer b.mu.Unlock()
-	return b.buffer.String()
-}
-
-// BufferLogger implements LoggerProvider and writes messages in a buffer.
-type BufferLogger struct {
-	WriterLogger
-}
-
-// NewBufferLogger create BufferLogger returning as LoggerProvider.
-func NewBufferLogger() LoggerProvider {
-	log := &BufferLogger{}
-	log.NewWriterLogger(&bufferWriteCloser{})
-	return log
-}
-
-// Init inits connection writer
-func (log *BufferLogger) Init(string) error {
-	log.NewWriterLogger(log.out)
-	return nil
-}
-
-// Content returns the content accumulated in the content provider
-func (log *BufferLogger) Content() (string, error) {
-	return log.out.(*bufferWriteCloser).String(), nil
-}
-
-// Flush when log should be flushed
-func (log *BufferLogger) Flush() {
-}
-
-// ReleaseReopen does nothing
-func (log *BufferLogger) ReleaseReopen() error {
-	return nil
-}
-
-// GetName returns the default name for this implementation
-func (log *BufferLogger) GetName() string {
-	return "buffer"
-}
-
-func init() {
-	Register("buffer", NewBufferLogger)
-}

modules/log/buffer_test.go

@@ -1,63 +0,0 @@
-// Copyright 2022 The Gitea Authors. All rights reserved.
-// SPDX-License-Identifier: MIT
-
-package log
-
-import (
-	"fmt"
-	"strings"
-	"testing"
-	"time"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func TestBufferLogger(t *testing.T) {
-	logger := NewBufferLogger()
-	bufferLogger := logger.(*BufferLogger)
-	assert.NotNil(t, bufferLogger)
-
-	err := logger.Init("")
-	assert.NoError(t, err)
-
-	location, _ := time.LoadLocation("EST")
-	date := time.Date(2019, time.January, 13, 22, 3, 30, 15, location)
-
-	msg := "TEST MSG"
-	event := Event{
-		level:    INFO,
-		msg:      msg,
-		caller:   "CALLER",
-		filename: "FULL/FILENAME",
-		line:     1,
-		time:     date,
-	}
-	logger.LogEvent(&event)
-	content, err := bufferLogger.Content()
-	assert.NoError(t, err)
-	assert.Contains(t, content, msg)
-	logger.Close()
-}
-
-func TestBufferLoggerContent(t *testing.T) {
-	level := INFO
-	logger := NewLogger(0, "console", "console", fmt.Sprintf(`{"level":"%s"}`, level.String()))
-
-	logger.SetLogger("buffer", "buffer", "{}")
-	defer logger.DelLogger("buffer")
-
-	msg := "A UNIQUE MESSAGE"
-	Error(msg)
-
-	found := false
-	for i := 0; i < 30000; i++ {
-		content, err := logger.GetLoggerProviderContent("buffer")
-		assert.NoError(t, err)
-		if strings.Contains(content, msg) {
-			found = true
-			break
-		}
-		time.Sleep(1 * time.Millisecond)
-	}
-	assert.True(t, found)
-}

modules/log/conn.go

@@ -118,11 +118,6 @@ func (log *ConnLogger) Init(jsonconfig string) error {
 	return nil
 }
 
-// Content returns the content accumulated in the content provider
-func (log *ConnLogger) Content() (string, error) {
-	return "", fmt.Errorf("not supported")
-}
-
 // Flush does nothing for this implementation
 func (log *ConnLogger) Flush() {
 }

modules/log/console.go

@@ -65,11 +65,6 @@ func (log *ConsoleLogger) Init(config string) error {
 	return nil
 }
 
-// Content returns the content accumulated in the content provider
-func (log *ConsoleLogger) Content() (string, error) {
-	return "", fmt.Errorf("not supported")
-}
-
 // Flush when log should be flushed
 func (log *ConsoleLogger) Flush() {
 }

modules/log/event.go

@@ -247,12 +247,6 @@ func (m *MultiChannelledLog) GetEventLogger(name string) EventLogger {
 	return m.loggers[name]
 }
 
-// GetEventProvider returns a sub logger provider content from this MultiChannelledLog
-func (m *MultiChannelledLog) GetLoggerProviderContent(name string) (string, error) {
-	channelledLogger := m.GetEventLogger(name).(*ChannelledLog)
-	return channelledLogger.loggerProvider.Content()
-}
-
 // GetEventLoggerNames returns a list of names
 func (m *MultiChannelledLog) GetEventLoggerNames() []string {
 	m.rwmutex.RLock()
@@ -460,3 +454,7 @@ func (m *MultiChannelledLog) ResetLevel() Level {
 func (m *MultiChannelledLog) GetName() string {
 	return m.name
 }
+
+func (e *Event) GetMsg() string {
+	return e.msg
+}

modules/log/file.go

@@ -253,15 +253,6 @@ func (log *FileLogger) deleteOldLog() {
 	})
 }
 
-// Content returns the content accumulated in the content provider
-func (log *FileLogger) Content() (string, error) {
-	b, err := os.ReadFile(log.Filename)
-	if err != nil {
-		return "", err
-	}
-	return string(b), nil
-}
-
 // Flush flush file logger.
 // there are no buffering messages in file logger in memory.
 // flush file means sync file from disk.

modules/log/provider.go

@@ -6,7 +6,6 @@ package log
 // LoggerProvider represents behaviors of a logger provider.
 type LoggerProvider interface {
 	Init(config string) error
-	Content() (string, error)
 	EventLogger
 }
 

modules/log/smtp.go

@@ -95,11 +95,6 @@ func (log *SMTPLogger) sendMail(p []byte) (int, error) {
 	)
 }
 
-// Content returns the content accumulated in the content provider
-func (log *SMTPLogger) Content() (string, error) {
-	return "", fmt.Errorf("not supported")
-}
-
 // Flush when log should be flushed
 func (log *SMTPLogger) Flush() {
 }