testRigor English-language support documentation

We support a vast variety of commands. The list below contains many examples of how to express them.

If you have a sequence that will be used often, you can save them as a Reusable Rule and refer to it with the name of your choosing.

login
click "Men Clothing"
scroll down
click "Men's cargo shorts"
click "brown"
click "Size 34"
click "Add to cart"
check that page contains "Your order is nearly complete!"

go to checkout page
check page contains "Add to cart"

You can also create rules with dynamic parameters. Rule name:

search "product" click on the link and then press "button"

Steps: (We're going to create variables with the same name you define between quotes.)

enter stored value "product" into "search"
click link stored value "product"
click stored value "button"

example Then you can call the rule like:

Search "Apple Macbook" click on the link and then press "Add to Cart"

The variables defined are scoped and can only be accessed inside the rule.

1. 1. 1. References. check that "peter" color is "ffaabb" will search:
         1. Nested text - example
         2. Placeholder - example
         3. Value - example
         4. data-tid/data-testid/data-test-id/Id/resource-id/data-id - example
         5. Name - example
         6. aria-label - example
         7. CSS Class - example
         8. Label from ML classification - example
         9. Hint/Title/Tooltip - example
         10. Alt/Src - example
         11. For inputs/edits/dropdowns/selects/etc. will also search corresponding label - example
      2. Generic indexes. For example, check that second "peter" color is "ffaabb"
         example
      3. Types. For example, check that input "peter" color is "ffaabb" will fail id "peter" is not an input/edit. Supported types:
         1. text - example
         2. label - example
         3. button - example
         4. link - example
         5. input (or "edit" or "field") - example
         6. dropdown (or "select") - example
         7. checkbox (or "switch") - example
         8. radiobutton - example
         9. file input (or "input file" or "edit file" or "input type file"): specifically an input of type file - example
      4. Typed indexes. For example, check that second input "peter" color is "ffaabb" will find the second input/edit related to "peter".
         example
      5. Stored value for controls. For example, check that stored value "peter" color is "ffaabb" will resolve stored value "peter" and use that resolved value to find the control.
         example
      6. Multiple references. For example, check that "peter" or "john" color is "ffaabb" will find the first control related to either "peter" or "john".
         example
      7. Image class. For example, click on "cart". testRigor classifies images on the screen and if there is a button which looks like a shopping cart it will click on it. Complete list of all button image categories is here.
         example
      8. Stored value for data. For example, check that "peter" contains stored value "actionNote" will find the second input/edit related to "peter".
         example

Multiple references support.

click "checkout" or "submit"

example

click "checkout" or "submit" if exists

example

Selecting elements in reference to other elements

click on button "Delete" below "Actions"

1. 1. to the left of - example
   2. to the right of - example
   3. above - example
   4. below - example
   5. on the right top of - example
   6. on the left top of - example
   7. on the right bottom of - example
   8. on the left bottom of - example
   9. near - example

click on button "Delete" below "Section Name" to the right of "label"

example

1. completely - default overlap with the target area is at least 30% - example
2. with at least "10" percent overlap - similar to above but overlap can be specified - example
3. roughly - element is anywhere below the cut line for "below", to the right of for "to the right of" - example

enter "Peter" into roughly below "Section"
enter "Peter" into element with at least "1" percent overlap on the right of "Description"

enter "Peter" into "Section" below and on the right of "Description"

enter "Peter" into "Section" roughly below and completely on the right of "Description"

Selecting elements in the context of other elements

click on "Delete" within the context of table "actions" at row containing "id1" and column "Actions"

example

click on "Delete" within the context of "sectionTwo" below "Actions" and to the right of "rowName"

Selecting elements using reference to other elements and in the context of other elements

1. Context is processed first, narrowing what to consider to what is inside that element
2. References to other elements is processed next, only considering what was delimited by the context

click on "Button" below "Title" in the context of "sectionOne"

example

click on "Button" below "Title" and to the right of "leftHeader" in the context of "sectionTwo"

example

click on "Button" below "Subtitle" and to the right of "leftHeader" in the context of "sectionOne" below "Title" and above "Second Title"

example

Specifying the type of an element

click on strictly button "Delete"

example

Case sensitivity and exact matches

click on exactly "Delete"

example

click on strictly button exactly "Delete"

example

1. case sensitive
2. exactly (case sensitive full string must be exactly the same)
3. full string (not necessarily case sensitive)
4. contains template contains substring which matches a simple template
5. contains regex contains substring which matches a regular expression
6. matches template the full string must match a simple template
7. matches regex the full string must match a regular expression
8. strictly less lexicographically strictly earlier (empty strings are always not less)
9. less or equal lexicographically earlier or equal (empty strings are always not less or equal)
10. strictly more lexicographically strictly later (empty strings are always not more)
11. more or equal lexicographically later or equal (empty strings are always not more or equal)

Fine-tuning access

click deepest element "Delete"

example

Specifying position on screen

click on "Delete" with offset "20,10"

click in the middle of the screen

1. in the middle of the screen - example
2. in the top quarter of the screen - example
3. in the second top quarter of the screen - example
4. in the bottom quarter of the screen - example
5. in the second bottom quarter of the screen - example
6. in the top third of the screen - example
7. in the bottom third of the screen - example
8. in the left quarter of the screen - example
9. in the second left quarter of the screen - example
10. in the right quarter of the screen - example
11. in the second right quarter of the screen - example
12. in the left third of the screen - example
13. in the right third of the screen - example
14. in the left side of the screen - example
15. in the right side of the screen - example
16. in the top of the screen - example
17. in the bottom of the screen - example
18. on the left edge of the screen - example
19. on the right edge of the screen - example
20. on the top edge of the screen - example
21. on the bottom edge of the screen - example
22. in the left top corner of the screen - example
23. in the right top corner of the screen - example
24. in the left bottom corner of the screen - example
25. in the right bottom corner of the screen - example

generate from regex "[a-z]{10,18}", then enter into "Notes" and save as "actionNotes" //example
validate that stored value "actionNotes" color is "ffaabb" //example
check that "peter" contains stored value "actionNote" //example
click on stored value "actionNotes" //example
check that page contains stored value from "actionNotes" //example

enter stored value "username" into "username_field" //example
enter stored value "password" into "password_field" //example

enter from the string with parameters "${homePrefix}/my/path" into "urlPath"

example

check that expression "${a} + ${b}" itself is equal as a number to "42"

example

check that page contains expression "var aDate=new Date();aDate.setDate(aDate.getDate()-30);''+aDate.getFullYear()"

1. username - example
2. password - example
3. homeDomain - example
4. homeFile - example
5. homePrefix - example
6. todayYear - example
7. todayYearShort - example
8. todayMonthNumber - example
9. todayMonthNumberTwoDigits - example
10. todayMonth - example
11. todayMonthShort - example
12. todayDayOfMonth - example
13. todayDayOfMonthTwoDigits - example
14. todayDayOfWeek - example
15. todayDayOfWeekShort - example
16. nowHour - example
17. nowHourTwoDigits - example
18. nowMinute - example
19. nowMinuteTwoDigits - example
20. nowSecond - example
21. nowSecondTwoDigits - example
22. nowNanosecond - example
23. nowDateIso - example
24. nowTimeIso - example
25. nowDateTimeIso - example
26. nowMillisecondsFrom1970 - example
27. nowDateTimeRFC1123UTC - example
28. nowUnixTime - example
29. testSuiteParentFolder - example
30. testSuitePath - example
31. testSuiteName - example
32. testCaseName - example
33. testCaseExecutionLink - example
34. currentUrl - example

grab value from "some-element" and save it as "my-email"
grab value from input "some-edit" and save it as "my-email"

example

generate from regex "[a-z]{10,18}" and save as "actionNotes" //example
save value "Peter" as "name" //example

click "Next" until page contains stored value "previously generated id"

example

click "Next" up to 12 times until page contains strictly button "Place order"

example

Go To The Next Page until page contains stored value "previously generated id"
Do Something up to 12 times until page contains strictly button "Place order"

You can verify visual changes on the screen using the following sample steps:

compare screen
compare screenshot to previous version
compare screen to previous version with allowance of "1%" treating error as "minor"
compare screen to previous version treating error as "minor"

It is possible to save a sample screenshot in test data and use it as the point of comparison instead of the previously saved screen image:

compare screen to stored value "Saved Screenshot"

Regarding the severity parameter, the allowed values are "minor", "major", "critical", or "blocker". The default value is "critical", which marks the test case as failed. Similarly, there is an option to use the "allowance" clause, a minimum acceptable difference in percentages. Any difference below this value will be ignored. You may need to experiment with this parameter. In any case, you can find actual discrepancy in "Extra info" for a particular step. On mobile devices we ignore the status bar on top. This is so because there is a time stamp that may be different for each screenshot. For this task you can also use Applitools. To enable Applitools integration you need to configure and enable it first. There is a documentation guide with the steps to do it. To use the algorithm in tests you need to add "using Applitools" clause. E.g.:

compare screen using Applitools
compare screenshot using Applitools
compare screens "Screen Name" using Applitools
compare screen using Applitools treating error as "minor"
compare screens "Screen Name" using Applitools treating error as "major"

The screen name and the severity of the error when the screens mismatched are optional. You can use the screen name to identify the screenshot in the Applitools application. If you didn't put the name it will be called as "Image n", where n is the index of the screen in the test case. For instance, you can use this command 3 times in one test case, this way names would be "Image 1", Image 2" and "Image 3". If Applitools identify a mismatch in the screen comparison, the test case will be marked according to severity and a link to the Applitools report will be provided. Applitools always compare the current screenshot with itself baseline. You can set the baseline of each screenshot in the Applitools application. If you don't do it, the first version of each screen would be considered it's baseline.

Clicking on specific images with visual testing

click on the 6th element by image from stored value "logo" with less than "10" % discrepancy

click by image from stored value "logo" with less than "10" % discrepancy

click on table "actions" at row "103" and column "Action"

example For the table will result in a click on "Open channel".

click on table "actions" at row containing "spk2" and column "Actions"

example

click on "Ignore" within the context of table "actions" at row containing "spk2" and column "Actions"

example

enter "york1" into first table at the second header row and column "Id"

example

check that table "actions" at row "102" and column "Name" contains "Spock" //example
check that table "actions" at row "101" and column "Additional Data" has value "Looks like a trap" //example
enter "This is a trap!" into table "actions" at row "101" and column "Additional Data" //example
click "Open channel" within the context of second table at row "103" and column "Action" //example
check that the second table at row containing "Nyota" and column "Action" contains link "Open channel"
click the first button within the context of second table at row containing "Nyota" and column "Action"

click "element" if page contains "bla" //example
enter "macbook" into "search" if "Search in" has value "bla" //example

click "element" if exists //example
enter "bla" into "element" if exists //example

the above commands will not fail if element is not found and will be skipped silently.

My Rule if page contains "bla"
Purchase Product if "Search in" has value "Products"

fail //example
fail with "error" //example

call api <TYPE> "<API_URL>" with headers "a:a" and "b:b" and body "body" and get "JsonPath" and save it as "variableName"

call api post "http://dummy.restapiexample.com/api/v1/create" with headers "Content-Type:application/json" and "Accept:application/json" and body "{\"name\":\"James\",\"salary\":\"123\",\"age\":\"32\"}" and get "$.data.name" and save it as "createdName"  and then check that http code is 200

example

call api "api" and save it as "variableName"

JsonPath is the way to refer to parts of JSON and described with examples here. If "JsonPath" is not defined in the action, the complete result of the request will be stored in "variableName".

1. get - example
2. post - example
3. put - example
4. patch - example
5. head - example
6. delete - example
7. options - example
8. trace - example

testRigor supports multiple headers separated by "and" like so: with headers "a:a" and "b:b" You can pass JSON into the body of POST message, with double quotes characters escaped like so: "\"". You could use tools like this to escape it for you. For example, and body "{\"name\":\"James\",\"salary\":\"123\",\"age\":\"32\"}"

call api post from the string with parameters "${homePrefix}/api/v1/create" with headers "Content-Type:application/json" and "Accept:application/json" and body text starting from next line and ending with [END]
{
"param": "value",
"param2": "value2"
}
[END] and get "$.data.name" and save it as "createdName"

call api post from the string with parameters "${homePrefix}/api/v1/create" with headers "Content-Type:application/json" and "Accept:application/json" and body from the string with parameters text starting from next line and ending with [END]
{
"param": "value",
"param2": "${dynamicValue}"
}
[END] and get "$.data.name" and save it as "createdName"

check that stored value "createdName" itself contains "James"

mock api call <TYPE> "<API_URL>" returning body "<MOCK_BODY>"

mock api call get "https://dummy.restapiexample.com/api/v1/employees" with headers "a:a" returning body "This is a mock response" with http status code 200

In the example above any get calls to the endpoint "https://dummy.restapiexample.com/api/v1/employees" with the headers "a:a" will reponse the testRigor mock with status 200. Some useful cases are:

• You might want to use mocking apis if you are using third party api calls, those calls can be charded and expensive so you can mock the responses insted of call the real service.
• You can test your application individually if servers are instable or down.
• You can test specific scenarios, for example if you want to test a scenario where de server returns error.

enter stored value "keyName" into input file "fileField" //example
enter "<FILE_URL>" into file input "fileField" //example

Where "fileField" is a file input element, i.e.: input type="file" ... You can upload the file into testRigor store in "Test Data" section, then use it by name as stored value. Alternatively you can use your own URL. If you choose to upload from your own URL, the link should be downloable. In any case the file is uploaded from within testRigor environment.

upload file from saved value "sampleFile"
upload file "https://some-page.com/path-to-file" to mobile device

Multiple files

enter from the string with parameters text starting from next line and ending with [END]
${file_var_one}
<FILE_URL>
[END] into file input "myFileInput"

example

Working with folders

If the input element has a webkitdirectory attribute, e.g. - <input type="file" webkitdirectory ... this element is expecting a folder. If you try uploading a file, we will put it into a temporary folder and enter that value. However, if you want to upload an actual folder, you can zip the folder and use it as an input. In such case, we will unzip the file, preserving directory structure and enter the root path. This is similar to the drag folder action. Note: This does NOT work in headless mode. It also does NOT work with Internet Explorer

Template files

some value, ${variable1}, another value
${variable2}, fixed value, ${variable3}

example

enter template stored value "keyName" into input file "fileField"
enter template "<FILE_URL>" into file input "fileField"

example

testRigor supports making a call through Twilio . There is a section in the application configuration under Integrations for setting Twilio parameters; it is required for making calls.

call "+15344297154" and validate it was picked up //example
make call to "+15344297154" and check it was answered //example
call to +15344297154 //example
call "+15344297154" and check it was completed //example
call "+15344297154" from "+15551234567" and verify it is ringing //example
check that phone call from "+15344297154" is ringing //example
check that phone call from "+15344297154" was answered //example

call from stored value "allocatedNumber" to stored value "answerPhoneNumber"

example

You can send messages thanks to Twilio integration. There is a section in the application configuration under Integrations for setting Twilio parameters; it is required for sending messages.

sms "+15344297154" with body "this is content" and validate it was sent //example
send sms to "+15344297154" with content "this is content"
send message to "+15344297154" with text "this is content" and check it was delivered //example
send message from +15551234567 to "+15344297154" with text "this is content" and check it was failed
message from +15551234567 to "+15344297154" with body "this is content" and check it was not delivered

Number from which to send message is optional and may need to be allocated prior to using.

check that sms from "+12345678901" to "+12345678902" contains "Code" and matches regex "Code\:\d\d\d\d" and save it as "sms"

check that sms to "+12345678902" matches regex "Code\:\d\d\d\d" and save it as "sms"
extract value by regex "(?<=Code\:)[0-9]{4}" from "sms" and save it as "confirmationCode"

send sms from stored value "allocatedNumber" to stored value "answerPhoneNumber" with content from string with parameters starting from next line and ending with <END>
${answerCode} b
<END>

example You can request a temporary phone number from Twilio . There is a section in the application configuration under Integrations for setting Twilio parameters; it is required for making calls.

allocate a temporary number and save it as "newNumber"

This custom step will request a new phone number (Twilio charges will apply) and save it in a variable "newNumber", which you can use to check for incoming calls or messages. When the test run finished, this number will be released automatically.

click "Sign in"
enter "jacob" into "Username"
enter "jacobs-secure-password" into "Password"
click "Verify me"
check that sms to "+12345678902" is delivered and matches regex "Code\:\d\d\d\d" and save it as "sms"
extract value by regex "(?<=Code\:)[0-9]{4}" from "sms" and save it as "confirmationCode"
enter saved value "confirmationCode" into "code"
click "Continue to Login"
check that page contains text "Welcome, Jacob!"

login

example This action identifies and performs the necessary steps required to login to the application automatically. After running successfully the first time, it creates a rule named Autogenerated Login for the application containing the identified steps, that you can override by creating a reusable rule with the same name.

enter stored value "username" into "email"
enter stored value "password" into "password"
click "Log In"

Note that login command relies on having login credentials configured for your application on testRigor.

send email to "[email protected]" with subject "Test message" and  body "Hi, this is a test, this is just a test message."
check that email from "[email protected]" is delivered

example

send email from "[email protected]" to "[email protected]" with  subject "Test message", and  body "Hi, this is a test, this is just a test message.", and attachment from saved value "Sample File"

example

send email from "[email protected]" to "[email protected]" with  subject "Test message", and  body "Hi, this is a test, this is just a test message.", and attachment "http://online.com/file/name.pdf"

example

1. "to" and "from" can be used at the same time. If not specified, "from" address will default to "[email protected]".
2. A stored file defined in "Test Data" can be used as an optional attachment. An attachment can also be a link to a file available online without username/password.
3. Both "from" and "to" addresses can be filled from stored values (e.g., "to saved value "newEmail"" and/or "from saved value "newEmail"")

check that email to "<random-user>@testrigor-mail.com" from "[email protected]" is delivered //example
check that two emails to "[email protected]" and "Confirm" in subject were delivered //example
check that one or more emails to "[email protected]" and "Confirm" in subject were delivered //example
check that email to saved value "newEmail" was received //example
check that email to saved value "newEmail" from "[email protected]" and "Confirm" in subject was received //example
check that email to saved value "newEmail" and "<regular expression>" in subject was received

check that email to "<random-user>@testrigor-mail.com" and "Confirm" in subject was received and show in mobile

example

check that email to "<random-user>@testrigor-mail.com" from "[email protected]" was not delivered

example

1. If the email count is not specified, we assume that only one message is expected. Multiple emails are treated as an error; so in order to avoid receiving the error message, specify the number of emails that should be expected or simply inform the system that more than one can be sent ad done below:

   check that one or more emails to saved value "<random-user>@testrigor-mail.com" were received

   example
2. The user should send a message to the following address: <random-user>@testrigor-mail.com, where <random-user> cab be any valid email handle. In order to avoid a conflict it is recommended that the user handle will contain customer name and some random part, e.g. [email protected] This is important when you are running email tests in multiple browsers and/or on multiple machines at the same time. In this case it is your responsibility to ensure that you are not getting messages, meant for another test case run.
3. The user is expected to add some wait time before checking email. This check action will validate delivery, but not wait for the message to arrive. For example,

   wait 2 minutes

4. Once the action has been executed successfully, the message is deleted from the mailbox and rendered in a new tab. Multiple emails will be marked as error, but each one will be rendered in a separate tab. You can switch between tabs using switch to tab "1", switch to tab "2", etc. Note that old content will stay in the tab before the first rendered email message. In most cases it is tab "1", unless you opened more tabs.
5. Each email tab is rendered as an html page, so you can use any actions that you would use on an html page. There are a few useful element ids that will help getting specific parts of an email:
   • "message-froms" a list of "From" addresses (usually one address)
   • "message-subject" subject line
   • "message-date" message sent date and time in Pacific Time zone.
   • "message-tos" a list of "To" addresses
   • "message-ccs" a list of "CC" addresses
   • "message-bccs" a list of "BCC" addresses
   • "message-reply-to" "Reply To" address
   • "message-text" the message text
   • "message-attachments" a list of attachments (file names only)
6. If you want to check again, you need to re-send the mail. Your custom actions cannot contain multiple "check" actions for the same message.
7. Multiple recipients can be separated with "and":

   send email to saved value "newEmail" and saved value "newEmail2" with subject "Test" and body "Hi"

   example
8. When checking emails we only take into account those sent after a specific test case has started. This is to avoid a conflict when an email was left unchecked from a previous, unfinished run.

Example of a test for a sign-up flow:

click "Sign up"
generate unique email and enter it into "Email", then save it as "generatedEmail"
generate unique name and enter it into "Name", then save it as "generatedName"
enter "PasswordSuperSecure" into "Password"
click "Submit"
check that email to stored value "generatedEmail" was delivered
click "Confirm email"
check that page contains "Email was confirmed"
check that page contains expression "Hello, ${generatedName}"

set cookie "cookie value" as "cookie-name" //example
set cookie from saved value "variableName" as "cookie-name" //example
get cookie "cookie-name" and save it as "variableName" //example
clear cookies //example

set item "item-data" in sessionstorage as "item-name" //example
get item "item-name" from session storage and save it as "varName" //example
clear sessionstorage //example
set item "item-data" in localstorage as "item-name" //example
get item "item-name" from local storage and save it as "varName" //example
clear localstorage //example

set user agent to "My User Agent" //example
unset user agent //example

click "my-cryptic-button" // actually clicks "add to cart"

example

You can test audio by recording it and then comparing it with another recording in the same test or an external file.

Recording

record audio through 10 seconds after clicking "audio-trigger" and save as "my-recording"

record audio from "my-audio-tag" through 20 seconds after clicking "audio-trigger" and save as "my-specific-recording"

Comparing

check that audio from "my-recording" is "70%" similar to "my-specific-recording"

check that audio from "my-recording" is "85%" similar to "https://some-page.com/path-to-file"

The supported file extension for external files is .wav

check that audio from "my-recording" is "99%" similar to "my-specific-recording"

check that audio from "my-recording" is "1%" different to "my-specific-recording"

Playing

If you need to reproduce audio as it was someone speaking through a microphone you could load the .wav that is going to be reproduced from a remote file. For tests running in linux, virtual devices are used (microphone/speakers) otherwise we attach to existing < audio > tags

play audio "https://some-page.com/path-to-file"

play audio "test-data-ref"

play audio "sound-to-play-ref" after clicking "start-recording" then click "stop-recording"

check that audio is playing

check that audio is not playing

You can use SQL in the steps for getting or inserting rows.

Select

run sql query "select top 1 UserID, LastName, FirstName from Users;"

example

enter stored value "FirstName" into "First name"
check that stored value "LastName" itself contains "Doe"

example

Insert

run sql query "insert into Users(UserID, FirstName, LastName) values (3, 'Jon', 'Doe');"

example

Multiple Connections

run sql query "select top 1 UserID, LastName, FirstName from Users;" using connection "connectionName"

Overriding the settings

Save value "user" as "connectionName:usernameJDBC". 
Save value "pass12345" as "connectionName:passwordJDBC
Save value "jdbc:mysql:host:port" as "connectionName:connStringJDBC"
run sql query "select top 1 UserID, LastName, FirstName from Users;" using connection "connectionName"