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.

Sign up for GitHub

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

Jump to bottom

test: fix sims #21735

Merged
merged 2 commits into from
Sep 15, 2024
Merged

test: fix sims #21735

merged 2 commits into from
Sep 15, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Sep 15, 2024 •
edited by coderabbitai bot
Loading

Description

Fixes sims failure: https://github.com/cosmos/cosmos-sdk/actions/runs/10869330913/job/30160410518#logs
Fixes job to wait for that seems (CI was sending a wrong success notification on Slack)

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

    • Added test-sim-deterministic as a dependency for success and failure notification jobs, enhancing workflow robustness.

  • Bug Fixes

    • Improved error handling in the GetString method to prevent runtime errors when accessing map values and type assertions.

These changes contribute to a more reliable and stable testing workflow.

@julienrbrt julienrbrt requested review from auricom, tac0turtle and a team as code owners September 15, 2024 08:51
@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Sep 15, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 15, 2024 •
edited
Loading

Walkthrough

Walkthrough

The changes involve modifications to two GitHub Actions workflow files and updates to methods in two Go source files. In the workflow files, the sims-notify-success and sims-notify-failure jobs now include an additional dependency, test-sim-deterministic, which must complete successfully before these jobs can execute. In the Go source files, the GetString methods have been updated to include error handling for type assertions, preventing potential runtime panics by returning an empty string when the expected type does not match.

Changes

File Change Summary
.github/workflows/sims-052.yml Added test-sim-deterministic as a dependency for sims-notify-success and sims-notify-failure.
.github/workflows/sims.yml Added test-sim-deterministic as a dependency for sims-notify-success and sims-notify-failure.
server/util_test.go Modified GetString method to check for key existence before accessing the map, returning an empty string if not found.
testutils/sims/runner.go Modified GetString method to include error handling for type assertions, returning an empty string if the assertion fails.
Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 47561a9 and 8e743d3.

Files selected for processing (4)
  • .github/workflows/sims-052.yml (2 hunks)
  • .github/workflows/sims.yml (2 hunks)
  • server/util_test.go (1 hunks)
  • testutils/sims/runner.go (1 hunks)
Additional context used
Path-based instructions (2)
testutils/sims/runner.go (1)

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

server/util_test.go (2)

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

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (6)
.github/workflows/sims.yml (2)

86-91: LGTM!

The addition of test-sim-deterministic to the needs section of the sims-notify-success job is correct. This change ensures that the success notification is only sent if the test-sim-deterministic job passes, fixing the issue of misleading success notifications.

119-124: LGTM!

The addition of test-sim-deterministic to the needs section of the sims-notify-failure job is correct. This change ensures that the failure notification is sent if any of the required jobs, including test-sim-deterministic, fail, fixing the issue of misleading success notifications.

.github/workflows/sims-052.yml (2)

96-101: LGTM!

Adding test-sim-deterministic as a dependency for the sims-notify-success job ensures that the deterministic simulations also pass before sending the Slack notification. This improves the reliability of the simulation tests and aligns with the PR objective.

128-133: LGTM!

Adding test-sim-deterministic as a dependency for the sims-notify-failure job ensures that the Slack failure notification is sent if the deterministic simulations fail. This improves the reliability of the simulation tests and fixes the issue of incorrect success notifications, aligning with the PR objective.

testutils/sims/runner.go (1)

239-244: LGTM! The updated implementation enhances the robustness of the code.

The changes in the GetString method introduce error handling for type assertions, which prevents potential runtime panics. By checking the success of the type assertion and returning an empty string when the assertion fails, the method ensures that it always returns a valid string type, even in cases where the expected type does not match.

This improvement enhances the overall reliability and stability of the code.

server/util_test.go (1)

496-501: LGTM!

The updated GetString method now includes proper error handling for type assertions. By checking if the key exists in the map and returning an empty string when the value is not of the expected type, the code prevents potential runtime panics and enhances robustness.

This change aligns with best practices for defensive programming and graceful error handling.

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

@julienrbrt julienrbrt added this pull request to the merge queue Sep 15, 2024
Merged via the queue into main with commit 0147347 Sep 15, 2024
73 checks passed
@julienrbrt julienrbrt deleted the julien/fix-sims branch September 15, 2024 16:12
mergify bot pushed a commit that referenced this pull request Sep 15, 2024
@julienrbrt @mergify
test: fix sims (#21735)
22db97d 
(cherry picked from commit 0147347)

# Conflicts:
#	.github/workflows/sims-045.yml
#	.github/workflows/sims.yml
#	server/util_test.go
#	testutils/sims/runner.go
@mergify mergify bot mentioned this pull request Sep 15, 2024
Closed
12 tasks
@julienrbrt julienrbrt added backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release and removed backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Sep 15, 2024
mergify bot pushed a commit that referenced this pull request Sep 15, 2024
@julienrbrt @mergify
test: fix sims (#21735)
59b6f78 
(cherry picked from commit 0147347)

# Conflicts:
#	.github/workflows/sims-052.yml
@mergify mergify bot mentioned this pull request Sep 15, 2024
Merged
12 tasks
julienrbrt added a commit that referenced this pull request Sep 15, 2024
@mergify @julienrbrt
test: fix sims (backport #21735) (#21738)
18b6e63 
Co-authored-by: Julien Robert <[email protected]>
alpe added a commit that referenced this pull request Sep 16, 2024
@alpe
Merge branch 'main' into alex/sims2_main
1ff734d 
* main:
  test: fix sims (#21735)
  build: bump proto-builder (#21730)
  refactor(schema)!: rename IntegerStringKind and DecimalStringKind (#21694)
  feat(types/collections): add `LegacyDec` collection value (#21693)
  refactor(server): alias AppOptions to coreserver.DynamicConfig (#21711)
  refactor(simapp): simplify simapp di (#21718)
  feat: replace the cosmos-db usecases in the tests with `core/testing` (#21525)
  feat(runtime/v2): store loader on simappv2 (#21704)
  docs(x/auth): vesting (#21715)
  build(deps): Bump google.golang.org/grpc from 1.66.1 to 1.66.2 (#21670)
  refactor(systemtest): Add cli.RunAndWait for common operations (#21689)
  fix(runtime/v2): provide default factory options if unset in app builder (#21690)
  chore: remove duplicate proto files for the same proto file (#21648)
  feat(x/genutil): add better error messages for genesis validation (#21701)
  build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.1 to 1.0.0-alpha.2 (#21698)
  test: migrate e2e/bank to system tests (#21607)
  chore: fix the gci lint issue in testutil (#21695)
  docs(x/authz): update grant docs (#21677)
This was referenced Sep 16, 2024
Merged
Merged
Closed
Merged
@coderabbitai coderabbitai bot mentioned this pull request Dec 5, 2024
Merged
12 tasks
@coderabbitai coderabbitai bot mentioned this pull request Dec 11, 2024
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sontrinh16 sontrinh16 sontrinh16 approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

@auricom auricom Awaiting requested review from auricom auricom is a code owner

Assignees

@tac0turtle tac0turtle

@sontrinh16 sontrinh16

Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release Type: CI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@julienrbrt @tac0turtle @sontrinh16