Add an option to consider nil pointers to be equivalent to zero values

seveas · seveas · commit 2b8252e0e292 · 2024-04-04T19:00:00.000+02:00
Similar to NilSlicesAreEmpty and NilStructsAreEmpty, this lets one
consider nil pointers and zero values as equal.
diff --git a/deep.go b/deep.go
@@ -43,6 +43,9 @@ var (
 
 	// NilMapsAreEmpty causes a nil map to be equal to an empty map.
 	NilMapsAreEmpty = false
+
+	// NilPointersAreZero causes a nil pointer to be equal to a zero value.
+	NilPointersAreZero = false
 )
 
 var (
@@ -190,6 +193,12 @@ func (c *cmp) equals(a, b reflect.Value, level int) {
 		if bElem {
 			b = b.Elem()
 		}
+		if aElem && NilPointersAreZero && !a.IsValid() && b.IsValid() {
+			a = reflect.Zero(b.Type())
+		}
+		if bElem && NilPointersAreZero && !b.IsValid() && a.IsValid() {
+			b = reflect.Zero(a.Type())
+		}
 		c.equals(a, b, level+1)
 		return
 	}
diff --git a/deep_test.go b/deep_test.go
@@ -1581,3 +1581,27 @@ func TestSliceOrderStruct(t *testing.T) {
 		t.Fatalf("expected 0 diff, got %d: %s", len(diff), diff)
 	}
 }
+
+func TestNilPointersAreZero(t *testing.T) {
+	defaultNilPointersAreZero := deep.NilPointersAreZero
+	deep.NilPointersAreZero = true
+	defer func() { deep.NilPointersAreZero = defaultNilPointersAreZero }()
+
+	type T struct {
+		S *string
+	}
+
+	a := T{S: nil}
+	b := T{S: new(string)}
+
+	diff := deep.Equal(a, b)
+	if len(diff) != 0 {
+		t.Fatalf("expected 0 diff, got %d: %s", len(diff), diff)
+	}
+
+	*b.S = "hello"
+	diff = deep.Equal(a, b)
+	if len(diff) != 1 {
+		t.Fatalf("expected 1 diff, got %d: %s", len(diff), diff)
+	}
+}
