Testing with HCL OneTest API

Before you begin

You must have completed the following tasks:

Installed HCL OneTest™ API Extension for HCL OneTest™ API.
Installed HCL OneTest™ Performance Agent and HCL OneTest™ API Agent to run tests remotely. When you install HCL OneTest™ API, you must have selected the This Agent will only run probes option.
Defined the environment variable INTEGRATION_TESTER_AGENT_HOME on each location where the Agent is installed, and have pointed to the root installation directory of HCL OneTest™ API Agent.

Note: The environment variables INTEGRATION_TESTER_HOME and INTEGRATION_TESTER_AGENT_HOME are automatically created when you install HCL OneTest™ API 10.2.2 or later.

Setting environment variable

You must set the environment variable INTEGRATION_TESTER_AGENT_HOME and point it to the HCL OneTest™ API Agent installation directory if you are using HCL OneTest™ API Agent 10.2.1 or earlier.

Run the following command to set the environment variable on Windows:
```
INTEGRATION_TESTER_AGENT_HOME = C:\Program Files\HCL\HCLProducts\Agent
```

Run the following commands to set the environment variable on Linux:

INTEGRATION_TESTER_AGENT_HOME=/opt/HCL/HOT-API-Agent
export INTEGRATION_TESTER_AGENT_HOME
echo $INTEGRATION_TESTER_AGENT_HOME

If the environment variable is not set, the compound or schedule test run fails with an error message as depicted in the following image:

Connecting to an existing API project

When you connect both the products any change or delete action made in one product workspace is reflected on the other product workspace, if both the products are installed on your machine.

Warning: If you delete a project from the Test Navigator, be sure that the option Delete project contents on disk is not selected in the Delete Resources dialog, otherwise the project would be deleted in HCL OneTest™ API if it is connected. If the option is selected, the project is deleted in both the products.

If the option is selected, the project is deleted in both the products.

In HCL OneTest™ UI, right-click on the Test Navigator, select New > Other > HCL OneTest API > Connect to an HCL OneTest API Project and click Next.
In the wizard page, click Browse and select the root folder that contains the project.
If the path contains a project, its name should automatically appear in Project Name and the Finish button should be enabled.

Setting HCL OneTest™ API preferences

To be able to open an HCL OneTest™ API project from HCL OneTest™ UI Test Navigator, you need to have both the products installed on the same computer, and you must set the path to the execution file in the Preferences.

In HCL OneTest™ UI, click Window > Preferences > Test > HIT Integration.
Click Browse and set the installation path to HCL OneTest™ API execution file. On Windows, the default location can be C:\Program Files\HCL\IntegrationTester.exe.
Click Apply and OK.

Opening HCL OneTest™ API resources from the Test Navigator

Once the preferences are set, you can open an HCL OneTest™ API project.
In the Test Navigator, open the project root node and children nodes, and at any level, right-click and select Open in HCL OneTest API Workbench.
If HCL OneTest™ API is automatically detected, the workspace opens for the selected resources.
If HCL OneTest™ API is not detected, a dialog opens on a Preference page where you need to verify the path to the execution file.
Warning: HCL OneTest™ API cannot open more than one project at a time. If you have another project open, an error is displayed. In that case, close HCL OneTest™ API and try to open the project again.

Importing HCL OneTest™ API project

If both the products are not installed on the same machine, you can import an HCL OneTest™ API project in your workspace. Another reason for the import is when you have HCL OneTest™ API installed but you do not want to connect to the HCL OneTest™ API project. In that case, the project is duplicated, any updates in one product workspace is not reflected in the workspace of the other product.

To import an HCL OneTest™ API project:
Right-click on the Test Navigator, choose Import and select Existing project into workspace.
Choose Select root directory or Select archive file; select a project to import and click Finish.
The selected project appears in the Test Navigator and the compound test editor automatically opens.

Modifying HCL OneTest™ API environments in UI Test perspective

In the compound test, you can select HCL OneTest™ API tests and change the environment of each test. The environments are set in HCL OneTest™ API, you can only change the selection from the edited compound test.

Open the compound editor and select a test.
In the HCL OneTest™ API details, you can browse and change the properties of the selected test. The Test path, the Environments and Description are automatically updated accordingly.
To select another environment for the Integration Tester test, use the dropdown menu.

Alternatively, you can change the environment selection for a test for a collection of tests:

Right-click on the tree at any level under a node in the compound test and select Replace HCL OneTest API Environments.
In the Set Invocation Tester Environments wizard, the first page displays the list of projects that use the selected environment and the number of tests from project that use this environment in the compound test.
Select another used environment in the dropdown list. Click Finish. The new choice applies to the selected node and its children.

Next step is to create a compound test in HCL OneTest™ UI to run the test. See Running HCL OneTest API tests.

To map the tags in HCL OneTest™ API with variables in HCL OneTest™ UI, you must follow these steps:

Click the HCL OneTest™ API test that contains the tags that you want to map.
The HCL OneTest™ API tags are displayed in the Integration Test Details pane.
Click the tag that you want to map with the variable in HCL OneTest™ UI.
Click the Ellipses button inline with the tag that you want to map with a variable.
The Variable Selection dialog box is displayed.
Select the variable, and then click OK.
The tag is mapped to the selected variable and it is displayed in the Variable column.

Note: While you map a tag in HCL OneTest™ API test to a variable in HCL OneTest™ UI, you can map only tags that contain the string value to variables. You cannot map a tag that contains multiple values to a variable in HCL OneTest™ UI.

You can add a dataset mapper in the compound test for tests that are using multiple tags. See Adding Dataset Mapper to map tags in the HCL OneTest™ API tests with the variable values of HCL OneTest™ UI.

Testing with HCL OneTest™ API