add: integration tests network suite #1728

facs95 · 2023-08-27T22:51:09Z

Description

This PR aims to propose a new global integration tests network and helpers to be used across the whole repository. The idea behind is this is to improve the quality of our current integration tests by first having a centralized code within our testing suites for:

Network setup
Query information from chain
Build, sign and broadcast transactions

Based on a bunch issues that we have experienced with misleading tests, this new design aims to force developers to simulate a more realistic scenario when building integration tests. The PR is trying to achieve this by:

Removing direct access to the network's context, keeper's and app forcing user to both, query the chain's information through GRPC and not being able to modify state without a transaction.
Forcing users to be explicit when changing the default configuration of the network.
Forcing users to be explicit when using the TxFactory (e.g being explicit when hard-coding gas or fees)

It will have to be expended as we start refractoring tests, what is included in the TxFactory and Grpc package specially is just an example of what I have identified will be needed for the first integration tests to be refractor.

This is just a first pass and a personal proposal, I expect this PR to be criticized and for it to be an active conversation so that when the PR gets merged we would have reached consensus on how we want integration tests to be built moving forward.

testutil/integration/factory/factory.go

testutil/integration/helpers.go

testutil/integration/network/network.go

+	// bondedAmt is the amount of tokens that each validator will have initially bonded
+	bondedAmt = sdktypes.TokensFromConsensusPower(1, types.PowerReduction)
+	// PrefundedAccountInitialBalance is the amount of tokens that each prefunded account has at genesis
+	PrefundedAccountInitialBalance = sdktypes.NewInt(int64(math.Pow10(18) * 4))


Vvaradinov

Great work @facs95. Left some nits and typos

testutil/integration/factory/factory.go

testutil/integration/grpc/evm.go

testutil/integration/grpc/revenue.go

testutil/integration/network/setup.go

GAtom22

Great work @facs95!!

Left some nit comments

testutil/integration/factory/factory.go

GAtom22 · 2023-08-28T12:41:25Z

testutil/integration/factory/factory.go

