UDN: add wait_for_network_ready

[myakove]

Summary by CodeRabbit

• New Features

  • Added a method to wait for a network to be ready with a configurable timeout.
  • Introduced a new constant for network readiness status.

• Chores

  • Updated resource constants to include network-related definitions.

[coderabbitai]

Walkthrough

The pull request introduces a new method wait_for_network_ready in the UserDefinedNetwork class, which includes a timeout parameter for waiting on network readiness. Additionally, a new constant NETWORK_READY with the value "NetworkReady" is added to both the Condition and Type classes within the ResourceConstants. These changes enhance the handling of network readiness and provide a standard constant for related statuses.

Changes

File	Change Summary
ocp_resources/user_defined_network.py	Added wait_for_network_ready(self, timeout=30) method to UserDefinedNetwork class
ocp_resources/utils/resource_constants.py	Added NETWORK_READY: str = "NetworkReady" constant to Condition and Type classes

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c12907 and fca2f21.

📒 Files selected for processing (1)

• ocp_resources/user_defined_network.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• ocp_resources/user_defined_network.py

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

• GitHub Check: tox
• GitHub Check: python-module-install

---

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.

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.

[redhat-qe-bot1]

Report bugs in Issues

The following are automatically added:

• Add reviewers from OWNER file (in the root of the repository) under reviewers section.
• Set PR size label.
• New issue is created for the PR. (Closed when PR is merged/closed)
• Run pre-commit if .pre-commit-config.yaml exists in the repo.

Available user actions:

• To mark PR as WIP comment /wip to the PR, To remove it from the PR comment /wip cancel to the PR.
• To block merging of PR comment /hold, To un-block merging of PR comment /hold cancel.
• 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 comment /cherry-pick <target branch to cherry-pick to> in the PR.
  • Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2)
  • Cherry-pick will be started when PR is merged
• To build and push container image command /build-and-push-container in the PR (tag will be the PR number).
  • You can add extra args to the Podman build command
    • Example: /build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT=<commit_hash>
• To add a label by comment use /<label name>, to remove, use /<label name> cancel
• To assign reviewers based on OWNERS file use /assign-reviewers
• To check if PR can be merged use /check-can-merge
• to assign reviewer to PR use /assign-reviewer <reviewer>

Supported /retest check runs

• /retest tox: Retest tox
• /retest python-module-install: Retest python-module-install
• /retest all: Retest all

Supported labels

• hold
• verified
• wip
• lgtm

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

ocp_resources/user_defined_network.py (1)

71-77: Add docstring to document the method.

Please add a docstring to explain the method's purpose and parameters, following the style of other methods in the class.

Apply this diff:

     def wait_for_network_ready(self, timeout=30):
+        """
+        Wait for the network to be ready.
+
+        Args:
+            timeout (int, optional): Maximum time to wait in seconds. Defaults to 30.
+
+        Raises:
+            TimeoutExpiredError: If the network is not ready within the specified timeout.
+        """
         self.wait_for_condition(
             condition=self.Condition.NETWORK_READY,
             status=self.Condition.Status.TRUE,
             timeout=timeout,
         )

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a0365ea and 5c12907.

📒 Files selected for processing (2)

• ocp_resources/user_defined_network.py (1 hunks)
• ocp_resources/utils/resource_constants.py (1 hunks)

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

• GitHub Check: python-module-install
• GitHub Check: tox

🔇 Additional comments (1)

ocp_resources/utils/resource_constants.py (1)

30-30: LGTM!

The constant follows the naming convention and value pattern of other condition constants in the class.