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.

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(systemtests): fix failing tests #22145

Merged
merged 4 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 25 additions & 20 deletions tests/systemtests/cometbft_client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package systemtests
import (
"context"
"fmt"
"net/http"
"net/url"
"testing"
"time"
Expand Down Expand Up @@ -82,6 +83,10 @@ func TestQueryBlockByHeight(t *testing.T) {
}

func TestQueryLatestValidatorSet(t *testing.T) {
if sut.NodesCount() < 2 {
t.Skip("not enough nodes")
return
}
Comment on lines +86 to +89
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove redundant return statement after t.Skip()

After calling t.Skip("not enough nodes"), the test execution is halted, so the return statement on line 88 is unnecessary and can be removed.

Apply this diff to remove the unnecessary return:

 if sut.NodesCount() < 2 {
     t.Skip("not enough nodes")
-    return
 }
📝 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
if sut.NodesCount() < 2 {
t.Skip("not enough nodes")
return
}
if sut.NodesCount() < 2 {
t.Skip("not enough nodes")
}

baseurl := fmt.Sprintf("http://localhost:%d", apiPortStart)
sut.ResetChain(t)
sut.StartChain(t)
Expand All @@ -103,7 +108,7 @@ func TestQueryLatestValidatorSet(t *testing.T) {
assert.NoError(t, err)
assert.Equal(t, len(res.Validators), 2)

restRes := GetRequest(t, mustV(url.JoinPath(baseurl, "/cosmos/base/tendermint/v1beta1/validatorsets/latest?pagination.offset=0&pagination.limit=2")))
restRes := GetRequest(t, fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/latest?pagination.offset=%d&pagination.limit=%d", baseurl, 0, 2))
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

Use net/url package to construct URLs safely

Constructing URLs using fmt.Sprintf may lead to issues if parameters contain special characters. Consider using the net/url package to properly encode query parameters and build the URL safely.

Refactor the URL construction as follows:

u, err := url.Parse(fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/latest", baseurl))
if err != nil {
    t.Fatal(err)
}
q := u.Query()
q.Set("pagination.offset", "0")
q.Set("pagination.limit", "2")
u.RawQuery = q.Encode()
restRes := GetRequest(t, u.String())

assert.Equal(t, len(gjson.GetBytes(restRes, "validators").Array()), 2)
}

Expand Down Expand Up @@ -161,13 +166,14 @@ func TestLatestValidatorSet_GRPCGateway(t *testing.T) {
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
rsp := GetRequest(t, mustV(url.JoinPath(baseurl, tc.url)))
if tc.expErr {
rsp := GetRequestWithHeaders(t, baseurl+tc.url, nil, http.StatusBadRequest)
errMsg := gjson.GetBytes(rsp, "message").String()
assert.Contains(t, errMsg, tc.expErrMsg)
} else {
assert.Equal(t, len(vals), int(gjson.GetBytes(rsp, "pagination.total").Int()))
return
}
rsp := GetRequest(t, baseurl+tc.url)
assert.Equal(t, len(vals), int(gjson.GetBytes(rsp, "pagination.total").Int()))
})
}
}
Expand Down Expand Up @@ -204,41 +210,40 @@ func TestValidatorSetByHeight(t *testing.T) {
}
}

func TestValidatorSetByHeight_GRPCGateway(t *testing.T) {
func TestValidatorSetByHeight_GRPCRestGateway(t *testing.T) {
sut.ResetChain(t)
sut.StartChain(t)

vals := sut.RPCClient(t).Validators()

baseurl := fmt.Sprintf("http://localhost:%d", apiPortStart)

baseurl := sut.APIAddress()
block := sut.AwaitNextBlock(t, time.Second*3)
testCases := []struct {
name string
url string
expErr bool
expErrMsg string
name string
url string
expErr bool
expErrMsg string
expHttpCode int
}{
{"invalid height", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", baseurl, -1), true, "height must be greater than 0"},
{"no pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", baseurl, block), false, ""},
{"pagination invalid fields", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.offset=-1&pagination.limit=-2", baseurl, block), true, "strconv.ParseUint"},
{"with pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.limit=2", baseurl, 1), false, ""},
{"invalid height", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", baseurl, -1), true, "height must be greater than 0", http.StatusInternalServerError},
{"no pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d", baseurl, block), false, "", http.StatusOK},
{"pagination invalid fields", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.offset=-1&pagination.limit=-2", baseurl, block), true, "strconv.ParseUint", http.StatusBadRequest},
{"with pagination", fmt.Sprintf("%s/cosmos/base/tendermint/v1beta1/validatorsets/%d?pagination.limit=2", baseurl, 1), false, "", http.StatusOK},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
rsp := GetRequest(t, tc.url)
rsp := GetRequestWithHeaders(t, tc.url, nil, tc.expHttpCode)
if tc.expErr {
errMsg := gjson.GetBytes(rsp, "message").String()
assert.Contains(t, errMsg, tc.expErrMsg)
} else {
assert.Equal(t, len(vals), int(gjson.GetBytes(rsp, "pagination.total").Int()))
return
}
assert.Equal(t, len(vals), int(gjson.GetBytes(rsp, "pagination.total").Int()))
})
}
}

