The naming convention used is the following:

(ATK-CY/PW-xxxx) Title @tag1 @tag2 ...
ATK-CY/PW-xxxx = use this to specify an exact test
ATK = Automated Testing Kit
CY/PW = Use one or the other depending on which testing framework you are using.
xxxx = Test number, grouped by category
Title = Title of the test, can also find with --grep on the command line
@tag1 @tag2 = tags for labeling and categorizing tests, such as "@ATK-CY-1000 @register-login @smoke @alters-db"

By convention:

  • the first tag is the code for the test; having a code makes it possible to execute specific tests in the pipeline and cross-reference tests from reports
  • the second tag is the web site component; create component tags according to your website.
  • the subsequent tags indicate important properties of tests allowing you to select tags with logic like "run all smoke tests that don't alter the database and are active (i.e. don't have the @skip tag). Each framework has a different way of filtering by tag. Refer to their documentation.

Some tags ATK uses are below; you can add as many tags as you want to your tests.

Property Tag
Description
@alters-db
Performs write operations on the database.
@content
Relies on test content in the database.
@empty
Tests an empty input.
@skip
Add this to skip a test. (Be sure to use "--grep-invert "@skip".)
@smoke
Part of smoke tests.

Automated Testing Kit Component List

Tests in the Kit belong to one of the following categories:

Category Tag
Description
@ckeditor
Tests related to CKEditor 5.
@contact-us
Tests related to contact forms (Webform, specifically).
@feeds
Tests related to the Feeds modules.
@media
Tests related to media entities.
@menu
Tests related to menus.
@node
Tests related to node entities (articles, pages, events, etc.).
@register-login
Tests related to registration, login and password resets.
@page-error
Tests related to 403, 404 and similar errors.
@sitemap
Tests related to the Simple XML Sitemap module.
@taxonomy
Tests related to taxonomy entities.
@user
Tests related to user entities.
@xml-sitemap
Tests related to the XML Sitemap module.

Test Descriptions

Cypress test IDs use -CY- and Cypress files end with .cy.js.

Playwright test IDs use -PW- and Playwright files end with .spec.js.

Test ID
File Name
Category
Tags
Description
ATK-XX-1000
atk_register_login
@register-login
@smoke       
@alters-db
Register a new user.
ATK-XX-1010
atk_register_login
@register-login
@smoke
Log in with form. Requires QA Accounts (but you can change qaUsers.json).
ATK-XX-1011
atk_register_login
@register-login
@smoke
Log in with POST. Requires QA Accounts (but you can change qaUsers.json).
ATK-XX-1012
atk_register_login
@register-login
@smoke
Log in via ULI. Requires QA Accounts (but you can change qaUsers.json).
ATK-XX-1030
atk_register_login
@register-login
@smoke
Reset password. Requires QA Accounts (but you can change qaUsers.json).
ATK-XX-1050
atk_contact_us
@contact-us
@smoke    
@alters-db
Contact Us form accepts input, saves response. Requires Webform module.
ATK-XX-1060
atk_page_error
@page-error
@smoke
Validate that 403 page appears.
ATK-XX-1061
atk_page_error
@page-error
@smoke
Validate that 404 page appears.
ATK-XX-1070
atk_sitemap
@xml-sitemap
@smoke
@drush
Return # of sitemap files; fail if zero.
ATK-XX-1071
atk_sitemap
@xml-sitemap 
@smoke
@drush
Regenerate sitemap files. Uses drush fprop (custom drush command).
ATK-XX-1080
atk_sitemap
@simple-xml-sitemap
@smoke
Validate the Simple XML Sitemap.
ATK-XX-1100
atk_user
@user
@smoke   
@drush   
@alters-db
Create and delete user with Drush.
ATK-XX-1101
atk_user
@user
@smoke   
@drush   
@alters-db
Create user with Drush, delete by UID.
ATK-XX-1110
atk_node
@node
@smoke   
@alters-db
Create, update, delete a page via the UI.
ATK-XX-1111
atk_node
@node
@smoke   
@alters-db
Create, update, delete an article via the UI.
ATK-XX-1120
atk_taxonomy
@taxonomy
@smoke   
@alters-db
Create, update, delete a taxonomy term via the UI.
ATK-XX-1130
atk_media
@media
@smoke   
@alters-db
Create, update, delete an image via the UI.
ATK-XX-1150
atk_menu
@menu
@smoke   
@alters-db
Create a new menu item, validate that it appears.
ATK-XX-1160
atk_search
@search
@smoke   
@content
Search content by a keyword.
ATK-XX-1161
atk_search
@search
@smoke   
@content
Advanced search.
ATK-XX-1162
atk_search
@search
@smoke   
@content
@empty
Search by a keyword: empty input
ATK-XX-1163
atk_search
@search
@smoke   
@content
@empty
Advanced search: empty input
ATK-XX-1180
atk_feeds (in process)
@feeds
@alters-db
Create a new feed definition, import fixture, validate that data is in the database.