Refactored tests to not duplicate code

engine/access/rest/websockets/data_providers/account_statuses_provider_test.go

@@ -139,17 +139,8 @@ func (s *AccountStatusesProviderSuite) subscribeAccountStatusesDataProviderTestC
 
 // requireAccountStatuses ensures that the received account statuses information matches the expected data.
 func (s *AccountStatusesProviderSuite) requireAccountStatuses(actual interface{}, expected interface{}) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
-
-	expectedResponsePayload, ok := expectedResponse.Payload.(*models.AccountStatusesResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*models.AccountStatusesResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", actualResponse.Payload)
+	expectedResponse, expectedResponsePayload := extractPayload[*models.AccountStatusesResponse](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*models.AccountStatusesResponse](s.T(), actual)
 
 	require.Equal(s.T(), expectedResponsePayload.BlockID, actualResponsePayload.BlockID)
 	require.Equal(s.T(), len(expectedResponsePayload.AccountEvents), len(actualResponsePayload.AccountEvents))

engine/access/rest/websockets/data_providers/block_digests_provider_test.go

@@ -6,7 +6,6 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
 	"github.com/onflow/flow-go/engine/access/rest/common/parser"
@@ -115,17 +114,8 @@ func (s *BlockDigestsProviderSuite) validBlockDigestsArgumentsTestCases() []test
 
 // requireBlockDigest ensures that the received block header information matches the expected data.
 func (s *BlocksProviderSuite) requireBlockDigest(actual interface{}, expected interface{}) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
-
-	expectedResponsePayload, ok := expectedResponse.Payload.(*models.BlockDigest)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*models.BlockDigest)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", actualResponse.Payload)
+	expectedResponse, expectedResponsePayload := extractPayload[*models.BlockDigest](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*models.BlockDigest](s.T(), actual)
 
 	s.Require().Equal(expectedResponse.Topic, actualResponse.Topic)
 	s.Require().Equal(expectedResponsePayload, actualResponsePayload)

engine/access/rest/websockets/data_providers/block_headers_provider_test.go

@@ -6,7 +6,6 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
 	commonmodels "github.com/onflow/flow-go/engine/access/rest/common/models"
@@ -114,17 +113,8 @@ func (s *BlockHeadersProviderSuite) validBlockHeadersArgumentsTestCases() []test
 
 // requireBlockHeaders ensures that the received block header information matches the expected data.
 func (s *BlockHeadersProviderSuite) requireBlockHeader(actual interface{}, expected interface{}) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
-
-	expectedResponsePayload, ok := expectedResponse.Payload.(*commonmodels.BlockHeader)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*commonmodels.BlockHeader)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", actualResponse.Payload)
+	expectedResponse, expectedResponsePayload := extractPayload[*commonmodels.BlockHeader](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*commonmodels.BlockHeader](s.T(), actual)
 
 	s.Require().Equal(expectedResponse.Topic, actualResponse.Topic)
 	s.Require().Equal(expectedResponsePayload, actualResponsePayload)

engine/access/rest/websockets/data_providers/blocks_provider_test.go

