[psud] Refactor PSU object retrieval to improve exception handling #659

LinJin23 · 2025-08-11T06:27:14Z

Description

This PR refactors the PSU object retrieval logic in psud by extracting the platform_chassis.get_psu() call into a dedicated wrapper function _wrapper_get_psu(). In addition, the process no longer exits when platform_psuutil is unavailable. The change improves exception handling consistency and code maintainability by centralizing PSU object retrieval logic.

Motivation and Context

The original code had duplicate platform_chassis.get_psu(psu_index - 1) calls scattered across multiple wrapper functions, making it difficult to maintain consistent exception handling and increasing code duplication.

How Has This Been Tested?

Unit tests were extended to test the PSU exception handling features and tested in physical platform.

Additional Information (Optional)

mssonicbld · 2025-08-11T06:27:22Z

/azp run

azure-pipelines · 2025-08-11T06:27:31Z

Azure Pipelines successfully started running 1 pipeline(s).

vvolam · 2025-08-22T18:46:33Z

sonic-psud/scripts/psud

+    if platform_chassis is not None:
+        try:
+            return platform_chassis.get_psu(psu_index - 1)
+        except NotImplementedError: # TODO: Is NotImplementedError sufficient? 


Log a warning for this exception and return None, Also add a general exception to make the code robust.

vvolam · 2025-08-22T18:47:32Z

sonic-psud/scripts/psud

 def _wrapper_get_psu_presence(psu_index):
    if platform_chassis is not None:
+        psu = _wrapper_get_psu(psu_index)
+        if not psu:


if psu returned is None here, add exception here to log error and returning false.

mssonicbld · 2025-08-26T14:41:11Z

/azp run

azure-pipelines · 2025-08-26T14:41:21Z

Azure Pipelines successfully started running 1 pipeline(s).

gregoryboudreau · 2025-09-10T20:25:19Z

sonic-psud/scripts/psud

+        try:
+            return platform_chassis.get_psu(psu_index - 1)
+        except NotImplementedError as e:
+            logger.log_warning("get_psu() not implemented by platform chassis: {}".format(str(e)))


is this something that needs to be logged? Also in its current form, you'll get two conflicting logs. Say you run the wrapper to get presence, this get_psu wrapper will log "get_psu() not implemented by platform chassis: {}" and return none, but now that its none the get_presence will print "Failed to get PSU {} object from platform chassis".

This also seems to deviate from the prior behavior where if the platform_chassis doesn't have the get_psu, it will fallback to the platform_psuutil case. Is it possible that some vendors have not implemented this get_psu on the platform_chassis and still rely on this fallback?

Thanks for your pointing out.

gregoryboudreau · 2025-09-10T20:29:45Z

sonic-psud/scripts/psud

+        psu = _wrapper_get_psu(psu_index)
+        if not psu:
+            logger.log_error("Failed to get PSU {} object from platform chassis".format(psu_index))
+            return ''


imo this should be a case where it returns the PSU_INFO_KEY_TEMPLATE, not an empty string.

LinJin23 · 2025-09-23T14:15:49Z

/azpw run

mssonicbld · 2025-09-23T14:15:52Z

/AzurePipelines run

azure-pipelines · 2025-09-23T14:16:01Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-09-23T14:52:29Z

/azp run

azure-pipelines · 2025-09-23T14:52:39Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-09-23T15:16:53Z

/azp run

azure-pipelines · 2025-09-23T15:17:03Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-09-23T15:32:06Z

/azp run

azure-pipelines · 2025-09-23T15:32:28Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-09-23T15:42:59Z

/azp run

azure-pipelines · 2025-09-23T15:43:08Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-09-23T16:02:30Z

/azp run

azure-pipelines · 2025-09-23T16:02:42Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-10T15:13:18Z

sonic-psud/scripts/psud

            except Exception as e:
-                self.log_error("Failed to load psuutil: %s" % (str(e)), True)
-                sys.exit(PSUUTIL_LOAD_ERROR)
+                self.log_warning("Failed to load psuutil: %s" % (str(e)), True)


The log_warning method is being called with a second parameter True, but logger methods typically don't take a boolean parameter for console output. This could cause runtime errors if the logger doesn't support this parameter pattern.

Suggested change

self.log_warning("Failed to load psuutil: %s" % (str(e)), True)

self.log_warning("Failed to load psuutil: %s" % (str(e)))

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-10-10T15:20:57Z

/azp run

azure-pipelines · 2025-10-10T15:21:06Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-10T15:21:41Z

sonic-psud/scripts/psud

-def _wrapper_get_psu_presence(psu_index):
+def _wrapper_get_psu(logger, psu_index):
+    """
+    Get PSU object from platform chassis


The docstring is missing the logger parameter description. Add ':param logger: Logger instance for error/warning messages' to document the logger parameter.

Suggested change

Get PSU object from platform chassis

Get PSU object from platform chassis

:param logger: Logger instance for error/warning messages

@LinJin23 Pls fix this.

Copilot · 2025-10-10T15:21:41Z

sonic-psud/scripts/psud

-                self.log_error("Failed to load psuutil: %s" % (str(e)), True)
-                sys.exit(PSUUTIL_LOAD_ERROR)
+                self.log_warning("Failed to load psuutil: %s" % (str(e)))
+                # Don't expect the PSUD to exit just because psuutil is not available


There's a grammatical error in the comment. It should be 'Don't expect PSUD to exit' instead of 'Don't expect the PSUD to exit'.

Suggested change

# Don't expect the PSUD to exit just because psuutil is not available

# Don't expect PSUD to exit just because psuutil is not available

This line has been removed.

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-14T18:20:50Z

sonic-psud/scripts/psud

-    return platform_psuutil.get_num_psus()
+    if platform_psuutil is not None:
+        return platform_psuutil.get_num_psus()
+    return 0


The function should maintain consistent fallback behavior. When platform_psuutil is None, returning 0 may not accurately represent the actual number of PSUs on the system. Consider returning a default value that makes sense for the platform or raising an appropriate exception.

Suggested change

return 0

raise RuntimeError("Unable to determine number of PSUs: neither platform_chassis nor platform_psuutil is available")

Copilot · 2025-10-14T18:20:50Z

sonic-psud/scripts/psud

+            except NotImplementedError:
+                pass
+    if platform_psuutil is not None:
+        return platform_psuutil.get_psu_presence(psu_index)


The fallback logic should handle potential exceptions from platform_psuutil.get_psu_presence(). Consider wrapping this call in a try-except block to prevent unhandled exceptions from propagating up.

Suggested change

return platform_psuutil.get_psu_presence(psu_index)

try:

return platform_psuutil.get_psu_presence(psu_index)

except Exception as e:

if logger:

logger.log_error("Exception in platform_psuutil.get_psu_presence({}): {}".format(psu_index, str(e)))

return False

Please wrap around this exception and log a warning message if it is not implemented.

Copilot · 2025-10-14T18:20:50Z

sonic-psud/scripts/psud

+            except NotImplementedError:
+                pass
+    if platform_psuutil is not None:
+        return platform_psuutil.get_psu_status(psu_index)


The fallback logic should handle potential exceptions from platform_psuutil.get_psu_status(). Consider wrapping this call in a try-except block to prevent unhandled exceptions from propagating up.

Suggested change

return platform_psuutil.get_psu_status(psu_index)

try:

return platform_psuutil.get_psu_status(psu_index)

except Exception as e:

if logger:

logger.log_error("Exception in platform_psuutil.get_psu_status({}): {}".format(psu_index, str(e)))

return False

Please add this exception

done, and at the suggested line 152, I changed log_error to log_warning.

vvolam · 2025-10-16T22:35:15Z

sonic-psud/scripts/psud

-def _wrapper_get_psu_presence(psu_index):
+def _wrapper_get_psu(logger, psu_index):
+    """
+    Get PSU object from platform chassis


@LinJin23 Pls fix this.

vvolam · 2025-10-16T22:36:31Z

sonic-psud/scripts/psud

+        except NotImplementedError as e:
+            if logger:
+                logger.log_warning("get_psu() not implemented by platform chassis: {}".format(str(e)))
+            return None


"return None" at line 121 is sufficient and line 116 and 120 is redundant

vvolam · 2025-10-16T22:37:13Z

sonic-psud/scripts/psud

+            return platform_chassis.get_psu(psu_index - 1)
+        except NotImplementedError as e:
+            if logger:
+                logger.log_warning("get_psu() not implemented by platform chassis: {}".format(str(e)))


notice is not available, so you can leave this as warning for now.

vvolam · 2025-10-16T22:39:41Z

sonic-psud/scripts/psud

+            except NotImplementedError:
+                pass
+    if platform_psuutil is not None:
+        return platform_psuutil.get_psu_presence(psu_index)


Please wrap around this exception and log a warning message if it is not implemented.

vvolam · 2025-10-16T22:40:53Z

sonic-psud/scripts/psud

+            except NotImplementedError:
+                pass
+    if platform_psuutil is not None:
+        return platform_psuutil.get_psu_status(psu_index)


Please add this exception

vvolam · 2025-10-20T22:48:24Z

sonic-psud/scripts/psud

-    return platform_psuutil.get_num_psus()
+    if platform_psuutil is not None:
+        return platform_psuutil.get_num_psus()
+    return 0


Add a warning log something like, if we have to return 0

if logger: logger.log_warning("No PSU provider available; assuming 0 PSUs")

vvolam · 2025-10-20T22:48:30Z

sonic-psud/scripts/psud

+            return None
+        except Exception as e:
+            if logger:
+                logger.log_warning("Failed to get PSU {} from platform chassis: {}".format(psu_index, str(e)))


This should be an error type log

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-10-23T15:32:00Z

/azp run

azure-pipelines · 2025-10-23T15:32:10Z

Azure Pipelines successfully started running 1 pipeline(s).

…dling Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-10-23T18:04:32Z

/azp run

azure-pipelines · 2025-10-23T18:04:41Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-23T18:14:40Z

sonic-psud/scripts/psud

+            try:
+                return psu.get_name()
+            except NotImplementedError:
+                pass


The comment explaining the IndexError exception handling was removed. This comment provided valuable context about why the exception is caught and should be preserved: 'some functionality is expectent on returning an expected key even if the psu object itself does not exist'.

Suggested change

pass

pass

# some functionality is expectent on returning an expected key even if the psu object itself does not exist

Copilot · 2025-10-23T18:14:40Z

sonic-psud/scripts/psud

                platform_psuutil = self.load_platform_util(PLATFORM_SPECIFIC_MODULE_NAME, PLATFORM_SPECIFIC_CLASS_NAME)
            except Exception as e:
-                self.log_error("Failed to load psuutil: %s" % (str(e)), True)
+                self.log_warning("Failed to load psuutil: %s" % (str(e)))


Logging a warning message before calling sys.exit() is contradictory. If the process is going to exit with an error code (PSUUTIL_LOAD_ERROR), this should remain as log_error(). Alternatively, if platform_psuutil being unavailable is truly non-fatal as the PR description suggests, the sys.exit() call should be removed.

Suggested change

self.log_warning("Failed to load psuutil: %s" % (str(e)))

self.log_error("Failed to load psuutil: %s" % (str(e)))

done, revert to original logic

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-10-24T00:27:10Z

/azp run

azure-pipelines · 2025-10-24T00:27:19Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-24T00:28:38Z

sonic-psud/scripts/psud

+    Get PSU object from platform chassis
+    :param logger: Logger instance for error/warning messages
+    :param psu_index: PSU index (1-based)
+    :return: PSU object if available, None otherwise


The docstring should clarify that logger can be None and that when None is passed, errors/warnings won't be logged. This is an important behavior detail for callers of this function.

Suggested change

Get PSU object from platform chassis

:param logger: Logger instance for error/warning messages

:param psu_index: PSU index (1-based)

:return: PSU object if available, None otherwise

Get PSU object from platform chassis.

:param logger: Logger instance for error/warning messages. Can be None; if None is passed, errors and warnings will not be logged.

:param psu_index: PSU index (1-based)

:return: PSU object if available, None otherwise

Note:

If logger is None, errors and warnings encountered during execution will not be logged.

