Leapwork Test Automation is often used in conjunction with Test Management products. This document describes the integration between Leapwork Test Automation and ALM Octane Test Management.
Leadwork’s no-code Test Automation technology makes it quicker and easier for regular business users and IT teams to adopt, so that they can scale automation faster - ultimately empowering quality assurance teams, leading to shorter test cycles and immediate return on investment. This means that enterprises can continue to grow and optimize their performance because they can rely on their business software to work as it should, with test automation as an integral part of their software development lifecycle.
The role of software testing is becoming increasingly important in the software development lifecycle to ensure that software is released with the highest possible quality. With an increased amount of testing, more advanced test plans and strategies, it is evident that a proper test management tool is needed. ALM Octane is a web-based application lifecycle management platform that enables teams to collaborate easily, manage the product delivery pipeline, and visualize the impact of changes.
CI-CD Pipeline implementation of the Continuous Integration/Continuous Deployment software is the backbone of the modern DevOps environment. Most of the organization using DevOps practices and using Jenkins. Jenkins is an open source CI tool which can be used to execute the Leapwork tests. Jenkins is a Continuous Integration tool which does this verification periodically or whenever the developer pushes the code to the repository.
Both Leapwork and ALM Octane integrate natively with Jenkins, and so with each other.
Picture 1: Example of Leapwork reporting in Octane
Both the ALM Octane and Leapwork plugins are installed from within the Jenkins “Plugin” store.
Open Manage Jenkins -> Manage Plugins
Picture 2: Plugin configuration in Jenkins
Leapwork plugin for Jenkins: Leapwork Integration
ALM Octane integration: Micro Focus Application Automation Tools
Picture 3: Leapwork Plugin in Jenkins
This section will describe the configuration of the different components in Leapwork, Octane and Jenkins
Picture 4: Architecture of Octane integration and Jenkins.
Picture 5: Entity relationships between Octane and Leapwork
ALM Octane configuration
Before configuring the Jenkins pipe, few things need to be configured in ALM Octane:
To set up CI/CD integration, use the ALM Octane CI Plugin:
In Settings > Spaces, select a workspace > API Access, obtain an access key and secret key that are assigned the CI/CD integration role in the relevant workspaces.
- Download the plugin from the plugin web pages.
- Install the plugin on your CI server.
- The space admin can obtain the Client ID and Client secret in ALM Octane Settings. The access keys must be assigned the CI/CD Integration role in all relevant workspaces. For details, see Set up API access.
- In the plugin configuration, enter the access key and secret key for accessing ALM Octane.
Picture 6: Adding Access Key
Picture 7: Assigning Role to API Access Key
Picture 8: Click on Copy and OK
Picture 9: API Access Key created successfully
Add CI servers on ALM Octane
For ALM Octane to integrate with a CI server, the servers and their URLs must be added in ALM Octane. Before aiding CI server, please make sure you have ALM Octane plugin configured correctly in “ALM Octane CI Configuration section” in Jenkins.
In Settings > Spaces, select a workspace.
Picture 10: Selecting Workspace
Click the DevOps tab. On the left side of the pane, select CI Servers.
Picture 11: Going to Devops tab and configuring CI Server
Click + to add a CI server and enter a name for the server.
Picture 12: Adding CI Server
Select a URL from the list of CI servers.
The list displays all servers that meet the following conditions:
The server has the ALM Octane CI 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.
You can now create pipelines in ALM Octane that reflect the ones running on the CI server.
For more information on setting up CI Server, please click here.
NOTE: The ALM Octane API keys are not the same as Jenkins Instance ID!
The Leapwork configuration is limited to:
- Creating an API key. (Settings-> API access Keys). Make a note of the key
- A Runlist. Create a runlist with required test (flows).
- A Schedule Create an “on Demand” schedule and make a note of the name.
Picture 13: Run lists in Leapwork
First step in Jenkins is to configure the ALM Octane server instance. In Jenkins goto:
Manage Jenkins -> Configure System
When the ALM Octane plugin is configured correctly you will find an “ALM Octane CI Configuration section”. Configure the server details. For credentials press “add” and use the ALM Octane Client ID and API key created previously. Use the “test connection” button to test the configuration, click on the save button once the connection is successfully tested.
Picture 14: ALM Octane configuration in Jenkins
Then press “New Item” button in Jenkins. A logical name could be similar to the Runlist \ Test plan names. Next to optional other configuration, press the “Add build step” button and select “Leapwork integration”. The Leapwork plugin will appear. Configure the following steps:
Picture 15: Leapwork plugin configuration in Jenkins
After configuring the Leapwork Plugin you may configure the ALM Octane plugin. Press the button “Add post-build action” and select “Publish JUnit test result report Task”. Configure the following steps:
Picture 16: ALM Octane plugin configuration in Jenkins
Adding ALM Octane Pipeline in Jenkins
- After creating a new project ( described above), open it and select ALM Octane Pipeline from left pane.
Picture 17: Creating ALM Octane Pipeline
2. Configure the following steps and click on Apply:
Picture 18: Configuring Pipeline
Executing the Project
- After configuring the Jenkins for Leapwork and ALM Octane and adding Pipeline for ALM Octane.
- Click on Build Now option.
- As soon as the build is executed, a pipeline with the same name will be created in ALM Octane.
Picture 19: Dashboard created in ALM Octane for the Pipeline created in Jenkins
Execute the pipeline from within ALM Octane
You may want to start the Automated Tests manually from within the ALM Octane Test Plan. In order to do this, in ALM Octane Dashboard browse to Pipelines and follow these steps:
- Click three vertical dots adjacent to the Pipeline name.
Picture 20: Running the existing Pipeline from ALM Octane
2. Select “Run”
For any clarification, please contact our Priority Support.