Ensure that different log implementations work

Author: Lars Ekman

pkg/log/logger.go

@@ -21,8 +21,10 @@ import (
 	"sync"
 
 	"github.com/go-logr/logr"
+	nsmlog "github.com/networkservicemesh/sdk/pkg/tools/log"
 )
 
+
 // Several different logr backends can be tested by remove/add comment
 // below.
 
@@ -38,7 +40,6 @@ func init() {
 	defaultLogger = newLogger("").WithName("Meridio")
 }
 */
-
 /*
 // Zerologr doesn't implement logger.Enabled() correctly
 import (
@@ -65,10 +66,12 @@ func newLogger(level string) logr.Logger {
     return zerologr.New(&zl)
 }
 func init() {
-	defaultLogger = newLogger("").WithName("Meridio")
+	Logger = newLogger("").WithName("Meridio")
+}
+func NSMLogger(logger logr.Logger) nsmlog.Logger {
+	return nil
 }
 */
-
 /*
 import (
 	"fmt"
@@ -97,10 +100,12 @@ func newLogger(level string) logr.Logger {
 
 }
 func init() {
-	defaultLogger = newLogger("").WithName("Meridio")
+	Logger = newLogger("").WithName("Meridio")
+}
+func NSMLogger(logger logr.Logger) nsmlog.Logger {
+	return nil
 }
 */
-
 /*
 import (
     "github.com/bombsimon/logrusr/v3"
@@ -123,7 +128,10 @@ func newLogger(level string) logr.Logger {
     return logrusr.New(logrusLog)
 }
 func init() {
-	defaultLogger = newLogger("").WithName("Meridio")
+	Logger = newLogger("").WithName("Meridio")
+}
+func NSMLogger(logger logr.Logger) nsmlog.Logger {
+	return nil
 }
 */
 
@@ -136,7 +144,6 @@ import (
 	"go.uber.org/zap"
 	"go.uber.org/zap/buffer"
 	"go.uber.org/zap/zapcore"
-	nsmlog "github.com/networkservicemesh/sdk/pkg/tools/log"
 )
 
 func timeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
@@ -311,45 +318,30 @@ func init() {
 	Logger = newLogger("").WithName("Meridio")
 }
 
+// ZapLogger returns the underlying zap.Logger.
+// NOTE; this breaks the use of different log implementations!
+func ZapLogger(logger logr.Logger) *zap.Logger {
+	if underlier, ok := logger.GetSink().(zapr.Underlier); ok {
+		return underlier.GetUnderlying()
+	} else {
+		return nil
+	}
+}
+
 // Fatal log the message using the passed logger and terminate
 func Fatal(logger logr.Logger, msg string, keysAndValues ...interface{}) {
-	// Get the zap logger
-	if underlier, ok := logger.GetSink().(zapr.Underlier); ok {
-		z := underlier.GetUnderlying()
+	if z := ZapLogger(logger); z != nil {
 		z.Sugar().Fatalw(msg, keysAndValues...)
 	} else {
 		// Fallback to go default
 		golog.Fatal(msg, keysAndValues)
 	}
 }
 
-// The global logger
-var Logger logr.Logger
-
-// FromContextOrDefault return a logger from the passed context or a
-// default logger. This function is intended as a temprary solution
-// during the transition to structured logging.
-func FromContextOrDefault(ctx context.Context) logr.Logger {
-	if logger, err := logr.FromContext(ctx); err == nil {
-		return logger
-	}
-	return Logger
-}
-
-// New returns a new logger. The level may be "DEBUG" (V(1)) or "TRACE" (V(2)),
-// any other string (e.g. "") is interpreted as "INFO" (V(0)).
-func New(name, level string) logr.Logger {
-	logger := newLogger(level).WithName(name)
-	once.Do(func () {Logger = logger})
-	return logger
-}
-var once sync.Once
-
-
 // NSMLogger return a logger to use for NSM logging.
-func NSMLogger(baseLogger logr.Logger) nsmlog.Logger {
+func NSMLogger(logger logr.Logger) nsmlog.Logger {
 	// Get the zap logger
-	if underlier, ok := baseLogger.GetSink().(zapr.Underlier); ok {
+	if underlier, ok := logger.GetSink().(zapr.Underlier); ok {
 		z := underlier.GetUnderlying()
 		return &nsmLogger{ z: z, s: z.Sugar() }
 	} else {
@@ -408,3 +400,27 @@ func (l *nsmLogger) WithField(key, value interface{}) nsmlog.Logger {
 		z: l.z.With(zap.Any(fmt.Sprintf("%v", key), value)),
 	}
 }
+
+
+// The global logger
+var Logger logr.Logger
+
+// FromContextOrGlobal return a logger from the passed context or the
+// global logger.
+func FromContextOrDefault(ctx context.Context) logr.Logger {
+	if logger, err := logr.FromContext(ctx); err == nil {
+		return logger
+	}
+	return Logger
+}
+
+// New returns a new logger. The level may be "DEBUG" (V(1)) or "TRACE" (V(2)),
+// any other string (e.g. "") is interpreted as "INFO" (V(0)). On first call
+// the global Logger is set.
+func New(name, level string) logr.Logger {
+	logger := newLogger(level).WithName(name)
+	once.Do(func () {Logger = logger})
+	return logger
+}
+var once sync.Once
+

pkg/log/logger_test.go

@@ -48,6 +48,8 @@ func TestLogger(t *testing.T) {
 	//log.Fatal(logger, "Can't read crucial data", "error", fmt.Errorf("Not found"))
 
 	nsmlogger := log.NSMLogger(log.New("NSMLogger-info", ""))
-	nsmlogger.Info("one", "two", "three")
-	nsmlogger.Infof("%v, %v, %v", "one", "two", "three")
+	if nsmlogger != nil {
+		nsmlogger.Info("one", "two", "three")
+		nsmlogger.Infof("%v, %v, %v", "one", "two", "three")
+	}
 }