log_test.go

package log

import (
	"bytes"
	"fmt"
	"io"
	"reflect"
	"testing"

	. "gopkg.in/check.v1"
)

func TestLog(t *testing.T) { TestingT(t) }

type LogSuite struct{}

var _ = Suite(&LogSuite{})

func (s *LogSuite) SetUpTest(c *C) {
	// reset global loggers chain before every test
	gl.loggers = []Logger{}
}

func (s *LogSuite) TestInit(c *C) {
	Init(newTestLogger("log1"), newTestLogger("log2"))
	c.Assert(len(gl.loggers), Equals, 2)
	c.Assert(typeOf(gl.loggers[0]), Equals, "*log.testLogger")
	c.Assert(typeOf(gl.loggers[1]), Equals, "*log.testLogger")
}

func (s *LogSuite) TestInitWithConfig(c *C) {
	InitWithConfig(Config{Console, "info"}, Config{Syslog, "info"})
	c.Assert(len(gl.loggers), Equals, 2)
	c.Assert(typeOf(gl.loggers[0]), Equals, "*log.consoleLogger")
	c.Assert(typeOf(gl.loggers[1]), Equals, "*log.sysLogger")
}

func (s *LogSuite) TestNewLogger(c *C) {
	l, err := NewLogger(Config{Console, "info"})
	c.Assert(err, IsNil)
	c.Assert(typeOf(l), Equals, "*log.consoleLogger")

	l, err = NewLogger(Config{Syslog, "warn"})
	c.Assert(err, IsNil)
	c.Assert(typeOf(l), Equals, "*log.sysLogger")

	l, err = NewLogger(Config{UDPLog, "error"})
	c.Assert(err, IsNil)
	c.Assert(typeOf(l), Equals, "*log.udpLogger")

	l, err = NewLogger(Config{"SuperDuperLogger", "info"})
	c.Assert(err, NotNil)
	c.Assert(l, IsNil)
}

func (s *LogSuite) TestDebugf(c *C) {
	logger1 := newTestLogger("log1")
	logger2 := newTestLogger("log2")
	Init(logger1, logger2)

	Debugf("hello %s", "world")
	c.Assert(logger1.b.String(), Equals, "DEBUG hello world\n")
	c.Assert(logger2.b.String(), Equals, "DEBUG hello world\n")
}

func (s *LogSuite) TestInfof(c *C) {
	logger1 := newTestLogger("log1")
	logger2 := newTestLogger("log2")
	Init(logger1, logger2)

	Infof("hello %s", "world")
	c.Assert(logger1.b.String(), Equals, "INFO hello world\n")
	c.Assert(logger2.b.String(), Equals, "INFO hello world\n")
}

func (s *LogSuite) TestWarningf(c *C) {
	logger1 := newTestLogger("log1")
	logger2 := newTestLogger("log2")
	Init(logger1, logger2)

	Warningf("hello %s", "world")
	c.Assert(logger1.b.String(), Equals, "WARN hello world\n")
	c.Assert(logger2.b.String(), Equals, "WARN hello world\n")
}

func (s *LogSuite) TestErrorf(c *C) {
	logger1 := newTestLogger("log1")
	logger2 := newTestLogger("log2")
	Init(logger1, logger2)

	Errorf("hello %s", "world")
	c.Assert(logger1.b.String(), Equals, "ERROR hello world\n")
	c.Assert(logger2.b.String(), Equals, "ERROR hello world\n")
}

func typeOf(o interface{}) string {
	return reflect.TypeOf(o).String()
}

// testLogger helps in tests.
type testLogger struct {
	id  string
	b   *bytes.Buffer
	sev Severity
}

func newTestLogger(id string) *testLogger {
	return &testLogger{id, &bytes.Buffer{}, SeverityDebug}
}

func (l *testLogger) Writer(sev Severity) io.Writer {
	return l.b
}

func (l *testLogger) SetSeverity(sev Severity) {
	l.sev = sev
}

func (l *testLogger) GetSeverity() Severity {
	return l.sev
}

func (l *testLogger) FormatMessage(sev Severity, caller *CallerInfo, format string, args ...interface{}) string {
	return fmt.Sprintf("%s %s\n", sev, fmt.Sprintf(format, args...))
}

func (s *LogSuite) TestCallerInfo(c *C) {
	for severity, logFunc := range map[Severity]func(format string, args ...interface{}){
		SeverityError:   Errorf,
		SeverityWarning: Warningf,
		SeverityInfo:    Infof,
		SeverityDebug:   Debugf,
	} {
		// Given
		var l callerLogger
		Init(&l)
		// When
		logFunc("blah")
		// Then
		c.Assert(l.b.String(), Equals, fmt.Sprintf(
			"%s log_test.go[138] github.com/mailgun/log.(*LogSuite).TestCallerInfo", severity))
	}
}

func (s *LogSuite) TestCallerInfoLogfmt(c *C) {
	// Given
	var l callerLogger
	Init(&l)
	// When
	Logfmt(0, SeverityInfo, "blah")
	// Then
	c.Assert(l.b.String(), Equals, "INFO log_test.go[150] github.com/mailgun/log.(*LogSuite).TestCallerInfoLogfmt")
}

type callerLogger struct {
	b bytes.Buffer
}

func (l *callerLogger) Writer(sev Severity) io.Writer {
	return &l.b
}

func (l *callerLogger) SetSeverity(sev Severity) {

}

func (l *callerLogger) GetSeverity() Severity {
	return SeverityInfo
}

func (l *callerLogger) FormatMessage(severity Severity, caller *CallerInfo, format string, args ...interface{}) string {
	return fmt.Sprintf("%s %s[%d] %s", severity, caller.FileName, caller.LineNo, caller.FuncName)
}