Signed-off-by: Lin Jin <[email protected]>

mssonicbld · 2025-10-24T00:36:56Z

/azp run

azure-pipelines · 2025-10-24T00:37:04Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

add exception handling in add_exception_psu

cf713d9

LinJin23 changed the title ~~add exception handling in add_exception_psu~~ [psud] Refactor PSU object retrieval to improve exception handling Aug 11, 2025

LinJin23 requested a review from vvolam August 13, 2025 01:08

vvolam reviewed Aug 22, 2025

View reviewed changes

address review comments

6063a6e

gregoryboudreau reviewed Sep 10, 2025

View reviewed changes

Fix tests and add handler to platform_psuutil

188652c

Signed-off-by: Lin Jin <[email protected]>

Fix comment

455572d

Signed-off-by: Lin Jin <[email protected]>

Fix test

048fc91

Signed-off-by: Lin Jin <[email protected]>

Fix test

bf4dede

Signed-off-by: Lin Jin <[email protected]>

Add tests

cf7161e

Signed-off-by: Lin Jin <[email protected]>

LinJin23 requested review from gregoryboudreau and vvolam September 23, 2025 16:11

Copilot AI reviewed Oct 10, 2025

View reviewed changes

address copilot comments

a7e21b5

Signed-off-by: Lin Jin <[email protected]>

LinJin23 requested a review from Copilot October 10, 2025 15:21

Copilot AI reviewed Oct 10, 2025

View reviewed changes

vvolam requested a review from Copilot October 14, 2025 18:19

Copilot AI reviewed Oct 14, 2025

View reviewed changes

vvolam reviewed Oct 16, 2025

View reviewed changes

vvolam suggested changes Oct 20, 2025

View reviewed changes

Revert to the previous behavior to keep exit when failed in get psuutil

8a52b30

Signed-off-by: Lin Jin <[email protected]>

enhance PSU wrapper functions to accept logger for improved error han…

508d208

…dling Signed-off-by: Lin Jin <[email protected]>

LinJin23 requested a review from Copilot October 23, 2025 18:14

Copilot AI reviewed Oct 23, 2025

View reviewed changes

Revert to the original psuutil exception handling logic

0a37102

Signed-off-by: Lin Jin <[email protected]>

LinJin23 requested a review from Copilot October 24, 2025 00:28

Copilot AI reviewed Oct 24, 2025

View reviewed changes

add docstring

23efbcf

Signed-off-by: Lin Jin <[email protected]>

LinJin23 requested a review from Copilot October 24, 2025 00:37

Copilot AI reviewed Oct 24, 2025

View reviewed changes

LinJin23 requested review from gregoryboudreau and vvolam October 24, 2025 00:39

	self.log_warning("Failed to load psuutil: %s" % (str(e)), True)
	self.log_warning("Failed to load psuutil: %s" % (str(e)))

	Get PSU object from platform chassis
	Get PSU object from platform chassis
	:param logger: Logger instance for error/warning messages

	# Don't expect the PSUD to exit just because psuutil is not available
	# Don't expect PSUD to exit just because psuutil is not available

	return 0
	raise RuntimeError("Unable to determine number of PSUs: neither platform_chassis nor platform_psuutil is available")

	pass
	pass
	# some functionality is expectent on returning an expected key even if the psu object itself does not exist

	self.log_warning("Failed to load psuutil: %s" % (str(e)))
	self.log_error("Failed to load psuutil: %s" % (str(e)))

[psud] Refactor PSU object retrieval to improve exception handling #659

Are you sure you want to change the base?

[psud] Refactor PSU object retrieval to improve exception handling #659

Uh oh!

Conversation

LinJin23 commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Additional Information (Optional)

Uh oh!

mssonicbld commented Aug 11, 2025

Uh oh!

azure-pipelines bot commented Aug 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Aug 26, 2025

Uh oh!

azure-pipelines bot commented Aug 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LinJin23 commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mssonicbld commented Oct 10, 2025

Uh oh!

azure-pipelines bot commented Oct 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 10, 2025

LinJin23 commented Aug 11, 2025 •

edited

Loading