🐛 Check to see if obj is nil so there is no panic trying to get the gvk (#1807)

* Check to see if obj is nil so there is no panic trying to get the gvk

Co-authored-by: Marty Spiewak <[email protected]>

* Update pkg/log/zap/zap_test.go

Co-authored-by: Alvaro Aleman <[email protected]>

* Fix lint check

Co-authored-by: Marty Spiewak <[email protected]>

Co-authored-by: Marty Spiewak <[email protected]>
Co-authored-by: Alvaro Aleman <[email protected]>

Author: 3 people

pkg/log/zap/kube_helpers.go

@@ -18,6 +18,7 @@ package zap
 
 import (
 	"fmt"
+	"reflect"
 
 	"go.uber.org/zap/buffer"
 	"go.uber.org/zap/zapcore"
@@ -64,6 +65,11 @@ type kubeObjectWrapper struct {
 func (w kubeObjectWrapper) MarshalLogObject(enc zapcore.ObjectEncoder) error {
 	// TODO(directxman12): log kind and apiversion if not set explicitly (common case)
 	// -- needs an a scheme to convert to the GVK.
+
+	if reflect.ValueOf(w.obj).IsNil() {
+		return fmt.Errorf("got nil for runtime.Object")
+	}
+
 	if gvk := w.obj.GetObjectKind().GroupVersionKind(); gvk.Version != "" {
 		enc.AddString("apiVersion", gvk.GroupVersion().String())
 		enc.AddString("kind", gvk.Kind)

pkg/log/zap/zap_test.go

@@ -255,6 +255,14 @@ var _ = Describe("Zap logger setup", func() {
 					"namespace": name.Namespace,
 				}))
 			})
+
+			It("should not panic with nil obj", func() {
+				var pod *corev1.Pod
+				logger.Info("here's a kubernetes object", "thing", pod)
+
+				outRaw := logOut.Bytes()
+				Expect(string(outRaw)).Should(ContainSubstring("got nil for runtime.Object"))
+			})
 		}
 
 		Context("with logger created using New", func() {