chore(sims): move sims with depinject to tests #19121
Conversation
github-actions
bot
added
C:x/staking
C:x/slashing
C:x/distribution
github-actions
bot
added
C:CLI
C:x/gov
C:Simulations
C:x/params
C:x/auth
C:x/group
C:x/circuit
labels
WalkthroughThe changes across various test and module files indicate a broad refactoring effort within a Cosmos SDK codebase. Package names have been standardized and renamed to more closely reflect their test context, such as Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| @@ -11,17 +11,13 @@ import ( | |||
| "github.com/stretchr/testify/suite" | |||
|
|
|||
| _ "cosmossdk.io/api/cosmos/authz/v1beta1" | |||
| govv1 "cosmossdk.io/api/cosmos/gov/v1" | |||
There was a problem hiding this comment.
Tip
Codebase Verification
The verification process has revealed that the govv1 import is still being used within the x/authz/client/cli/tx_test.go file, specifically for declaring the typeMsgVote variable. This indicates that the removal of the gov module imports, as mentioned in the AI-generated summary, may have been incomplete or incorrect since there is still a dependency on the gov module within the test file.
Analysis chain
Removal of imports related to the gov module is noted. Confirm that this does not affect other parts of the test file where gov module types or functions might be used.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify that no other parts of the test file are using the removed `gov` module types or functions.
ast-grep --lang go --pattern 'govv1.$$$' --exec 'rg --files-with-matches "govv1"'
Length of output: 277
Script:
#!/bin/bash
# Verify that no other parts of the test file are using the removed `gov` module types or functions.
# First, find the path to the tx_test.go file using fd.
tx_test_path=$(fd tx_test.go | grep 'x/authz/client/cli/tx_test.go')
# Then, use rg to search for 'govv1' within that file.
rg 'govv1' "${tx_test_path}"
Length of output: 231
| @@ -1,4 +1,4 @@ | |||
| package simulation_test | |||
| package authz | |||
There was a problem hiding this comment.
Tip
Codebase Verification
The verification process has revealed that the tests/sims/authz/operations_test.go file is indeed a test file, as indicated by the presence of test functions and the testing package import. Additionally, the output from the directory listing shows that operations_test.go is the only file in the tests/sims/authz directory.
However, the package name authz used in operations_test.go does not follow the Go convention of appending _test to the package name for test files. This convention is used to distinguish test packages from the packages they are testing. In this case, the authz package name is also used by the actual implementation files in the x/authz directory, which could lead to confusion or potential conflicts when the package namespace is considered.
Given this information, the review comment is correct in pointing out the need to confirm that the package name change does not conflict with other package names and that the tests are still correctly categorized. The tests are indeed categorized correctly as part of the authz module, but the package naming convention for test files is not followed, which could be a point of improvement.
Analysis chain
The package name has been changed from simulation_test to authz. Confirm that this change does not conflict with other package names and that the tests are still correctly categorized.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for any potential package name conflicts.
rg --type go '^package authz$'
Length of output: 913
Script:
#!/bin/bash
# Check if the 'authz' package in the 'tests/sims/authz' directory is exclusively used for test files
# and follows the Go convention of having test files in a separate package with '_test' suffix.
fd '^operations_test\.go$' tests/sims/authz --exec cat {}
Length of output: 7864
Script:
#!/bin/bash
# List all files in the 'tests/sims/authz' directory to see if they are all test files.
fd '.' tests/sims/authz --exec ls -1 {}
Length of output: 77
Description
This pr moves sims with depinject usage to sims within ./tests
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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.
I have...