Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(accounts): fix integration tests #22418

Merged
merged 8 commits into from
Nov 11, 2024
Merged

test(accounts): fix integration tests #22418

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
68cd699
test(accounts): fix integration tests and update ci
akhilkumarpilli Nov 4, 2024
efc6ac8
revert change
akhilkumarpilli Nov 4, 2024
5b52d2a
revert ci changes and fix one file test
akhilkumarpilli Nov 5, 2024
093f4dc
revert change
akhilkumarpilli Nov 5, 2024
8b8c6e0
Merge branch 'main' into akhil/fix-appv1-build
akhilkumarpilli Nov 8, 2024
b8431ae
Merge branch 'main' into akhil/fix-appv1-build
akhilkumarpilli Nov 11, 2024
eeb9814
fix baseaccount test
akhilkumarpilli Nov 11, 2024
a410360
fix block test
akhilkumarpilli Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ jobs:
with:
name: "${{ github.sha }}-integration-coverage"
path: ./tests/integration-profile.out
- name: integration tests v1
if: env.GIT_DIFF
run: |
make test-integration-v1

test-system: # v2 system tests are in v2-test.yml
runs-on: ubuntu-latest
Expand Down
5 changes: 4 additions & 1 deletion scripts/build/testing.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,11 @@ test-integration:
#? test-integration-cov: Run `make -C tests test-integration-cov`
test-integration-cov:
$(MAKE) -C tests test-integration-cov
#? test-integration-v1: Run `make -C tests test-integration-v1`
test-integration-v1:
$(MAKE) -C tests test-integration-v1
#? test-all: Run all test
test-all: test-unit test-integration test-ledger-mock test-race
test-all: test-unit test-integration test-integration-v1 test-ledger-mock test-race

.PHONY: test-system
test-system: build
Expand Down
3 changes: 3 additions & 0 deletions tests/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
test-integration:
go test ./integration/... -timeout 30m

test-integration-v1:
go test -tags='app_v1' ./integration/... -timeout 30m

test-integration-cov:
go test ./integration/... -timeout 30m -coverpkg=../... -coverprofile=integration-profile.out -covermode=atomic
19 changes: 19 additions & 0 deletions tests/integration/accounts/base_account_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,18 @@ import (
banktypes "cosmossdk.io/x/bank/types"

codectypes "github.com/cosmos/cosmos-sdk/codec/types"
"github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1"
cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
"github.com/cosmos/cosmos-sdk/testutil/sims"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/stretchr/testify/require"
)

var (
privKey = secp256k1.GenPrivKey()
accCreator = []byte("creator")
)
Comment on lines +23 to +26
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider improving test determinism and maintainability.

The current implementation has several potential issues:

  1. Using GenPrivKey() at the package level could lead to non-deterministic tests. Consider moving key generation into a test setup function with a fixed seed.
  2. The magic string "creator" should be documented or defined as a named constant.
  3. Global variables can make tests harder to maintain and understand. Consider using a test fixture struct.

Here's a suggested refactor:

-var (
-    privKey    = secp256k1.GenPrivKey()
-    accCreator = []byte("creator")
-)

+const (
+    testCreatorID = "creator"
+)
+
+type testFixture struct {
+    privKey    cryptotypes.PrivKey
+    accCreator []byte
+}
+
+func setupTestFixture(t *testing.T) *testFixture {
+    t.Helper()
+    return &testFixture{
+        privKey:    secp256k1.GenPrivKeyFromSecret([]byte("fixed_test_seed")),
+        accCreator: []byte(testCreatorID),
+    }
+}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
var (
privKey = secp256k1.GenPrivKey()
accCreator = []byte("creator")
)
const (
testCreatorID = "creator"
)
type testFixture struct {
privKey cryptotypes.PrivKey
accCreator []byte
}
func setupTestFixture(t *testing.T) *testFixture {
t.Helper()
return &testFixture{
privKey: secp256k1.GenPrivKeyFromSecret([]byte("fixed_test_seed")),
accCreator: []byte(testCreatorID),
}
}


func TestBaseAccount(t *testing.T) {
app := setupApp(t)
ak := app.AccountsKeeper
Expand Down Expand Up @@ -95,3 +101,16 @@ func toAnyPb(t *testing.T, pm gogoproto.Message) *codectypes.Any {
require.NoError(t, err)
return pb
}

func coins(t *testing.T, s string) sdk.Coins {
t.Helper()
coins, err := sdk.ParseCoinsNormalized(s)
require.NoError(t, err)
return coins
}

func setupApp(t *testing.T) *simapp.SimApp {
t.Helper()
app := simapp.Setup(t, false)
return app
}
Loading