SeleniumBase icon indicating copy to clipboard operation
SeleniumBase copied to clipboard

New Feature: Test Case Management Software

Open mdmintz opened this issue 3 years ago • 1 comments

It's time SeleniumBase had its own test case management software. There should be a way to easily generate boilerplate files for storing test case steps and expected results. These tables should be easily readable via GitHub, (which can be represented using Markdown format or HTML format).

# Step Description Expected Result
1 Perform Action 1 Verify Action 1
2 Perform Action 2 Verify Action 2

Using Markdown Format:

| # | Step Description | Expected Result |
| - | ---------------- | --------------- |
| 1 | Perform Action 1 | Verify Action 1 |
| 2 | Perform Action 2 | Verify Action 2 |
# Step Description Expected Result
1 Perform Action 1 Verify Action 1
2 Perform Action 2 Verify Action 2

Using HTML Format:

<table><thead>
<tr><th> # </th><th> Step Description </th><th> Expected Result </th></tr>
</thead>
<tbody>
<tr><td> 1 </td><td> Perform Action 1 </td><td> Verify Action 1 </td></tr>
<tr><td> 2 </td><td> Perform Action 2 </td><td> Verify Action 2 </td></tr>
</tbody>
</table>
# Step Description Expected Result
1 Perform Action 1 Verify Action 1
2 Perform Action 2 Verify Action 2

To make this even more useful, there should be a way to tie this together with test files and be able to link the two together.

mdmintz avatar Aug 02 '22 15:08 mdmintz

A more complete example of using Markdown for Test Case Management:

``test_mfa_login.py::TestMFALogin::test_mfa_login``
---
| # | Step Description | Expected Result |
| - | ---------------- | --------------- |
| 1 | Navigate to https://seleniumbase.io/realworld/login <br /> Enter Username, Password, MFA code, and Sign In. | Verify that Sign In was successful. |
| 2 | Click the "This Page" button. <br /> Save a screenshot to the logs. | |
| 3 | Click to Sign Out | Verify that Sign Out was successful. |

test_mfa_login.py::TestMFALogin::test_mfa_login

# Step Description Expected Result
1 Navigate to https://seleniumbase.io/realworld/login
Enter Username, Password, MFA code, and Sign In.
Verify that Sign In was successful.
2 Click the "This Page" button.
Save a screenshot to the logs.
3 Click to Sign Out Verify that Sign Out was successful.

mdmintz avatar Aug 08 '22 15:08 mdmintz

Documentation: help_docs/case_plans.md

mdmintz avatar Aug 19 '22 16:08 mdmintz