Ban require.Equal when testing for 0 (ava-labs#1495)

Author: dhrubabasu

codec/test_codec.go

@@ -149,7 +149,7 @@ func TestStruct(codec GeneralCodec, t testing.TB) {
 	version, err := manager.Unmarshal(myStructBytes, myStructUnmarshaled)
 	require.NoError(err)
 
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myStructInstance, *myStructUnmarshaled)
 }
 
@@ -180,7 +180,7 @@ func TestUInt32(codec GeneralCodec, t testing.TB) {
 	var numberUnmarshaled uint32
 	version, err := manager.Unmarshal(bytes, &numberUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(number, numberUnmarshaled)
 }
 
@@ -215,7 +215,7 @@ func TestSlice(codec GeneralCodec, t testing.TB) {
 	var sliceUnmarshaled []bool
 	version, err := manager.Unmarshal(bytes, &sliceUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(mySlice, sliceUnmarshaled)
 }
 
@@ -240,7 +240,7 @@ func TestMaxSizeSlice(codec GeneralCodec, t testing.TB) {
 	var sliceUnmarshaled []string
 	version, err := manager.Unmarshal(bytes, &sliceUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(mySlice, sliceUnmarshaled)
 }
 
@@ -263,7 +263,7 @@ func TestBool(codec GeneralCodec, t testing.TB) {
 	var boolUnmarshaled bool
 	version, err := manager.Unmarshal(bytes, &boolUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myBool, boolUnmarshaled)
 }
 
@@ -286,7 +286,7 @@ func TestArray(codec GeneralCodec, t testing.TB) {
 	var myArrUnmarshaled [5]uint64
 	version, err := manager.Unmarshal(bytes, &myArrUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myArr, myArrUnmarshaled)
 }
 
@@ -309,7 +309,7 @@ func TestBigArray(codec GeneralCodec, t testing.TB) {
 	var myArrUnmarshaled [30000]uint64
 	version, err := manager.Unmarshal(bytes, &myArrUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myArr, myArrUnmarshaled)
 }
 
@@ -332,7 +332,7 @@ func TestPointerToStruct(codec GeneralCodec, t testing.TB) {
 	var myPtrUnmarshaled *MyInnerStruct
 	version, err := manager.Unmarshal(bytes, &myPtrUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myPtr, myPtrUnmarshaled)
 }
 
@@ -369,7 +369,7 @@ func TestSliceOfStruct(codec GeneralCodec, t testing.TB) {
 	var mySliceUnmarshaled []MyInnerStruct3
 	version, err := manager.Unmarshal(bytes, &mySliceUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(mySlice, mySliceUnmarshaled)
 }
 
@@ -395,7 +395,7 @@ func TestInterface(codec GeneralCodec, t testing.TB) {
 	var unmarshaledFoo Foo
 	version, err := manager.Unmarshal(bytes, &unmarshaledFoo)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(f, unmarshaledFoo)
 }
 
@@ -428,7 +428,7 @@ func TestSliceOfInterface(codec GeneralCodec, t testing.TB) {
 	var mySliceUnmarshaled []Foo
 	version, err := manager.Unmarshal(bytes, &mySliceUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(mySlice, mySliceUnmarshaled)
 }
 
@@ -461,7 +461,7 @@ func TestArrayOfInterface(codec GeneralCodec, t testing.TB) {
 	var myArrayUnmarshaled [2]Foo
 	version, err := manager.Unmarshal(bytes, &myArrayUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myArray, myArrayUnmarshaled)
 }
 
@@ -489,7 +489,7 @@ func TestPointerToInterface(codec GeneralCodec, t testing.TB) {
 	var myPtrUnmarshaled *Foo
 	version, err := manager.Unmarshal(bytes, &myPtrUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myPtr, myPtrUnmarshaled)
 }
 
@@ -512,7 +512,7 @@ func TestString(codec GeneralCodec, t testing.TB) {
 	var stringUnmarshaled string
 	version, err := manager.Unmarshal(bytes, &stringUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myString, stringUnmarshaled)
 }
 
@@ -539,8 +539,8 @@ func TestNilSlice(codec GeneralCodec, t testing.TB) {
 	var structUnmarshaled structWithSlice
 	version, err := manager.Unmarshal(bytes, &structUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
-	require.Equal(0, len(structUnmarshaled.Slice))
+	require.Zero(version)
+	require.Empty(structUnmarshaled.Slice)
 }
 
 // Ensure that trying to serialize a struct with an unexported member
@@ -596,7 +596,7 @@ func TestSerializeOfNoSerializeField(codec GeneralCodec, t testing.TB) {
 	unmarshalled := s{}
 	version, err := manager.Unmarshal(marshalled, &unmarshalled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 
 	expectedUnmarshalled := s{SerializedField: "Serialize me"}
 	require.Equal(expectedUnmarshalled, unmarshalled)
@@ -627,8 +627,8 @@ func TestNilSliceSerialization(codec GeneralCodec, t testing.TB) {
 	valUnmarshaled := &simpleSliceStruct{}
 	version, err := manager.Unmarshal(result, &valUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
-	require.Equal(0, len(valUnmarshaled.Arr))
+	require.Zero(version)
+	require.Empty(valUnmarshaled.Arr)
 }
 
 // Test marshaling a slice that has 0 elements (but isn't nil)
@@ -656,7 +656,7 @@ func TestEmptySliceSerialization(codec GeneralCodec, t testing.TB) {
 	valUnmarshaled := &simpleSliceStruct{}
 	version, err := manager.Unmarshal(result, &valUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(val, valUnmarshaled)
 }
 
@@ -689,7 +689,7 @@ func TestSliceWithEmptySerialization(codec GeneralCodec, t testing.TB) {
 	unmarshaled := nestedSliceStruct{}
 	version, err := manager.Unmarshal(expected, &unmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(1000, len(unmarshaled.Arr))
 }
 
@@ -756,7 +756,7 @@ func TestNegativeNumbers(codec GeneralCodec, t testing.TB) {
 	mySUnmarshaled := s{}
 	version, err := manager.Unmarshal(bytes, &mySUnmarshaled)
 	require.NoError(err)
-	require.Equal(uint16(0), version)
+	require.Zero(version)
 	require.Equal(myS, mySUnmarshaled)
 }
 
@@ -808,7 +808,7 @@ func TestUnmarshalInvalidInterface(codec GeneralCodec, t testing.TB) {
 		s := outer{}
 		version, err := manager.Unmarshal(bytes, &s)
 		require.NoError(err)
-		require.Equal(uint16(0), version)
+		require.Zero(version)
 	}
 	{
 		bytes := []byte{0, 0, 0, 0, 0, 1}

database/manager/manager_test.go

@@ -39,7 +39,7 @@ func TestNewSingleLevelDB(t *testing.T) {
 
 	semDB := manager.Current()
 	cmp := semDB.Version.Compare(v1)
-	require.Equal(0, cmp, "incorrect version on current database")
+	require.Zero(cmp, "incorrect version on current database")
 
 	_, exists := manager.Previous()
 	require.False(exists, "there should be no previous database")
@@ -63,7 +63,7 @@ func TestNewCreatesSingleDB(t *testing.T) {
 
 	semDB := manager.Current()
 	cmp := semDB.Version.Compare(v1)
-	require.Equal(0, cmp, "incorrect version on current database")
+	require.Zero(cmp, "incorrect version on current database")
 
 	_, exists := manager.Previous()
 	require.False(exists, "there should be no previous database")
@@ -173,19 +173,19 @@ func TestNewSortsDatabases(t *testing.T) {
 
 	semDB := manager.Current()
 	cmp := semDB.Version.Compare(vers[0])
-	require.Equal(0, cmp, "incorrect version on current database")
+	require.Zero(cmp, "incorrect version on current database")
 
 	prev, exists := manager.Previous()
 	require.True(exists, "expected to find a previous database")
 	cmp = prev.Version.Compare(vers[1])
-	require.Equal(0, cmp, "incorrect version on previous database")
+	require.Zero(cmp, "incorrect version on previous database")
 
 	dbs := manager.GetDatabases()
 	require.Equal(len(vers), len(dbs))
 
 	for i, db := range dbs {
 		cmp = db.Version.Compare(vers[i])
-		require.Equal(0, cmp, "expected to find database version %s, but found %s", vers[i], db.Version.String())
+		require.Zero(cmp, "expected to find database version %s, but found %s", vers[i], db.Version.String())
 	}
 }
 
@@ -401,7 +401,7 @@ func TestNewManagerFromDBs(t *testing.T) {
 	dbs := m.GetDatabases()
 	require.Len(dbs, len(versions))
 	for i, db := range dbs {
-		require.Equal(0, db.Version.Compare(versions[i]))
+		require.Zero(db.Version.Compare(versions[i]))
 	}
 }
 

database/test_database.go

@@ -949,7 +949,7 @@ func TestClear(t *testing.T, db Database) {
 
 	count, err = Count(db)
 	require.NoError(err)
-	require.Equal(0, count)
+	require.Zero(count)
 
 	require.NoError(db.Close())
 }

scripts/lint.sh

@@ -21,7 +21,7 @@ fi
 # by default, "./scripts/lint.sh" runs all lint tests
 # to run only "license_header" test
 # TESTS='license_header' ./scripts/lint.sh
-TESTS=${TESTS:-"golangci_lint license_header require_error_is_no_funcs_as_params single_import interface_compliance_nil"}
+TESTS=${TESTS:-"golangci_lint license_header require_error_is_no_funcs_as_params single_import interface_compliance_nil require_equal_zero"}
 
 function test_golangci_lint {
   go install -v github.com/golangci/golangci-lint/cmd/golangci-lint@v1.51.2
@@ -57,6 +57,24 @@ function test_require_error_is_no_funcs_as_params {
   fi
 }
 
+function test_require_equal_zero {
+  # check if the first arg, other than t, is 0
+  if grep -R -o -P 'require\.Equal\((t, )?(u?int\d*\(0\)|0)' .; then
+    echo ""
+    echo "Use require.Zero instead of require.Equal when testing for 0."
+    echo ""
+    return 1
+  fi
+
+  # check if the last arg is 0
+  if grep -R -zo -P 'require\.Equal\(.+?, (u?int\d*\(0\)|0)\)\n' .; then
+    echo ""
+    echo "Use require.Zero instead of require.Equal when testing for 0."
+    echo ""
+    return 1
+  fi
+}
+
 # Ref: https://go.dev/doc/effective_go#blank_implements
 function test_interface_compliance_nil {
   if grep -R -o -P '_ .+? = &.+?\{\}' .; then

snow/engine/common/requests_test.go

@@ -15,7 +15,7 @@ func TestRequests(t *testing.T) {
 	req := Requests{}
 
 	length := req.Len()
-	require.Equal(t, 0, length, "should have had no outstanding requests")
+	require.Zero(t, length, "should have had no outstanding requests")
 
 	_, removed := req.Remove(ids.EmptyNodeID, 0)
 	require.False(t, removed, "shouldn't have removed the request")
@@ -69,7 +69,7 @@ func TestRequests(t *testing.T) {
 	require.True(t, removed, "should have removed the request")
 
 	length = req.Len()
-	require.Equal(t, 0, length, "should have had no outstanding requests")
+	require.Zero(t, length, "should have had no outstanding requests")
 
 	req.Add(ids.EmptyNodeID, 0, ids.Empty)
 
@@ -80,11 +80,11 @@ func TestRequests(t *testing.T) {
 	require.True(t, removed, "should have removed the request")
 
 	length = req.Len()
-	require.Equal(t, 0, length, "should have had no outstanding requests")
+	require.Zero(t, length, "should have had no outstanding requests")
 
 	removed = req.RemoveAny(ids.Empty)
 	require.False(t, removed, "shouldn't have removed the request")
 
 	length = req.Len()
-	require.Equal(t, 0, length, "should have had no outstanding requests")
+	require.Zero(t, length, "should have had no outstanding requests")
 }

snow/networking/benchlist/benchlist_test.go

@@ -73,8 +73,8 @@ func TestBenchlistAdd(t *testing.T) {
 	require.False(t, b.isBenched(vdrID3))
 	require.False(t, b.isBenched(vdrID4))
 	require.Len(t, b.failureStreaks, 0)
-	require.Equal(t, b.benchedQueue.Len(), 0)
-	require.Equal(t, b.benchlistSet.Len(), 0)
+	require.Zero(t, b.benchedQueue.Len())
+	require.Zero(t, b.benchlistSet.Len())
 	b.lock.Unlock()
 
 	// Register [threshold - 1] failures in a row for vdr0
@@ -84,8 +84,8 @@ func TestBenchlistAdd(t *testing.T) {
 
 	// Still shouldn't be benched due to not enough consecutive failure
 	require.False(t, b.isBenched(vdrID0))
-	require.Equal(t, b.benchedQueue.Len(), 0)
-	require.Equal(t, b.benchlistSet.Len(), 0)
+	require.Zero(t, b.benchedQueue.Len())
+	require.Zero(t, b.benchlistSet.Len())
 	require.Len(t, b.failureStreaks, 1)
 	fs := b.failureStreaks[vdrID0]
 	require.Equal(t, threshold-1, fs.consecutive)
@@ -98,8 +98,8 @@ func TestBenchlistAdd(t *testing.T) {
 	// has passed since the first failure
 	b.lock.Lock()
 	require.False(t, b.isBenched(vdrID0))
-	require.Equal(t, b.benchedQueue.Len(), 0)
-	require.Equal(t, b.benchlistSet.Len(), 0)
+	require.Zero(t, b.benchedQueue.Len())
+	require.Zero(t, b.benchlistSet.Len())
 	b.lock.Unlock()
 
 	// Move the time up

snow/networking/router/chain_router_test.go

@@ -801,7 +801,7 @@ func TestRouterHonorsRequestedEngine(t *testing.T) {
 		chainRouter.HandleInbound(context.Background(), msg)
 	}
 
-	require.Equal(0, chainRouter.timedRequests.Len())
+	require.Zero(chainRouter.timedRequests.Len())
 }
 
 func TestRouterClearTimeouts(t *testing.T) {
@@ -1087,7 +1087,7 @@ func TestRouterClearTimeouts(t *testing.T) {
 		chainRouter.HandleInbound(context.Background(), msg)
 	}
 
-	require.Equal(t, 0, chainRouter.timedRequests.Len())
+	require.Zero(t, chainRouter.timedRequests.Len())
 }
 
 func TestValidatorOnlyMessageDrops(t *testing.T) {