test(robot): refine test case Test Replica Auto Balance Node Least Effort

[yangchiu]

Which issue(s) this PR fixes:

Issue longhorn/longhorn#10276

What this PR does / why we need it:

refine test case Test Replica Auto Balance Node Least Effort

Special notes for your reviewer:

Additional documentation or context

Summary by CodeRabbit

• New Features

  • Added a new keyword for validating volume replica distribution across nodes
  • Enhanced test case for replica auto-balancing with more flexible assertions

• Tests

  • Updated scheduling test to allow broader range of replica distribution states
  • Improved verification of replica count comparisons between nodes

[coderabbitai]

Walkthrough

A new keyword has been added to the volume.resource file to validate the replica count distribution across nodes. The test case in test_scheduling.robot has been modified to use this new keyword, replacing exact replica count assertions with more flexible checks that ensure the replica distribution meets specific criteria while maintaining the core logic of replica distribution.

Changes

File	Change Summary
e2e/keywords/volume.resource	Added new keyword Number of volume ${volume_id} replicas on node ${node_id_0} should be less than on node ${node_id_1} to check replica counts across nodes
e2e/tests/regression/test_scheduling.robot	Updated "Test Replica Auto Balance Node Least Effort" section with more generalized assertions and added a new assertion to compare replica counts between nodes

Sequence Diagram

sequenceDiagram
    participant Test as Test Case
    participant Keyword as Volume Keyword
    participant Volume as Volume Management
    participant Node0 as Node 0
    participant Node1 as Node 1

    Test->>Keyword: Generate volume name
    Keyword->>Volume: Get volume details
    Keyword->>Node0: Get replica count
    Keyword->>Node1: Get replica count
    Keyword->>Keyword: Compare replica counts
    Keyword-->>Test: Verify replica distribution

Loading

Possibly related PRs

• test(robot): migrate test_soft_anti_affinity_scheduling #2158: Modifications to replica count assertions on nodes
• test(robot): migrate test_replica_rebuild_per_volume_limit #2159: New keywords for managing volume replicas
• test(robot): migrate test_replica_auto_balance_node_least_effort #2163: Keywords for validating volume replica states

Suggested reviewers

• chriscchien

Poem

🐰 Replicas dancing, node to node,
Balanced steps, a rhythmic code,
Least effort's gentle, subtle sway,
Volumes spread in their own way,
A robotic ballet, precise and bright! 🤖

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 958d54b and 551df47.

📒 Files selected for processing (2)

• e2e/keywords/volume.resource (1 hunks)
• e2e/tests/regression/test_scheduling.robot (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: Build images
• GitHub Check: Summary

🔇 Additional comments (3)

e2e/tests/regression/test_scheduling.robot (2)

122-125: LGTM! The assertions have been refined to be more flexible.

The changes improve the test by:

1. Replacing exact replica count assertions with more flexible checks
2. Adding validation to ensure scheduling stability
3. Verifying the relative distribution of replicas between nodes

---

135-138: LGTM! Consistent assertion pattern applied for node 2.

The changes maintain consistency with the previous section's improvements.

e2e/keywords/volume.resource (1)

290-297: LGTM! Well-structured implementation of the new comparison keyword.

The keyword follows existing patterns and properly implements the replica count comparison logic.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.

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.