+	}
+
+	var gasLimit uint64
+	if txArgs.Gas == 0 {


Nit: should we add a flag to use the simulated gas?
Cause could be the case that we actually want to use a Gas = 0 in a test

I think carrying a separate flag would be more annoying than just put 1 everywhere we want to basically use no gas - or do you see a test case where it's necessary to specifically put 0?

I agree - I wanted to avoid passing flags all around

testutil/integration/factory/factory.go

testutil/integration/factory/helpers.go

fedekunze

LGTM. I'd remove the Cosmos logic (DoCosmosTx, CosmosTxArgs) since we will deprecate that logic in favor of the EVM Extensions.

Please also add the License comment on each file

testutil/integration/factory/factory.go

testutil/integration/network/network.go

testutil/integration/factory/factory.go

Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com>

facs95 · 2023-08-29T23:15:28Z

LGTM. I'd remove the Cosmos logic (DoCosmosTx, CosmosTxArgs) since we will deprecate that logic in favor of the EVM Extensions.

Please also add the License comment on each file

So we are not going to test modules through cosmos txs anymore? - Are we blocking all cosmos txs on the ante handler? @fedekunze. It might be sometime until we accomplish such migration, are you ok with maintaining this as we refractor the tests and then when that migration does happen we can remove the unnecessary helpers?

Will add the licenses 👍

Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com>

MalteHerrmann

Awesome work @facs95! absolutely love to see this.

I notice that there are no tests for these test utilities yet, I think it definitely would make sense to check if they are all working as expected.

CHANGELOG.md

go.mod

testutil/integration/factory/factory.go

MalteHerrmann · 2023-08-31T16:13:59Z

testutil/integration/grpc/feemarket.go

+// GetBaseFee returns the base fee from the feemarket module.
+func (gqh *IntegrationHandler) GetBaseFee() (*feemarkettypes.QueryBaseFeeResponse, error) {
+	feeMarketClient := gqh.network.GetFeeMarketClient()
+	return feeMarketClient.BaseFee(context.Background(), &feemarkettypes.QueryBaseFeeRequest{})


why are we using an empty context here, and not gph.network.GetContext()?

This query simulates a user that is making a query from an external agent that has no access to the context.. the network conext is requested internally from the GetFeeMarketClient to simulate that grpc client

testutil/integration/grpc/grpc.go

testutil/integration/grpc/account.go

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

testutil/integration/factory/factory.go

testutil/integration/network/abci.go

0xstepit · 2023-09-11T16:12:29Z

testutil/integration/network/setup.go

@@ -93,6 +96,7 @@ func createEvmosApp(chainID string) *app.Evmos {
 	)
 }

+// createStakingValidator creates a staking validator from the given tm validator and bonded
 func createStakingValidator(val *tmtypes.Validator, amtOfBondedTokens sdkmath.Int) (stakingtypes.Validator, error) {


Suggested change

func createStakingValidator(val *tmtypes.Validator, amtOfBondedTokens sdkmath.Int) (stakingtypes.Validator, error) {

func createStakingValidator(val *tmtypes.Validator, bondedAmt sdkmath.Int) (stakingtypes.Validator, error) {

I would suggest to update this input name to be consistent with the function createStakingValidators.

0xstepit

Great job @facs95 !

Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com>

GAtom22

LGTM! Great work @facs95!! 🙌

MalteHerrmann

Just some more small nits - this is great, super excited to get it merged! 🚀

testutil/integration/factory/factory.go

testutil/integration/keyring/keyring.go

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

Vvaradinov · 2023-10-16T15:03:30Z

https://github.com/Mergifyio backport release/v15.0.x

mergify · 2023-10-16T15:03:38Z

backport release/v15.0.x

✅ Backports have been created

#1879 add: integration tests network suite (backport #1728) has been created for branch release/v15.0.x but encountered conflicts

* integration interface * grpc and factory packages * fix linter issues * Update testutil/integration/factory/factory.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * Update testutil/integration/factory/factory.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * Update testutil/integration/grpc/evm.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * Update testutil/integration/grpc/revenue.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * remove unnecesary comment * refractor based on comments * fix lint * Update testutil/integration/factory/factory.go Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> * fix comment * add licenses * add changelog * Update CHANGELOG.md Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/helpers.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/grpc/grpc.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * review comments * add error wrappers * refractor executeCosmosTx function * keyring package * Update testutil/integration/network/setup.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * rename NextBlock * fix typos * unified slice allocation thorugh setup * add doc comments * add chainID checker * Update testutil/integration/network/abci.go Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> * fix float arithmetic * fix licenses * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * rename var createStakingValidator --------- Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com> (cherry picked from commit 66eaddb) # Conflicts: # CHANGELOG.md

* add: integration tests network suite (#1728) * integration interface * grpc and factory packages * fix linter issues * Update testutil/integration/factory/factory.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * Update testutil/integration/factory/factory.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * Update testutil/integration/grpc/evm.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * Update testutil/integration/grpc/revenue.go Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> * remove unnecesary comment * refractor based on comments * fix lint * Update testutil/integration/factory/factory.go Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> * fix comment * add licenses * add changelog * Update CHANGELOG.md Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/helpers.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/grpc/grpc.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * review comments * add error wrappers * refractor executeCosmosTx function * keyring package * Update testutil/integration/network/setup.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * rename NextBlock * fix typos * unified slice allocation thorugh setup * add doc comments * add chainID checker * Update testutil/integration/network/abci.go Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> * fix float arithmetic * fix licenses * Update testutil/integration/factory/factory.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * Update testutil/integration/keyring/keyring.go Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> * rename var createStakingValidator --------- Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com> Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com> Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com> Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com> (cherry picked from commit 66eaddb) # Conflicts: # CHANGELOG.md * CHANGELOG * fix CHANGELOG --------- Co-authored-by: Freddy Caceres <facs95@gmail.com> Co-authored-by: Vlad <vladislav.varadinov@gmail.com>

facs95 added 3 commits August 25, 2023 18:56

integration interface

4cdc9e6

grpc and factory packages

14f4c0e

Merge branch 'main' into facs95/integration-test

9a6bf89

facs95 requested a review from a team as a code owner August 27, 2023 22:51

facs95 requested review from Vvaradinov and MalteHerrmann and removed request for a team August 27, 2023 22:51

github-advanced-security bot found potential problems Aug 27, 2023

View reviewed changes

fix linter issues

8d870c7

facs95 changed the title ~~add: integration tests network and helpers suite~~ add: integration tests network suite Aug 27, 2023

Vvaradinov reviewed Aug 28, 2023

View reviewed changes

GAtom22 reviewed Aug 28, 2023

View reviewed changes

fedekunze requested changes Aug 29, 2023

View reviewed changes

testutil/integration/factory/factory.go Outdated Show resolved Hide resolved

testutil/integration/factory/factory.go Outdated Show resolved Hide resolved

testutil/integration/factory/factory.go Outdated Show resolved Hide resolved

0xstepit reviewed Aug 29, 2023

View reviewed changes

testutil/integration/network/network.go Outdated Show resolved Hide resolved

0xstepit reviewed Aug 29, 2023

View reviewed changes

testutil/integration/factory/factory.go Outdated Show resolved Hide resolved

facs95 and others added 5 commits August 29, 2023 18:39

Update testutil/integration/factory/factory.go

57c3298

Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com>

Update testutil/integration/factory/factory.go

2d3e55c

Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com>

Update testutil/integration/grpc/evm.go

2533a88

Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com>

Update testutil/integration/grpc/revenue.go

0d7428d

Co-authored-by: Vladislav Varadinov <vladislav.varadinov@gmail.com>

remove unnecesary comment

9dbf64a

facs95 and others added 7 commits August 29, 2023 19:15

refractor based on comments

54c3c53

fix lint

89f0559

Update testutil/integration/factory/factory.go

231114b

Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com>

fix comment

103dcdd

add licenses

dd11c11

add changelog

67038a3

Merge branch 'main' into facs95/integration-test

158f768

MalteHerrmann reviewed Aug 31, 2023

View reviewed changes

Update CHANGELOG.md

6da16bb

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

facs95 added 4 commits September 8, 2023 13:34

unified slice allocation thorugh setup

58acb85

add doc comments

b11c20d

add chainID checker

cc7b98b

Merge branch 'main' into facs95/integration-test

f139275

github-advanced-security bot found potential problems Sep 8, 2023

View reviewed changes

testutil/integration/factory/factory.go Fixed Show fixed Hide fixed

0xstepit reviewed Sep 11, 2023

View reviewed changes

testutil/integration/network/abci.go Outdated Show resolved Hide resolved

0xstepit reviewed Sep 11, 2023

View reviewed changes

0xstepit approved these changes Sep 11, 2023

View reviewed changes

facs95 and others added 3 commits September 12, 2023 11:03

Update testutil/integration/network/abci.go

b94ed2b

Co-authored-by: stepit <48993133+0xstepit@users.noreply.github.com>

fix float arithmetic

3d31b13

fix licenses

bbb4119

GAtom22 approved these changes Sep 12, 2023

View reviewed changes

Merge branch 'main' into facs95/integration-test

79b0f98

GAtom22 requested a review from fedekunze September 12, 2023 22:14

MalteHerrmann approved these changes Sep 13, 2023

View reviewed changes

facs95 and others added 8 commits September 13, 2023 10:15

Update testutil/integration/factory/factory.go

a713ea1

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

Update testutil/integration/keyring/keyring.go

a30b27d

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

Update testutil/integration/keyring/keyring.go

d68f8f1

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

Update testutil/integration/keyring/keyring.go

e07686e

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

Update testutil/integration/keyring/keyring.go

1154eab

Co-authored-by: MalteHerrmann <42640438+MalteHerrmann@users.noreply.github.com>

Merge branch 'main' into facs95/integration-test

3a48290

Merge branch 'main' into facs95/integration-test

e90f507

rename var createStakingValidator

8eafbd5

facs95 merged commit 66eaddb into main Sep 18, 2023
33 of 34 checks passed

facs95 deleted the facs95/integration-test branch September 18, 2023 12:39

mergify bot mentioned this pull request Oct 16, 2023

add: integration tests network suite (backport #1728) #1879

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add: integration tests network suite #1728

add: integration tests network suite #1728

facs95 commented Aug 27, 2023 •

edited

Loading

Vvaradinov left a comment

GAtom22 left a comment

GAtom22 Aug 28, 2023

MalteHerrmann Aug 31, 2023

facs95 Sep 1, 2023

fedekunze left a comment

facs95 commented Aug 29, 2023

MalteHerrmann left a comment

MalteHerrmann Aug 31, 2023

facs95 Sep 8, 2023

0xstepit Sep 11, 2023

0xstepit left a comment

GAtom22 left a comment

MalteHerrmann left a comment

Vvaradinov commented Oct 16, 2023

mergify bot commented Oct 16, 2023 •

edited

Loading

	func createStakingValidator(val *tmtypes.Validator, amtOfBondedTokens sdkmath.Int) (stakingtypes.Validator, error) {
	func createStakingValidator(val *tmtypes.Validator, bondedAmt sdkmath.Int) (stakingtypes.Validator, error) {

add: integration tests network suite #1728

add: integration tests network suite #1728

Conversation

facs95 commented Aug 27, 2023 • edited Loading

Description

Vvaradinov left a comment

Choose a reason for hiding this comment

GAtom22 left a comment

Choose a reason for hiding this comment

GAtom22 Aug 28, 2023

Choose a reason for hiding this comment

MalteHerrmann Aug 31, 2023

Choose a reason for hiding this comment

facs95 Sep 1, 2023

Choose a reason for hiding this comment

fedekunze left a comment

Choose a reason for hiding this comment

facs95 commented Aug 29, 2023

MalteHerrmann left a comment

Choose a reason for hiding this comment

MalteHerrmann Aug 31, 2023

Choose a reason for hiding this comment

facs95 Sep 8, 2023

Choose a reason for hiding this comment

0xstepit Sep 11, 2023

Choose a reason for hiding this comment

0xstepit left a comment

Choose a reason for hiding this comment

GAtom22 left a comment

Choose a reason for hiding this comment

MalteHerrmann left a comment

Choose a reason for hiding this comment

Vvaradinov commented Oct 16, 2023

mergify bot commented Oct 16, 2023 • edited Loading

✅ Backports have been created

facs95 commented Aug 27, 2023 •

edited

Loading

mergify bot commented Oct 16, 2023 •

edited

Loading