openstack/ironic
Code Issues Proposed changes

trivial: add missing exception to agent code path docstrings

Browse Source 
While investigating https://bugs.launchpad.net/ironic/+bug/2110698
I noticed you could end up with an additional exception raised which
would be considered a hard failure. Overall, the code path looks okay
for it, its just not in the doc strings, so I figured easy enough to
fix it.

Change-Id: I528b6f327fac95cdb8b620843c073fc9cdec1833
This commit is contained in:
Julia Kreger
2025-05-14 09:01:03 -07:00
parent 1bdea20488
commit a43d615e18
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
ironic/drivers/modules/agent_base.py
View File

@ -545,6 +545,7 @@ class HeartbeatMixin(object):
LOG.exception('Asynchronous exception for node %(node)s: %(err)s',
{'node': task.node.uuid, 'err': last_error})
# Do not call the error handler is the node is already DEPLOYFAIL
# or DEPLOYWAIT
if node.provision_state in (states.DEPLOYING, states.DEPLOYWAIT):
deploy_utils.set_failed_state(
task, last_error, collect_logs=self.collect_deploy_logs)

4
ironic/drivers/modules/agent_client.py
View File

@ -183,6 +183,8 @@ class AgentClient(object):
:raises: AgentAPIError when agent failed to execute specified command.
:raises: AgentInProgress when the command fails to execute as the agent
is presently executing the prior command.
:raises: AgentConnectionFailed when connectivity has failed and there
is no prior command to determine the status of.
:returns: A dict containing command result from agent, see
get_commands_status for a sample.
"""
@ -577,6 +579,8 @@ class AgentClient(object):
:raises: IronicException when failed to issue the request or there was
a malformed response from the agent.
:raises: AgentAPIError when agent failed to execute specified command.
:raises: AgentConnectionFailed when an a transient connection failure
breaks the connection while the request is being processed.
:returns: A dict containing command response from agent.
See :func:`get_commands_status` for a command result sample.
The value of key command_result is in the form of: