xlog_test.go

package xlog_test

import (
	"io/ioutil"
	"os"
	"testing"
	"time"

	"github.com/goinsane/xlog"
)

var (
	testTime, _ = time.ParseInLocation("2006-01-02T15:04:05", "2010-11-12T13:14:15", time.Local)
)

// resetForTest resets xlog to run new test.
func resetForTest() {
	xlog.Reset()
	xlog.SetFlags(xlog.FlagDefault & ^xlog.FlagDate & ^xlog.FlagTime & ^xlog.FlagStackTrace)
	xlog.SetOutputWriter(os.Stdout)
}

func Example() {
	// reset xlog for previous changes if it is running in go test.
	xlog.Reset()
	// change writer of default output to stdout from stderr.
	xlog.SetOutputWriter(os.Stdout)

	// log by Severity.
	// default severity is SeverityInfo.
	// default verbose is 0.
	xlog.Debug("this is debug log. but it won't be shown.")
	xlog.Info("this is info log.")
	xlog.Warning("this is warning log.")
	xlog.V(1).Error("this is error log, verbosity 1. but it won't be shown.")

	// SetSeverity()
	xlog.SetSeverity(xlog.SeverityDebug)
	xlog.Debug("this is debug log. it will now be shown.")

	// SetVerbose() and V()
	xlog.SetVerbose(1)
	xlog.V(1).Error("this is error log, verbosity 1. it will now be shown.")
	xlog.V(2).Warning("this is warning log, verbosity 2. it won't be shown.")

	// SetFlags()
	// default flags is FlagDefault.
	xlog.SetFlags(xlog.FlagDefault | xlog.FlagShortFile)
	xlog.Info("this is info log. you can see file name and line in this log.")

	// log using Print.
	// default print severity is SeverityInfo.
	xlog.Print("this log will be shown as info log.")

	// SetPrintSeverity()
	xlog.SetPrintSeverity(xlog.SeverityWarning)
	xlog.Print("this log will now be shown as warning log.")

	// SetStackTraceSeverity()
	// default stack trace severity is none.
	xlog.SetStackTraceSeverity(xlog.SeverityWarning)
	xlog.Warning("this is warning log. you can see stack trace end of this log.")
	xlog.Error("this is error log. you can still see stack trace end of this log.")
	xlog.Info("this is info log. stack trace won't be shown end of this log.")

	// WithPrefix()
	xlog.WithPrefix("prefix1").Warning("this is warning log with prefix 'prefix1'.")
	xlog.WithPrefix("prefix1").WithPrefix("prefix2").Error("this is error log with both of prefixes 'prefix1' and 'prefix2'.")

	// WithTime()
	xlog.WithTime(testTime).Info("this is info log with custom time.")

	// WithFieldKeyVals()
	xlog.WithFieldKeyVals("key1", "val1", "key2", "val2", "key3", "val3", "key1", "val1-2", "key2", "val2-2").Info("this is info log with several fields.")
}

func Example_test1() {
	// reset xlog for previous changes if it is running in go test.
	xlog.Reset()
	// just show severity.
	xlog.SetFlags(xlog.FlagSeverity)
	// change writer of default output to stdout from stderr.
	xlog.SetOutputWriter(os.Stdout)

	xlog.Debug("this is debug log, verbosity 0. it will not be shown.")
	xlog.Info("this is info log, verbosity 0.")
	xlog.Warning("this is warning log, verbosity 0.")
	xlog.Error("this is error log, verbosity 0.")
	xlog.Print("this is info log, verbosity 0 caused by Print().")
	xlog.V(1).Info("this is info log, verbosity 1. it will not be shown.")

	xlog.SetSeverity(xlog.SeverityDebug)
	xlog.Debug("this is debug log, verbosity 0.")

	xlog.SetVerbose(1)
	xlog.V(0).Info("this is info log, verbosity 0.")
	xlog.V(1).Info("this is info log, verbosity 1.")
	xlog.V(2).Info("this is info log, verbosity 2. it will not be shown.")

	xlog.SetPrintSeverity(xlog.SeverityWarning)
	xlog.Print("this is warning log, verbosity 0 caused by Print().")

	xlog.Warning("this is warning log, verbosity 0.\nwithout padding.")
	xlog.SetFlags(xlog.FlagSeverity | xlog.FlagPadding)
	xlog.Warning("this is warning log, verbosity 0.\nwith padding.")

	xlog.SetFlags(xlog.FlagDefault)
	tm, _ := time.ParseInLocation("2006-01-02T15:04:05", "2019-11-13T21:56:24", time.Local)
	xlog.WithTime(tm).Info("this is info log, verbosity 0.")

	// Output:
	// INFO - this is info log, verbosity 0.
	// WARNING - this is warning log, verbosity 0.
	// ERROR - this is error log, verbosity 0.
	// INFO - this is info log, verbosity 0 caused by Print().
	// DEBUG - this is debug log, verbosity 0.
	// INFO - this is info log, verbosity 0.
	// INFO - this is info log, verbosity 1.
	// WARNING - this is warning log, verbosity 0 caused by Print().
	// WARNING - this is warning log, verbosity 0.
	// without padding.
	// WARNING - this is warning log, verbosity 0.
	//           with padding.
	// 2019/11/13 21:56:24 INFO - this is info log, verbosity 0.
}