@@ -9,7 +9,6 @@ import (
 	"github.com/rs/zerolog"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
 	accessmock "github.com/onflow/flow-go/access/mock"
@@ -183,17 +182,8 @@ func (s *BlocksProviderSuite) validBlockArgumentsTestCases() []testType {
 
 // requireBlock ensures that the received block information matches the expected data.
 func (s *BlocksProviderSuite) requireBlock(actual interface{}, expected interface{}) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
-
-	expectedResponsePayload, ok := expectedResponse.Payload.(*commonmodels.Block)
-	require.True(s.T(), ok, "unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*commonmodels.Block)
-	require.True(s.T(), ok, "unexpected response payload type: %T", actualResponse.Payload)
+	expectedResponse, expectedResponsePayload := extractPayload[*commonmodels.Block](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*commonmodels.Block](s.T(), actual)
 
 	s.Require().Equal(expectedResponse.Topic, actualResponse.Topic)
 	s.Require().Equal(expectedResponsePayload, actualResponsePayload)

engine/access/rest/websockets/data_providers/events_provider_test.go

@@ -9,7 +9,6 @@ import (
 
 	"github.com/rs/zerolog"
 	"github.com/stretchr/testify/mock"
-	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
 
 	"github.com/onflow/flow-go/engine/access/rest/websockets/models"
@@ -139,20 +138,12 @@ func (s *EventsProviderSuite) subscribeEventsDataProviderTestCases(backendRespon
 
 // requireEvents ensures that the received event information matches the expected data.
 func (s *EventsProviderSuite) requireEvents(actual interface{}, expected interface{}) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
+	expectedResponse, expectedResponsePayload := extractPayload[*models.EventResponse](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*models.EventResponse](s.T(), actual)
 
-	expectedResponsePayload, ok := expectedResponse.Payload.(*models.EventResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*models.EventResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", actualResponse.Payload)
-
-	s.Require().ElementsMatch(expectedResponsePayload.Events, actualResponsePayload.Events)
+	s.Require().Equal(expectedResponse.Topic, actualResponse.Topic)
 	s.Require().Equal(expectedResponsePayload.MessageIndex, actualResponsePayload.MessageIndex)
+	s.Require().ElementsMatch(expectedResponsePayload.Events, actualResponsePayload.Events)
 }
 
 // backendEventsResponses creates backend events responses based on the provided events.

engine/access/rest/websockets/data_providers/send_and_get_transaction_statuses_provider_test.go

@@ -111,17 +111,8 @@ func (s *SendTransactionStatusesProviderSuite) requireTransactionStatuses(
 	actual interface{},
 	expected interface{},
 ) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
-
-	expectedResponsePayload, ok := expectedResponse.Payload.(*models.TransactionStatusesResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*models.TransactionStatusesResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", actualResponse.Payload)
+	expectedResponse, expectedResponsePayload := extractPayload[*models.TransactionStatusesResponse](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*models.TransactionStatusesResponse](s.T(), actual)
 
 	require.Equal(s.T(), expectedResponse.Topic, actualResponse.Topic)
 	require.Equal(s.T(), expectedResponsePayload.TransactionResult.BlockId, actualResponsePayload.TransactionResult.BlockId)

engine/access/rest/websockets/data_providers/transaction_statuses_provider_test.go

@@ -147,17 +147,8 @@ func (s *TransactionStatusesProviderSuite) requireTransactionStatuses(
 	actual interface{},
 	expected interface{},
 ) {
-	expectedResponse, ok := expected.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", expected)
-
-	expectedResponsePayload, ok := expectedResponse.Payload.(*models.TransactionStatusesResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", expectedResponse.Payload)
-
-	actualResponse, ok := actual.(*models.BaseDataProvidersResponse)
-	require.True(s.T(), ok, "Expected *models.BaseDataProvidersResponse, got %T", actual)
-
-	actualResponsePayload, ok := actualResponse.Payload.(*models.TransactionStatusesResponse)
-	require.True(s.T(), ok, "Unexpected response payload type: %T", actualResponse.Payload)
+	expectedResponse, expectedResponsePayload := extractPayload[*models.TransactionStatusesResponse](s.T(), expected)
+	actualResponse, actualResponsePayload := extractPayload[*models.TransactionStatusesResponse](s.T(), actual)
 
 	require.Equal(s.T(), expectedResponse.Topic, actualResponse.Topic)
 	require.Equal(s.T(), expectedResponsePayload.TransactionResult.BlockId, actualResponsePayload.TransactionResult.BlockId)

engine/access/rest/websockets/data_providers/unit_test.go

@@ -100,3 +100,14 @@ func testHappyPath(
 		})
 	}
 }
+
+// extractPayload extracts the BaseDataProvidersResponse and its typed Payload.
+func extractPayload[T any](t *testing.T, v interface{}) (*models.BaseDataProvidersResponse, T) {
+	response, ok := v.(*models.BaseDataProvidersResponse)
+	require.True(t, ok, "Expected *models.BaseDataProvidersResponse, got %T", v)
+
+	payload, ok := response.Payload.(T)
+	require.True(t, ok, "Unexpected response payload type: %T", response.Payload)
+
+	return response, payload
+}