func TestABCIQuery(t *testing.T) {
sut.ResetChain(t)
sut.StartChain(t)

qc := cmtservice.NewServiceClient(sut.RPCClient(t))
Expand Down Expand Up @@ -312,7 +317,7 @@ func TestABCIQuery(t *testing.T) {
} else {
assert.NoError(t, err)
assert.NotNil(t, res)
assert.Equal(t, res.Code, tc.expectedCode)
assert.Equal(t, tc.expectedCode, res.Code)
}

if tc.validQuery {
Expand Down
4 changes: 2 additions & 2 deletions tests/systemtests/rest_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ func GetRequestWithHeaders(t *testing.T, url string, headers map[string]string,
defer func() {
_ = res.Body.Close()
}()
require.Equal(t, expCode, res.StatusCode, "status code should be %d, got: %d", expCode, res.StatusCode)

body, err := io.ReadAll(res.Body)
require.NoError(t, err)
require.Equal(t, expCode, res.StatusCode, "status code should be %d, got: %d, %s", expCode, res.StatusCode, body)

return body
}
5 changes: 5 additions & 0 deletions tests/systemtests/system.go
Original file line number Diff line number Diff line change
Expand Up @@ -766,6 +766,11 @@ func (s *SystemUnderTest) CurrentHeight() int64 {
return s.currentHeight.Load()
}

// NodesCount returns the number of node instances used
func (s *SystemUnderTest) NodesCount() int {
return s.nodesCount
}

type Node struct {
ID string
IP string
Expand Down
14 changes: 14 additions & 0 deletions tests/systemtests/testnet_init.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,20 @@ func NewSingleHostTestnetCmdInitializer(
}
}

// InitializerWithBinary creates new SingleHostTestnetCmdInitializer from sut with given binary
func InitializerWithBinary(binary string, sut *SystemUnderTest) TestnetInitializer {
return NewSingleHostTestnetCmdInitializer(
binary,
WorkDir,
sut.chainID,
sut.outputDir,
sut.initialNodesCount,
sut.minGasPrice,
sut.CommitTimeout(),
sut.Log,
)
}

func (s SingleHostTestnetCmdInitializer) Initialize() {
args := []string{
"testnet",
Expand Down
9 changes: 6 additions & 3 deletions tests/systemtests/upgrade_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,28 @@ import (
)

func TestChainUpgrade(t *testing.T) {
// err> panic: failed to load latest version: failed to load store: initial version set to 22, but found earlier version 1 [cosmossdk.io/store@v1.1.1/rootmulti/store.go:256]
Copy link
Member

Choose a reason for hiding this comment

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

this probably needs to be reverted in the 0.52 backport

t.Skip("Skipped until any v052 artifact is available AND main branch handles the store upgrade proper")

// Scenario:
// start a legacy chain with some state
// when a chain upgrade proposal is executed
// then the chain upgrades successfully
sut.StopChain()

legacyBinary := FetchExecutable(t, "v0.50")
legacyBinary := FetchExecutable(t, "v0.52")
t.Logf("+++ legacy binary: %s\n", legacyBinary)
currentBranchBinary := sut.execBinary
currentInitializer := sut.testnetInitializer
sut.SetExecBinary(legacyBinary)
sut.SetTestnetInitializer(NewModifyConfigYamlInitializer(legacyBinary, sut))
sut.SetTestnetInitializer(InitializerWithBinary(legacyBinary, sut))
sut.SetupChain()
votingPeriod := 5 * time.Second // enough time to vote
sut.ModifyGenesisJSON(t, SetGovVotingPeriod(t, votingPeriod))

const (
upgradeHeight int64 = 22
upgradeName = "v050-to-v051"
upgradeName = "v052-to-v054" // must match UpgradeName in simapp/upgrades.go
)

sut.StartChain(t, fmt.Sprintf("--halt-height=%d", upgradeHeight+1))
Expand Down
Loading