Merge pull request #1105 from vincepri/remove-deprecated-log

⚠️ Remove deprecated pkg/runtime/log package and utils
kubernetes-sigs · Aug 4, 2020 · 752d59d · 752d59d
2 parents e639487 + a32b29d
commit 752d59d
Show file tree

Hide file tree

Showing 27 changed files with 23 additions and 151 deletions.
diff --git a/examples/builtins/main.go b/examples/builtins/main.go
@@ -36,7 +36,7 @@ import (
 var log = logf.Log.WithName("example-controller")
 
 func main() {
-	logf.SetLogger(zap.Logger(false))
+	logf.SetLogger(zap.New())
 	entryLog := log.WithName("entrypoint")
 
 	// Setup a Manager

diff --git a/examples/crd/main.go b/examples/crd/main.go
@@ -103,7 +103,7 @@ func (r *reconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
 }
 
 func main() {
-	ctrl.SetLogger(zap.Logger(true))
+	ctrl.SetLogger(zap.New())
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{})
 	if err != nil {

diff --git a/examples/crd/pkg/groupversion_info.go b/examples/crd/pkg/groupversion_info.go
@@ -20,7 +20,7 @@ package pkg
 
 import (
 	"k8s.io/apimachinery/pkg/runtime/schema"
-	logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
+	logf "sigs.k8s.io/controller-runtime/pkg/log"
 	"sigs.k8s.io/controller-runtime/pkg/scheme"
 )
 

diff --git a/pkg/builder/builder_suite_test.go b/pkg/builder/builder_suite_test.go
@@ -46,7 +46,7 @@ var testenv *envtest.Environment
 var cfg *rest.Config
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 	addCRDToEnvironment(testenv,

diff --git a/pkg/cache/cache_suite_test.go b/pkg/cache/cache_suite_test.go
@@ -40,7 +40,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 

diff --git a/pkg/client/apiutil/apiutil_suite_test.go b/pkg/client/apiutil/apiutil_suite_test.go
@@ -37,7 +37,7 @@ func TestSource(t *testing.T) {
 var cfg *rest.Config
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	// for things that technically need a rest.Config for defaulting, but don't actually use them
 	cfg = &rest.Config{}

diff --git a/pkg/client/client_suite_test.go b/pkg/client/client_suite_test.go
@@ -41,7 +41,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 

diff --git a/pkg/client/config/config_suite_test.go b/pkg/client/config/config_suite_test.go
@@ -34,7 +34,7 @@ func TestConfig(t *testing.T) {
 }
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	close(done)
 }, 60)
diff --git a/pkg/client/fake/client_suite_test.go b/pkg/client/fake/client_suite_test.go
@@ -34,6 +34,6 @@ func TestSource(t *testing.T) {
 }
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 	close(done)
 }, 60)
diff --git a/pkg/controller/controller_suite_test.go b/pkg/controller/controller_suite_test.go
@@ -46,7 +46,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	err := (&crscheme.Builder{
 		GroupVersion: schema.GroupVersion{Group: "chaosapps.metamagical.io", Version: "v1"},

diff --git a/pkg/envtest/envtest_suite_test.go b/pkg/envtest/envtest_suite_test.go
@@ -39,7 +39,7 @@ func TestSource(t *testing.T) {
 var env *Environment
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 	env = &Environment{}
 	// we're initializing webhook here and not in webhook.go to also test the envtest install code via WebhookOptions
 	initializeWebhookInEnvironment()

diff --git a/pkg/handler/eventhandler_suite_test.go b/pkg/handler/eventhandler_suite_test.go
@@ -38,7 +38,7 @@ var testenv *envtest.Environment
 var cfg *rest.Config
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 	var err error

diff --git a/pkg/healthz/healthz_suite_test.go b/pkg/healthz/healthz_suite_test.go
@@ -33,5 +33,5 @@ func TestHealthz(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 })
diff --git a/pkg/internal/controller/controller_suite_test.go b/pkg/internal/controller/controller_suite_test.go
@@ -40,7 +40,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 

diff --git a/pkg/internal/log/log.go b/pkg/internal/log/log.go
@@ -14,9 +14,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package log contains utilities for fetching a new logger
-// when one is not already available.
-// Deprecated: use pkg/log
 package log
 
 import (

diff --git a/pkg/internal/recorder/recorder_suite_test.go b/pkg/internal/recorder/recorder_suite_test.go
@@ -40,7 +40,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 

diff --git a/pkg/log/zap/zap.go b/pkg/log/zap/zap.go
@@ -37,39 +37,6 @@ func New(opts ...Opts) logr.Logger {
 	return zapr.NewLogger(NewRaw(opts...))
 }
 
-// Logger is a Logger implementation.
-// 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).
-//
-// Deprecated: use New() and the functional opts pattern instead:
-//
-// New(UseDevMode(development))
-func Logger(development bool) logr.Logger {
-	return LoggerTo(os.Stderr, development)
-}
-
-// LoggerTo returns a new Logger implementation using Zap which logs
-// to the given destination, instead of stderr.  It otherwise behaves like
-// ZapLogger.
-//
-// Deprecated: use New() and the functional opts pattern instead:
-//
-// New(UseDevMode(development), WriteTo(writer))
-func LoggerTo(destWriter io.Writer, development bool) logr.Logger {
-	return zapr.NewLogger(RawLoggerTo(destWriter, development))
-}
-
-// RawLoggerTo returns a new zap.Logger configured with KubeAwareEncoder
-// which logs to a given destination
-//
-// Deprecated: use NewRaw() and the functional opts pattern instead:
-//
-// NewRaw(UseDevMode(development), WriteTo(destWriter), RawZapOpts(opts...))
-func RawLoggerTo(destWriter io.Writer, development bool, opts ...zap.Option) *zap.Logger {
-	return NewRaw(UseDevMode(development), WriteTo(destWriter), RawZapOpts(opts...))
-}
-
 // Opts allows to manipulate Options
 type Opts func(*Options)
 

diff --git a/pkg/log/zap/zap_test.go b/pkg/log/zap/zap_test.go
@@ -20,7 +20,6 @@ import (
 	"bytes"
 	"encoding/json"
 	"flag"
-	"io/ioutil"
 	"os"
 
 	"github.com/go-logr/logr"
@@ -143,30 +142,6 @@ var _ = Describe("Zap options setup", func() {
 })
 
 var _ = Describe("Zap logger setup", func() {
-	Context("with the default output", func() {
-		It("shouldn't fail when setting up production", func() {
-			Expect(Logger(false)).NotTo(BeNil())
-			Expect(New(UseDevMode(false))).NotTo(BeNil())
-		})
-
-		It("shouldn't fail when setting up development", func() {
-			Expect(Logger(true)).NotTo(BeNil())
-			Expect(New(UseDevMode(true))).NotTo(BeNil())
-		})
-	})
-
-	Context("with custom non-sync output", func() {
-		It("shouldn't fail when setting up production", func() {
-			Expect(LoggerTo(ioutil.Discard, false)).NotTo(BeNil())
-			Expect(New(WriteTo(ioutil.Discard), UseDevMode(false))).NotTo(BeNil())
-		})
-
-		It("shouldn't fail when setting up development", func() {
-			Expect(LoggerTo(ioutil.Discard, true)).NotTo(BeNil())
-			Expect(New(WriteTo(ioutil.Discard), UseDevMode(true))).NotTo(BeNil())
-		})
-	})
-
 	Context("when logging kubernetes objects", func() {
 		var logOut *bytes.Buffer
 		var logger logr.Logger
@@ -288,15 +263,6 @@ var _ = Describe("Zap logger setup", func() {
 			defineTests()
 
 		})
-		Context("with logger created using LoggerTo", func() {
-			BeforeEach(func() {
-				logOut = new(bytes.Buffer)
-				By("setting up the logger")
-				// use production settings (false) to get just json output
-				logger = LoggerTo(logOut, false)
-			})
-			defineTests()
-		})
 	})
 })
 

diff --git a/pkg/manager/manager_suite_test.go b/pkg/manager/manager_suite_test.go
@@ -41,7 +41,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 

diff --git a/pkg/predicate/predicate_suite_test.go b/pkg/predicate/predicate_suite_test.go
@@ -33,5 +33,5 @@ func TestPredicate(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 })
diff --git a/pkg/reconcile/reconcile_suite_test.go b/pkg/reconcile/reconcile_suite_test.go
@@ -33,5 +33,5 @@ func TestReconcile(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 })
diff --git a/pkg/runtime/log/log.go b/pkg/runtime/log/log.go
diff --git a/pkg/source/internal/internal_suite_test.go b/pkg/source/internal/internal_suite_test.go
@@ -33,5 +33,5 @@ func TestInternal(t *testing.T) {
 }
 
 var _ = BeforeSuite(func() {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 })
diff --git a/pkg/source/source_suite_test.go b/pkg/source/source_suite_test.go
@@ -44,7 +44,7 @@ var stop chan struct{}
 
 var _ = BeforeSuite(func(done Done) {
 	stop = make(chan struct{})
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}
 

diff --git a/pkg/webhook/admission/admission_suite_test.go b/pkg/webhook/admission/admission_suite_test.go
@@ -34,7 +34,7 @@ func TestAdmissionWebhook(t *testing.T) {
 }
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	close(done)
 }, 60)
diff --git a/pkg/webhook/conversion/conversion_suite_test.go b/pkg/webhook/conversion/conversion_suite_test.go
@@ -33,7 +33,7 @@ func TestConversionWebhook(t *testing.T) {
 }
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	close(done)
 })
diff --git a/pkg/webhook/webhook_suite_test.go b/pkg/webhook/webhook_suite_test.go
@@ -41,7 +41,7 @@ var cfg *rest.Config
 var clientset *kubernetes.Clientset
 
 var _ = BeforeSuite(func(done Done) {
-	logf.SetLogger(zap.LoggerTo(GinkgoWriter, true))
+	logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true)))
 
 	testenv = &envtest.Environment{}