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: migrate e2e/authz to system tests #21819

Merged
merged 17 commits into from
Oct 1, 2024
Merged

Conversation

akhilkumarpilli
Copy link
Contributor

@akhilkumarpilli akhilkumarpilli commented Sep 19, 2024

Description

Closes: #21609


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive suite of system tests for authorization functionalities, enhancing testing coverage for granting, executing, and revoking permissions.
  • Refactor

    • Improved structure and execution of gRPC query test cases for better code reusability and clarity.
    • Simplified test case logic in bank transaction tests for clearer error handling.
  • Chores

    • Updated the SystemUnderTest struct to include a new API address field for better configuration management.
    • Added utility functions to streamline the execution of gRPC test cases and file handling.

Copy link
Contributor

coderabbitai bot commented Sep 19, 2024

Caution

Review failed

The head commit changed during the review from fb4dc68 to 2ce8237.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request involves migrating end-to-end (E2E) tests for authorization from the tests/e2e/authz directory to a new system test suite in tests/systemtests/authz_test.go. The existing E2E tests have been deleted, and new system tests have been created to validate similar functionalities. Additionally, there are various modifications to enhance the structure and execution of tests across the system testing framework.

Changes

Files Change Summary
tests/e2e/authz/cli_test.go, tests/e2e/authz/grpc.go, tests/e2e/authz/tx.go Deleted files containing E2E tests for authorization functionalities, with multiple test methods removed.
tests/systemtests/authz_test.go New file containing a system test suite for authorization functionalities, including methods for granting, executing, and revoking permissions.
tests/systemtests/bank_test.go Refactored TestBankGRPCQueries to use a common GRPCTestCase struct for better reusability.
tests/systemtests/system.go Added new field apiAddr to SystemUnderTest struct and updated the constructor and added a method for API address retrieval.
tests/systemtests/test_runner.go Introduced GRPCTestCase struct, RunGRPCQueries function, and WriteToTempJSONFile utility function.
x/authz/module/autocli.go Modified AutoCLIOptions method to change the msgs argument to accept a fixed number of arguments by removing the Varargs property.

Assessment against linked issues

Objective Addressed Explanation
Find an e2e test from tests/e2e that looks like a system test (#[21609])
Rewrite it as a system test and verify it runs with v1 and v2 (#[21609])
Delete the old e2e test (#[21609])

Possibly related PRs

Suggested reviewers

  • julienrbrt
  • sontrinh16

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 10

Outside diff range and nitpick comments (3)
tests/systemtests/test_runner.go (1)

140-152: LGTM: Well-implemented RunGRPCQueries function with a minor suggestion

The RunGRPCQueries function is well-implemented and aligns with the PR objective of migrating e2e tests to system tests. It effectively uses subtests and proper error handling.

Consider adding a timeout mechanism for GRPC requests to prevent tests from hanging indefinitely in case of network issues. You could use a context with timeout:

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
resp, err := testutil.GetRequestWithContext(ctx, tc.url)

This change would require updating the testutil.GetRequest function to accept a context parameter.

tests/systemtests/bank_test.go (1)

Line range hint 286-304: LGTM: Improved test case structure and execution

The refactoring of denom metadata test cases to use the GRPCTestCase struct is a good improvement. It enhances code organization and reusability. The use of RunGRPCQueries for test execution likely simplifies the testing process.

This change aligns well with the PR objective of rewriting the e2e test as a system test.

Consider adding a comment explaining the GRPCTestCase struct fields for better readability, especially for developers new to the codebase.

tests/systemtests/authz_test.go (1)

5-13: Organize Import Statements According to Go Standards

Ensure that import statements are organized with standard library packages first, followed by third-party packages, and local packages last. Also, separate them with blank lines for better readability.

Organize imports as:

import (
    "fmt"
    "testing"
    "time"

    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/require"
    "github.com/tidwall/gjson"
)
Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4666e1d and e0b3ecf.

Files selected for processing (8)
  • tests/e2e/authz/cli_test.go (0 hunks)
  • tests/e2e/authz/grpc.go (0 hunks)
  • tests/e2e/authz/tx.go (0 hunks)
  • tests/systemtests/authz_test.go (1 hunks)
  • tests/systemtests/bank_test.go (4 hunks)
  • tests/systemtests/system.go (3 hunks)
  • tests/systemtests/test_runner.go (2 hunks)
  • x/authz/module/autocli.go (1 hunks)
Files not reviewed due to no reviewable changes (3)
  • tests/e2e/authz/cli_test.go
  • tests/e2e/authz/grpc.go
  • tests/e2e/authz/tx.go
Additional context used
Path-based instructions (5)
tests/systemtests/authz_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

tests/systemtests/bank_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

tests/systemtests/system.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"

tests/systemtests/test_runner.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"

x/authz/module/autocli.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (9)
x/authz/module/autocli.go (1)

59-59: LGTM! Consider verifying impact and updating docs.

The removal of Varargs: true for the msgs argument aligns with the PR objectives of migrating e2e tests to system tests by potentially enforcing stricter input requirements. This change looks good and is likely to improve the robustness of the system tests.

To ensure this change doesn't break existing functionality:

  1. Verify that all existing usages of this command in the codebase and tests have been updated to comply with the new input format.
  2. Update any relevant documentation or examples that may reference the old varargs behavior.

Here's a script to help verify the usage:

Please review the results of this script to ensure all usages are compatible with the new input format.

Verification successful

Verified! No issues found with the authz exec usage.

The removal of Varargs: true for the msgs argument has been successfully validated against the existing codebase and tests. All current usages of the authz exec command conform to the new single-argument requirement, ensuring that the change aligns with the PR objectives without introducing regressions.

  • No instances of multiple msg-json-file arguments were found.
  • Deprecated legacy-exec commands appropriately guide towards the updated exec usage.
  • Tests are in place to support the new command structure.

Please proceed with merging this change and ensure that all relevant documentation is updated to reflect the enforced single argument requirement for the authz exec command.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for usages of the 'authz exec' command in Go files and tests

# Search in Go files
echo "Searching in Go files:"
rg --type go 'authz\s+exec' -C 3

# Search in test files
echo "Searching in test files:"
rg --type-add 'test:*.{go,t,sh}' --type test 'authz\s+exec' -C 3

Length of output: 3625

tests/systemtests/test_runner.go (2)

134-138: LGTM: Well-structured GRPCTestCase struct

The GRPCTestCase struct is well-defined and aligns with the PR objective of migrating e2e tests to system tests. The field names are clear and self-explanatory, making it easy to understand and use in test scenarios.


133-168: Summary: Effective implementation supporting e2e to system test migration

The changes in this file effectively support the PR objective of migrating e2e tests to system tests. The new GRPCTestCase struct, RunGRPCQueries function, and WriteToTempJSONFile function enhance the testing capabilities and provide a solid foundation for implementing system tests.

These additions align well with the coding guidelines for test files and demonstrate good practices in test implementation, such as using subtests, proper error handling, and test isolation.

To ensure that these changes are properly integrated and utilized, please run the following command to check for any new system tests that use these new functions:

This will help verify that the new functionality is being used in actual system tests, furthering the PR's objective of migrating e2e tests to system tests.

Verification successful

Verification Successful: New Functions Utilized in System Tests

The shell script confirmed that both RunGRPCQueries and WriteToTempJSONFile are actively used in tests/systemtests/bank_test.go and tests/systemtests/authz_test.go. This verifies that the new implementations are integrated effectively, supporting the migration from e2e tests to system tests as intended.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for new system tests using the new functions
rg --type go 'RunGRPCQueries|WriteToTempJSONFile' tests/systemtests

Length of output: 1158

tests/systemtests/bank_test.go (3)

227-227: LGTM: Improved flexibility in obtaining API address

The change to use sut.APIAddress() for obtaining the base URL is a good improvement. It enhances flexibility and maintainability by using a method to retrieve the API address instead of hard-coding it.


Line range hint 1-328: Summary: Successful migration of bank GRPC queries to system tests

The changes in this file successfully achieve the PR objective of migrating e2e tests to system tests for bank GRPC queries. Key improvements include:

  1. Enhanced flexibility in obtaining the API address.
  2. Improved test case structure using the GRPCTestCase struct for both denom metadata and balance tests.
  3. Consistent use of RunGRPCQueries for test execution.

These changes not only fulfill the migration requirement but also improve code organization, reusability, and maintainability. The refactoring aligns well with Go best practices.

To fully complete the PR objectives, ensure that:

  1. The old e2e test has been removed (as verified by the previous script).
  2. The CI process successfully runs these tests with both version 1 and version 2 of the software.

Line range hint 310-328: LGTM: Consistent improvement in test case structure

The refactoring of balance test cases to use the GRPCTestCase struct is consistent with the earlier changes and improves code organization. The use of RunGRPCQueries for test execution maintains consistency across different test types.

This change aligns well with the PR objective of rewriting the e2e test as a system test.

To ensure the completeness of the migration, let's verify that the old e2e test has been removed as mentioned in the PR objectives. Run the following script:

Verification successful

✅ Verification Successful: Old e2e test files have been removed

The executed shell script confirmed that no old e2e test files containing bank GRPC queries exist in the tests/e2e directory. This confirms that the migration to system tests is complete and aligns with the PR objectives.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the old e2e test file for bank queries has been removed

# Search for any file in the e2e directory that might contain bank GRPC queries
result=$(find tests/e2e -type f -exec grep -l "bank.*GRPC" {} +)

if [ -n "$result" ]; then
    echo "Potential old e2e test file(s) found:"
    echo "$result"
else
    echo "No potential old e2e test files found. Migration seems complete."
fi

Length of output: 224

tests/systemtests/system.go (3)

56-56: LGTM: Addition of apiAddr field

The addition of the apiAddr field to the SystemUnderTest struct is appropriate and well-placed. It's consistent with the structure's purpose and will allow for storing and accessing the API address.


626-628: LGTM: Addition of APIAddress method

The APIAddress method is a well-implemented getter for the apiAddr field. It follows Go conventions and provides a clean way to access the API address.


90-90: Verify the apiPortStart variable

The initialization of apiAddr uses a variable apiPortStart which is not defined in the visible code. This could lead to compilation errors or unexpected behavior.

Please ensure that apiPortStart is properly defined and initialized before its use. If it's defined in another file, consider adding a comment to clarify its source. Alternatively, you might want to pass it as a parameter to the NewSystemUnderTest function.

To verify this, you can run the following command:

Comment on lines 156 to 168
func WriteToTempJSONFile(tb testing.TB, s string) *os.File {
tb.Helper()

tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
require.Nil(tb, err)
defer tmpFile.Close()

// Write to the temporary file
_, err = tmpFile.WriteString(s)
require.Nil(tb, err)

return tmpFile
}
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM: Well-implemented WriteToTempJSONFile function with a suggestion

The WriteToTempJSONFile function is well-implemented and provides a useful utility for creating temporary JSON files in tests. It properly uses the testing.TB interface and follows good practices for test isolation.

Consider adding an option to close the file before returning it. This would allow the caller to decide whether they need the file open or closed. You could modify the function signature and implementation as follows:

func WriteToTempJSONFile(tb testing.TB, s string, keepOpen bool) *os.File {
    // ... existing implementation ...

    if !keepOpen {
        err = tmpFile.Close()
        require.Nil(tb, err)
    }

    return tmpFile
}

This change would provide more flexibility to the function users while maintaining the current functionality.

Comment on lines 390 to 400
bankTx := fmt.Sprintf(`{
"@type": "%s",
"from_address": "%s",
"to_address": "%s",
"amount": [
{
"denom": "%s",
"amount": "%d"
}
]
}`, msgSendTypeURL, granterAddr, tc.toAddr, denom, tc.amount)
Copy link
Contributor

Choose a reason for hiding this comment

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

Use Structs and json.Marshal Instead of fmt.Sprintf for JSON Construction

Constructing JSON messages using fmt.Sprintf can lead to errors if the data contains special characters or unexpected formats. It's recommended to use Go structs and json.Marshal to build JSON messages, which ensures proper encoding and reduces the risk of invalid JSON.

Apply this refactor to construct the JSON message safely:

type BankTx struct {
    Type        string `json:"@type"`
    FromAddress string `json:"from_address"`
    ToAddress   string `json:"to_address"`
    Amount      []struct {
        Denom  string `json:"denom"`
        Amount string `json:"amount"`
    } `json:"amount"`
}

bankTxStruct := BankTx{
    Type:        msgSendTypeURL,
    FromAddress: granterAddr,
    ToAddress:   tc.toAddr,
    Amount: []struct {
        Denom  string `json:"denom"`
        Amount string `json:"amount"`
    }{
        {
            Denom:  denom,
            Amount: fmt.Sprintf("%d", tc.amount),
        },
    },
}

bankTxBytes, err := json.Marshal(bankTxStruct)
require.NoError(t, err)
execMsg := WriteToTempJSONFile(t, string(bankTxBytes))

Comment on lines 428 to 438
bankTx := fmt.Sprintf(`{
"@type": "%s",
"from_address": "%s",
"to_address": "%s",
"amount": [
{
"denom": "%s",
"amount": "%d"
}
]
}`, msgSendTypeURL, granterAddr, allowedAddr, denom, 10)
Copy link
Contributor

Choose a reason for hiding this comment

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

Use Structs and json.Marshal for Consistent JSON Message Construction

Similar to previous instances, constructing JSON using fmt.Sprintf can be error-prone. Using structs with json.Marshal enhances code safety and readability.

Refactor the code as suggested to utilize structs and json.Marshal.

Comment on lines 546 to 551
delegateTx := fmt.Sprintf(`{"@type":"%s","delegator_address":"%s","validator_address":"%s","amount":{"denom":"%s","amount":"%d"}}`,
msgDelegateTypeURL, granterAddr, tc.valAddr, denom, tc.amount)
execMsg := WriteToTempJSONFile(t, delegateTx)
defer execMsg.Close()

cmd := append(append(execCmdArgs, execMsg.Name()), "--from="+tc.grantee)
Copy link
Contributor

Choose a reason for hiding this comment

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

Prefer Using Structs and json.Marshal for Delegate Transactions

Constructing JSON payloads with fmt.Sprintf might introduce formatting errors. Leveraging Go structs and json.Marshal ensures the JSON is correctly formatted.

Implement the refactor using structs:

type DelegateTx struct {
    Type              string `json:"@type"`
    DelegatorAddress  string `json:"delegator_address"`
    ValidatorAddress  string `json:"validator_address"`
    Amount            struct {
        Denom  string `json:"denom"`
        Amount string `json:"amount"`
    } `json:"amount"`
}

delegateTxStruct := DelegateTx{
    Type:             msgDelegateTypeURL,
    DelegatorAddress: granterAddr,
    ValidatorAddress: tc.valAddr,
    Amount: struct {
        Denom  string `json:"denom"`
        Amount string `json:"amount"`
    }{
        Denom:  denom,
        Amount: fmt.Sprintf("%d", tc.amount),
    },
}

delegateTxBytes, err := json.Marshal(delegateTxStruct)
require.NoError(t, err)
execMsg := WriteToTempJSONFile(t, string(delegateTxBytes))

require.Equal(t, initialAmount, allowedAddrBal)

var spendLimitAmount int64 = 1000
expirationTime := time.Now().Add(time.Second * 10).Unix()
Copy link
Contributor

Choose a reason for hiding this comment

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

Avoid Using time.Now() Directly in Tests

Using time.Now() in tests can lead to flaky tests due to timing issues. Consider injecting a time provider or using a fixed timestamp to make tests deterministic and reliable.

Also applies to: 449-449

}

// test grant expiry
time.Sleep(time.Second * 10)
Copy link
Contributor

Choose a reason for hiding this comment

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

Minimize Use of time.Sleep in Tests

Using time.Sleep can slow down tests and cause flakiness. It's better to mock time or adjust the logic to wait for events or conditions instead of fixed sleep durations.

Also applies to: 467-467

Comment on lines +51 to +52
valOperAddr := gjson.Get(rsp, "validators.#.operator_address").Array()[0].String()

Copy link
Contributor

Choose a reason for hiding this comment

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

Check for Empty Validator List Before Accessing Elements

Directly accessing the first element of the validators array without checking if it's empty can cause a panic if the array is empty. Ensure that the array has elements before accessing.

Modify the code to include a check:

validators := gjson.Get(rsp, "validators.#.operator_address").Array()
require.GreaterOrEqual(t, len(validators), 1)
valOperAddr := validators[0].String()

Comment on lines 23 to 256
true,
"decoding bech32 failed",
false,
},
{
"redelegate authorization with invalid deny validator address",
grantee1Addr,
[]string{"redelegate", "--deny-validators=invalid"},
true,
"decoding bech32 failed",
false,
},
{
"valid send authorization",
grantee1Addr,
[]string{"send", "--spend-limit=1000stake"},
false,
"",
false,
},
{
"valid send authorization with expiration",
grantee2Addr,
[]string{"send", "--spend-limit=1000stake", fmt.Sprintf("--expiration=%d", expirationTime)},
false,
"",
false,
},
{
"valid generic authorization",
grantee3Addr,
[]string{"generic", "--msg-type=" + msgVoteTypeURL},
false,
"",
false,
},
{
"valid delegate authorization",
grantee4Addr,
[]string{"delegate", "--allowed-validators=" + valOperAddr},
false,
"",
false,
},
{
"valid unbond authorization",
grantee5Addr,
[]string{"unbond", "--deny-validators=" + valOperAddr},
false,
"",
false,
},
{
"valid redelegate authorization",
grantee6Addr,
[]string{"redelegate", "--allowed-validators=" + valOperAddr},
false,
"",
false,
},
}

grantsCount := 0

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
cmd := append(append(grantCmdArgs, tc.grantee), tc.cmdArgs...)
if tc.expectErr {
if tc.queryTx {
rsp := cli.Run(cmd...)
RequireTxFailure(t, rsp)
require.Contains(t, rsp, tc.expErrMsg)
} else {
assertErr := func(_ assert.TestingT, gotErr error, gotOutputs ...interface{}) bool {
require.Len(t, gotOutputs, 1)
output := gotOutputs[0].(string)
require.Contains(t, output, tc.expErrMsg)
return false
}
_ = cli.WithRunErrorMatcher(assertErr).Run(cmd...)
}
} else {
rsp := cli.RunAndWait(cmd...)
RequireTxSuccess(t, rsp)

// query granter-grantee grants
resp := cli.CustomQuery("q", "authz", "grants", granterAddr, tc.grantee)
grants := gjson.Get(resp, "grants").Array()
// check grants length equal to 1 to confirm grant created successfully
require.Len(t, grants, 1)
grantsCount++
}
})
}

// query grants-by-granter
resp := cli.CustomQuery("q", "authz", "grants-by-granter", granterAddr)
grants := gjson.Get(resp, "grants").Array()
require.Len(t, grants, grantsCount)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Split Long Test Function into Smaller, Focused Tests

