Define test and variables – Ranorex Studio

First, define the steps of the data-driven test. Then, define the required variables for this scenario. Also, find out how to manage variables in Ranorex Studio.

Variables are one of the key parts of data-driven testing. They are the placeholders for values you want to feed your test, either from data sources or parameters. In Ranorex Studio, we differentiate between three types of variables: Action variables, their subtype validation variables, and repository variables.

Screencast: The screencast Defining Variables walks you through the information found in this chapter.

Test definition

As usual, use the Ranorex Studio Demo Application for the example. It has a database function that you can test. Testing a database is a common real-world application of a data-driven test.

The test contains the following steps:

Start the Demo App and click the Test database tab.
Add an entry to the database by clicking Add entry.
Repeat until there are 8 entries in the database…
After each entry, validate that the Number of entries updates correctly.
Close the Demo App.

Sample solution and prepared modules

The sample solution already contains all the modules with the necessary actions for the steps above. They are organized in a simple test suite. This serves as our starting point for the next step: replacing constant values in several modules with variables.

Module browser with recording modules structured in folders.
Test suite with a ready-to-run database test scenario.

Define action variables

Action variables replace a constant value in a component or property of an action, for example, the specific text string in a Key sequence action. Action variables are limited to the recording module they’re defined in.

First, let's replace the constant text values in the respective actions for entering the first name, last name, and age of a person in the Demo App database.

Note: In Ranorex Studio, variable names have the pattern $<variablename>, where <variable name> cannot start with a number or contain any special characters, except for underscores.

To replace a constant value with a variable:

Open the drop-down list for the constant value you want to change and click As new variable…
Name the variable so you can easily identify what value it is a placeholder for and click OK.
The variable appears in the action table in green, replacing the constant value.
Repeat the above process for the last name (InsertName module) and the age (InsertAge module).

The final result should look like this:

Variable $txtFirstName replacing the constant value ‘John’ for the first name.
Variable $txtLastName replacing the constant value ‘Public’ for the last name.
Variable $intAge replacing the constant value ’48’ for age.

Note: Action variables can only be used in the recording module you defined them in.

Define repository variables

Aside from making action value variables, data-driven testing often involves creating repository variables. Repository variables replace a certain part of an item’s RanoreXPath, the defining attribute, with a variable. You can make any repository item variable this way. Repository variables are available in the repository they were defined in and all modules that reference this repository.

For this example, make a list selection and radio buttons variable. These are repository items where it often makes sense to make them variable because they are usually part of a selection process with multiple options.

Reference: Read more information about RanoreXPath

Make a list selection variable

Here, let's make the repository item for the Department list selection variable.

In the module SelectDepartment of the sample solution, the Click action is linked to a constant repository item that points to the Project Management entry in the list. In the item’s RanoreXPath, the attribute @text=’Project Management’ is responsible for this.

Let's replace the constant attribute value Project Management with the variable $lstDepartment so the Click action is performed on whatever list entry our future data source specifies.

Note: When we create our data source later, we will need to make sure the entries for the department selection are the same as in the list, or else Ranorex Studio won’t be able to identify the UI elements. For example, there is no entry IT, so a repository item with the resulting attribute @text=’IT’ wouldn’t point to anything.

To define the variable:

Right-click the second Click action and choose Make repository item variable…
Ranorex Spy opens with the constant value of the text attribute already highlighted. Click the variable symbol next to it.
Name the variable so you can easily identify what repository item it refers to and click OK.
In the yellow bar, click Apply.
In the repository, you can now see the variable in the item’s RanoreXPath.

1. Repository variable $lstDepartment replaces the constant value for department selection.

Make radio buttons variable

Here, let's make the repository item for the Gender selection variable.

In the module SelectGender of the sample solution, the Click action is linked to a constant repository item that points to the radio button for Male. In the item’s RanoreXPath, the attribute @controlname=’rdbMale’ is responsible for this.

Let's now replace the constant attribute value in the RanoreXPath of this repository item with a variable ($selGender) so the Click action is performed on whatever Gender radio button our future data source specifies.

Note: When we create our data source later, we will need to make sure the entries for the gender selection are the same as the respective @controlname attributes of the two radio buttons, i.e. rdbMale and rdbFemale, or else Ranorex Studio won’t be able to identify the UI elements. A data source with just Male and Female would not work because the repository item with the resulting attribute @controlname=’Male’ wouldn’t point to anything.

Hint: To make data-driven testing robust against localization (other languages), it is recommended to use attributes such as ControlName.

To define the variable:

Right-click the Click action and choose Make repository item variable…
Ranorex Spy opens with the constant value of the text attribute already highlighted. Click the variable symbol next to it.
Name the variable so you can easily identify the repository item it refers to and click OK.
Click Apply.
In the repository, you can now see the variable in the item’s RanoreXPath.

1. Repository item representing the Gender radio button selection with variable $selGender

Note: Repository variables can be used in the repository you defined them in and all recording modules that use this repository.

Define validation variable

Our example test includes a step that validates whether the database counter updates correctly as entries are added. For this validation to work, we need to make it variable.

So, we’ll replace the constant Match value of the validation action in the ValidateEntries module with a variable.

Note: In principle, validation variables are the same as action variables. However, as the Validation action is more complex than most others, we treat their variables separately and therefore also explain the process separately.

To define the variable:

Open the drop-down list for the Match value and click As new variable…
Name the variable so you can easily identify the value it is a placeholder for and click OK.
The variable appears in the action table in green, replacing the constant value.

Default values

The default value of a variable is the value that is used when no data source is available. This is the case when running a recording module from the recording module view, for example. Therefore, you should always make sure to define a meaningful default value.

Note: When you replace a constant value with a variable, the original constant value is automatically used as the default value.

View and manage variables

You can view the status of variables and manage them in different places: the data binding pad gives you a detailed overview of the status of all variables in a recording module, while the VARIABLES… dialog allows you to add variables and edit them.

Data binding pad

When opened in the recording module view, the data binding pad shows the status of action, repository, or code variables in this recording module and their default values. The data binding pad reflects the icons and status designations from the VARIABLES… dialog. These are explained in the next topic below.

While in the recording module view, click the View data-binding button in the toolbar.
To display action or repository variables, their status (In use/In use from repository/In use in code/Not in use), and their default values, click anywhere in…

2a. The action table

2b. The repository

If the recording module contains variables that are only used in code, then these initially appear under Not in use. The button Identify code variables identifies them and causes them to be displayed under In use in code.

VARIABLES… dialog

This dialog shows you variable status and also lets you add and edit variables.

Open the dialog for managing variables.
For action variables, open the recording where they are defined and click VARIABLES….
For repository variables, click Variables… in the repository view.

The variable management dialog opens:

Variable status, Name, and corresponding Default value
Variable editor toolbar
Options to copy/paste a variable to/from the clipboard.
Option to add a new variable directly.
Option to remove unused variables (variable cleanup).
(Action variable dialog only) Option to copy a repository variable to the current recording module, where it becomes an action variable.
Variable status legend
Variable in use: A variable is used, for example, it is assigned to an action. Does not indicate whether the variable is bound/unbound to a data source.
(Action variable dialog only) Variable in use from repository: Same as previous, but for repository variables that are in use in the action table through a linked repository item.
Variable not in use: Variable is defined, but not assigned to an action item. Does not indicate whether the variable is bound/unbound to a data source.

Overview of defined variables

You now defined all the variables we need for our data-driven test. When you switch to the test suite view, you can now see the number of variables defined per module. Note they are still unbound, i.e. they have not been assigned a data source.

In the next chapter, we’ll define this data source and assign it to our test case. We’ll also discuss the options for managing data sources.

The test suite view displays the defined, but currently unbound variables.

Related to