chore(tests): refactor tests/utils/request_utils.go (#2385)

- Inject context to `PostRPC` and `PostRPCWithRetry` - Swap method and url arguments for `PostRPC` and `PostRPCWithRetry` - Remove some global variables - Wrap all possible errors - `PostRPCWithRetry` retries until context is canceled - Keep 1s timeout for RPC calls
ChainSafe · Mar 31, 2022 · e700d5e · e700d5e
1 parent 19a2b4e
commit e700d5e
Show file tree

Hide file tree

Showing 23 changed files with 354 additions and 147 deletions.
diff --git a/tests/rpc/rpc_00_test.go b/tests/rpc/rpc_00_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"reflect"
@@ -38,13 +39,14 @@ type testCase struct {
 	skip        bool
 }
 
-func getResponse(t *testing.T, test *testCase) interface{} {
+func getResponse(ctx context.Context, t *testing.T, test *testCase) interface{} {
 	if test.skip {
 		t.Skip("RPC endpoint not yet implemented")
 		return nil
 	}
 
-	respBody, err := utils.PostRPC(test.method, utils.NewEndpoint(currentPort), test.params)
+	endpoint := utils.NewEndpoint(currentPort)
+	respBody, err := utils.PostRPC(ctx, endpoint, test.method, test.params)
 	require.NoError(t, err)
 
 	target := reflect.New(reflect.TypeOf(test.expected)).Interface()

diff --git a/tests/rpc/rpc_01-system_test.go b/tests/rpc/rpc_01-system_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -97,7 +98,10 @@ func TestSystemRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			target := getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			target := getResponse(getResponseCtx, t, test)
 
 			switch v := target.(type) {
 			case *modules.SystemHealthResponse:

diff --git a/tests/rpc/rpc_02-author_test.go b/tests/rpc/rpc_02-author_test.go
@@ -5,6 +5,7 @@ package rpc
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"testing"
 	"time"
@@ -139,7 +140,10 @@ func TestAuthorRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 

diff --git a/tests/rpc/rpc_03-chain_test.go b/tests/rpc/rpc_03-chain_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"log"
 	"testing"
 	"time"
@@ -72,7 +73,11 @@ func TestChainRPC(t *testing.T) {
 				test.params = "[\"" + chainBlockHeaderHash + "\"]"
 			}
 
-			target := getResponse(t, test)
+			ctx := context.Background()
+
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			target := getResponse(getResponseCtx, t, test)
 
 			switch v := target.(type) {
 			case *modules.ChainBlockHeaderResponse:

diff --git a/tests/rpc/rpc_04-offchain_test.go b/tests/rpc/rpc_04-offchain_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -43,7 +44,10 @@ func TestOffchainRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 

diff --git a/tests/rpc/rpc_05-state_test.go b/tests/rpc/rpc_05-state_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"fmt"
 	"testing"
 	"time"
@@ -33,7 +34,11 @@ func TestStateRPCResponseValidation(t *testing.T) {
 
 	time.Sleep(time.Second) // give server a second to start
 
-	blockHash, err := utils.GetBlockHash(t, nodes[0], "")
+	ctx := context.Background()
+
+	getBlockHashCtx, cancel := context.WithTimeout(ctx, time.Second)
+	blockHash, err := utils.GetBlockHash(getBlockHashCtx, t, nodes[0], "")
+	cancel()
 	require.NoError(t, err)
 
 	testCases := []*testCase{
@@ -118,7 +123,10 @@ func TestStateRPCResponseValidation(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 
@@ -142,7 +150,11 @@ func TestStateRPCAPI(t *testing.T) {
 
 	time.Sleep(5 * time.Second) // Wait for block production
 
-	blockHash, err := utils.GetBlockHash(t, nodes[0], "")
+	ctx := context.Background()
+
+	getBlockHashCtx, cancel := context.WithTimeout(ctx, time.Second)
+	blockHash, err := utils.GetBlockHash(getBlockHashCtx, t, nodes[0], "")
+	cancel()
 	require.NoError(t, err)
 
 	const (
@@ -319,7 +331,11 @@ func TestStateRPCAPI(t *testing.T) {
 	// Cases for valid block hash in RPC params
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			respBody, err := utils.PostRPC(test.method, utils.NewEndpoint(nodes[0].RPCPort), test.params)
+			ctx := context.Background()
+			postRPCCtx, cancel := context.WithTimeout(ctx, time.Second)
+			endpoint := utils.NewEndpoint(nodes[0].RPCPort)
+			respBody, err := utils.PostRPC(postRPCCtx, endpoint, test.method, test.params)
+			cancel()
 			require.NoError(t, err)
 
 			require.Contains(t, string(respBody), test.expected)
@@ -351,7 +367,12 @@ func TestRPCStructParamUnmarshal(t *testing.T) {
 		params:      `[["0xf2794c22e353e9a839f12faab03a911bf68967d635641a7087e53f2bff1ecad3c6756fee45ec79ead60347fffb770bcdf0ec74da701ab3d6495986fe1ecc3027"],"0xa32c60dee8647b07435ae7583eb35cee606209a595718562dd4a486a07b6de15", null]`, //nolint:lll
 	}
 	t.Run(test.description, func(t *testing.T) {
-		respBody, err := utils.PostRPC(test.method, utils.NewEndpoint(nodes[0].RPCPort), test.params)
+		ctx := context.Background()
+
+		postRPCCtx, cancel := context.WithTimeout(ctx, time.Second)
+		endpoint := utils.NewEndpoint(nodes[0].RPCPort)
+		respBody, err := utils.PostRPC(postRPCCtx, endpoint, test.method, test.params)
+		cancel()
 		require.NoError(t, err)
 		require.NotContains(t, string(respBody), "json: cannot unmarshal")
 		fmt.Println(string(respBody))

diff --git a/tests/rpc/rpc_06-engine_test.go b/tests/rpc/rpc_06-engine_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -38,7 +39,10 @@ func TestEngineRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 

diff --git a/tests/rpc/rpc_07-payment_test.go b/tests/rpc/rpc_07-payment_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -33,7 +34,10 @@ func TestPaymentRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 

diff --git a/tests/rpc/rpc_08-contracts_test.go b/tests/rpc/rpc_08-contracts_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -38,7 +39,10 @@ func TestContractsRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 

diff --git a/tests/rpc/rpc_09-babe_test.go b/tests/rpc/rpc_09-babe_test.go
@@ -4,6 +4,7 @@
 package rpc
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -33,7 +34,10 @@ func TestBabeRPC(t *testing.T) {
 
 	for _, test := range testCases {
 		t.Run(test.description, func(t *testing.T) {
-			_ = getResponse(t, test)
+			ctx := context.Background()
+			getResponseCtx, cancel := context.WithTimeout(ctx, time.Second)
+			defer cancel()
+			_ = getResponse(getResponseCtx, t, test)
 		})
 	}
 

diff --git a/tests/rpc/system_integration_test.go b/tests/rpc/system_integration_test.go
@@ -4,6 +4,8 @@
 package rpc
 
 import (
+	"context"
+	"fmt"
 	"reflect"
 	"strconv"
 	"testing"
@@ -53,7 +55,11 @@ func TestStableNetworkRPC(t *testing.T) {
 
 	for _, test := range testsCases {
 		t.Run(test.description, func(t *testing.T) {
-			respBody, err := utils.PostRPC(test.method, "http://"+utils.HOSTNAME+":"+utils.PORT, "{}")
+			ctx := context.Background()
+
+			endpoint := fmt.Sprintf("http://%s:%s", utils.HOSTNAME, utils.PORT)
+			const params = "{}"
+			respBody, err := utils.PostRPC(ctx, endpoint, test.method, params)
 			require.NoError(t, err)
 
 			target := reflect.New(reflect.TypeOf(test.expected)).Interface()

diff --git a/tests/stress/grandpa_test.go b/tests/stress/grandpa_test.go
@@ -4,6 +4,7 @@
 package stress
 
 import (
+	"context"
 	"os"
 	"testing"
 	"time"
@@ -25,11 +26,16 @@ func TestStress_Grandpa_OneAuthority(t *testing.T) {
 
 	time.Sleep(time.Second * 10)
 
-	compareChainHeadsWithRetry(t, nodes)
-	prev, _ := compareFinalizedHeads(t, nodes)
+	ctx := context.Background()
+
+	const getChainHeadTimeout = time.Second
+	compareChainHeadsWithRetry(ctx, t, nodes, getChainHeadTimeout)
+
+	const getFinalizedHeadTimeout = time.Second
+	prev, _ := compareFinalizedHeads(ctx, t, nodes, getFinalizedHeadTimeout)
 
 	time.Sleep(time.Second * 10)
-	curr, _ := compareFinalizedHeads(t, nodes)
+	curr, _ := compareFinalizedHeads(ctx, t, nodes, getFinalizedHeadTimeout)
 	require.NotEqual(t, prev, curr)
 }
 
@@ -48,9 +54,13 @@ func TestStress_Grandpa_ThreeAuthorities(t *testing.T) {
 		require.Len(t, errList, 0)
 	}()
 
+	ctx := context.Background()
+
 	numRounds := 5
 	for i := 1; i < numRounds+1; i++ {
-		fin, err := compareFinalizedHeadsWithRetry(t, nodes, uint64(i))
+		const getFinalizedHeadByRoundTimeout = time.Second
+		fin, err := compareFinalizedHeadsWithRetry(ctx, t,
+			nodes, uint64(i), getFinalizedHeadByRoundTimeout)
 		require.NoError(t, err)
 		t.Logf("finalised hash in round %d: %s", i, fin)
 	}
@@ -70,9 +80,13 @@ func TestStress_Grandpa_SixAuthorities(t *testing.T) {
 		require.Len(t, errList, 0)
 	}()
 
+	ctx := context.Background()
+
 	numRounds := 10
 	for i := 1; i < numRounds+1; i++ {
-		fin, err := compareFinalizedHeadsWithRetry(t, nodes, uint64(i))
+		const getFinalizedHeadByRoundTimeout = time.Second
+		fin, err := compareFinalizedHeadsWithRetry(ctx, t, nodes,
+			uint64(i), getFinalizedHeadByRoundTimeout)
 		require.NoError(t, err)
 		t.Logf("finalised hash in round %d: %s", i, fin)
 	}
@@ -95,9 +109,13 @@ func TestStress_Grandpa_NineAuthorities(t *testing.T) {
 		require.Len(t, errList, 0)
 	}()
 
+	ctx := context.Background()
+
 	numRounds := 3
 	for i := 1; i < numRounds+1; i++ {
-		fin, err := compareFinalizedHeadsWithRetry(t, nodes, uint64(i))
+		const getFinalizedHeadByRoundTimeout = time.Second
+		fin, err := compareFinalizedHeadsWithRetry(ctx, t, nodes,
+			uint64(i), getFinalizedHeadByRoundTimeout)
 		require.NoError(t, err)
 		t.Logf("finalised hash in round %d: %s", i, fin)
 	}
@@ -129,9 +147,12 @@ func TestStress_Grandpa_CatchUp(t *testing.T) {
 	require.NoError(t, err)
 	nodes = append(nodes, node)
 
+	ctx := context.Background()
+
 	numRounds := 10
 	for i := 1; i < numRounds+1; i++ {
-		fin, err := compareFinalizedHeadsWithRetry(t, nodes, uint64(i))
+		const getFinalizedHeadByRoundTimeout = time.Second
+		fin, err := compareFinalizedHeadsWithRetry(ctx, t, nodes, uint64(i), getFinalizedHeadByRoundTimeout)
 		require.NoError(t, err)
 		t.Logf("finalised hash in round %d: %s", i, fin)
 	}