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

fix(test/e2e): name cannot be empty error #3706

Merged
merged 1 commit into from
Jul 19, 2024

Conversation

rootulp
Copy link
Collaborator

@rootulp rootulp commented Jul 18, 2024

Recent e2e tests failed with:

2024/07/18 17:22:08 Failed to setup testnet: converting accounts into sdk types: invalid account 4: name cannot be empty

because #3690 merged. Since e2e tests aren't run as part of CI on each PR, I didn't learn about the failure until @ninabarbakadze pinged about it.

Testing

make test-e2e

gets past that error locally.

@rootulp rootulp added the backport:v2.x PR will be backported automatically to the v2.x branch upon merging label Jul 18, 2024
@rootulp rootulp self-assigned this Jul 18, 2024
@rootulp rootulp requested a review from a team as a code owner July 18, 2024 19:11
@rootulp rootulp requested review from evan-forbes and ninabarbakadze and removed request for a team July 18, 2024 19:11
Copy link
Contributor

coderabbitai bot commented Jul 18, 2024

Walkthrough

Walkthrough

The recent changes introduce a Name field to the genesis.Account struct in the CreateAccount method, enabling account naming. Additionally, the AddAccount method in the Genesis struct now performs a validation check to ensure that only valid accounts are added to the genesis configuration.

Changes

File Change Summary
test/e2e/testnet/testnet.go Added Name field to genesis.Account in the CreateAccount method, allowing accounts to be named.
test/util/genesis/genesis.go Added a validation check in AddAccount method to ensure only valid accounts are added to the genesis.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Testnet
    participant Genesis
    participant Account

    User->>Testnet: Call CreateAccount(name, pubkey, balance)
    Testnet->>Genesis: Add Account (with Name)
    Genesis->>Account: ValidateBasic()
    Account-->>Genesis: Validation Result
    Genesis-->>Testnet: Add Account Result
    Testnet-->>User: CreateAccount Result
Loading

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@celestia-bot celestia-bot requested a review from a team July 18, 2024 19:11
Copy link
Member

@ninabarbakadze ninabarbakadze left a comment

Choose a reason for hiding this comment

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

thanks rootul!!

@@ -122,6 +122,9 @@ func (g *Genesis) WithKeyringAccounts(accs ...KeyringAccount) *Genesis {

// AddAccount adds an existing account to the genesis.
func (g *Genesis) AddAccount(account Account) error {
if err := account.ValidateBasic(); err != nil {
Copy link
Member

Choose a reason for hiding this comment

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

are there any scenarios where this could consensus breaking? if so, are those scenarios relevant and do we need to document this somewhere?

Copy link
Contributor

Choose a reason for hiding this comment

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

Why would this be consensus breaking? This is just about creating the genesis - I don't quite see how it affects actual running of a chain

Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

approving as this makes sense even if it is consensus breaking

the only time it ever could get hit is with a new chain, we just might not be able to backport this to v2

@evan-forbes evan-forbes removed the backport:v2.x PR will be backported automatically to the v2.x branch upon merging label Jul 19, 2024
@evan-forbes
Copy link
Member

tentatively removed the backport command out of an abundance of caution, but we can add it back if we don't need to be worried about this

Copy link
Contributor

@cmwaters cmwaters left a comment

Choose a reason for hiding this comment

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

👍

@@ -122,6 +122,9 @@ func (g *Genesis) WithKeyringAccounts(accs ...KeyringAccount) *Genesis {

// AddAccount adds an existing account to the genesis.
func (g *Genesis) AddAccount(account Account) error {
if err := account.ValidateBasic(); err != nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why would this be consensus breaking? This is just about creating the genesis - I don't quite see how it affects actual running of a chain

Comment on lines 218 to 222
err = t.genesis.AddAccount(genesis.Account{
PubKey: pk,
Balance: tokens,
Name: name,
})
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

[note to self] this may be why it is preferable to use a struct constructor like NewGenesisAccount instead of creating a struct via genesis.Account{} in many files. That way the PR that added a new field to the struct can add it to the NewGenesisAccount constructor and doesn't have to CMD + F for all instances of the struct in the entire codebase to make sure one isn't missed.

Would be nice if Go compiler complained that the field wasn't initialized.

@rootulp
Copy link
Collaborator Author

rootulp commented Jul 19, 2024

I think this can be backported to v2.x b/c AFAICT it only impacts test/ files so shouldn't be consensus breaking.

@rootulp rootulp added the backport:v2.x PR will be backported automatically to the v2.x branch upon merging label Jul 19, 2024
@rootulp rootulp enabled auto-merge (squash) July 19, 2024 15:30
@rootulp rootulp merged commit acf7fc1 into celestiaorg:main Jul 19, 2024
35 checks passed
mergify bot pushed a commit that referenced this pull request Jul 19, 2024
Recent e2e tests failed with:

```
2024/07/18 17:22:08 Failed to setup testnet: converting accounts into sdk types: invalid account 4: name cannot be empty
```

because #3690 merged.
Since e2e tests aren't run as part of CI on each PR, I didn't learn
about the failure until @ninabarbakadze pinged about it.

## Testing

```
make test-e2e
```

gets past that error locally.

(cherry picked from commit acf7fc1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:v2.x PR will be backported automatically to the v2.x branch upon merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants