- Remove logger as globals to use dedicated pointer (#104)

# Refactor Logger :
- Remove logger as globals to use dedicated pointer
- Add compat file to allow retro-compatibility (function are deprecated)
- Add field management to allow add custom information
- Add option struct to manage options
- Add entry struct to manage all log entry
- Add multithreading capabilities (with race prevention)
- Allow to log to file + stdout/stderr + syslog
- Add io.WriteCloser compatibility interface
- Add logrus hook to manage option by hook instance
- Add capabilities to custom each logfile/syslog/standard independently
- Add small test suite

# Update Packages for logger new options : 
- archive
- cluster
- context
- httpcli
- httpserver
- ldap
- tests

# Other : 
- bump dependancies
- update minio server for aws test
This commit is contained in:
Nicolas JUHEL
2021-05-21 17:32:47 +02:00
committed by GitHub
parent 9ac6920e16
commit c127359ffb
30 changed files with 2776 additions and 850 deletions

160
logger/interface_test.go Normal file
View File

@@ -0,0 +1,160 @@
/*
* MIT License
*
* Copyright (c) 2020 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package logger_test
import (
"github.com/nabbar/golib/logger"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
)
var _ = Describe("Logger", func() {
Context("Create New Logger with Default Config", func() {
It("Must succeed", func() {
log := logger.New()
log.SetLevel(logger.DebugLevel)
err := log.SetOptions(GetContext(), &logger.Options{})
Expect(err).ToNot(HaveOccurred())
log.LogDetails(logger.InfoLevel, "test logger", nil, nil, nil)
})
})
Context("Create New Logger with Default Config and trace", func() {
It("Must succeed", func() {
log := logger.New()
log.SetLevel(logger.DebugLevel)
err := log.SetOptions(GetContext(), &logger.Options{
EnableTrace: true,
})
Expect(err).ToNot(HaveOccurred())
log.LogDetails(logger.InfoLevel, "test logger with trace", nil, nil, nil)
})
})
Context("Create New Logger with field", func() {
It("Must succeed", func() {
log := logger.New()
log.SetLevel(logger.DebugLevel)
err := log.SetOptions(GetContext(), &logger.Options{
EnableTrace: true,
})
log.SetFields(logger.NewFields().Add("test-field", "ok"))
Expect(err).ToNot(HaveOccurred())
log.LogDetails(logger.InfoLevel, "test logger with field", nil, nil, nil)
})
})
Context("Create New Logger with file", func() {
It("Must succeed", func() {
log := logger.New()
log.SetLevel(logger.DebugLevel)
fsp, err := GetTempFile()
defer func() {
err = DelTempFile(fsp)
Expect(err).ToNot(HaveOccurred())
}()
Expect(err).ToNot(HaveOccurred())
err = log.SetOptions(GetContext(), &logger.Options{
EnableTrace: true,
LogFile: []logger.OptionsFile{
{
LogLevel: nil,
Filepath: fsp,
Create: true,
CreatePath: true,
FileMode: 0644,
PathMode: 0755,
DisableStack: false,
DisableTimestamp: false,
EnableTrace: true,
},
},
})
Expect(err).ToNot(HaveOccurred())
log.SetFields(logger.NewFields().Add("test-field", "ok"))
log.LogDetails(logger.InfoLevel, "test logger with field", nil, nil, nil)
})
})
Context("Create New Logger with file in multithread mode", func() {
It("Must succeed", func() {
log := logger.New()
log.SetLevel(logger.DebugLevel)
fsp, err := GetTempFile()
defer func() {
err = DelTempFile(fsp)
Expect(err).ToNot(HaveOccurred())
}()
Expect(err).ToNot(HaveOccurred())
err = log.SetOptions(GetContext(), &logger.Options{
EnableTrace: true,
LogFile: []logger.OptionsFile{
{
LogLevel: nil,
Filepath: fsp,
Create: true,
CreatePath: true,
FileMode: 0644,
PathMode: 0755,
DisableStack: false,
DisableTimestamp: false,
EnableTrace: true,
},
},
})
Expect(err).ToNot(HaveOccurred())
log.SetFields(logger.NewFields().Add("test-field", "ok"))
log.LogDetails(logger.InfoLevel, "test logger with field", nil, nil, nil)
var sub logger.Logger
sub, err = log.Clone(GetContext())
Expect(err).ToNot(HaveOccurred())
go func(log logger.Logger) {
defer func() {
se := log.Close()
Expect(se).ToNot(HaveOccurred())
}()
log.SetFields(logger.NewFields().Add("logger", "sub"))
for i := 0; i < 10; i++ {
log.Entry(logger.InfoLevel, "test multithreading logger").FieldAdd("id", i).Log()
}
}(sub)
log.SetFields(logger.NewFields().Add("logger", "main"))
for i := 0; i < 10; i++ {
log.Entry(logger.InfoLevel, "test multithreading logger").FieldAdd("id", i).Log()
}
})
})
})