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(testutil): fix FreeTCPAddr localhost usage #18996

Merged
merged 1 commit into from
Jan 10, 2024
Merged

fix(testutil): fix FreeTCPAddr localhost usage #18996

merged 1 commit into from
Jan 10, 2024

Conversation

gluax
Copy link
Contributor

@gluax gluax commented Jan 10, 2024

Description

Closes: #18992

Makes the change in the FreeTCPAddr to check if the port is free on 127.0.0.1 since localhost is not always equal to that IP as a standard.
Should not affect any systems where localhost is equal to that IP. Would only fix it for systems where that is not the case.


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
  • 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.

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

@gluax gluax requested a review from a team as a code owner January 10, 2024 02:48
Copy link
Contributor

coderabbitai bot commented Jan 10, 2024

Walkthrough

The change involves updating the FreeTCPAddr function within the testutil/network/util.go file. The modification switches the binding address from "localhost" to "127.0.0.1". This adjustment aims to resolve a binding issue that occurs when running commands from a node in Windows Subsystem for Linux (WSL) with the cosmos SDK, which was causing a panic error.

Changes

File Change Summary
testutil/network/util.go Changed address from "localhost" to "127.0.0.1" in FreeTCPAddr function.

Assessment against linked issues

Objective Addressed Explanation
Avoid using the keyword localhost and replace it with 127.0.0.1 in testutil to fix binding issues in WSL (#18992)
Ensure code changes are compatible with Cosmos SDK version 0.50.* (#18992) The compatibility with Cosmos SDK version 0.50.* cannot be determined from the provided summary alone. Additional context or code review would be necessary to confirm.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@gluax
Copy link
Contributor Author

gluax commented Jan 10, 2024

I don't think additional testing is relevant, nor would I be sure how to make a CI test for one of those environments. That being said, I have tested these changes in WSL, which is such a system, and it now works instead of panicking :). I could attach a before and after screenshot if desired.

As far as the entry changelog, I could write something similar, but shorter, for the changelog if desired. Or is this a simple enough PR that this doesn't require that?

Copy link
Member

@facundomedica facundomedica left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@tac0turtle tac0turtle assigned tac0turtle and unassigned likhita-809 Jan 10, 2024
@tac0turtle tac0turtle added this pull request to the merge queue Jan 10, 2024
Merged via the queue into cosmos:main with commit 78ce70d Jan 10, 2024
58 of 60 checks passed
@julienrbrt
Copy link
Member

@Mergifyio backport release/v0.50.x

Copy link
Contributor

mergify bot commented Jan 10, 2024

backport release/v0.50.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jan 10, 2024
tac0turtle pushed a commit that referenced this pull request Jan 10, 2024
)

Co-authored-by: gluax <16431709+gluax@users.noreply.github.com>
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
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.

[Bug]: Testutil Net Doesn't in WSL
5 participants