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

test: fix e2e compatiblity tests #2055

Merged
merged 1 commit into from
Jul 18, 2024
Merged

test: fix e2e compatiblity tests #2055

merged 1 commit into from
Jul 18, 2024

Conversation

bermuell
Copy link
Contributor

@bermuell bermuell commented Jul 17, 2024

Description

Closes: #XXXX

Fix e2e compatibility tests for version v4.4.x


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
  • Targeted the correct branch (see PR Targeting)
  • Provided a link to the relevant issue or specification
  • Reviewed "Files changed" and left comments if necessary
  • 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
  • Confirmed that this PR does not change production code

Summary by CodeRabbit

  • Bug Fixes
    • Updated chain configuration logic to ensure proper setup for versions below "v5.0.0".

@bermuell bermuell self-assigned this Jul 17, 2024
@github-actions github-actions bot added the C:Testing Assigned automatically by the PR labeler label Jul 17, 2024
@@ -359,20 +359,6 @@ func CompatibilityTestConfig(providerVersion, consumerVersion string) TestConfig
".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\"",
}
} else if semver.Compare(consumerVersion, "v5.0.0-alpha1") < 0 { // TODO: change this to first published v5 release - once it's out
Copy link
Contributor Author

Choose a reason for hiding this comment

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

not needed anymore as default config matches the one use by v5.x

@bermuell bermuell marked this pull request as ready for review July 17, 2024 13:32
@bermuell bermuell requested a review from a team as a code owner July 17, 2024 13:32
Copy link
Contributor

coderabbitai bot commented Jul 17, 2024

Walkthrough

Walkthrough

The recent changes in tests/e2e/config.go focus on updating the configuration logic for compatibility tests based on version checks. Specifically, the block of code related to configuring consumer chains for versions below "v5.0.0-alpha1" was removed, and a new block for configuring provider chains for versions below "v5.0.0" was added. This update refines how chain configurations are handled depending on the software version, ensuring greater accuracy and relevance.

Changes

File Change Summary
tests/e2e/config.go Removed consumer chain configuration block for versions below "v5.0.0-alpha1". Added provider chain configuration block for versions below "v5.0.0". Updated logic for selecting and setting chain configurations based on version checks.

Sequence Diagram(s)

The changes are primarily updates to configuration logic and do not include new features or significant modifications to control flow, so a sequence diagram is not necessary.


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

@bermuell bermuell requested a review from sainoe July 17, 2024 13:33
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: 1

Comment on lines +428 to +446
} else if semver.Compare(semver.MajorMinor(providerVersion), "v5.0.0") < 0 {
fmt.Println("Using provider chain config for v4.x.x")
providerConfig = ChainConfig{
ChainId: ChainID("provi"),
AccountPrefix: ProviderAccountPrefix,
BinaryName: "interchain-security-pd",
IpPrefix: "7.7.7",
VotingWaitTime: 20,
GenesisChanges: ".app_state.gov.params.voting_period = \"20s\" | " +
// Custom slashing parameters for testing validator downtime functionality
// See https://docs.cosmos.network/main/modules/slashing/04_begin_block.html#uptime-tracking
".app_state.slashing.params.signed_blocks_window = \"10\" | " +
".app_state.slashing.params.min_signed_per_window = \"0.500000000000000000\" | " +
".app_state.slashing.params.downtime_jail_duration = \"60s\" | " +
".app_state.slashing.params.slash_fraction_downtime = \"0.010000000000000000\" | " +
".app_state.provider.params.slash_meter_replenish_fraction = \"1.0\" | " + // This disables slash packet throttling
".app_state.provider.params.slash_meter_replenish_period = \"3s\" | " +
".app_state.provider.params.blocks_per_epoch = 3",
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Refactor suggestion for version handling in configuration setup

The block handling provider chain configuration for versions below "v5.0.0" has been added. This block sets various parameters such as voting period, slashing parameters, and provider params. The logic appears correct, but it can be optimized by reducing redundancy and improving readability.

-	if !semver.IsValid(providerVersion) {
-		fmt.Printf("Invalid sem-version '%s' for provider. Using default provider chain config\n", providerVersion)
-		providerConfig = testCfg.chainConfigs[ChainID("provi")]
-	} else if semver.Compare(providerVersion, "v3.0.0") < 0 {
-		fmt.Println("Using provider chain config for v2.x.x")
-		providerConfig = ChainConfig{
-			// configuration details...
-		}
-	} else if semver.Compare(providerVersion, "v4.0.0") <= 0 {
-		fmt.Println("Using provider chain config for v3.x.x")
-		providerConfig = ChainConfig{
-			// configuration details...
-		}
-	} else if semver.Compare(semver.MajorMinor(providerVersion), "v4.3.0") >= 0 && strings.HasSuffix(providerVersion, "-lsm") {
-		// configuration details...
-	} else if semver.Compare(semver.MajorMinor(providerVersion), "v5.0.0") < 0 {
-		fmt.Println("Using provider chain config for v4.x.x")
-		providerConfig = ChainConfig{
-			// configuration details...
-		}
-	} else {
-		fmt.Println("Using default provider chain config")
-		providerConfig = testCfg.chainConfigs[ChainID("provi")]
-	}
+	// Simplified version handling
+	switch {
+	case !semver.IsValid(providerVersion):
+		fmt.Printf("Invalid sem-version '%s' for provider. Using default provider chain config\n", providerVersion)
+	case semver.Compare(providerVersion, "v5.0.0") < 0:
+		fmt.Printf("Using provider chain config for version %s\n", providerVersion)
+		providerConfig = getProviderConfigByVersion(providerVersion)
+	default:
+		fmt.Println("Using default provider chain config")
+		providerConfig = testCfg.chainConfigs[ChainID("provi")]
+	}

This refactoring introduces a function getProviderConfigByVersion that encapsulates the version-specific logic, making the main function cleaner and easier to maintain.

Committable suggestion was skipped due to low confidence.

@bermuell bermuell requested a review from p-offtermatt July 17, 2024 14:05
@MSalopek MSalopek added this pull request to the merge queue Jul 18, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jul 18, 2024
@p-offtermatt p-offtermatt added this pull request to the merge queue Jul 18, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jul 18, 2024
@MSalopek MSalopek added this pull request to the merge queue Jul 18, 2024
@MSalopek MSalopek removed this pull request from the merge queue due to a manual request Jul 18, 2024
@MSalopek MSalopek added this pull request to the merge queue Jul 18, 2024
Merged via the queue into main with commit 31b5d99 Jul 18, 2024
17 of 18 checks passed
@MSalopek MSalopek deleted the bernd/e2e-fix-comp branch July 18, 2024 10:37
mergify bot pushed a commit that referenced this pull request Jul 18, 2024
fix e2e compatiblity tests

(cherry picked from commit 31b5d99)
MSalopek pushed a commit that referenced this pull request Jul 18, 2024
test: fix e2e compatiblity tests (#2055)

fix e2e compatiblity tests

(cherry picked from commit 31b5d99)

Co-authored-by: bernd-m <[email protected]>
insumity pushed a commit that referenced this pull request Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v5.2.x C:Testing Assigned automatically by the PR labeler
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants