test(monitoringc): normalize tests (#968)

* module scope * types * keeper * client: Co-authored-by: Lucas Btd <[email protected]>
tendermint · Oct 1, 2022 · e2fd4bd · e2fd4bd
1 parent 57bd459
commit e2fd4bd
Show file tree

Hide file tree

Showing 20 changed files with 260 additions and 214 deletions.
diff --git a/x/monitoringc/client/cli/query_launch_id_from_channel_id_test.go b/x/monitoringc/client/cli/query_launch_id_from_channel_id_test.go
@@ -25,29 +25,29 @@ func (suite *QueryTestSuite) TestShowLaunchIDFromChannelID() {
 		fmt.Sprintf("--%s=json", tmcli.OutputFlag),
 	}
 	for _, tc := range []struct {
-		desc        string
+		name        string
 		idChannelID string
 
 		args []string
 		err  error
 		obj  types.LaunchIDFromChannelID
 	}{
 		{
-			desc:        "found",
+			name:        "should allow valid query",
 			idChannelID: objs[0].ChannelID,
 
 			args: common,
 			obj:  objs[0],
 		},
 		{
-			desc:        "not found",
+			name:        "should fail if not found",
 			idChannelID: strconv.Itoa(100000),
 
 			args: common,
 			err:  status.Error(codes.NotFound, "not found"),
 		},
 	} {
-		suite.T().Run(tc.desc, func(t *testing.T) {
+		suite.T().Run(tc.name, func(t *testing.T) {
 			args := []string{
 				tc.idChannelID,
 			}
@@ -90,7 +90,7 @@ func (suite *QueryTestSuite) TestListLaunchIDFromChannelID() {
 		}
 		return args
 	}
-	suite.T().Run("by offset", func(t *testing.T) {
+	suite.T().Run("should paginate by offset", func(t *testing.T) {
 		step := 2
 		for i := 0; i < len(objs); i += step {
 			args := request(nil, uint64(i), uint64(step), false)
@@ -105,7 +105,7 @@ func (suite *QueryTestSuite) TestListLaunchIDFromChannelID() {
 			)
 		}
 	})
-	suite.T().Run("by key", func(t *testing.T) {
+	suite.T().Run("should paginate by key", func(t *testing.T) {
 		step := 2
 		var next []byte
 		for i := 0; i < len(objs); i += step {
@@ -122,7 +122,7 @@ func (suite *QueryTestSuite) TestListLaunchIDFromChannelID() {
 			next = resp.Pagination.NextKey
 		}
 	})
-	suite.T().Run("total", func(t *testing.T) {
+	suite.T().Run("should paginate all", func(t *testing.T) {
 		args := request(nil, 0, uint64(len(objs)), true)
 		out, err := clitestutil.ExecTestCLICmd(ctx, cli.CmdListLaunchIDFromChannelID(), args)
 		require.NoError(t, err)

diff --git a/x/monitoringc/client/cli/query_monitoring_history_test.go b/x/monitoringc/client/cli/query_monitoring_history_test.go
@@ -32,14 +32,14 @@ func (suite *QueryTestSuite) TestShowMonitoringHistory() {
 		obj  types.MonitoringHistory
 	}{
 		{
-			desc:       "found",
+			desc:       "should allow valid query",
 			idLaunchID: objs[0].LaunchID,
 
 			args: common,
 			obj:  objs[0],
 		},
 		{
-			desc:       "not found",
+			desc:       "should fail if not found",
 			idLaunchID: 100000,
 
 			args: common,

diff --git a/x/monitoringc/client/cli/query_provider_client_id_test.go b/x/monitoringc/client/cli/query_provider_client_id_test.go
@@ -33,14 +33,14 @@ func (suite *QueryTestSuite) TestShowProviderClientID() {
 		obj  types.ProviderClientID
 	}{
 		{
-			desc:       "found",
+			desc:       "should allow valid query",
 			idLaunchID: objs[0].LaunchID,
 
 			args: common,
 			obj:  objs[0],
 		},
 		{
-			desc:       "not found",
+			desc:       "should fail if not found",
 			idLaunchID: 100000,
 
 			args: common,
@@ -90,7 +90,7 @@ func (suite *QueryTestSuite) TestListProviderClientID() {
 		}
 		return args
 	}
-	suite.T().Run("by offset", func(t *testing.T) {
+	suite.T().Run("should paginate by offset", func(t *testing.T) {
 		step := 2
 		for i := 0; i < len(objs); i += step {
 			args := request(nil, uint64(i), uint64(step), false)
@@ -105,7 +105,7 @@ func (suite *QueryTestSuite) TestListProviderClientID() {
 			)
 		}
 	})
-	suite.T().Run("by key", func(t *testing.T) {
+	suite.T().Run("should paginate by key", func(t *testing.T) {
 		step := 2
 		var next []byte
 		for i := 0; i < len(objs); i += step {
@@ -122,7 +122,7 @@ func (suite *QueryTestSuite) TestListProviderClientID() {
 			next = resp.Pagination.NextKey
 		}
 	})
-	suite.T().Run("total", func(t *testing.T) {
+	suite.T().Run("should paginate all", func(t *testing.T) {
 		args := request(nil, 0, uint64(len(objs)), true)
 		out, err := clitestutil.ExecTestCLICmd(ctx, cli.CmdListProviderClientID(), args)
 		require.NoError(t, err)

diff --git a/x/monitoringc/client/cli/query_verified_client_ids_test.go b/x/monitoringc/client/cli/query_verified_client_ids_test.go
@@ -32,14 +32,14 @@ func (suite *QueryTestSuite) TestShowVerifiedClientIds() {
 		obj  types.VerifiedClientID
 	}{
 		{
-			desc:       "found",
+			desc:       "should allow valid query",
 			idLaunchID: objs[0].LaunchID,
 
 			args: common,
 			obj:  objs[0],
 		},
 		{
-			desc:       "not found",
+			desc:       "should fail if not found",
 			idLaunchID: 100000,
 
 			args: common,

diff --git a/x/monitoringc/genesis_test.go b/x/monitoringc/genesis_test.go
@@ -61,19 +61,21 @@ func TestGenesis(t *testing.T) {
 	}
 
 	ctx, tk, _ := testkeeper.NewTestSetup(t)
-	monitoringc.InitGenesis(ctx, *tk.MonitoringConsumerKeeper, genesisState)
-	got := monitoringc.ExportGenesis(ctx, *tk.MonitoringConsumerKeeper)
-	require.NotNil(t, got)
+	t.Run("should allow import and export of genesis", func(t *testing.T) {
+		monitoringc.InitGenesis(ctx, *tk.MonitoringConsumerKeeper, genesisState)
+		got := monitoringc.ExportGenesis(ctx, *tk.MonitoringConsumerKeeper)
+		require.NotNil(t, got)
 
-	nullify.Fill(&genesisState)
-	nullify.Fill(got)
+		nullify.Fill(&genesisState)
+		nullify.Fill(got)
 
-	require.Equal(t, genesisState.PortId, got.PortId)
+		require.Equal(t, genesisState.PortId, got.PortId)
 
-	require.ElementsMatch(t, genesisState.VerifiedClientIDs, got.VerifiedClientIDs)
-	require.ElementsMatch(t, genesisState.ProviderClientIDs, got.ProviderClientIDs)
-	require.ElementsMatch(t, genesisState.LaunchIDsFromVerifiedClientID, got.LaunchIDsFromVerifiedClientID)
-	require.ElementsMatch(t, genesisState.LaunchIDsFromChannelID, got.LaunchIDsFromChannelID)
-	require.ElementsMatch(t, genesisState.MonitoringHistories, got.MonitoringHistories)
-	// this line is used by starport scaffolding # genesis/test/assert
+		require.ElementsMatch(t, genesisState.VerifiedClientIDs, got.VerifiedClientIDs)
+		require.ElementsMatch(t, genesisState.ProviderClientIDs, got.ProviderClientIDs)
+		require.ElementsMatch(t, genesisState.LaunchIDsFromVerifiedClientID, got.LaunchIDsFromVerifiedClientID)
+		require.ElementsMatch(t, genesisState.LaunchIDsFromChannelID, got.LaunchIDsFromChannelID)
+		require.ElementsMatch(t, genesisState.MonitoringHistories, got.MonitoringHistories)
+		// this line is used by starport scaffolding # genesis/test/assert
+	})
 }
diff --git a/x/monitoringc/keeper/grpc_launch_id_from_channel_id_test.go b/x/monitoringc/keeper/grpc_launch_id_from_channel_id_test.go
@@ -20,38 +20,38 @@ func TestLaunchIDFromChannelIDQuerySingle(t *testing.T) {
 	wctx := sdk.WrapSDKContext(ctx)
 	items := createNLaunchIDFromChannelID(ctx, tk.MonitoringConsumerKeeper, 2)
 	for _, tc := range []struct {
-		desc     string
+		name     string
 		request  *types.QueryGetLaunchIDFromChannelIDRequest
 		response *types.QueryGetLaunchIDFromChannelIDResponse
 		err      error
 	}{
 		{
-			desc: "first",
+			name: "should allow valid first query",
 			request: &types.QueryGetLaunchIDFromChannelIDRequest{
 				ChannelID: items[0].ChannelID,
 			},
 			response: &types.QueryGetLaunchIDFromChannelIDResponse{LaunchIDFromChannelID: items[0]},
 		},
 		{
-			desc: "second",
+			name: "should allow valid second query",
 			request: &types.QueryGetLaunchIDFromChannelIDRequest{
 				ChannelID: items[1].ChannelID,
 			},
 			response: &types.QueryGetLaunchIDFromChannelIDResponse{LaunchIDFromChannelID: items[1]},
 		},
 		{
-			desc: "key not found",
+			name: "should return key not found",
 			request: &types.QueryGetLaunchIDFromChannelIDRequest{
 				ChannelID: strconv.Itoa(100000),
 			},
 			err: status.Error(codes.NotFound, "not found"),
 		},
 		{
-			desc: "invalid request",
+			name: "should return invalid request",
 			err:  status.Error(codes.InvalidArgument, "invalid request"),
 		},
 	} {
-		t.Run(tc.desc, func(t *testing.T) {
+		t.Run(tc.name, func(t *testing.T) {
 			response, err := tk.MonitoringConsumerKeeper.LaunchIDFromChannelID(wctx, tc.request)
 			if tc.err != nil {
 				require.ErrorIs(t, err, tc.err)
@@ -81,7 +81,7 @@ func TestLaunchIDFromChannelIDQueryPaginated(t *testing.T) {
 			},
 		}
 	}
-	t.Run("by offset", func(t *testing.T) {
+	t.Run("should paginate by offset", func(t *testing.T) {
 		step := 2
 		for i := 0; i < len(items); i += step {
 			resp, err := tk.MonitoringConsumerKeeper.LaunchIDFromChannelIDAll(wctx, request(nil, uint64(i), uint64(step), false))
@@ -93,7 +93,7 @@ func TestLaunchIDFromChannelIDQueryPaginated(t *testing.T) {
 			)
 		}
 	})
-	t.Run("by key", func(t *testing.T) {
+	t.Run("should paginate by key", func(t *testing.T) {
 		step := 2
 		var next []byte
 		for i := 0; i < len(items); i += step {
@@ -107,7 +107,7 @@ func TestLaunchIDFromChannelIDQueryPaginated(t *testing.T) {
 			next = resp.Pagination.NextKey
 		}
 	})
-	t.Run("total", func(t *testing.T) {
+	t.Run("should paginate all", func(t *testing.T) {
 		resp, err := tk.MonitoringConsumerKeeper.LaunchIDFromChannelIDAll(wctx, request(nil, 0, 0, true))
 		require.NoError(t, err)
 		require.Equal(t, len(items), int(resp.Pagination.Total))
@@ -116,7 +116,7 @@ func TestLaunchIDFromChannelIDQueryPaginated(t *testing.T) {
 			nullify.Fill(resp.LaunchIDFromChannelID),
 		)
 	})
-	t.Run("InvalidRequest", func(t *testing.T) {
+	t.Run("should return InvalidRequest", func(t *testing.T) {
 		_, err := tk.MonitoringConsumerKeeper.LaunchIDFromChannelIDAll(wctx, nil)
 		require.ErrorIs(t, err, status.Error(codes.InvalidArgument, "invalid request"))
 	})

diff --git a/x/monitoringc/keeper/grpc_monitoring_history_test.go b/x/monitoringc/keeper/grpc_monitoring_history_test.go
@@ -18,38 +18,38 @@ func TestMonitoringHistoryQuerySingle(t *testing.T) {
 	wctx := sdk.WrapSDKContext(ctx)
 	items := createNMonitoringHistory(ctx, tk.MonitoringConsumerKeeper, 2)
 	for _, tc := range []struct {
-		desc     string
+		name     string
 		request  *types.QueryGetMonitoringHistoryRequest
 		response *types.QueryGetMonitoringHistoryResponse
 		err      error
 	}{
 		{
-			desc: "first",
+			name: "should allow valid first query",
 			request: &types.QueryGetMonitoringHistoryRequest{
 				LaunchID: items[0].LaunchID,
 			},
 			response: &types.QueryGetMonitoringHistoryResponse{MonitoringHistory: items[0]},
 		},
 		{
-			desc: "second",
+			name: "should allow valid second query",
 			request: &types.QueryGetMonitoringHistoryRequest{
 				LaunchID: items[1].LaunchID,
 			},
 			response: &types.QueryGetMonitoringHistoryResponse{MonitoringHistory: items[1]},
 		},
 		{
-			desc: "key not found",
+			name: "should return key not found",
 			request: &types.QueryGetMonitoringHistoryRequest{
 				LaunchID: 100000,
 			},
 			err: status.Error(codes.NotFound, "not found"),
 		},
 		{
-			desc: "invalid request",
+			name: "should return invalid request",
 			err:  status.Error(codes.InvalidArgument, "invalid request"),
 		},
 	} {
-		t.Run(tc.desc, func(t *testing.T) {
+		t.Run(tc.name, func(t *testing.T) {
 			response, err := tk.MonitoringConsumerKeeper.MonitoringHistory(wctx, tc.request)
 			if tc.err != nil {
 				require.ErrorIs(t, err, tc.err)

diff --git a/x/monitoringc/keeper/grpc_params_test.go b/x/monitoringc/keeper/grpc_params_test.go
@@ -13,13 +13,16 @@ import (
 func TestParamsQuery(t *testing.T) {
 	ctx, tk, _ := testkeeper.NewTestSetup(t)
 	wctx := sdk.WrapSDKContext(ctx)
-	params := types.DefaultParams()
-	tk.MonitoringConsumerKeeper.SetParams(ctx, params)
 
-	response, err := tk.MonitoringConsumerKeeper.Params(wctx, &types.QueryParamsRequest{})
-	require.NoError(t, err)
-	require.Equal(t, &types.QueryParamsResponse{Params: params}, response)
+	t.Run("should allow params query", func(t *testing.T) {
+		params := types.DefaultParams()
+		tk.MonitoringConsumerKeeper.SetParams(ctx, params)
 
-	_, err = tk.MonitoringConsumerKeeper.Params(wctx, nil)
-	require.Error(t, err)
+		response, err := tk.MonitoringConsumerKeeper.Params(wctx, &types.QueryParamsRequest{})
+		require.NoError(t, err)
+		require.Equal(t, &types.QueryParamsResponse{Params: params}, response)
+
+		_, err = tk.MonitoringConsumerKeeper.Params(wctx, nil)
+		require.Error(t, err)
+	})
 }