
1. Log all warnings, don't hide none of them 2. Write fatal messages (stop analysis) with error log level 3. Remove ugly timestamp counter from logrus output 4. Print nested module prefix in log 5. Make logger abstraction: no global logging anymore 6. Refactor config reading to config.FileReader struct to avoid passing logger into every function 7. Replace exit codes hardcoding with constants in exitcodes package 8. Fail test if any warning was logged 9. Fix calculation of relative path if we analyze parent dir ../ 10. Move Runner initialization from Executor to NewRunner func 11. Log every AST parsing error 12. Properly print used config file path in verbose mode 13. Print package files if only 1 package is analyzedin verbose mode, print not compiling packages in verbose mode 14. Forbid usage of github.com/sirupsen/logrus by DepGuard linter 15. Add default ignore pattern to folint: "comment on exported const"
107 lines
2.1 KiB
Go
107 lines
2.1 KiB
Go
package logutils
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/golangci/golangci-lint/pkg/exitcodes"
|
|
"github.com/sirupsen/logrus" //nolint:depguard
|
|
)
|
|
|
|
var isTestRun = os.Getenv("GL_TEST_RUN") == "1"
|
|
|
|
type StderrLog struct {
|
|
name string
|
|
logger *logrus.Logger
|
|
level LogLevel
|
|
}
|
|
|
|
var _ Log = NewStderrLog("")
|
|
|
|
func NewStderrLog(name string) *StderrLog {
|
|
sl := &StderrLog{
|
|
name: name,
|
|
logger: logrus.New(),
|
|
level: LogLevelWarn,
|
|
}
|
|
|
|
// control log level in logutils, not in logrus
|
|
sl.logger.SetLevel(logrus.DebugLevel)
|
|
sl.logger.Formatter = &logrus.TextFormatter{
|
|
DisableTimestamp: true, // `INFO[0007] msg` -> `INFO msg`
|
|
}
|
|
return sl
|
|
}
|
|
|
|
func exitIfTest() {
|
|
if isTestRun {
|
|
os.Exit(exitcodes.WarningInTest)
|
|
}
|
|
}
|
|
|
|
func (sl StderrLog) prefix() string {
|
|
prefix := ""
|
|
if sl.name != "" {
|
|
prefix = fmt.Sprintf("[%s] ", sl.name)
|
|
}
|
|
|
|
return prefix
|
|
}
|
|
|
|
func (sl StderrLog) Fatalf(format string, args ...interface{}) {
|
|
sl.logger.Errorf("%s%s", sl.prefix(), fmt.Sprintf(format, args...))
|
|
os.Exit(exitcodes.Failure)
|
|
}
|
|
|
|
func (sl StderrLog) Errorf(format string, args ...interface{}) {
|
|
if sl.level > LogLevelError {
|
|
return
|
|
}
|
|
|
|
sl.logger.Errorf("%s%s", sl.prefix(), fmt.Sprintf(format, args...))
|
|
// don't call exitIfTest() because the idea is to
|
|
// crash on hidden errors (warnings); but Errorf MUST NOT be
|
|
// called on hidden errors, see log levels comments.
|
|
}
|
|
|
|
func (sl StderrLog) Warnf(format string, args ...interface{}) {
|
|
if sl.level > LogLevelWarn {
|
|
return
|
|
}
|
|
|
|
sl.logger.Warnf("%s%s", sl.prefix(), fmt.Sprintf(format, args...))
|
|
exitIfTest()
|
|
}
|
|
|
|
func (sl StderrLog) Infof(format string, args ...interface{}) {
|
|
if sl.level > LogLevelInfo {
|
|
return
|
|
}
|
|
|
|
sl.logger.Infof("%s%s", sl.prefix(), fmt.Sprintf(format, args...))
|
|
}
|
|
|
|
func (sl StderrLog) Debugf(format string, args ...interface{}) {
|
|
if sl.level > LogLevelDebug {
|
|
return
|
|
}
|
|
|
|
sl.logger.Debugf("%s%s", sl.prefix(), fmt.Sprintf(format, args...))
|
|
}
|
|
|
|
func (sl StderrLog) Child(name string) Log {
|
|
prefix := ""
|
|
if sl.name != "" {
|
|
prefix = sl.name + ":"
|
|
}
|
|
|
|
child := sl
|
|
child.name = prefix + name
|
|
|
|
return &child
|
|
}
|
|
|
|
func (sl *StderrLog) SetLevel(level LogLevel) {
|
|
sl.level = level
|
|
}
|