--- sourceDocument: Yokohama Build or modify applications sourceDocumentLink: https://www.servicenow.com/docs/r/yokohama/application-development Release : - yokohama ft:locale : - en-US ft:publication_title : - Yokohama Build or modify applications ft:clusterId : - cadev bundleId : - cadev workflow : - Development, Data, and Analytics --- # Building and running automated test suites # Building and running automated test suites {#ariaid-title1} * Release version: Yokohama * * Updated January 30, 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Building and running automated test suites Automated Test Framework (ATF) in ServiceNow enables you to create and run test suites---collections of tests and nested test suites---to verify applications or related features. Test suites can be organized hierarchically, where parent suites contain child suites or individual tests. This structure allows comprehensive and ordered testing of complex scenarios. Show full answer Show less ## Key Features * **Test Suite Hierarchies:** Build multi-level test suite hierarchies where a suite can be both a parent and a child, enabling modular and scalable test organization. * **Scheduling:** Schedule test suites to run automatically based on defined schedule records. Scheduling requires an active Scheduled Client Test Runner with matching browser conditions. Note that only test suites (not individual tests) can be scheduled. * **Dynamic Test Inclusion via Filters:** Use filters to automate adding tests to a suite based on matching criteria. This reduces manual maintenance and keeps test suites up to date. * **Copying Test Suites:** Duplicate entire test suites, including nested tests and child suites, to accelerate test creation and modification. * **Running Tests:** Run test suites manually in non-production instances or trigger scheduled runs. You can also execute scheduled suites immediately via script for automation purposes. * **Re-running Failed Tests:** Option to re-run only failed tests within a suite, saving time by avoiding full suite re-execution. * **Notifications:** Configure watchlists on test suite run records to notify users via email upon completion of test execution. ## Practical Considerations * Ensure a Scheduled Client Test Runner is active and configured properly for UI-based test steps when running scheduled suites. * Scheduled tests cannot run on locked, powered-down machines or without the appropriate browser session already open. * Use filters to maintain test suites dynamically, reducing manual effort for test designers. ## Next Steps for ServiceNow Customers * Create automated test suites by grouping relevant tests and child suites to reflect application features or workflows. * Leverage scheduling to run test suites during off-hours or as part of continuous integration pipelines. * Utilize filtering and copying features to efficiently manage and scale your test suites as your instance evolves. * Monitor test suite runs and configure email notifications to stay informed of results and failures. Run a group of tests in a specific order to test an application or a group of related features. A test suite can contain both individual tests and other test suites. A test suite that contains another test suite is called a parent, and the test suite contained within the parent is called a child. While a test suite can have both individual tests and test suites as children, tests cannot have other tests as children. Tests can only contain test steps. ## Benefits {#atf-suites-overview__section_czv_r23_5fb} Grouping tests into test suites offers these benefits. * Allows testers to run every test in a test suite with one action. * Allows testers to run all child test suites in a parent test suite. * Allows testers to see test results for every test in a test suite. * Allows test designers and testers to schedule when to run test suites. * Allows test designers and testers to schedule starting client test runners to support test runs. {#atf-suites-overview__ul_vc2_wwh_5fb} ## Hierarchies {#atf-suites-overview__section_fdw_5b3_5fb} Automated Test Framework supports building a multi-level hierarchies where a test suite can be both a parent and child. For example, this figure illustrates Test Suite 1 as the parent at the top of the hierarchy. Test Suite 1.3 is a child of Test Suite 1 and also a parent of Test Suite 1.3.1 and Test Suite 1.3.2. Figure 1. Example of Test Suite Hierarchy ## Schedules {#atf-suites-overview__section_lgc_gf3_5fb} To schedule a test suite, you need three components: * a test suite record * a schedule record specifying when you want the system to run the test suite * a scheduled suite run record that associates the test suite to run with the schedule for running it {#atf-suites-overview__pbf_3bt_bz} With this model, you can associate a schedule with many different test suites, and vice versa. Note: You can schedule only test suites, not individual tests. Scheduled tests will run only if there is an open Scheduled Client Test Runner page matching the scheduled suite's browser conditions. Scheduled tests cannot run on a machine that is locked, powered down, or does not already have the browser open. The watchlist on the test suite run record also allows you to specify users to receive an email when the system finishes executing the test suite run. If the test suite contains one or more form steps (steps involving a user interface), you must ensure that a scheduled client test runner is actively running in a browser when the schedule triggers the suite run. Note: See [Browser recommendations and requirements](https://www.servicenow.com/docs/RCkgkemnippD_sUkq2mTnw#atf-test-runners__kvv_h25_gx) for recommendations and requirements for running the client test runner. For step-by-step instructions on how to schedule a test suite, see [Schedule an automated test suite](https://www.servicenow.com/docs/fhHssok5mQiuhcLf~DcfCQ "Schedule one or more test suites to run at a specific date and time."). ## Filters {#atf-suites-overview__section_hjv_3f3_5fb} Automate the creation of test suites by using a filter to dynamically add tests to a test suite when they match the filter conditions. Reduce the time that your test designers spend manually creating and maintaining test suites. * **[Create an automated test suite](https://www.servicenow.com/docs/aLVf2SV6WQwflz5nvRIxfQ)** Group automated tests into a suite you can execute as a batch. * **[Copy an automated test suite](https://www.servicenow.com/docs/pnexim540Ylr2MFTal36xQ)** Reduce time when creating tests by copying an entire test suite. Rename and modify the test suite after copying. The Copy Test Suite button on the Test Suite form copies all the nested tests and child test suites within the text suite. * **[Add tests to a suite with a filter](https://www.servicenow.com/docs/ZqGtgwDybwMofBzWWzEZug)** Automate the creation of test suites by using a filter to dynamically add tests to a test suite when they match the filter conditions. Reduce the time that your test designers spend manually creating and maintaining test suites. * **[Add test to an existing automated test suite](https://www.servicenow.com/docs/QQuPzCEIDVik2J5kXSy1Tw)** Add a test to a test suite that already exists. * **[Add child test suite to parent test suite](https://www.servicenow.com/docs/FkDVamzFsNUhqMIHefeG7w)** Add to a multi-level test suite by including a child test suite within a parent test suite. * **[Run an automated test suite](https://www.servicenow.com/docs/ISILEOdBX7vBRUKztQ3DNA)** After creating an automated test suite, run it in a non-production instance. * **[Schedule an automated test suite](https://www.servicenow.com/docs/fhHssok5mQiuhcLf~DcfCQ)** Schedule one or more test suites to run at a specific date and time. * **[Run a scheduled test suite using a script](https://www.servicenow.com/docs/10xrgLMUolO17kFFnBUnBw)** Execute a scheduled UI test suite immediately using a script without having to wait for the scheduled time. You can use this method while trying to automate the process of running a test. * **[Re-run failed tests in an automated test suite](https://www.servicenow.com/docs/Jy3CTKKD9wn8lX1Br72YFQ)** Re-run failed tests within a test suite without rerunning the entire suite. **Related concepts** * [Building and running automated tests with the Automated Test Framework](https://www.servicenow.com/docs/cUKQ1OCNZgN3~W~voLUFdQ "Basic tasks in the Automated Test Framework.") * [Cancelling automated tests and test suites](https://www.servicenow.com/docs/7QK4cItQGt5TOq9Wd2ewqA#atf-cancelling "You can cancel automated tests and automated test suites that are running or are queued to run.") * [Suites](https://www.servicenow.com/docs/o0lVAI89aHV~pSGgkgv4vw "The Suites module opens the Test Suites table. You can create, edit, and run test suites from this table.") **Related tasks** * [Auto-generate ATF tests](https://www.servicenow.com/docs/eeW9pPcjZWEzvD_tSPL1QA "Auto-generate ATF tests by selecting the auto-generate option either from the Auto-generate Tests module or Tests/Suites modules.") **Related reference** * [Step results record](https://www.servicenow.com/docs/LVZzEHAtDzOopOorz0Iz9A "The Step Results record contains information about one step in a test result. You access specific step results from the Step Results related list in the Test Results record.")