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(systemtests): avoid HTTP server on port 8080 conflict when AddFullnode #22810

Merged
merged 4 commits into from
Dec 10, 2024

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Dec 10, 2024

in TestValidatorDoubleSign

Closes: #XXXX


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 default port configurations for RPC, REST, gRPC, and P2P communications.
    • Enhanced initialization process for testnet commands with improved port management.
  • Bug Fixes

    • Avoided HTTP server conflicts on port 8080.
  • Chores

    • Removed redundant port constants to centralize port management.
    • Updated changelog for version v1.0.0-rc.4.

@mmsqe mmsqe requested a review from a team as a code owner December 10, 2024 01:27
Copy link
Contributor

coderabbitai bot commented Dec 10, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request involve modifications to the systemtests/system.go, systemtests/testnet_init.go, and systemtests/CHANGELOG.md files. New default port constants for RPC, REST, gRPC, and P2P communications have been introduced, replacing hardcoded values in the initialization process. The AddFullnode method has been updated to utilize these constants and to modify the app.toml file accordingly. Additionally, the changelog has been updated to document the latest version and changes related to port conflicts.

Changes

File Path Change Summary
systemtests/system.go Added constants for DefaultRpcPort, DefaultRestPort, DefaultGrpcPort, and DefaultP2PPort. Updated AddFullnode method to modify app.toml for REST address and rearranged node starting logic. Imported tomledit package for TOML editing. Removed redundant lines.
systemtests/testnet_init.go Removed hardcoded port constants (rpcPortStart, apiPortStart, grpcPortStart, p2pPortStart) and replaced usages with new default constants. Updated Initialize method to use DefaultP2PPort and streamlined initialization process.
systemtests/CHANGELOG.md Added new version entry [v1.0.0-rc.4] - 2024-12-10 documenting the change to avoid HTTP server conflicts on port 8080.

Possibly related PRs

Suggested labels

C:Store, C:server/v2, backport/v0.52.x

Suggested reviewers

  • akhilkumarpilli
  • julienrbrt
  • tac0turtle

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 16cc06a and 1d2178c.

📒 Files selected for processing (1)
  • systemtests/CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • systemtests/CHANGELOG.md

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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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: 0

🧹 Outside diff range and nitpick comments (2)
systemtests/system.go (2)

727-740: Consider adding port availability checks.

While the configuration setup is good, consider adding port availability validation before starting the node to prevent runtime failures.

func isPortAvailable(port int) bool {
    ln, err := net.Listen("tcp", fmt.Sprintf(":%d", port))
    if err != nil {
        return false
    }
    ln.Close()
    return true
}

754-754: Add error handling for gRPC port configuration.

The gRPC port configuration should include error handling to ensure the port is properly set.

-fmt.Sprintf("--grpc.address=localhost:%d", DefaultGrpcPort+nodeNumber),
+grpcPort := DefaultGrpcPort + nodeNumber
+if err := validateGrpcPort(grpcPort); err != nil {
+    return Node{}, fmt.Errorf("invalid gRPC port: %w", err)
+}
+fmt.Sprintf("--grpc.address=localhost:%d", grpcPort),
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 332d0b1 and 49749a8.

📒 Files selected for processing (2)
  • systemtests/system.go (4 hunks)
  • systemtests/testnet_init.go (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
systemtests/system.go (1)

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

systemtests/testnet_init.go (1)

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

🔇 Additional comments (2)
systemtests/testnet_init.go (1)

150-150: LGTM! Good refactoring of port configuration.

The replacement of hardcoded port values with centralized constants improves maintainability and reduces the risk of port conflicts.

Also applies to: 158-159, 170-171

systemtests/system.go (1)

42-46: LGTM! Well-structured port constant definitions.

The default ports are:

  • Well-separated to avoid conflicts
  • Follow standard port conventions
  • Use clear, descriptive naming

@julienrbrt
Copy link
Member

Can you add a changelog under systemtests/changelog? Could you name it rc.4 as well with the date of today?

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.

utACK

@julienrbrt julienrbrt changed the title fix(simapp/v2): avoid HTTP server on port 8080 conflict when AddFullnode fix(systemtests): avoid HTTP server on port 8080 conflict when AddFullnode Dec 10, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Dec 10, 2024
Merged via the queue into cosmos:main with commit e07fee5 Dec 10, 2024
74 of 78 checks passed
@julienrbrt
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants