Add helper to log to a particular writer

DirectXMan12 · DirectXMan12 · commit 19b9f173c1f4 · 2018-07-31T16:17:20.000-04:00
This adds a helper (ZapLoggerTo) to log to a particular io.Writer.  This
allows us to set our suite logging to `GinkgoWriter`, so that ginkgo
captures the logging output correctly.
diff --git a/pkg/admission/cert/writer/suite_test.go b/pkg/admission/cert/writer/suite_test.go
@@ -32,6 +32,6 @@ func TestSource(t *testing.T) {
 }
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 	close(done)
 }, 60)
diff --git a/pkg/builder/builder_suite_test.go b/pkg/builder/builder_suite_test.go
@@ -19,7 +19,7 @@ var testenv *envtest.Environment
 var cfg *rest.Config
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/cache/cache_suite_test.go b/pkg/cache/cache_suite_test.go
@@ -37,7 +37,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/client/client_suite_test.go b/pkg/client/client_suite_test.go
@@ -38,7 +38,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/client/fake/client_suite_test.go b/pkg/client/fake/client_suite_test.go
@@ -32,6 +32,6 @@ func TestSource(t *testing.T) {
 }
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 	close(done)
 }, 60)
diff --git a/pkg/controller/controller_suite_test.go b/pkg/controller/controller_suite_test.go
@@ -37,7 +37,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/envtest/envtest_suite_test.go b/pkg/envtest/envtest_suite_test.go
@@ -32,7 +32,7 @@ func TestSource(t *testing.T) {
 var env *Environment
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 	env = &Environment{}
 	_, err := env.Start()
 	Expect(err).NotTo(HaveOccurred())
diff --git a/pkg/handler/eventhandler_suite_test.go b/pkg/handler/eventhandler_suite_test.go
@@ -31,5 +31,5 @@ func TestEventhandler(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 })
diff --git a/pkg/internal/controller/controller_suite_test.go b/pkg/internal/controller/controller_suite_test.go
@@ -37,7 +37,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/internal/recorder/recorder_suite_test.go b/pkg/internal/recorder/recorder_suite_test.go
@@ -37,7 +37,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/manager/manager_suite_test.go b/pkg/manager/manager_suite_test.go
@@ -37,7 +37,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 
diff --git a/pkg/predicate/predicate_suite_test.go b/pkg/predicate/predicate_suite_test.go
@@ -31,5 +31,5 @@ func TestPredicate(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 })
diff --git a/pkg/reconcile/reconcile_suite_test.go b/pkg/reconcile/reconcile_suite_test.go
@@ -31,5 +31,5 @@ func TestReconcile(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(logf.ZapLogger(false))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 })
diff --git a/pkg/runtime/log/log.go b/pkg/runtime/log/log.go
@@ -3,15 +3,20 @@
 package log
 
 import (
+	"io"
 	"log"
+	"time"
 
 	"github.com/go-logr/logr"
 	"github.com/go-logr/zapr"
 	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
 )
 
 // ZapLogger is a Logger implementation.
-// if development is true stack traces will be printed for errors
+// If development is true, a Zap development config will be used
+// (stacktraces on warnings, no sampling), otherwise a Zap production
+// config will be used (stacktraces on errors, sampling).
 func ZapLogger(development bool) logr.Logger {
 	var zapLog *zap.Logger
 	var err error
@@ -27,6 +32,40 @@ func ZapLogger(development bool) logr.Logger {
 	return zapr.NewLogger(zapLog)
 }
 
+// ZapLoggerTo returns a new Logger implementation using Zap which logs
+// to the given destination, instead of stderr.  It otherise behaves like
+// ZapLogger.
+func ZapLoggerTo(destWriter io.Writer, development bool) logr.Logger {
+	// this basically mimics New<type>Config, but with a custom sink
+	var sink zapcore.WriteSyncer
+	if asSyncer, isSyncer := destWriter.(zapcore.WriteSyncer); isSyncer {
+		sink = asSyncer
+	} else {
+		sink = zapcore.AddSync(destWriter)
+	}
+	var enc zapcore.Encoder
+	var lvl zap.AtomicLevel
+	var opts []zap.Option
+	if development {
+		encCfg := zap.NewDevelopmentEncoderConfig()
+		enc = zapcore.NewConsoleEncoder(encCfg)
+		lvl = zap.NewAtomicLevelAt(zap.DebugLevel)
+		opts = append(opts, zap.Development(), zap.AddStacktrace(zap.ErrorLevel))
+	} else {
+		encCfg := zap.NewProductionEncoderConfig()
+		enc = zapcore.NewJSONEncoder(encCfg)
+		lvl = zap.NewAtomicLevelAt(zap.InfoLevel)
+		opts = append(opts, zap.AddStacktrace(zap.WarnLevel),
+			zap.WrapCore(func(core zapcore.Core) zapcore.Core {
+				return zapcore.NewSampler(core, time.Second, 100, 100)
+			}))
+	}
+	opts = append(opts, zap.AddCallerSkip(1), zap.ErrorOutput(sink))
+	log := zap.New(zapcore.NewCore(enc, sink, lvl))
+	log = log.WithOptions(opts...)
+	return zapr.NewLogger(log)
+}
+
 func fatalIfErr(err error, f func(format string, v ...interface{})) {
 	if err != nil {
 		f("unable to construct the logger: %v", err)
diff --git a/pkg/source/internal/internal_suite_test.go b/pkg/source/internal/internal_suite_test.go
@@ -31,5 +31,5 @@ func TestInternal(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(logf.ZapLogger(true))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 })
diff --git a/pkg/source/source_suite_test.go b/pkg/source/source_suite_test.go
@@ -41,7 +41,7 @@ var stop chan struct{}
 
 var _ = BeforeSuite(func(done Done) {
 	stop = make(chan struct{})
-	logf.SetLogger(logf.ZapLogger(true))
+	logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))
 
 	testenv = &envtest.Environment{}
 

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,6 @@ func TestSource(t *testing.T) {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`var _ = BeforeSuite(func(done Done) {`
`35`		`- logf.SetLogger(logf.ZapLogger(false))`
	`35`	`+ logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))`
`36`	`36`	`close(done)`
`37`	`37`	`}, 60)`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,5 @@ func TestEventhandler(t *testing.T) {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`var _ = BeforeSuite(func() {`
`34`		`- logf.SetLogger(logf.ZapLogger(false))`
	`34`	`+ logf.SetLogger(logf.ZapLoggerTo(GinkgoWriter, true))`
`35`	`35`	`})`