Wait for dsc and dsci ready state in cluster_sanity check

[dbasunag]

Description

How Has This Been Tested?

Merge criteria:

• The commits are squashed in a cohesive manner and have meaningful messages.
• Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
• The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

• Improvements
  • Enhanced resource readiness checks to automatically retry verification for up to 2 minutes, improving reliability and reducing immediate failures during cluster sanity checks.

[coderabbitai]

Walkthrough

The code replaces immediate status verification functions for DSC initialization and cluster resources with new retry-enabled functions that wait for readiness, retrying every 5 seconds for up to 120 seconds. The cluster sanity check now uses these new wait functions, allowing for retries instead of failing immediately if resources are not ready.

Changes

File(s)	Change Summary
utilities/infra.py	Replaced verify_dsci_status_ready and verify_dsc_status_ready with retry-enabled wait_for_dsci_status_ready and wait_for_dsc_status_ready; updated verify_cluster_sanity to use new wait functions and changed function signatures accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant ClusterSanityChecker
    participant DSCInitialization
    participant DataScienceCluster

    ClusterSanityChecker->>DSCInitialization: wait_for_dsci_status_ready()
    alt Resource not ready
        DSCInitialization-->>ClusterSanityChecker: Raise ResourceNotReadyError
        ClusterSanityChecker->>DSCInitialization: Retry (every 5s, up to 120s)
    else Resource ready
        DSCInitialization-->>ClusterSanityChecker: Return True
    end

    ClusterSanityChecker->>DataScienceCluster: wait_for_dsc_status_ready()
    alt Resource not ready
        DataScienceCluster-->>ClusterSanityChecker: Raise ResourceNotReadyError
        ClusterSanityChecker->>DataScienceCluster: Retry (every 5s, up to 120s)
    else Resource ready
        DataScienceCluster-->>ClusterSanityChecker: Return True
    end

Loading

Poem

🐇
Patience is key, the rabbit knows,
Wait and retry as the cluster grows.
No more failing at first glance—
Give your resources a second chance!
With every hop and every try,
Success is near—just wait and retry!
🌱

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

utilities/infra.py (2)

854-867: Robust implementation with retry mechanism.

The new function wait_for_dsci_status_ready enhances resilience by implementing a retry mechanism for DSCI readiness checks. This is a good improvement over immediate verification.

Consider using a constant from the Timeout class for the timeout value instead of the hard-coded 120:

@retry(
-    wait_timeout=120,
+    wait_timeout=Timeout.TIMEOUT_2MIN,
    sleep=5,
    exceptions_dict={ResourceNotReadyError: []},
)

---

869-880: Fix grammar in log message.

The implementation for DSC readiness checks with retry mechanism is good, but there's a grammar issue in the log message.

Fix the grammar in the log message to match the style of the DSCI function:

@retry(
    wait_timeout=120,
    sleep=5,
    exceptions_dict={ResourceNotReadyError: []},
)
def wait_for_dsc_status_ready(dsc_resource: DataScienceCluster) -> bool:
-    LOGGER.info(f"Wait for DSC {dsc_resource.name} are {dsc_resource.Status.READY}.")
+    LOGGER.info(f"Wait for DSC {dsc_resource.name} to be in {dsc_resource.Status.READY} status.")
    if dsc_resource.status == dsc_resource.Status.READY:
        return True
    raise ResourceNotReadyError(
        f"DSC {dsc_resource.name} is not ready.\nCurrent status: {dsc_resource.instance.status}"
    )

Also consider using Timeout.TIMEOUT_2MIN for consistency with other timeout values in the codebase.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eda4aeb and dc039b0.

📒 Files selected for processing (1)

• utilities/infra.py (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

utilities/infra.py (2)

utilities/exceptions.py (1)

• ResourceNotReadyError (99-100)

tests/conftest.py (2)

• dsci_resource (334-335)
• dsc_resource (339-340)

🔇 Additional comments (1)

utilities/infra.py (1)

917-920: Improved cluster sanity check with retry mechanisms.

The updated verify_cluster_sanity function now uses the new wait functions that include retry mechanisms, making the sanity check more resilient to transient resource readiness issues.

[github-actions]

The following are automatically added/executed:

• PR size label.
• Run pre-commit
• Run tox
• Add PR author as the PR assignee

Available user actions:

• To mark a PR as WIP, add /wip in a comment. To remove it from the PR comment /wip cancel to the PR.
• To block merging of a PR, add /hold in a comment. To un-block merging of PR comment /hold cancel.
• To mark a PR as approved, add /lgtm in a comment. To remove, add /lgtm cancel.
  lgtm label removed on each new commit push.
• To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
  verified label removed on each new commit push.
• To Cherry-pick a merged PR /cherry-pick <target_branch_name> to the PR. If <target_branch_name> is valid,
  and the current PR is merged, a cherry-picked PR would be created and linked to the current PR.

Supported labels

{'/verified', '/wip', '/lgtm', '/hold'}

[dbasunag]

/verified

[lugi0]

/lgtm

[github-actions]

Status of building tag latest: success.
Status of pushing tag latest to image registry: success.