Test Suite Editor

Applies to ReadyAPI 3.56, last modified on November 25, 2024

A test suite is a collection of test cases that can be used for grouping functional tests into logical units.

Your project can contain any number of test suites and you can see and execute them all in sequence or parallel (see Test Suites).

Test suite editor

Click the image to enlarge it.

Toolbar

The test suite toolbar contains quick access to the most frequently used commands.

Test suite editor toolbar

Click the image to enlarge it.

Test Cases Page

The main purpose of the Test Cases page is managing test cases. To learn how to do it, see Managing Test Cases.

The Test Cases page gives you an overview of the contained test cases and their run status. It allows you to add, remove or modify test cases, as well as assign tags and use them to filter test cases for a test run. For more info, see Working With Tags.

Besides that, panels of the page allow you to modify various test suite aspects:

  • Description – Specify the text description of the test case.

  • Properties – Manage the list of test case properties. See the Test Suite Properties section.

  • Setup Script – Specify a script that is run at the start of a test case run. To learn more, see Setup, TearDown, and Report Scripts.

  • TearDown Script – Specify a script that is run when the test case run finishes. To learn more, see Setup, TearDown, and Report Scripts.

  • Report Script – Specify a script that is run when you generate a report. To learn more, see Script Extensions.

  • Report Parameters – Manage the list of parameters used for the report creation. To learn more, see Script Extensions.

Other Editor Pages

To learn about See
Transaction Log Transaction Log Page
Compare Compare Page
History Test History Page
Coverage Coverage Testing

Test Suite Properties

Besides editor panels, you can adjust test case behavior by using its properties in the property tabs in the Navigator.

Name Description
Name

The name of the test suite.

Special characters in the name, including (but not limited to) &, -, /, (, and ), may cause issues with reporting.

Custom Test Suite Properties tab in the Navigator and the Properties panel in the test suite editor, you can create any number of properties. These properties are available to child test cases and other test suites in your project. To manage the property list, use the toolbar:

Custom test suite properties can be stored locally in your workspace file by selecting the checkbox on the right. To learn more about it, see Locally Stored Properties.

Working With Tags

Tags help you group test cases within a test suite. You can run only the tests containing tagged test cases. Also, you can exclude test cases with the specific tags from the test run. Tags are always alphanumeric.

You can edit all tags in the project from the Tags tab in the Project editor.

Add Tags

  1. Select the test case.

  2. Click Assign Tag on the toolbar.

  3. Specify the name of the tag and press Enter. The specified tag will be added to the selected test case.

Add tag

Click the image to enlarge it.

Remove Tags

  1. Select the test case.

  2. Click Assign Tag on the toolbar.

  3. Remove selection of the tags you do not need. These tags will be removed from the selected test case.

Remove tag

Click the image to enlarge it.

Focus Test Run on Desired Test Cases

  1. Open the list of selected tags.

  2. To include the tagged test cases to the test run and exclude others, select Show from the Show/Hide drop-down menu.

  3. Select a filtering rule:

    • Select All tags to show test cases only with all the selected tags. For example, if you select tag1 and tag2, ReadyAPI will only show test cases that contain both tag1 and tag2.

    • Select At least one to show test cases with any of the selected tags. For example, if you select tag1 and tag2, ReadyAPI will show test cases that contain either tag1, tag2, or both.

  4. Select the tags you need.

Show test cases

Click the image to enlarge it.

Exclude Specific Test Cases From Test Run

  1. Open the list of selected tags.

  2. To exclude the test cases from the test run, select Hide from the Show/Hide drop-down menu.

  3. Select a filtering rule:

    • Select All tags to show test cases only with all the selected tags. For example, if you select tag1 and tag2, ReadyAPI will hide only test cases that contain both tag1 and tag2.

    • Select At least one to show test cases only with any of the selected tags. For example, if you select tag1 and tag2, ReadyAPI will hide test cases that contain either tag1, tag2, or both.

  4. Select the tags you need.

Hide test cases

Click the image to enlarge it.

See Also

Project Editor
Test Case Editor

Highlight search results