Replace iterator equality helper (#3380)

utils/iterator/slice.go

@@ -5,6 +5,18 @@ package iterator
 
 var _ Iterator[any] = (*slice[any])(nil)
 
+// ToSlice returns a slice that contains all of the elements from [it] in order.
+// [it] will be released before returning.
+func ToSlice[T any](it Iterator[T]) []T {
+	defer it.Release()
+
+	var elements []T
+	for it.Next() {
+		elements = append(elements, it.Value())
+	}
+	return elements
+}
+
 type slice[T any] struct {
 	index    int
 	elements []T

vms/platformvm/state/diff_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/utils"
 	"github.com/ava-labs/avalanchego/utils/constants"
+	"github.com/ava-labs/avalanchego/utils/iterator"
 	"github.com/ava-labs/avalanchego/utils/iterator/iteratormock"
 	"github.com/ava-labs/avalanchego/vms/components/avax"
 	"github.com/ava-labs/avalanchego/vms/components/gas"
@@ -530,14 +531,20 @@ func assertChainsEqual(t *testing.T, expected, actual Chain) {
 	actualCurrentStakerIterator, actualErr := actual.GetCurrentStakerIterator()
 	require.Equal(expectedErr, actualErr)
 	if expectedErr == nil {
-		assertIteratorsEqual(t, expectedCurrentStakerIterator, actualCurrentStakerIterator)
+		require.Equal(
+			iterator.ToSlice(expectedCurrentStakerIterator),
+			iterator.ToSlice(actualCurrentStakerIterator),
+		)
 	}
 
 	expectedPendingStakerIterator, expectedErr := expected.GetPendingStakerIterator()
 	actualPendingStakerIterator, actualErr := actual.GetPendingStakerIterator()
 	require.Equal(expectedErr, actualErr)
 	if expectedErr == nil {
-		assertIteratorsEqual(t, expectedPendingStakerIterator, actualPendingStakerIterator)
+		require.Equal(
+			iterator.ToSlice(expectedPendingStakerIterator),
+			iterator.ToSlice(actualPendingStakerIterator),
+		)
 	}
 
 	require.Equal(expected.GetTimestamp(), actual.GetTimestamp())

vms/platformvm/state/stakers_test.go

@@ -86,7 +86,10 @@ func TestBaseStakersValidator(t *testing.T) {
 	require.ErrorIs(err, database.ErrNotFound)
 
 	stakerIterator := v.GetStakerIterator()
-	assertIteratorsEqual(t, iterator.FromSlice(delegator), stakerIterator)
+	require.Equal(
+		[]*Staker{delegator},
+		iterator.ToSlice(stakerIterator),
+	)
 
 	v.PutValidator(staker)
 
@@ -97,46 +100,63 @@ func TestBaseStakersValidator(t *testing.T) {
 	v.DeleteDelegator(delegator)
 
 	stakerIterator = v.GetStakerIterator()
-	assertIteratorsEqual(t, iterator.FromSlice(staker), stakerIterator)
+	require.Equal(
+		[]*Staker{staker},
+		iterator.ToSlice(stakerIterator),
+	)
 
 	v.DeleteValidator(staker)
 
 	_, err = v.GetValidator(staker.SubnetID, staker.NodeID)
 	require.ErrorIs(err, database.ErrNotFound)
 
 	stakerIterator = v.GetStakerIterator()
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, stakerIterator)
+	require.Empty(
+		iterator.ToSlice(stakerIterator),
+	)
 }
 
 func TestBaseStakersDelegator(t *testing.T) {
+	require := require.New(t)
 	staker := newTestStaker()
 	delegator := newTestStaker()
 
 	v := newBaseStakers()
 
 	delegatorIterator := v.GetDelegatorIterator(delegator.SubnetID, delegator.NodeID)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	v.PutDelegator(delegator)
 
 	delegatorIterator = v.GetDelegatorIterator(delegator.SubnetID, ids.GenerateTestNodeID())
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	delegatorIterator = v.GetDelegatorIterator(delegator.SubnetID, delegator.NodeID)
-	assertIteratorsEqual(t, iterator.FromSlice(delegator), delegatorIterator)
+	require.Equal(
+		[]*Staker{delegator},
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	v.DeleteDelegator(delegator)
 
 	delegatorIterator = v.GetDelegatorIterator(delegator.SubnetID, delegator.NodeID)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	v.PutValidator(staker)
 
 	v.PutDelegator(delegator)
 	v.DeleteDelegator(delegator)
 
 	delegatorIterator = v.GetDelegatorIterator(staker.SubnetID, staker.NodeID)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 }
 
 func TestDiffStakersValidator(t *testing.T) {
@@ -160,7 +180,10 @@ func TestDiffStakersValidator(t *testing.T) {
 	require.Equal(unmodified, status)
 
 	stakerIterator := v.GetStakerIterator(iterator.Empty[*Staker]{})
-	assertIteratorsEqual(t, iterator.FromSlice(delegator), stakerIterator)
+	require.Equal(
+		[]*Staker{delegator},
+		iterator.ToSlice(stakerIterator),
+	)
 
 	require.NoError(v.PutValidator(staker))
 
@@ -177,7 +200,10 @@ func TestDiffStakersValidator(t *testing.T) {
 	require.Equal(unmodified, status)
 
 	stakerIterator = v.GetStakerIterator(iterator.Empty[*Staker]{})
-	assertIteratorsEqual(t, iterator.FromSlice(delegator), stakerIterator)
+	require.Equal(
+		[]*Staker{delegator},
+		iterator.ToSlice(stakerIterator),
+	)
 }
 
 func TestDiffStakersDeleteValidator(t *testing.T) {
@@ -198,25 +224,33 @@ func TestDiffStakersDeleteValidator(t *testing.T) {
 }
 
 func TestDiffStakersDelegator(t *testing.T) {
+	require := require.New(t)
 	staker := newTestStaker()
 	delegator := newTestStaker()
 
 	v := diffStakers{}
 
-	require.NoError(t, v.PutValidator(staker))
+	require.NoError(v.PutValidator(staker))
 
 	delegatorIterator := v.GetDelegatorIterator(iterator.Empty[*Staker]{}, ids.GenerateTestID(), delegator.NodeID)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	v.PutDelegator(delegator)
 
 	delegatorIterator = v.GetDelegatorIterator(iterator.Empty[*Staker]{}, delegator.SubnetID, delegator.NodeID)
-	assertIteratorsEqual(t, iterator.FromSlice(delegator), delegatorIterator)
+	require.Equal(
+		[]*Staker{delegator},
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	v.DeleteDelegator(delegator)
 
 	delegatorIterator = v.GetDelegatorIterator(iterator.Empty[*Staker]{}, ids.GenerateTestID(), delegator.NodeID)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 }
 
 func newTestStaker() *Staker {
@@ -235,22 +269,3 @@ func newTestStaker() *Staker {
 		Priority: txs.PrimaryNetworkDelegatorCurrentPriority,
 	}
 }
-
-func assertIteratorsEqual(t *testing.T, expected, actual iterator.Iterator[*Staker]) {
-	require := require.New(t)
-
-	t.Helper()
-
-	for expected.Next() {
-		require.True(actual.Next())
-
-		expectedStaker := expected.Value()
-		actualStaker := actual.Value()
-
-		require.Equal(expectedStaker, actualStaker)
-	}
-	require.False(actual.Next())
-
-	expected.Release()
-	actual.Release()
-}

vms/platformvm/state/state_test.go

@@ -88,18 +88,25 @@ func TestStateSyncGenesis(t *testing.T) {
 
 	delegatorIterator, err := state.GetCurrentDelegatorIterator(constants.PrimaryNetworkID, defaultValidatorNodeID)
 	require.NoError(err)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 
 	stakerIterator, err := state.GetCurrentStakerIterator()
 	require.NoError(err)
-	assertIteratorsEqual(t, iterator.FromSlice(staker), stakerIterator)
+	require.Equal(
+		[]*Staker{staker},
+		iterator.ToSlice(stakerIterator),
+	)
 
 	_, err = state.GetPendingValidator(constants.PrimaryNetworkID, defaultValidatorNodeID)
 	require.ErrorIs(err, database.ErrNotFound)
 
 	delegatorIterator, err = state.GetPendingDelegatorIterator(constants.PrimaryNetworkID, defaultValidatorNodeID)
 	require.NoError(err)
-	assertIteratorsEqual(t, iterator.Empty[*Staker]{}, delegatorIterator)
+	require.Empty(
+		iterator.ToSlice(delegatorIterator),
+	)
 }
 
 // Whenever we store a staker, a whole bunch a data structures are updated