exceptions
Module for handling exceptions in the cafex framework.
Provides exception handling with reporting integration.
CoreExceptions
Handles custom exceptions with reporting integration.
This class provides methods to: - Raise and handle custom exceptions - Create detailed stack traces - Integrate with the reporting system - Control test execution flow
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
|
__build_exception_message(user_message, exc_type=None, exc_value=None)
Build formatted exception message with context.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
user_message
|
str
|
Initial user message |
required |
exc_type
|
Exception type |
None
|
|
exc_value
|
Exception value |
None
|
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Formatted exception message |
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 |
|
__clean_message_for_report(message)
staticmethod
Clean exception message for reporting.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
Raw exception message |
required |
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Cleaned message suitable for reporting |
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
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 |
|
__get_complete_stack_trace()
Get complete stack trace including both cafex and external frames. Provides comprehensive view of the error chain.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Complete formatted stack trace |
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
|
__get_context_info()
Get current test and step context.
Returns:
Type | Description |
---|---|
dict
|
Dictionary containing context information |
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
339 340 341 342 343 344 345 346 347 348 |
|
__get_stack_frames(tb)
Extract and format relevant stack frames.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tb
|
Traceback object |
required |
Returns:
Name | Type | Description |
---|---|---|
list |
list
|
Formatted frame strings for cafex and feature code |
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
|
__get_trim_stack_trace()
Get trimmed stack trace with just cafex frames. Provides a concise view focusing on application-specific code.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
Formatted stack trace with cafex frames |
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
|
__init__()
Initialize the Exceptions class.
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
|
raise_generic_exception(message, insert_report=True, trim_log=True, log_local=True, fail_test=True)
Raise and handle a generic exception with comprehensive error reporting.
This method provides centralized exception handling with flexible reporting options. It captures stack traces, adds context information, and can optionally fail the test.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
The exception message to log and report |
required |
insert_report
|
bool
|
Whether to add exception details to the test report |
True
|
trim_log
|
bool
|
If True, includes only application frames in stack trace |
True
|
log_local
|
bool
|
Whether to enable local logging of the exception |
True
|
fail_test
|
bool
|
If True, marks the current test as failed |
True
|
Examples:
Basic API test error handling: # In your API test class def test_api_endpoint(self): try: response = self.client.get("/api/data") except Exception as e: self.exceptions.raise_generic_exception( f"API request failed: {str(e)}" )
UI element interaction error: # In your UI test class def verify_element_visible(self, locator: str) -> bool: try: self.driver.find_element(locator) return True except Exception as e: error_msg = f"Element not visible: '{locator}'" self.exceptions.raise_generic_exception( message=error_msg, fail_test=False ) return False
Database operation error: # In your DB test class def execute_query(self, query: str) -> None: try: self.cursor.execute(query) except Exception as e: self.exceptions.raise_generic_exception( message=f"Query execution failed: {str(e)}", trim_log=True, fail_test=False )
Note
- Uses session store to maintain exception context
- Integrates with the reporting system for test results
- Supports both BDD and non-BDD test frameworks
- Handles nested exceptions and maintains original stack traces
Source code in libs\cafex_core\src\cafex_core\utils\exceptions.py
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
|