reporting
Reporting
Handles reporting functionality for test execution, including step and assertion tracking.
Source code in libs\cafex_core\src\cafex_core\reporting_\reporting.py
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 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 |
|
insert_step(expected_message, actual_message, status='IC', step_name=None, step_type='step', exception_detail=None, take_screenshot=True, api_response=None, trim_exception_detail=False)
Inserts a step or assertion into the test report.
If called within an existing step (i.e., current_step is set in session_store), adds data as an assertion to that step. Otherwise, creates a new step in the test report.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
expected_message
|
str
|
Expected result or condition |
required |
actual_message
|
str
|
Actual result or condition |
required |
status
|
str
|
Step/assertion status ("Pass", "Fail", or "IC"). Defaults to "IC". |
'IC'
|
step_name
|
str
|
Custom name for the step. If not provided, constructs name from expected and actual messages. |
None
|
step_type
|
str
|
Type of step ("step", "verify", "assert", etc.). Defaults to "step". |
'step'
|
exception_detail
|
str
|
Details of any exception that occurred. |
None
|
take_screenshot
|
bool
|
Whether to capture a screenshot. Defaults to True. |
True
|
api_response
|
dict
|
API response data to include in the report. |
None
|
trim_exception_detail
|
bool
|
Whether to trim exception detail to 3990 chars. Defaults to False. |
False
|
Examples:
-
Basic step with pass status:
reporting.insert_step( "Login button should be enabled", "Login button is enabled", "Pass" )
-
Failed step with custom name and exception:
reporting.insert_step( "User should be logged in", "Login failed", "Fail", step_name="Login Verification", exception_detail="InvalidCredentialsError: Username or password incorrect" )
-
API test step with response data:
api_response = { "status_code": 200, "body": {"user_id": 123, "status": "active"} } reporting.insert_step( "API should return 200", f"API returned {api_response['status_code']}", "Pass", step_type="api", api_response=api_response )
-
Step within another step (adds as assertion):
# In a test using @step decorator or within a BDD step reporting.insert_step( "Element should be visible", "Element is visible", "Pass", step_type="verify" )
-
Disable screenshot for performance:
reporting.insert_step( "Database should be connected", "Connected successfully", "Pass", take_screenshot=False )
-
Handle long exception details:
reporting.insert_step( "Parse large file", "Parsing failed", "Fail", exception_detail=long_stack_trace, trim_exception_detail=True )
Notes
- The method automatically captures screenshots unless disabled
- For failed steps (status="Fail"), it marks the test as failed in session_store
- When used within a step (e.g., in BDD steps), adds the data as an assertion
- Screenshots and API responses are stored in the step's evidence
Source code in libs\cafex_core\src\cafex_core\reporting_\reporting.py
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 |
|
report_exception(message, exception_type=None, trace=None, context=None, fail_test=True)
Report an exception to result.json with screenshots if available.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
message
|
str
|
Exception message |
required |
exception_type
|
str
|
Type of exception |
None
|
trace
|
str
|
Stack trace info |
None
|
context
|
dict
|
test context |
None
|
fail_test
|
bool
|
Mark test as failed |
True
|
Source code in libs\cafex_core\src\cafex_core\reporting_\reporting.py
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 |
|