The TestAuthzGrantTxCmd function is lengthy and covers multiple scenarios. Consider splitting it into smaller test functions, each focusing on a specific aspect or scenario. This improves readability and makes maintenance easier.

Comment on lines 427 to 428
time.Sleep(time.Second * 10)
bankTx := fmt.Sprintf(`{
Copy link
Contributor

Choose a reason for hiding this comment

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

Use Time Mocking Instead of time.Sleep for Expiration Tests

Relying on time.Sleep to test expiration can make tests slow and unreliable. Use a time mocking library or dependency injection to simulate time passage, making the tests faster and more stable.

Consider using a time mocking library like github.com/benbjohnson/clock to control time in tests.

Also applies to: 467-468

Comment on lines +225 to +237
if tc.queryTx {
rsp := cli.Run(cmd...)
RequireTxFailure(t, rsp)
require.Contains(t, rsp, tc.expErrMsg)
} else {
assertErr := func(_ assert.TestingT, gotErr error, gotOutputs ...interface{}) bool {
require.Len(t, gotOutputs, 1)
output := gotOutputs[0].(string)
require.Contains(t, output, tc.expErrMsg)
return false
}
_ = cli.WithRunErrorMatcher(assertErr).Run(cmd...)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify Error Handling in Test Cases

The error handling logic within the test cases can be simplified for clarity. Instead of defining an anonymous function for error matching, consider using require.ErrorContains or similar assertions provided by the testify package.

Refactor the error assertions:

if tc.expectErr {
    rsp := cli.Run(cmd...)
    RequireTxFailure(t, rsp)
    require.Contains(t, rsp, tc.expErrMsg)
} else {
    rsp := cli.RunAndWait(cmd...)
    RequireTxSuccess(t, rsp)
    // Additional success assertions...
}

Copy link
Contributor

@alpe alpe left a comment

Choose a reason for hiding this comment

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

Nice start. 💪

@@ -127,3 +130,39 @@ func printResultFlag(ok bool) {
fmt.Println(failureFlag)
}
}

type GRPCTestCase struct {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why GRPC? Isn't this a REST api?

personal preference:
Adding more framework code for common operations makes sense. I am wondering if it would be more beneficial to add them to a new file. The type and method added in this PR could fit into some rest client helper type.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. Even though it's REST api, named it as GRPC as it runs using grpc gateway endpoints.

t.Run(tc.name, func(t *testing.T) {
resp, err := testutil.GetRequest(tc.url)
require.NoError(t, err)
require.Contains(t, string(resp), tc.expOut)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a weak check. Would it make sense to use require.JSONEq( ) instead?


// Write the given string to a new temporary json file.
// Returns an file for the test to use.
func WriteToTempJSONFile(tb testing.TB, s string) *os.File {
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: the method makes no assumption on the file content. Why limit this to json only?
It is used in authz_test.go only. We can move it there to start with until a second use case pops up.

Copy link
Contributor Author

@akhilkumarpilli akhilkumarpilli Sep 24, 2024

Choose a reason for hiding this comment

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

We already have a method WriteToTempFile in testutil which writes given data to a temp file. But for authz exec command, it supports only json file, so I wrote a separate method for it. Will move this method to authz_test.go

tb.Helper()

tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
require.Nil(tb, err)
Copy link
Contributor

Choose a reason for hiding this comment

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

here and others: this give a better failure message

Suggested change
require.Nil(tb, err)
require.NoError(tb, err)

@@ -224,7 +224,7 @@ func TestBankGRPCQueries(t *testing.T) {

// start chain
sut.StartChain(t)
baseurl := fmt.Sprintf("http://localhost:%d", apiPortStart)
baseurl := sut.APIAddress()
Copy link
Contributor

Choose a reason for hiding this comment

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

👍 to have this in a single place

_ = cli.WithRunErrorMatcher(assertErr).Run(cmd...)
}
} else {
rsp := cli.RunAndWait(cmd...)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: you can use cli.RunAndWait(cmd...) for the happy path, now.

Copy link
Contributor Author

@akhilkumarpilli akhilkumarpilli Sep 23, 2024

Choose a reason for hiding this comment

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

Just to confirm, is this what is being used here?

cli := NewCLIWrapper(t, sut, verbose)

// get validator address which will be used as granter
granterAddr := gjson.Get(cli.Keys("keys", "list"), "1.address").String()
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: see comment above

]
}`, msgSendTypeURL, granterAddr, tc.toAddr, denom, tc.amount)
execMsg := WriteToTempJSONFile(t, bankTx)
defer execMsg.Close()
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: the file is closed already. No need to do it here again

}

// test grant expiry
time.Sleep(time.Second * 10)
Copy link
Contributor

Choose a reason for hiding this comment

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

The time can not be mocked here but maybe test setups can be re-arranged to reduce the total sleep time. For example, first setup the 2 grants that will timeout, run some other tests, wait for the timeout to happen.
The SUT does not provide a CurrentBlockTime() method yet. But we could extend the block listener to also store the block time from the header. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, may be works.

resp = cli.CustomQuery("q", "authz", "grants-by-granter", granterAddr)
grants = gjson.Get(resp, "grants").Array()
require.Len(t, grants, 0)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

This was a very big test. Although I do understand that all the cases share the exec command, do you see some way to simplify this or split into multiple tests? You are covering send, generic, delegate, undelegate
as well as use cases like expired and and revoked. I would expect most of this is covered by unit tests already.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am trying to migrate tests already present in tests/e2e. So, I had implemented all those which were present. Will try to split them into multiple tests.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Outside diff range and nitpick comments (2)
tests/systemtests/rest_cli.go (2)

10-14: Consider adding comments to improve documentation.

While the struct definition is clear, it would be beneficial to add comments describing the purpose of the GRPCTestCase struct and its fields. This will enhance code readability and maintainability.

Consider adding comments like this:

// GRPCTestCase represents a test case for gRPC queries.
type GRPCTestCase struct {
    name   string // Name of the test case
    url    string // URL for the gRPC request
    expOut string // Expected output of the request
}

16-28: LGTM: Well-implemented test helper function.

The RunGRPCQueries function is well-structured and follows Go conventions. It correctly uses t.Helper() and provides proper error handling and assertions.

Consider adding a brief comment for the t.Run block to explain its purpose:

for _, tc := range testCases {
    t.Run(tc.name, func(t *testing.T) {
        // Run individual test case
        resp, err := testutil.GetRequest(tc.url)
        require.NoError(t, err)
        require.JSONEq(t, tc.expOut, string(resp))
    })
}
Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e0b3ecf and 4e48f8b.

Files selected for processing (3)
  • tests/systemtests/authz_test.go (1 hunks)
  • tests/systemtests/bank_test.go (6 hunks)
  • tests/systemtests/rest_cli.go (1 hunks)
Additional context used
Path-based instructions (3)
tests/systemtests/authz_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

tests/systemtests/bank_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

tests/systemtests/rest_cli.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"

Gitleaks
tests/systemtests/authz_test.go

776-776: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

Additional comments not posted (10)
tests/systemtests/rest_cli.go (2)

1-8: LGTM: Package declaration and imports are well-structured.

The package name is appropriate, and imports are correctly grouped and used.


1-28: Ensure comprehensive test coverage in implementation.

The RunGRPCQueries function provides a solid framework for running gRPC test cases, which is good for system testing. It integrates well with the cosmos-sdk testutil package and is flexible for various gRPC endpoints.

To ensure comprehensive test coverage:

  1. Implement actual test cases using this framework in a separate file.
  2. Verify that all relevant gRPC endpoints are covered.

Run the following script to check for test implementations:

If no results are found, consider adding test implementations to utilize this framework effectively.

tests/systemtests/bank_test.go (5)

24-24: Improved validator address retrieval

The change from parsing cli.Keys("keys", "list") output to using cli.GetKeyAddr("node0") is a good improvement. It simplifies the code and reduces the potential for errors in parsing. This change aligns well with the PR objective of improving test efficiency without compromising test coverage.


Line range hint 157-187: Enhanced error handling and balance verification in TestBankMultiSendTxCmd

The changes in this section significantly improve the test quality:

  1. The error handling is now more precise, checking for specific error messages instead of a boolean flag.
  2. For successful transactions, detailed balance checks have been added for all involved accounts.
  3. The balance updates are tracked throughout the test, ensuring consistency.

These improvements enhance the test coverage and align well with the PR objective of improving test quality. The additional checks provide better verification of the multi-send functionality.


221-221: Improved API base URL retrieval

The change to use sut.APIAddress() for obtaining the base URL is a good improvement. This approach makes the test more flexible and less prone to errors that could arise from hardcoded URLs. It aligns with best practices for system tests by using dynamic configuration, which can adapt to different test environments more easily.


280-298: Refactored denom metadata test cases

The changes in this section improve the structure and efficiency of the tests:

  1. Test cases now use the GRPCTestCase struct, enhancing code reusability and readability.
  2. The loop for executing test cases has been replaced with a call to RunGRPCQueries, which likely encapsulates common test execution logic.

These improvements align well with the PR objective of enhancing test structure and efficiency. The use of a common struct and execution function reduces code duplication and makes it easier to add or modify test cases in the future.


