Skip to content

fix(test): avoid nil pointer on conflicting swagger port for new node in fraud test#24247

Closed
mmsqe wants to merge 3 commits intocosmos:mainfrom
mmsqe:fix_swagger
Closed

fix(test): avoid nil pointer on conflicting swagger port for new node in fraud test#24247
mmsqe wants to merge 3 commits intocosmos:mainfrom
mmsqe:fix_swagger

Conversation

@mmsqe
Copy link
Copy Markdown
Collaborator

@mmsqe mmsqe commented Apr 1, 2025

for more info, https://github.com/cosmos/cosmos-sdk/actions/runs/14170361098/job/39692592132

Description

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

  • Documentation
    • Updated server description to accurately reflect it as a Swagger server.
  • New Features
    • Introduced a configurable default port for Swagger endpoints.
    • Enhanced node initialization to include configuration of the Swagger port for each node.
  • Chores
    • Updated artifact upload path in GitHub Actions workflow to reflect new directory structure.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 1, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This pull request updates the documentation and configuration for the Swagger server. The comment in the server creation function is revised to clearly state that a Swagger server is created. In addition, the default Swagger port is introduced in the system tests, and the configuration for each node is enhanced by setting its corresponding Swagger endpoint during both full node addition and testnet initialization.

Changes

File(s) Change Summary
server/.../swagger/server.go Updated function comment for NewWithConfigOptions to specify that it creates a Swagger UI server instead of a telemetry server.
systemtests/{system.go, testnet_init.go} Added a new variable DefaultSwaggerPort (8090) and updated configuration methods (AddFullnode and Initialize) to set the Swagger address/port for each node.
.github/workflows/v2-test.yml Updated artifact upload path from ./systemtests/testnet/ to ./tests/systemtests/testnet/ in job test-system-v2.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Caller
    participant Registry as Fullnode Registry
    participant Config as Config Document

    Client->>Registry: Call AddFullnode(nodeNumber)
    Registry->>Config: SetValue(doc, node.IP:(DefaultSwaggerPort+nodeNumber), "swagger", "address")
    Config-->>Registry: Confirmation of updated config
    Registry-->>Client: Fullnode added with Swagger endpoint
Loading
sequenceDiagram
    participant Initializer as TestnetInitializer
    participant Config as Config Document

    Initializer->>Config: UpdatePort(doc, DefaultSwaggerPort+i, "swagger", "address")
    Config-->>Initializer: Port configuration updated
Loading

Possibly related PRs

Suggested labels

backport/v0.52.x

Suggested reviewers

  • aljo242
  • julienrbrt
  • tac0turtle

🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@mmsqe mmsqe marked this pull request as draft April 1, 2025 15:34
@mmsqe mmsqe closed this Apr 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant