test: refactors cli.network suites with 'Integration' to use common function

.github/workflows/unit-tests.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     paths: ["**.go", "**.proto", "go.mod", "go.sum"]
 
-# Allow concurrent runs on main/release branches but isolates other branches 
+# Allow concurrent runs on main/release branches but isolates other branches
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}-${{ github.head_ref }}
   cancel-in-progress: ${{ ! (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release/')) }}
@@ -22,17 +22,17 @@ jobs:
           cache: true
 
       - name: Run all unit tests.
-        run: make test-coverage
+        run: make test-unit
 
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Go
-      uses: actions/setup-go@v4
-      with:
-        go-version: 1.19
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: 1.19
 
-    - name: Build the nibid binary 
-      run: make build
+      - name: Build the nibid binary
+        run: make build

CHANGELOG.md

@@ -66,6 +66,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * [#1631](https://github.com/NibiruChain/nibiru/pull/1631) - fix(.goreleaser.yml): Load version for wasmvm dynamically.
 * [#1638](https://github.com/NibiruChain/nibiru/pull/1638) - test(tokenfactory): integration test core logic with a real smart contract using `nibiru-std`
 * [#1639](https://github.com/NibiruChain/nibiru/pull/1639) - fix(perp): by default, disable new markets until they are toggled on.
+* [#1652](https://github.com/NibiruChain/nibiru/pull/1652) - test: refactors cli.network suites with 'Integration' to use common function
 
 ### Dependencies
 - Bump `github.com/prometheus/client_golang` from 1.16.0 to 1.17.0 ([#1605](https://github.com/NibiruChain/nibiru/pull/1605))
@@ -779,4 +780,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Testing
 
 * [#695](https://github.com/NibiruChain/nibiru/pull/695) Add `OpenPosition` integration tests.
-* [#692](https://github.com/NibiruChain/nibiru/pull/692) Add test coverage for Perp MsgServer methods.
+* [#692](https://github.com/NibiruChain/nibiru/pull/692) Add test coverage for Perp MsgServer methods.

contrib/make/test.mk

@@ -2,11 +2,13 @@
 # Tests
 #########################################################################
 
-PACKAGES_NOSIMULATION = ${shell go list ./... | grep -v simapp}
+.PHONY: test-unit
+test-unit:
+	go test ./... -short
 
-.PHONY: test-coverage
-test-coverage:
-	go test ./... $(PACKAGES_NOSIMULATION) -short \
+.PHONY: test-coverage-unit
+test-coverage-unit:
+	go test ./... -short \
 		-coverprofile=coverage.txt \
 		-covermode=atomic \
 		-race

simapp/sim_test.go

@@ -16,20 +16,45 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/simulation"
 	simcli "github.com/cosmos/cosmos-sdk/x/simulation/client/cli"
 	"github.com/stretchr/testify/require"
+	"github.com/stretchr/testify/suite"
 
 	"github.com/NibiruChain/nibiru/app"
 	appsim "github.com/NibiruChain/nibiru/app/sim"
+	"github.com/NibiruChain/nibiru/x/common/testutil"
 	"github.com/NibiruChain/nibiru/x/common/testutil/testapp"
 )
 
 // SimAppChainID hardcoded chainID for simulation
 const SimAppChainID = "simulation-app"
 
-func init() {
+type SimulationTestSuite struct {
+	suite.Suite
+}
+
+func TestSimulationTestSuite(t *testing.T) {
+	suite.Run(t, new(SimulationTestSuite))
+}
+
+var _ suite.SetupTestSuite = (*SimulationTestSuite)(nil)
+var _ suite.SetupAllSuite = (*SimulationTestSuite)(nil)
+
+// SetupSuite: Runs before the entire test suite.
+func (s *SimulationTestSuite) SetupSuite() {
+	// We call GetSimulatorFlags here in order to set the value for
+	// 'simapp.FlagEnabledValue', which enables simulations
 	appsim.GetSimulatorFlags()
 }
 
-func TestFullAppSimulation(tb *testing.T) {
+// SetupTest: Runs before every test in the suite.
+func (s *SimulationTestSuite) SetupTest() {
+	testutil.BeforeIntegrationSuite(s.T())
+	if !simapp.FlagEnabledValue {
+		s.T().Skip("skipping application simulation")
+	}
+}
+
+func (s *SimulationTestSuite) TestFullAppSimulation() {
+	t := s.T()
 	config := simcli.NewConfigFromFlags()
 	config.ChainID = SimAppChainID
 
@@ -40,15 +65,15 @@ func TestFullAppSimulation(tb *testing.T) {
 		simcli.FlagVerboseValue, simcli.FlagEnabledValue,
 	)
 	if skip {
-		tb.Skip("skipping application simulation")
+		t.Skip("skipping application simulation")
 	}
-	require.NoError(tb, err, "simulation setup failed")
+	require.NoError(t, err, "simulation setup failed")
 
 	defer func() {
 		db.Close()
 		err = os.RemoveAll(dir)
 		if err != nil {
-			tb.Fatal(err)
+			t.Fatal(err)
 		}
 	}()
 
@@ -57,7 +82,7 @@ func TestFullAppSimulation(tb *testing.T) {
 
 	// Run randomized simulation:
 	_, simParams, simErr := simulation.SimulateFromSeed(
-		/* tb */ tb,
+		/* tb */ t,
 		/* w */ os.Stdout,
 		/* app */ app.BaseApp,
 		/* appStateFn */ AppStateFn(app.AppCodec(), app.SimulationManager()),
@@ -70,22 +95,20 @@ func TestFullAppSimulation(tb *testing.T) {
 
 	// export state and simParams before the simulation error is checked
 	if err = helpers.CheckExportSimulation(app, config, simParams); err != nil {
-		tb.Fatal(err)
+		t.Fatal(err)
 	}
 
 	if simErr != nil {
-		tb.Fatal(simErr)
+		t.Fatal(simErr)
 	}
 
 	if config.Commit {
 		simapp.PrintStats(db)
 	}
 }
 
-func TestAppStateDeterminism(t *testing.T) {
-	if !simapp.FlagEnabledValue {
-		t.Skip("skipping application simulation")
-	}
+func (s *SimulationTestSuite) TestAppStateDeterminism() {
+	t := s.T()
 
 	encoding := app.MakeEncodingConfig()
 

wasmbinding/test/cli_test.go

@@ -18,6 +18,7 @@ import (
 	"github.com/NibiruChain/nibiru/x/common"
 	"github.com/NibiruChain/nibiru/x/common/asset"
 	"github.com/NibiruChain/nibiru/x/common/denoms"
+	"github.com/NibiruChain/nibiru/x/common/testutil"
 	testutilcli "github.com/NibiruChain/nibiru/x/common/testutil/cli"
 	"github.com/NibiruChain/nibiru/x/common/testutil/genesis"
 	epochstypes "github.com/NibiruChain/nibiru/x/epochs/types"
@@ -39,11 +40,7 @@ type IntegrationTestSuite struct {
 }
 
 func (s *IntegrationTestSuite) SetupSuite() {
-	if testing.Short() {
-		s.T().Skip("skipping integration test suite")
-	}
-
-	s.T().Log("setting up integration test suite")
+	testutil.BeforeIntegrationSuite(s.T())
 
 	app.SetPrefixes(app.AccountAddressPrefix)
 

x/common/testutil/cases.go

@@ -18,3 +18,19 @@ func RunFunctionTests(t *testing.T, testCases []FunctionTestCase) {
 		})
 	}
 }
+
+/*
+BeforeIntegrationSuite: Skips a test if the `-short` flag is not used:
+
+All tests: `go test ./...`
+Unit tests only: `go test ./... -short`
+Integration tests only: `go test ./... -run Integration`
+
+See: https://stackoverflow.com/a/41407042/13305627
+*/
+func BeforeIntegrationSuite(suiteT *testing.T) {
+	if testing.Short() {
+		suiteT.Skip("skipping integration test suite")
+	}
+	suiteT.Log("setting up integration test suite")
+}

x/devgas/v1/keeper/grpc_query_test.go

@@ -9,7 +9,7 @@ import (
 	devgastypes "github.com/NibiruChain/nibiru/x/devgas/v1/types"
 )
 
-func (s *IntegrationTestSuite) TestQueryFeeShares() {
+func (s *KeeperTestSuite) TestQueryFeeShares() {
 	s.SetupTest()
 	_, _, sender := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(
@@ -70,7 +70,7 @@ func (s *IntegrationTestSuite) TestQueryFeeShares() {
 	})
 }
 
-func (s *IntegrationTestSuite) TestFeeShare() {
+func (s *KeeperTestSuite) TestFeeShare() {
 	s.SetupTest()
 	_, _, sender := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(s.ctx, sender, sdk.NewCoins(sdk.NewCoin("stake", sdk.NewInt(1_000_000))))
@@ -102,7 +102,7 @@ func (s *IntegrationTestSuite) TestFeeShare() {
 	s.Require().Equal(resp.Feeshare, feeShare)
 }
 
-func (s *IntegrationTestSuite) TestFeeSharesByWithdrawer() {
+func (s *KeeperTestSuite) TestFeeSharesByWithdrawer() {
 	s.SetupTest()
 	_, _, sender := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(s.ctx, sender, sdk.NewCoins(sdk.NewCoin("stake", sdk.NewInt(1_000_000))))
@@ -141,15 +141,15 @@ func (s *IntegrationTestSuite) TestFeeSharesByWithdrawer() {
 	})
 }
 
-func (s *IntegrationTestSuite) TestQueryParams() {
+func (s *KeeperTestSuite) TestQueryParams() {
 	s.SetupTest()
 	goCtx := sdk.WrapSDKContext(s.ctx)
 	resp, err := s.queryClient.Params(goCtx, nil)
 	s.NoError(err)
 	s.NotNil(resp)
 }
 
-func (s *IntegrationTestSuite) TestNilRequests() {
+func (s *KeeperTestSuite) TestNilRequests() {
 	s.SetupTest()
 	goCtx := sdk.WrapSDKContext(s.ctx)
 	querier := devgaskeeper.NewQuerier(s.app.DevGasKeeper)

x/devgas/v1/keeper/keeper_test.go

@@ -25,7 +25,7 @@ type BankKeeper interface {
 	SendCoinsFromModuleToModule(ctx sdk.Context, senderModule, recipientModule string, amt sdk.Coins) error
 }
 
-type IntegrationTestSuite struct {
+type KeeperTestSuite struct {
 	suite.Suite
 
 	ctx             sdk.Context
@@ -35,7 +35,7 @@ type IntegrationTestSuite struct {
 	wasmMsgServer   wasmtypes.MsgServer
 }
 
-func (s *IntegrationTestSuite) SetupTest() {
+func (s *KeeperTestSuite) SetupTest() {
 	nibiruApp, ctx := testapp.NewNibiruTestAppAndContext()
 	s.app = nibiruApp
 	s.ctx = ctx
@@ -52,16 +52,16 @@ func (s *IntegrationTestSuite) SetupTest() {
 	s.wasmMsgServer = wasmkeeper.NewMsgServerImpl(&s.app.WasmKeeper)
 }
 
-func (s *IntegrationTestSuite) SetupSuite() {
+func (s *KeeperTestSuite) SetupSuite() {
 	s.SetupTest()
 }
 
-func (s *IntegrationTestSuite) FundAccount(
+func (s *KeeperTestSuite) FundAccount(
 	ctx sdk.Context, addr sdk.AccAddress, amounts sdk.Coins,
 ) error {
 	return testapp.FundAccount(s.app.BankKeeper, ctx, addr, amounts)
 }
 
 func TestKeeperTestSuite(t *testing.T) {
-	suite.Run(t, new(IntegrationTestSuite))
+	suite.Run(t, new(KeeperTestSuite))
 }

x/devgas/v1/keeper/msg_server_test.go

@@ -20,7 +20,7 @@ import (
 //go:embed testdata/reflect.wasm
 var wasmContract []byte
 
-func (s *IntegrationTestSuite) StoreCode() {
+func (s *KeeperTestSuite) StoreCode() {
 	_, _, sender := testdata.KeyTestPubAddr()
 	msg := wasmtypes.MsgStoreCodeFixture(func(m *wasmtypes.MsgStoreCode) {
 		m.WASMByteCode = wasmContract
@@ -41,7 +41,7 @@ func (s *IntegrationTestSuite) StoreCode() {
 	s.Require().Equal(wasmtypes.DefaultParams().InstantiateDefaultPermission.With(sender), info.InstantiateConfig)
 }
 
-func (s *IntegrationTestSuite) InstantiateContract(sender string, admin string) string {
+func (s *KeeperTestSuite) InstantiateContract(sender string, admin string) string {
 	msgStoreCode := wasmtypes.MsgStoreCodeFixture(func(m *wasmtypes.MsgStoreCode) {
 		m.WASMByteCode = wasmContract
 		m.Sender = sender
@@ -66,7 +66,7 @@ func (s *IntegrationTestSuite) InstantiateContract(sender string, admin string)
 	return result.Address
 }
 
-func (s *IntegrationTestSuite) TestGetContractAdminOrCreatorAddress() {
+func (s *KeeperTestSuite) TestGetContractAdminOrCreatorAddress() {
 	_, _, sender := testdata.KeyTestPubAddr()
 	_, _, admin := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(s.ctx, sender, sdk.NewCoins(sdk.NewCoin("stake", sdk.NewInt(1_000_000))))
@@ -117,7 +117,7 @@ func (s *IntegrationTestSuite) TestGetContractAdminOrCreatorAddress() {
 	}
 }
 
-func (s *IntegrationTestSuite) TestRegisterFeeShare() {
+func (s *KeeperTestSuite) TestRegisterFeeShare() {
 	_, _, sender := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(s.ctx, sender, sdk.NewCoins(sdk.NewCoin("stake", sdk.NewInt(1_000_000))))
 
@@ -245,7 +245,7 @@ func (s *IntegrationTestSuite) TestRegisterFeeShare() {
 	}
 }
 
-func (s *IntegrationTestSuite) TestUpdateFeeShare() {
+func (s *KeeperTestSuite) TestUpdateFeeShare() {
 	_, _, sender := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(s.ctx, sender, sdk.NewCoins(sdk.NewCoin("stake", sdk.NewInt(1_000_000))))
 
@@ -342,7 +342,7 @@ func (s *IntegrationTestSuite) TestUpdateFeeShare() {
 	}
 }
 
-func (s *IntegrationTestSuite) TestCancelFeeShare() {
+func (s *KeeperTestSuite) TestCancelFeeShare() {
 	_, _, sender := testdata.KeyTestPubAddr()
 	_ = s.FundAccount(s.ctx, sender, sdk.NewCoins(sdk.NewCoin("stake", sdk.NewInt(1_000_000))))
 
@@ -409,7 +409,7 @@ func (s *IntegrationTestSuite) TestCancelFeeShare() {
 	}
 }
 
-func (s *IntegrationTestSuite) TestUpdateParams() {
+func (s *KeeperTestSuite) TestUpdateParams() {
 	govModuleAddr := authtypes.NewModuleAddress(govtypes.ModuleName).String()
 	goCtx := sdk.WrapSDKContext(s.ctx)
 

x/perp/v2/client/cli/cli_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/NibiruChain/nibiru/x/common"
 	"github.com/NibiruChain/nibiru/x/common/asset"
 	"github.com/NibiruChain/nibiru/x/common/denoms"
+	"github.com/NibiruChain/nibiru/x/common/testutil"
 	testutilcli "github.com/NibiruChain/nibiru/x/common/testutil/cli"
 	"github.com/NibiruChain/nibiru/x/common/testutil/genesis"
 	oracletypes "github.com/NibiruChain/nibiru/x/oracle/types"
@@ -32,16 +33,7 @@ type IntegrationTestSuite struct {
 }
 
 func (s *IntegrationTestSuite) SetupSuite() {
-	/* 	Make test skip if -short is not used:
-	All tests: `go test ./...`
-	Unit tests only: `go test ./... -short`
-	Integration tests only: `go test ./... -run Integration`
-	https://stackoverflow.com/a/41407042/13305627 */
-	if testing.Short() {
-		s.T().Skip("skipping integration test suite")
-	}
-
-	s.T().Log("setting up integration test suite")
+	testutil.BeforeIntegrationSuite(s.T())
 
 	app.SetPrefixes(app.AccountAddressPrefix)