Guide to Suites
This page is a full rundown of Shiplight AI's Suite feature, including what they are, what they do, and how to create one.
Table of Contents:
1. What is a Suite
A suite is a collection of test cases, bundled together for convenience. Suites offer a variety of benefits:
- Suites can be selected in a schedule to run regularly
- Organize related test cases together
- Track test status and metrics
- Enable bulk operations on multiple tests
2. Making a Suite
The Suite page is located on the left sidebar. Upon opening the page you can see existing Suites and their information, including case count and latest result. To create a Suite, click the Create test suite button in the top right. Suite creation can also be started by pressing the 
in the top left corner, then selecting Create suite.
Creating a suite requires three fields:
- Title: A name for the suite. Does not need to be unique
- Description: An optional description to increase readability
- Tests: Select test cases to add to the suite. Test cases can be searched by name as well as found in the list. Multiple test cases can be selected.
3. Suite UI
The website will automatically direct you to the Suite UI after creation. The Suite UI can also be reached by clicking on the Suite in the Suite page.
Modifying Tests
To add test cases, press the + button in the top right then select the test cases to add. To remove tests, click the ... on the rightmost column, then select delete from the dropdown.
Metrics
The Suite UI displays two main sections of metrics:
Suite Properties:
- Total Tests: Total number of test cases in the suite
- Active Tests: Number of test cases currently set to active status
Latest Run Results (when the suite has been executed):
- Result: Overall pass/fail status of the last run
- Start Time: When the last run began
- End Time: When the last run completed
- Duration: How long the last run took
- Total Passed/Failed: Breakdown of test results
Deleting A Suite
You can delete a Suite in the Suite UI by clicking the ... in the top left corner next to the Suite ID. Alternatively, Suites can be deleted from the Suites page by clicking the ... on the rightmost column, then selecting delete.