911975059a
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.
94 lines
2.0 KiB
Go
94 lines
2.0 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package log
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
|
|
"code.gitea.io/gitea/modules/json"
|
|
)
|
|
|
|
// CanColorStdout reports if we can color the Stdout
|
|
// Although we could do terminal sniffing and the like - in reality
|
|
// most tools on *nix are happy to display ansi colors.
|
|
// We will terminal sniff on Windows in console_windows.go
|
|
var CanColorStdout = true
|
|
|
|
// CanColorStderr reports if we can color the Stderr
|
|
var CanColorStderr = true
|
|
|
|
type nopWriteCloser struct {
|
|
w io.WriteCloser
|
|
}
|
|
|
|
func (n *nopWriteCloser) Write(p []byte) (int, error) {
|
|
return n.w.Write(p)
|
|
}
|
|
|
|
func (n *nopWriteCloser) Close() error {
|
|
return nil
|
|
}
|
|
|
|
// ConsoleLogger implements LoggerProvider and writes messages to terminal.
|
|
type ConsoleLogger struct {
|
|
WriterLogger
|
|
Stderr bool `json:"stderr"`
|
|
}
|
|
|
|
// NewConsoleLogger create ConsoleLogger returning as LoggerProvider.
|
|
func NewConsoleLogger() LoggerProvider {
|
|
log := &ConsoleLogger{}
|
|
log.NewWriterLogger(&nopWriteCloser{
|
|
w: os.Stdout,
|
|
})
|
|
return log
|
|
}
|
|
|
|
// Init inits connection writer with json config.
|
|
// json config only need key "level".
|
|
func (log *ConsoleLogger) Init(config string) error {
|
|
err := json.Unmarshal([]byte(config), log)
|
|
if err != nil {
|
|
return fmt.Errorf("Unable to parse JSON: %w", err)
|
|
}
|
|
if log.Stderr {
|
|
log.NewWriterLogger(&nopWriteCloser{
|
|
w: os.Stderr,
|
|
})
|
|
} else {
|
|
log.NewWriterLogger(log.out)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Flush when log should be flushed
|
|
func (log *ConsoleLogger) Flush() {
|
|
}
|
|
|
|
// ReleaseReopen causes the console logger to reconnect to os.Stdout
|
|
func (log *ConsoleLogger) ReleaseReopen() error {
|
|
if log.Stderr {
|
|
log.NewWriterLogger(&nopWriteCloser{
|
|
w: os.Stderr,
|
|
})
|
|
} else {
|
|
log.NewWriterLogger(&nopWriteCloser{
|
|
w: os.Stdout,
|
|
})
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// GetName returns the default name for this implementation
|
|
func (log *ConsoleLogger) GetName() string {
|
|
return "console"
|
|
}
|
|
|
|
func init() {
|
|
Register("console", NewConsoleLogger)
|
|
}
|