Module variables and data-driven testing

As mentioned above, local or global code variables cannot access external data. This is where module variables come in. Module variables act as a bridge between an external data source and the code module.

1. 1. External data source added to the test suite by way of a CSV connector.

   2. Module variable in the test suite view, bound to the external data.

   3. Module variable in code.

Now let's create a code module that pulls the first name from an external data source and enters it in the respective database field. This process is the same for all fields that use action variables.

For gender and department, which are radio buttons and list elements, connect module variables to repository variables. This is explained further below.

1. Create a new code module and name it InsertPerson.cs.

2. Right-click below the empty constructor and click Insert new module variable…

3. Name the module variable varFirstName, enter John as the default value, and click OK.

Ranorex Studio will create a module variable definition with the following content:

1. 1. Private string constant _varFirstName with the default value of the variable.

   2. Internal reference.

   3. Public module variable varFirstName with Get and Set methods.

The variable also appears in the UI of Ranorex Studio:

1. 1. Variable in the module browser as part of the code module.

   2. Unbound variable in the test suite view next to the code module.

This shows that the module variable has been defined correctly and is recognized outside of the code module. It’s ready to be fed with external data.

The module variable is defined, but now it needs to be connected to the correct repository item. Otherwise, the value received from the external data source ends up nowhere.

Connect the module variable to the repository item representing the text field for the first name:

1. At the beginning of the class InsertPerson, add a private, static repository.
   

2. Instantiate the repository in the previously empty constructor.
   

3. Implement the data transfer from the module variable to the repository item in the Run() method.
   

Finally, to complete the data chain from the external data source to the repository item, bind the module variable to the data. This is done through the Ranorex Studio UI and not in code.

Reference: Managing and assigning data sources is explained in Manage and assign data sources and Data binding.

To bind the module variable(s) to the data:

1. Add a CSV data source using a CSV data connector and name it myData. You can find the CSV file RxTestDatabase.csv in the sample solution. Alternatively, create your own CSV file.

2. Assign the CSV data source to the test case that contains the code module.

3. Under Data binding…, bind the column FirstName to the module variable varFirstName and repeat for the other columns.

The data chain is now complete. The module variable pulls data from the external data source and then passes it to the repository item.

Just like the value of a text entry action, repository items can also be made variable. This is particularly useful for UI elements like menu entries, list elements, radio buttons, etc. The variables used for this purpose are called repository variables. In our example, this applies to the gender and department entries, as they are radio buttons and list elements, respectively.

In this section, we’ll show you how to use module variables to address existing repository variables in code. This requires that you first define them in the Ranorex Studio UI, which is explained here. First, take a look at the radio buttons, and then list elements.

Test scenario

Test to select the radio button based on values (“Male” or “Female”) and pull from a data source. In a recording module, the solution would look like this:

1. 1. Gender radio buttons in the database of the Ranorex Studio Demo Application.

   2. Variable repository item that represents the radio buttons. Note the repository variable $varGender in the RanoreXPath.

   3. Mouse-click action linked to the variable repository item.

Reference: For more details on how this is accomplished with a recording module, please refer to Define variables or take a look at the sample solution for this chapter.

Address radio buttons

In a code module named SelectGender.cs, carry out the following steps:

1. In the class SelectGender, declare the private, static repository myRepo.
   
   

2. Instantiate the repository in the constructor of the SelectGender class.
   

3. Below the constructor, insert the module variable ModVarGender. This module variable will take on the value of the repository variable $varGender. Complete the code as follows to implement the selection functionality:
   

1. Get method that returns the current value of the variable $varGender.

2. Set method

Sets the value of the variable $varGender to the current value pulled from the data source through data binding.

Then calls the Select() method to select the radio button defined by the value of the variable.