Line range hint 304-322: Refactored balance query test cases

The changes in this section mirror the improvements made to the denom metadata test cases:

  1. Balance query test cases now use the GRPCTestCase struct, enhancing code reusability and readability.
  2. The execution of test cases has been simplified by using the RunGRPCQueries function.

These changes maintain consistency with the previous improvements and further contribute to the overall enhancement of test structure and efficiency. This refactoring makes the tests more maintainable and easier to extend in the future.

tests/systemtests/authz_test.go (3)

53-54: Check for Empty Validator List Before Accessing Elements

Directly accessing the first element of the validators array without checking if it's empty can cause a panic if the array is empty. Ensure that the array has elements before accessing.


207-219: Simplify Error Handling in Test Cases

The error handling logic within the test cases can be simplified for clarity. Instead of defining an anonymous function for error matching, consider using require.ErrorContains or similar assertions provided by the testify package.


401-401: Avoid Using time.Sleep in Tests

Using time.Sleep can slow down tests and cause flakiness. It's better to mock time or adjust the logic to wait for events or conditions instead of fixed sleep durations.

Also applies to: 440-440

Comment on lines 851 to 854
granterAddr := cli.GetKeyAddr("node0")
require.NotEmpty(t, granterAddr)
granteeAddr := cli.GetKeyAddr("node1")
require.NotEmpty(t, granterAddr)
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

Fix Incorrect Variable in Validation

In the setupChain function, after retrieving granteeAddr, you're checking require.NotEmpty(t, granterAddr) again instead of granteeAddr. This appears to be a copy-paste error and may cause the test to miss a potential empty granteeAddr.

Apply this diff to correct the variable:

 granteeAddr := cli.GetKeyAddr("node1")
-require.NotEmpty(t, granterAddr)
+require.NotEmpty(t, granteeAddr)
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
granterAddr := cli.GetKeyAddr("node0")
require.NotEmpty(t, granterAddr)
granteeAddr := cli.GetKeyAddr("node1")
require.NotEmpty(t, granterAddr)
granterAddr := cli.GetKeyAddr("node0")
require.NotEmpty(t, granterAddr)
granteeAddr := cli.GetKeyAddr("node1")
require.NotEmpty(t, granteeAddr)

Comment on lines 882 to 892
tb.Helper()

tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
require.NoError(tb, err)
defer tmpFile.Close()

// Write to the temporary file
_, err = tmpFile.WriteString(s)
require.NoError(tb, err)

return tmpFile
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

Avoid Closing the File Before Returning It

In the WriteToTempJSONFile function, you defer tmpFile.Close() but then return the *os.File. Closing the file before returning it may lead to unexpected behavior if the calling function tries to use the file. Consider closing the file after you are done using it or adjusting the function to return the file name instead.

Apply this diff to fix the issue:

 func WriteToTempJSONFile(tb testing.TB, s string) *os.File {
 	tb.Helper()

 	tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
 	require.NoError(tb, err)
-	defer tmpFile.Close()

 	// Write to the temporary file
 	_, err = tmpFile.WriteString(s)
 	require.NoError(tb, err)
 
+	// Close the file after writing
+	err = tmpFile.Close()
+	require.NoError(tb, err)
+
 	return tmpFile
 }

And update the usage if necessary to accommodate the change.

Committable suggestion was skipped due to low confidence.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (1)
tests/systemtests/authz_test.go (1)

58-58: Avoid using time.Now() directly in tests

Using time.Now() in tests can lead to non-deterministic behavior and flaky tests. Consider injecting a mock time or using a fixed timestamp to make the tests deterministic and reliable.

Refactor to use a fixed timestamp:

-expirationTime := time.Now().Add(time.Hour).Unix()
+fixedTime := time.Unix(1609459200, 0) // Fixed timestamp
+expirationTime := fixedTime.Add(time.Hour).Unix()
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4e48f8b and 621723c.

Files selected for processing (4)
  • tests/systemtests/authz_test.go (1 hunks)
  • tests/systemtests/bank_test.go (6 hunks)
  • tests/systemtests/rest_cli.go (1 hunks)
  • tests/systemtests/system.go (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • tests/systemtests/bank_test.go
  • tests/systemtests/rest_cli.go
  • tests/systemtests/system.go
🧰 Additional context used
📓 Path-based instructions (1)
tests/systemtests/authz_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Gitleaks
tests/systemtests/authz_test.go

777-777: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments not posted (2)
tests/systemtests/authz_test.go (2)

493-497: Verify the expected error message for exceeding spend limit

In the test case "amount greater than spend limit", the expected error message is set to "negative coin amount". However, providing an amount greater than the spend limit might result in a different error, such as "requested amount is more than spend limit". Please verify that the error message matches the actual error produced when the amount exceeds the spend limit.


55-56: ⚠️ Potential issue

Check for empty validator list before accessing elements

Directly accessing the first element of the validators array without checking if it's empty can cause a panic if the array is empty. Ensure that the array has elements before accessing to prevent potential runtime errors.

Modify the code to include a check:

 rsp := cli.CustomQuery("q", "staking", "validators")
+validators := gjson.Get(rsp, "validators.#.operator_address").Array()
+require.GreaterOrEqual(t, len(validators), 1)
-valOperAddr := gjson.Get(rsp, "validators.#.operator_address").Array()[0].String()
+valOperAddr := validators[0].String()

Likely invalid or redundant comment.

Comment on lines +423 to +441
expirationTime := time.Now().Add(time.Second * 5).Unix()
execSendCmd := msgSendExec(t, granterAddr, granteeAddr, allowedAddr, testDenom, 10)

// create generic authorization grant
rsp := cli.RunAndWait("tx", "authz", "grant", granteeAddr, "generic",
"--msg-type="+msgSendTypeURL,
"--expiration="+fmt.Sprintf("%d", expirationTime),
"--fees=1"+testDenom,
"--from", granterAddr)
RequireTxSuccess(t, rsp)
granterBal--

rsp = cli.RunAndWait(execSendCmd...)
RequireTxSuccess(t, rsp)
// check granter balance equals to granterBal - transferredAmount
expGranterBal := granterBal - 10
require.Equal(t, expGranterBal, cli.QueryBalance(granterAddr, testDenom))

time.Sleep(time.Second * 5)
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

Reduce dependency on real time in tests

Using real time functions like time.Now() and time.Sleep() can cause tests to be slow and flaky. Instead, mock the time or use a testing clock to simulate the passage of time, which will make the tests faster and more reliable.

Consider using a mocked time package or dependency injection for time.

Comment on lines +889 to +900
tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
require.NoError(tb, err)

// Write to the temporary file
_, err = tmpFile.WriteString(s)
require.NoError(tb, err)

// Close the file after writing
err = tmpFile.Close()
require.NoError(tb, err)

return tmpFile
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

Handle file closure properly in WriteToTempJSONFile

Currently, the temporary file is closed before it is used by the calling function, which may lead to errors when the file is accessed later. Instead of closing the file within WriteToTempJSONFile, defer the closure or leave it to the caller to close the file after use.

Apply this change to defer closing the file:

 func WriteToTempJSONFile(tb testing.TB, s string) *os.File {
 	tb.Helper()

 	tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
 	require.NoError(tb, err)
+	// Caller is responsible for closing the file
-	err = tmpFile.Close()
-	require.NoError(tb, err)

 	// Write to the temporary file
 	_, err = tmpFile.WriteString(s)
 	require.NoError(tb, err)

-	// Close the file after writing
-	err = tmpFile.Close()
-	require.NoError(tb, err)

 	return tmpFile
 }
📝 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
tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
require.NoError(tb, err)
// Write to the temporary file
_, err = tmpFile.WriteString(s)
require.NoError(tb, err)
// Close the file after writing
err = tmpFile.Close()
require.NoError(tb, err)
return tmpFile
func WriteToTempJSONFile(tb testing.TB, s string) *os.File {
tb.Helper()
tmpFile, err := os.CreateTemp(tb.TempDir(), "test-*.json")
require.NoError(tb, err)
// Caller is responsible for closing the file
// Write to the temporary file
_, err = tmpFile.WriteString(s)
require.NoError(tb, err)
return tmpFile
}

Comment on lines +403 to +404
time.Sleep(time.Second * 10)

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

Avoid using time.Sleep in tests

Using time.Sleep can make tests slower and lead to flakiness. Consider mocking time or restructuring the test to wait for specific events or conditions instead of a fixed sleep duration. This will improve the reliability and efficiency of the test.

Apply this refactor to remove time.Sleep:

-func TestAuthzExecSendAuthorization(t *testing.T) {
...
-	// test grant expiry
-	time.Sleep(time.Second * 10)
+	// test grant expiry
+	waitForGrantExpiry()
...

+func waitForGrantExpiry() {
+	// Implement logic to wait until the grant has expired without using time.Sleep
+}

Committable suggestion was skipped due to low confidence.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

nice work! Some test cases about CLI argument validation could be deleted (a system test doesn't need to test that) but other than that lgtm!

@@ -56,7 +56,7 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
Short: "Execute tx on behalf of granter account",
Example: fmt.Sprintf("$ %s tx authz exec msg.json --from grantee\n $ %[1]s tx bank send [granter] [recipient] [amount] --generate-only | jq .body.messages > msg.json && %[1]s tx authz exec msg.json --from grantee", version.AppName),
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
{ProtoField: "msgs", Varargs: true},
{ProtoField: "msgs"},
Copy link
Member

Choose a reason for hiding this comment

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

I think it should be varargs, as it can take multiple msgs

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 25, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 621723c and 2ce8237.

📒 Files selected for processing (1)
  • tests/systemtests/authz_test.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
tests/systemtests/authz_test.go (3)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Gitleaks
tests/systemtests/authz_test.go

725-725: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments not posted (2)
tests/systemtests/authz_test.go (2)

27-233: Well-Structured Tests with Comprehensive Coverage

The TestAuthzGrantTxCmd function is well-organized, utilizing table-driven tests to cover various scenarios effectively. It enhances readability and maintainability by systematically testing both valid and invalid authorization grants.


725-725: False Positive Alert from Static Analysis

The static analysis hint regarding a Generic API Key on line 725 appears to be a false positive. The next_key in the pagination response is a base64-encoded string for pagination purposes and does not expose any sensitive information.

🧰 Tools
Gitleaks

725-725: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

tests/systemtests/authz_test.go Show resolved Hide resolved
tests/systemtests/authz_test.go Show resolved Hide resolved
Comment on lines +813 to +831
t.Helper()

bankTx := fmt.Sprintf(`{
"@type": "%s",
"from_address": "%s",
"to_address": "%s",
"amount": [
{
"denom": "%s",
"amount": "%d"
}
]
}`, msgSendTypeURL, granter, toAddr, denom, amount)
execMsg := WriteToTempJSONFile(t, bankTx)

execSendCmd := []string{"tx", "authz", "exec", execMsg.Name(), "--from=" + grantee}
return execSendCmd
}

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

Use Structs and json.Marshal Instead of fmt.Sprintf for JSON Construction

Constructing JSON messages using fmt.Sprintf can lead to errors if the data contains special characters or unexpected formats. It's recommended to use Go structs and json.Marshal to build JSON messages, which ensures proper encoding and reduces the risk of invalid JSON.

Apply this refactor to construct the JSON message safely:

type BankTx struct {
    Type        string `json:"@type"`
    FromAddress string `json:"from_address"`
    ToAddress   string `json:"to_address"`
    Amount      []struct {
        Denom  string `json:"denom"`
        Amount string `json:"amount"`
    } `json:"amount"`
}

bankTxStruct := BankTx{
    Type:        msgSendTypeURL,
    FromAddress: granter,
    ToAddress:   toAddr,
    Amount: []struct {
        Denom  string `json:"denom"`
        Amount string `json:"amount"`
    }{
        {
            Denom:  denom,
            Amount: fmt.Sprintf("%d", amount),
        },
    },
}

bankTxBytes, err := json.Marshal(bankTxStruct)
require.NoError(t, err)
execMsg := WriteToTempJSONFile(t, string(bankTxBytes))

This approach enhances code safety and readability.

tests/systemtests/authz_test.go Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
tests/systemtests/rest_cli.go (4)

11-15: Consider improving field visibility and naming in GRPCTestCase.

The GRPCTestCase structure is well-defined, but consider the following suggestions:

  1. If this structure is intended to be used outside this package, consider making the fields exported (capitalized).
  2. The expOut field name could be more explicit, e.g., expectedOutput or expectedResponse.

Example:

type GRPCTestCase struct {
    Name             string
    URL              string
    ExpectedResponse string
}

17-29: LGTM: Well-structured test function, but consider renaming.

The RunGRPCQueries function is well-implemented, using subtests and proper error handling. However, the function name might be misleading as it's making HTTP requests, not gRPC calls. Consider renaming it to RunHTTPQueries or RunRESTQueries for clarity.


31-36: Consider improving field visibility and naming in GRPCTestCaseWithHeaders.

Similar to the GRPCTestCase structure, consider the following improvements:

  1. If this structure is intended to be used outside this package, consider making the fields exported (capitalized).
  2. The expOut field name could be more explicit, e.g., expectedOutput or expectedResponse.

Example:

type GRPCTestCaseWithHeaders struct {
    Name             string
    URL              string
    Headers          map[string]string
    ExpectedResponse string
}

38-50: LGTM: Well-structured test function with headers, but consider renaming.

The RunGRPCQueriesWithHeaders function is well-implemented, following the same good practices as RunGRPCQueries. However, the function name might be misleading as it's making HTTP requests with headers, not gRPC calls. Consider renaming it to RunHTTPQueriesWithHeaders or RunRESTQueriesWithHeaders for clarity.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2ce8237 and d602eed.

📒 Files selected for processing (2)
  • tests/systemtests/bank_test.go (5 hunks)
  • tests/systemtests/rest_cli.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/systemtests/bank_test.go
🧰 Additional context used
📓 Path-based instructions (1)
tests/systemtests/rest_cli.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern tests/**/*: "Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"

🔇 Additional comments not posted (2)
tests/systemtests/rest_cli.go (2)

1-9: LGTM: Package declaration and imports are well-structured.

The package name systemtests is appropriate for the content, and the imports are correctly organized according to the Uber Go Style Guide (standard library first, followed by external packages).


1-50: Overall assessment: Well-structured system test framework with minor improvements needed.

This new file introduces a solid framework for running HTTP-based system tests, which aligns well with the PR objectives of migrating e2e tests to system tests. The code is well-structured, follows good Go practices, and provides reusable components for test cases with and without headers.

Key strengths:

  1. Clear separation of concerns with distinct structures for different test case types.
  2. Good use of subtests and error handling in test functions.
  3. Reusable design that can be easily extended for various system test scenarios.

Suggested improvements:

  1. Rename functions to accurately reflect that they're running HTTP/REST queries, not gRPC.
  2. Consider making structure fields exported for better reusability.
  3. Use more explicit names for some fields (e.g., expOut to expectedResponse).

Overall, this code provides a good foundation for system testing and seems to offer sufficient coverage for the associated changes in the pull request.

@akhilkumarpilli akhilkumarpilli added this pull request to the merge queue Oct 1, 2024
Merged via the queue into main with commit 8eeb3ff Oct 1, 2024
141 checks passed
@akhilkumarpilli akhilkumarpilli deleted the akhil/authz-system-tests branch October 1, 2024 08:21
mergify bot pushed a commit that referenced this pull request Oct 1, 2024
julienrbrt pushed a commit that referenced this pull request Oct 1, 2024
alpe added a commit that referenced this pull request Oct 1, 2024
* main:
  docs: amend docs for 52 changes  (#21992)
  test: migrate e2e/authz to system tests (#21819)
  refactor(runtime/v2): use StoreBuilder (#21989)
  feat(schema): add API descriptors, struct, oneof & list types, and wire encoding spec (#21482)
  docs: add instructions to change DefaultGenesis (#21680)
  feat(x/staking)!: Add metadata field to validator info (#21315)
  chore(x/authz)!: Remove account keeper dependency (#21632)
alpe added a commit that referenced this pull request Oct 1, 2024
* main:
  docs: amend docs for 52 changes  (#21992)
  test: migrate e2e/authz to system tests (#21819)
  refactor(runtime/v2): use StoreBuilder (#21989)
  feat(schema): add API descriptors, struct, oneof & list types, and wire encoding spec (#21482)
  docs: add instructions to change DefaultGenesis (#21680)
  feat(x/staking)!: Add metadata field to validator info (#21315)
  chore(x/authz)!: Remove account keeper dependency (#21632)
  chore(contributing): delete link (#21990)
  test(gov): Migrate e2e to system test (#21927)
  test: e2e/client to system tests (#21981)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tests/e2e/authz to system tests
5 participants