func ExampleSetSeverity() {
	resetForTest()
	xlog.SetSeverity(xlog.SeverityDebug)
	xlog.Debug("this is debug log, verbosity 0.")
	xlog.Info("this is info log, verbosity 0.")
	xlog.Warning("this is warning log, verbosity 0.")

	// Output:
	// DEBUG - this is debug log, verbosity 0.
	// INFO - this is info log, verbosity 0.
	// WARNING - this is warning log, verbosity 0.
}

func ExampleSetVerbose() {
	resetForTest()
	xlog.SetVerbose(2)
	xlog.V(0).Debug("this is debug log, verbosity 0. it won't be shown.")
	xlog.V(1).Info("this is info log, verbosity 1.")
	xlog.V(2).Warning("this is warning log, verbosity 2.")
	xlog.V(3).Error("this is error log, verbosity 3. it won't be shown.")

	// Output:
	// INFO - this is info log, verbosity 1.
	// WARNING - this is warning log, verbosity 2.
}

func ExampleSetFlags() {
	resetForTest()
	xlog.SetFlags(0)
	xlog.Info("this is info log, verbosity 0.")

	// Output:
	// this is info log, verbosity 0.
}

func ExampleWithTime() {
	resetForTest()
	xlog.SetFlags(xlog.FlagDefault)
	xlog.WithTime(testTime).Info("this is info log, verbosity 0.")

	// Output:
	// 2010/11/12 13:14:15 INFO - this is info log, verbosity 0.
}

func ExampleLogger() {
	logger := xlog.New(xlog.NewTextOutput(os.Stdout), xlog.SeverityInfo, 2)
	logger.SetFlags(xlog.FlagSeverity)

	logger.Info("this is info log, verbosity 0.")
	logger.V(0).Info("this is info log, verbosity 0.")
	logger.V(1).Warning("this is warning log, verbosity 1.")
	logger.V(2).Error("this is error log, verbosity 2.")
	logger.V(3).Error("this is error log, verbosity 3. it won't be shown.")
	logger.Debug("this is debug log, verbosity 0. it won't be shown.")

	// Output:
	// INFO - this is info log, verbosity 0.
	// INFO - this is info log, verbosity 0.
	// WARNING - this is warning log, verbosity 1.
	// ERROR - this is error log, verbosity 2.
}

func BenchmarkLogger_Info(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Info("benchmark")
	}
}

func BenchmarkLogger_Infof(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Infof("%s", "benchmark")
	}
}

func BenchmarkLogger_Infoln(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Infoln("benchmark")
	}
}

func BenchmarkLogger_Info_withStackTrace(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	logger.SetStackTraceSeverity(xlog.SeverityInfo)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Info("benchmark")
	}
}

func BenchmarkLogger_Info_withFlagLongFunc(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	logger.SetFlags(xlog.FlagDefault | xlog.FlagLongFunc)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Info("benchmark")
	}
}

func BenchmarkLogger_Info_withFlagShortFunc(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	logger.SetFlags(xlog.FlagDefault | xlog.FlagShortFunc)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Info("benchmark")
	}
}

func BenchmarkLogger_Info_withFlagLongFile(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	logger.SetFlags(xlog.FlagDefault | xlog.FlagLongFile)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Info("benchmark")
	}
}

func BenchmarkLogger_Info_withFlagShortFile(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	logger.SetFlags(xlog.FlagDefault | xlog.FlagShortFile)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.Info("benchmark")
	}
}

func BenchmarkLogger_V(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 5)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.V(1)
	}
}

func BenchmarkLogger_WithPrefix(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.WithPrefix("prefix")
	}
}

func BenchmarkLogger_WithPrefixf(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.WithPrefixf("%s", "prefix")
	}
}

func BenchmarkLogger_WithTime(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.WithTime(testTime)
	}
}

func BenchmarkLogger_WithFieldKeyVals(b *testing.B) {
	logger := xlog.New(xlog.NewTextOutput(ioutil.Discard), xlog.SeverityInfo, 0)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		logger.WithFieldKeyVals("key1", "value1")
	}
}