1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2010-2014 Intel Corporation
# Copyright(c) 2022-2023 PANTHEON.tech s.r.o.
# Copyright(c) 2022-2023 University of New Hampshire
# Copyright(c) 2024 Arm Limited
"""DTS exceptions.
The exceptions all have different severities expressed as an integer.
The highest severity of all raised exceptions is used as the exit code of DTS.
"""
from enum import IntEnum, unique
from typing import ClassVar
@unique
class ErrorSeverity(IntEnum):
"""The severity of errors that occur during DTS execution.
All exceptions are caught and the most severe error is used as return code.
"""
#:
NO_ERR = 0
#:
GENERIC_ERR = 1
#:
CONFIG_ERR = 2
#:
REMOTE_CMD_EXEC_ERR = 3
#:
SSH_ERR = 4
#:
INTERNAL_ERR = 5
#:
DPDK_BUILD_ERR = 10
#:
TESTCASE_VERIFY_ERR = 20
#:
BLOCKING_TESTSUITE_ERR = 25
class DTSError(Exception):
"""The base exception from which all DTS exceptions are subclassed.
Do not use this exception, only use subclassed exceptions.
"""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.GENERIC_ERR
class SSHConnectionError(DTSError):
"""An unsuccessful SSH connection."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR
_host: str
_errors: list[str]
def __init__(self, host: str, errors: list[str] | None = None):
"""Define the meaning of the first two arguments.
Args:
host: The hostname to which we're trying to connect.
errors: Any errors that occurred during the connection attempt.
"""
self._host = host
self._errors = [] if errors is None else errors
def __str__(self) -> str:
"""Include the errors in the string representation."""
message = f"Error trying to connect with {self._host}."
if self._errors:
message += f" Errors encountered while retrying: {', '.join(self._errors)}"
return message
class _SSHTimeoutError(DTSError):
"""The execution of a command via SSH timed out.
This class is private and meant to be raised as its interactive and non-interactive variants.
"""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR
_command: str
def __init__(self, command: str):
"""Define the meaning of the first argument.
Args:
command: The executed command.
"""
self._command = command
def __str__(self) -> str:
"""Add some context to the string representation."""
return f"{self._command} execution timed out."
class SSHTimeoutError(_SSHTimeoutError):
"""The execution of a command on a non-interactive SSH session timed out."""
class InteractiveSSHTimeoutError(_SSHTimeoutError):
"""The execution of a command on an interactive SSH session timed out."""
class _SSHSessionDeadError(DTSError):
"""The SSH session is no longer alive.
This class is private and meant to be raised as its interactive and non-interactive variants.
"""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.SSH_ERR
_host: str
def __init__(self, host: str):
"""Define the meaning of the first argument.
Args:
host: The hostname of the disconnected node.
"""
self._host = host
def __str__(self) -> str:
"""Add some context to the string representation."""
return f"SSH session with {self._host} has died."
class SSHSessionDeadError(_SSHSessionDeadError):
"""Non-interactive SSH session has died."""
class InteractiveSSHSessionDeadError(_SSHSessionDeadError):
"""Interactive SSH session as died."""
class ConfigurationError(DTSError):
"""An invalid configuration."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.CONFIG_ERR
class RemoteCommandExecutionError(DTSError):
"""An unsuccessful execution of a remote command."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.REMOTE_CMD_EXEC_ERR
#: The executed command.
command: str
_command_stderr: str
_command_return_code: int
def __init__(self, command: str, command_stderr: str, command_return_code: int):
"""Define the meaning of the first two arguments.
Args:
command: The executed command.
command_stderr: The stderr of the executed command.
command_return_code: The return code of the executed command.
"""
self.command = command
self._command_stderr = command_stderr
self._command_return_code = command_return_code
def __str__(self) -> str:
"""Include the command, its return code and stderr in the string representation."""
return (
f"Command '{self.command}' returned a non-zero exit code: "
f"{self._command_return_code}\nStderr: {self._command_stderr}"
)
class InteractiveCommandExecutionError(DTSError):
"""An unsuccessful execution of a remote command in an interactive environment."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.REMOTE_CMD_EXEC_ERR
class RemoteFileNotFoundError(DTSError):
"""A remote file or directory is requested but doesn’t exist."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.REMOTE_CMD_EXEC_ERR
class DPDKBuildError(DTSError):
"""A DPDK build failure."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.DPDK_BUILD_ERR
class TestCaseVerifyError(DTSError):
"""A test case failure."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.TESTCASE_VERIFY_ERR
class BlockingTestSuiteError(DTSError):
"""A failure in a blocking test suite."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.BLOCKING_TESTSUITE_ERR
_suite_name: str
def __init__(self, suite_name: str) -> None:
"""Define the meaning of the first argument.
Args:
suite_name: The blocking test suite.
"""
self._suite_name = suite_name
def __str__(self) -> str:
"""Add some context to the string representation."""
return f"Blocking suite {self._suite_name} failed."
class InternalError(DTSError):
"""An internal error or bug has occurred in DTS."""
#:
severity: ClassVar[ErrorSeverity] = ErrorSeverity.INTERNAL_ERR
|
