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

Update wait_for_status_success() call to look at both type and status for status.conditions #2289

Merged
merged 11 commits into from
Jan 27, 2025

Conversation

dbasunag
Copy link
Contributor

@dbasunag dbasunag commented Jan 22, 2025

Short description:
More details:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Special notes for reviewer:
Bug:

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced status checking logic for Node Network Configuration Policy
    • Improved validation of configuration status conditions
    • Streamlined control flow and error handling in the status checking process
    • Increased sleep interval for status sampling from 1 second to 5 seconds

Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request modifies the NodeNetworkConfigurationPolicy class in the node_network_configuration_policy.py file. The wait_for_status_success method is updated to implement a new internal logic for checking the status of conditions using a TimeoutSampler. The previous implementation, which called wait_for_configuration_conditions_unknown_or_progressing, has been removed. The updated method retrieves the available condition and checks its status and reason, maintaining error handling by raising NNCPConfigurationFailed with appropriate messages.

Changes

File Change Summary
ocp_resources/node_network_configuration_policy.py - Updated method wait_for_status_success(self) to utilize a TimeoutSampler for checking available condition status.
- Removed the call to wait_for_configuration_conditions_unknown_or_progressing and modified error handling for conditions like NO_MATCHING_NODE and FAILED_TO_CONFIGURE.

Possibly related PRs

  • UDN: add wait_for_network_ready #2265: The wait_for_network_ready method in the UserDefinedNetwork class involves waiting for a specific condition (NETWORK_READY), which is conceptually similar to the wait_for_status_success method's role in checking status conditions in the NodeNetworkConfigurationPolicy class.

Suggested labels

size/XS

Suggested reviewers

  • rnetser
  • EdDev
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, 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
Copy link

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

Copy link

@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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 025dd62 and 521064e.

📒 Files selected for processing (1)
  • ocp_resources/node_network_configuration_policy.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: python-module-install
  • GitHub Check: tox

ocp_resources/node_network_configuration_policy.py Outdated Show resolved Hide resolved
ocp_resources/node_network_configuration_policy.py Outdated Show resolved Hide resolved
@dbasunag dbasunag changed the title status should return reason, when condition status is True Update wait_for_status_success() call to look at both type and status for status.conditions Jan 22, 2025
Copy link

@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

🧹 Nitpick comments (1)
ocp_resources/node_network_configuration_policy.py (1)

373-373: Document retry parameters and behavior.

Add a docstring explaining the retry behavior, including why the specific wait_timeout and sleep values were chosen.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 521064e and 9aca3b6.

📒 Files selected for processing (1)
  • ocp_resources/node_network_configuration_policy.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: python-module-install
  • GitHub Check: tox
🔇 Additional comments (2)
ocp_resources/node_network_configuration_policy.py (2)

13-13: LGTM!

The retry import is correctly added alongside other timeout_sampler imports.


378-392: 🛠️ Refactor suggestion

Improve error handling and code reusability.

The method has several issues:

  1. Duplicates condition retrieval logic instead of using get_available_condition
  2. Missing error handling for empty available_condition list
  3. Inconsistent error handling between branches

Apply this diff to fix the issues:

@retry(wait_timeout=120, sleep=5)
def wait_for_status_success(self):
    """
    Wait for the policy to reach success status.

    Returns:
        list: Available conditions if successful.

    Raises:
        NNCPConfigurationFailed: If configuration fails or no matching node found.
    """
    failed_condition_reason = self.Conditions.Reason.FAILED_TO_CONFIGURE
    no_match_node_condition_reason = self.Conditions.Reason.NO_MATCHING_NODE

-    available_condition = [
-        condition
-        for condition in self.instance.get("status", {}).get("conditions", [])
-        if condition and condition["type"] == self.Conditions.Type.AVAILABLE
-    ]
-    if available_condition:
-        if available_condition[0]["status"] == self.Condition.Status.TRUE:
-            self.logger.info(f"NNCP {self.name} configured Successfully")
-            return available_condition
-
-        elif available_condition[0]["reason"] == no_match_node_condition_reason:
-            raise NNCPConfigurationFailed(f"{self.name}. Reason: {no_match_node_condition_reason}")
-
-        elif available_condition[0]["reason"] == failed_condition_reason:
-            self._process_failed_status(failed_condition_reason=failed_condition_reason)
+    available_condition = self.get_available_condition()
+    if not available_condition:
+        raise NNCPConfigurationFailed(f"{self.name}. Reason: No available condition found")
+
+    if available_condition["status"] == self.Condition.Status.TRUE:
+        self.logger.info(f"NNCP {self.name} configured Successfully")
+        return [available_condition]
+
+    if available_condition["reason"] == no_match_node_condition_reason:
+        raise NNCPConfigurationFailed(f"{self.name}. Reason: {no_match_node_condition_reason}")
+
+    if available_condition["reason"] == failed_condition_reason:
+        self._process_failed_status(failed_condition_reason=failed_condition_reason)
+
+    raise NNCPConfigurationFailed(
+        f"{self.name}. Unexpected reason: {available_condition['reason']}"
+    )

Likely invalid or redundant comment.

ocp_resources/node_network_configuration_policy.py Outdated Show resolved Hide resolved
@dbasunag
Copy link
Contributor Author

/verified

@dbasunag
Copy link
Contributor Author

/verified

@dbasunag
Copy link
Contributor Author

/verified

@myakove myakove merged commit 44eb90f into main Jan 27, 2025
6 checks passed
@myakove myakove deleted the nncp branch January 27, 2025 14:42
@dbasunag
Copy link
Contributor Author

/cherry-pick v4.17

redhat-qe-bot pushed a commit that referenced this pull request Jan 28, 2025
… for status.conditions (#2289)

* status should return reason, when condition status is True

* based on review comments and offline conversation with dev team

* remove unnecessary code

* undo retry

* addressed review comment

* address review comment

* update based on reviews
@redhat-qe-bot
Copy link
Contributor

Cherry-picked PR Update wait_for_status_success() call to look at both type and status for status.conditions into v4.17

redhat-qe-bot1 pushed a commit that referenced this pull request Jan 28, 2025
… for status.conditions (#2289) (#2297)

* status should return reason, when condition status is True

* based on review comments and offline conversation with dev team

* remove unnecessary code

* undo retry

* addressed review comment

* address review comment

* update based on reviews

Co-authored-by: Debarati Basu-Nag <[email protected]>
@dbasunag
Copy link
Contributor Author

/cherry-pick v4.16

redhat-qe-bot2 pushed a commit that referenced this pull request Jan 28, 2025
… for status.conditions (#2289)

* status should return reason, when condition status is True

* based on review comments and offline conversation with dev team

* remove unnecessary code

* undo retry

* addressed review comment

* address review comment

* update based on reviews
@redhat-qe-bot2
Copy link

Cherry-picked PR Update wait_for_status_success() call to look at both type and status for status.conditions into v4.16

redhat-qe-bot pushed a commit that referenced this pull request Jan 28, 2025
… for status.conditions (#2289) (#2300)

* status should return reason, when condition status is True

* based on review comments and offline conversation with dev team

* remove unnecessary code

* undo retry

* addressed review comment

* address review comment

* update based on reviews

Co-authored-by: Debarati Basu-Nag <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants