Set up UFT One integration

This topic explains how to integrate ALM Octane with UFT One via your CI server. This integration enables ALM Octane to reflect the UFT One tests from your source code management (SCM) repository as executable automated tests. You can then include and run these UFT One tests in test suites.

ALM Octane-UFT One integration flow

Once the UFT One integration is set up, the CI server and the SCM system are transparent and you can work with UFT One and ALM Octane directly: 

  • Create and edit your tests and their data tables in UFT One and save them in a Git or SVN repository.
  • Run the tests and track their results in ALM Octane.

The ALM Octane-UFT One integration flow includes the following:

Action Description
Set up To set up the integration, create a CI server and a testing tool connection in the ALM Octane settings. This process is described in the sections below.
ALM Octane discovers UFT One tests and data tables

ALM Octane creates automated test entities to represent the GUI and API UFT One tests stored in your repository.

ALM Octane periodically checks for changes in the repository.

Associate tests with ALM Octane entities

Associate the tests with your backlog and application modules. This helps you use the test run results in ALM Octane to track your product and release quality.

Run tests

Include the tests in test suites to plan and run them from ALM Octane. ALM Octane triggers the test runs via the CI server. The tests run on UFT One machines configured as Jenkins execution nodes.

Analyze release and product quality Track the UFT One test results as part of the overall data in the backlog, quality, and dashboard modules.

The image below summarizes the architecture of this integration with Jenkins. For details on supported CI servers, see Functionality supported by CI integrations.

Back to top

Before you set up the integration

Set up UFT One to store tests and data tables in a Git or SVN repository. For details, see the UFT One Help Center.

Follow these integration guidelines:

  • UFT One-SCM integration is supported for UFT One 12.50 and later.
  • For ALM Octane to locate the data tables in your repository, store them in an entirely separate folder from your tests.

Tip: If you don't have a dedicated CI server, and you only need a lightweight CI to be used primarily for triggering UFT One test runs from ALM Octane, refer to Minimal Jenkins Installation for ALM Octane.

Back to top

Set up connection to ALM Octane

In your CI server, set up the connection to ALM Octane.

Back to top

Add the CI server in ALM Octane

In ALM Octane, add your CI server.

To add the server:

  1. In ALM Octane, click Settings > Spaces and select a workspace.

  2. Select the DevOps > CI Server tab.

  3. Add a CI server and select your CI server's URL.

For details, see Add CI/CD servers on ALM Octane.

Back to top

Create a UFT One test runner

This section describes how to create a UFT One test runner in ALM Octane.

Note: The test runner framework only supports external data tables on UFT One tests of GUI type (and not API type).

To create a UFT One test runner:

  1. In ALM Octane, click Settings >  Spaces and select a workspace.

  2. Select the DevOps > Test Runners tab.

  3. Click + Test Runner.

  4. Name the test runner entity that ALM Octane will use to run the UFT One tests, and select the UFT framework.

  5. Select your CI server.

    The list displays all servers that meet the following conditions:

    • The server has the Application Automation Tools plugin installed and configured to access your ALM Octane.

    • The API Access keys that the plugin is using are assigned the CI/CD Integration role in the current workspace.

  6. Specify the type and URL of the SCM repository that contains your UFT One tests and data tables.

    You can create multiple UFT One test runners in a workspace, but each test runner must have a separate repository.

  7. If required, provide the authentication details for your repository.

  8. Click Test Connection to make sure the configuration is correct.

  9. Click Save and Connect to complete the connection.

  • If you are integrating via Bamboo, ALM Octane creates two plans: UFT One test discovery that connects to the repository and discovers the UFT One tests and data tables, and UFT One test executor that runs the tests.

  • If you are integrating via Jenkins, ALM Octane creates a Jenkins job that connects to the repository and discovers the UFT One tests and data tables.

Tip: If necessary for troubleshooting, you can find this job on your CI server based on the connection ID.

To enable test execution, see Enable the CI server to trigger UFT One test runs.

The test scripts and the data table content are available in UFT One only.

Tests tab

In the automated test entities in ALM Octane, the following fields are set:

  • Testing tool type = UFT One

  • Test type = API or UI

  • Executable = Yes. These tests can be added to test suites and run from ALM Octane.

If you do not see all of the expected tests in the Tests tab in ALM Octane, try refreshing the list of tests.

What happens when a test is changed in UFT One

ALM Octane continues to periodically check the repository and updates its entities as follows:

  • If you add a new test in UFT One or change an existing one, the changes are reflected in ALM Octane.

  • If you delete a test from UFT One, the relevant test in ALM Octane is not deleted but is marked as not executable. This way, the test and its history, runs, and reports remain available.

  • If you rename a UFT One test in GIT, the test is renamed in ALM Octane if your ALM Octane version is 12.60.3 or later, and the test was committed without additional changes.

  • If you rename a UFT One test in SVN, or if you rename in GIT and do not fill the above conditions, a new test is created in ALM Octane and the original test is marked as not executable

Back to top

Run UFT One tests on-demand using GitLab

You can use the FTToolsLauncher tool to integrate between ALM Octane and GitLab, to execute UFT One tests in GitLab on- demand. This is supported for GitLab 14.3 and later, including GitLab Cloud.

For details on how to set up this integration, see Running UFT Tests using ALM Octane testing framework (Test Runners).

Back to top

Link from ALM Octane to a UFT One automated test

ALM Octane can create links that you can use to drill from your UFT One automated test, directly to the corresponding test in the SCM.

To enable SCM test links:

  1. Create a UFT One test runner as described above.

  2. Define a File in branch template pointing to your SCM repository, as described in Enable links to the Git or SVN viewer.

  3. When a UFT One automated test is discovered by the test runner, the test details in ALM Octane will include an SCM test link field. Click the link to navigate to the UFT test in the repository, based on the template you set in the File in branch template.

Back to top

Enable the CI server to trigger UFT One test runs

This section describes how to enable the CI server to trigger UFT One test runs for Bamboo and Jenkins.

Back to top

Next steps: