summaryrefslogtreecommitdiffstats
path: root/modules
diff options
context:
space:
mode:
authorwxiaoguang <wxiaoguang@gmail.com>2023-04-22 04:32:25 +0800
committerGitHub <noreply@github.com>2023-04-21 16:32:25 -0400
commit911975059a50e71632d33567da7000a97aa28f22 (patch)
tree336ccc3a6ca64ab0967daf4cbbd8f908f4dac078 /modules
parent65fe0fb22cfb264f0b756065d0c3ce7a17d7e55b (diff)
downloadgitea-911975059a50e71632d33567da7000a97aa28f22.tar.gz
gitea-911975059a50e71632d33567da7000a97aa28f22.zip
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.
Diffstat (limited to 'modules')
-rw-r--r--modules/log/buffer.go71
-rw-r--r--modules/log/buffer_test.go63
-rw-r--r--modules/log/conn.go5
-rw-r--r--modules/log/console.go5
-rw-r--r--modules/log/event.go10
-rw-r--r--modules/log/file.go9
-rw-r--r--modules/log/provider.go1
-rw-r--r--modules/log/smtp.go5
-rw-r--r--modules/test/logchecker.go116
-rw-r--r--modules/test/logchecker_test.go47
10 files changed, 167 insertions, 165 deletions
diff --git a/modules/log/buffer.go b/modules/log/buffer.go
deleted file mode 100644
index 1eee2465f1..0000000000
--- a/modules/log/buffer.go
+++ /dev/null
@@ -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)
-}
diff --git a/modules/log/buffer_test.go b/modules/log/buffer_test.go
deleted file mode 100644
index 1c39006050..0000000000
--- a/modules/log/buffer_test.go
+++ /dev/null
@@ -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)
-}
diff --git a/modules/log/conn.go b/modules/log/conn.go
index 39d5234214..b21a744037 100644
--- a/modules/log/conn.go
+++ b/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() {
}
diff --git a/modules/log/console.go b/modules/log/console.go
index 8764d984ac..ce0415d139 100644
--- a/modules/log/console.go
+++ b/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() {
}
diff --git a/modules/log/event.go b/modules/log/event.go
index d23e56807b..5729e022bf 100644
--- a/modules/log/event.go
+++ b/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
+}
diff --git a/modules/log/file.go b/modules/log/file.go
index 55147ffac8..2ec6de450c 100644
--- a/modules/log/file.go
+++ b/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.
diff --git a/modules/log/provider.go b/modules/log/provider.go
index 490c3fa71b..b5058139d7 100644
--- a/modules/log/provider.go
+++ b/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
}
diff --git a/modules/log/smtp.go b/modules/log/smtp.go
index e385020c67..4e896496d7 100644
--- a/modules/log/smtp.go
+++ b/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() {
}
diff --git a/modules/test/logchecker.go b/modules/test/logchecker.go
new file mode 100644
index 0000000000..8f8c753c76
--- /dev/null
+++ b/modules/test/logchecker.go
@@ -0,0 +1,116 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package test
+
+import (
+ "strconv"
+ "strings"
+ "sync"
+ "sync/atomic"
+ "time"
+
+ "code.gitea.io/gitea/modules/log"
+)
+
+type LogChecker struct {
+ logger *log.MultiChannelledLogger
+ loggerName string
+ eventLoggerName string
+
+ filterMessages []string
+ filtered []bool
+
+ stopMark string
+ stopped bool
+
+ mu sync.Mutex
+}
+
+func (lc *LogChecker) LogEvent(event *log.Event) error {
+ lc.mu.Lock()
+ defer lc.mu.Unlock()
+ for i, msg := range lc.filterMessages {
+ if strings.Contains(event.GetMsg(), msg) {
+ lc.filtered[i] = true
+ }
+ }
+ if strings.Contains(event.GetMsg(), lc.stopMark) {
+ lc.stopped = true
+ }
+ return nil
+}
+
+func (lc *LogChecker) Close() {}
+
+func (lc *LogChecker) Flush() {}
+
+func (lc *LogChecker) GetLevel() log.Level {
+ return log.TRACE
+}
+
+func (lc *LogChecker) GetStacktraceLevel() log.Level {
+ return log.NONE
+}
+
+func (lc *LogChecker) GetName() string {
+ return lc.eventLoggerName
+}
+
+func (lc *LogChecker) ReleaseReopen() error {
+ return nil
+}
+
+var checkerIndex int64
+
+func NewLogChecker(loggerName string) (logChecker *LogChecker, cancel func()) {
+ logger := log.GetLogger(loggerName)
+ newCheckerIndex := atomic.AddInt64(&checkerIndex, 1)
+ lc := &LogChecker{
+ logger: logger,
+ loggerName: loggerName,
+ eventLoggerName: "TestLogChecker-" + strconv.FormatInt(newCheckerIndex, 10),
+ }
+ if err := logger.AddLogger(lc); err != nil {
+ panic(err) // it's impossible
+ }
+ return lc, func() { _, _ = logger.DelLogger(lc.GetName()) }
+}
+
+// Filter will make the `Check` function to check if these logs are outputted.
+func (lc *LogChecker) Filter(msgs ...string) *LogChecker {
+ lc.mu.Lock()
+ defer lc.mu.Unlock()
+ lc.filterMessages = make([]string, len(msgs))
+ copy(lc.filterMessages, msgs)
+ lc.filtered = make([]bool, len(lc.filterMessages))
+ return lc
+}
+
+func (lc *LogChecker) StopMark(msg string) *LogChecker {
+ lc.mu.Lock()
+ defer lc.mu.Unlock()
+ lc.stopMark = msg
+ lc.stopped = false
+ return lc
+}
+
+// Check returns the filtered slice and whether the stop mark is reached.
+func (lc *LogChecker) Check(d time.Duration) (filtered []bool, stopped bool) {
+ stop := time.Now().Add(d)
+
+ for {
+ lc.mu.Lock()
+ stopped = lc.stopped
+ lc.mu.Unlock()
+
+ if time.Now().After(stop) || stopped {
+ lc.mu.Lock()
+ f := make([]bool, len(lc.filtered))
+ copy(f, lc.filtered)
+ lc.mu.Unlock()
+ return f, stopped
+ }
+ time.Sleep(10 * time.Millisecond)
+ }
+}
diff --git a/modules/test/logchecker_test.go b/modules/test/logchecker_test.go
new file mode 100644
index 0000000000..1ed7f427f4
--- /dev/null
+++ b/modules/test/logchecker_test.go
@@ -0,0 +1,47 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package test
+
+import (
+ "testing"
+ "time"
+
+ "code.gitea.io/gitea/modules/log"
+
+ "github.com/stretchr/testify/assert"
+)
+
+func TestLogChecker(t *testing.T) {
+ _ = log.NewLogger(1000, "console", "console", `{"level":"info","stacktracelevel":"NONE","stderr":true}`)
+
+ lc, cleanup := NewLogChecker(log.DEFAULT)
+ defer cleanup()
+
+ lc.Filter("First", "Third").StopMark("End")
+ log.Info("test")
+
+ filtered, stopped := lc.Check(100 * time.Millisecond)
+ assert.EqualValues(t, []bool{false, false}, filtered)
+ assert.EqualValues(t, false, stopped)
+
+ log.Info("First")
+ filtered, stopped = lc.Check(100 * time.Millisecond)
+ assert.EqualValues(t, []bool{true, false}, filtered)
+ assert.EqualValues(t, false, stopped)
+
+ log.Info("Second")
+ filtered, stopped = lc.Check(100 * time.Millisecond)
+ assert.EqualValues(t, []bool{true, false}, filtered)
+ assert.EqualValues(t, false, stopped)
+
+ log.Info("Third")
+ filtered, stopped = lc.Check(100 * time.Millisecond)
+ assert.EqualValues(t, []bool{true, true}, filtered)
+ assert.EqualValues(t, false, stopped)
+
+ log.Info("End")
+ filtered, stopped = lc.Check(100 * time.Millisecond)
+ assert.EqualValues(t, []bool{true, true}, filtered)
+ assert.EqualValues(t, true, stopped)
+}