Micro Focus ALM Octane
The following provides instructions for triggering Automation test executions from within Micro Focus Application Lifecycle Management (ALM) Octane via a Jenkins CI Server in order to create a host and provide a secure webhook endpoint.
Many Provar customers use Micro Focus ALM and Automation to integrate tests and test results. With this integration, you can store Automation test cases in ALM (with full check out and versioning support) and upload automation results into the ALM Test Lab.
Prerequisites
It’s also worth mentioning that this support article is designed for users with experience setting up Jenkins to run Provar tests under Apache Ant. If you don’t have experience or want to learn more, please refer to Running Provar tests on Jenkins for additional information.
Please feel free to contact us with any feedback or assistance with your setup.
Launch ALM Octane
Step 1: Log in to your Micro Focus account.
Step 2: From the Products tab, select ALM Octane and click the Launch button.
Above: View of the Micro Focus Products tab.
Note: Make a note of the project ID populated within the URL. An example is highlighted in yellow below. You will need to use this later in the process. This is required to connect to the Jenkins server.
Above: View of the project ID.
Generate the Client ID and secret from ALM Octane
Step 3: Go to the Administration console > Spaces.
Step 4: Click the active, default shared space within the left-hand menu and click the API ACCESS tab.
Above: View of the API ACCESS tab.
Step 5: Click the Add API ACCESS button and enter an endpoint name. Jenkins is used in these example screenshots.
Step 6: In Role, select CI/CD Integration. Within the In Workspaces field, select the workspace that you want to connect with Jenkins.
Above: View of the API ACCESS screen.
Step 7: After clicking the Add button, the system will generate the Client ID and the Client Secret. Copy the content and save it in a secure place.
Above: View of the Client ID and Client Secret dialog box.
Set up ALM Octane plug-in in Jenkins
Step 8: Log in to your Jenkins server go to Manage Jenkins > Plugin Manager, and install the Micro Focus Application Automation Tools plugin. A Jenkins server restart is required.
Step 9: Go to Manage Jenkins > Configure system and scroll to ALM Octane CI. This section allows you to configure the plug-in and provide the connection details.
Enter the location of the ALM Octane server. This is the portion of the URL before the project space ID. Enter the Client ID, Secret, and the Jenkins user.
Above: View of the ALM Octane Server Configuration screen.
Step 10: Click the Test Connection button to verify the connectivity.
Add the CI server in the Workspace
Step 11: In ALM Octane, go to the Workspace > DEVOPS tab. Click the Add CI Server button (highlighted in yellow below) and select the CI server from the dropbox. Ensure the connected status displays a green check-mark indicating it was successfully completed. If not, check your connection again in the previous step.
Above: View of the DEVOPS tab within ALM Octane.
Set up a Jenkins job to execute Automation tests
Step 12: Create a new job in Jenkins and set up a build step to execute your Provar build.xml file using Apache Ant.
Above: View of the Jenkins build step.
Step 13: In the Post Build Actions, select the Publish JUnit test result report plug-in and add the JUnit.xml path.
Above: View of the Post-Build Actions screen within Jenkins.
Execute the Jenkins job and check your results
Step 14: Execute your job in Jenkins and check that the operation works correctly when you click the local build option.
Step 15: To execute the job from ALM, go to the ALM Octane console and then Pipelines. Select the Jenkins job you created earlier and click on the Run button.
Above: View of the Pipelines tab within the ALM Octane console.
Step 16: After the execution of the job, the status will be visible in the Overview screen.
Above: View of the Overview screen with job status information.
Step 17: The number of executed tests with status information can be visible within the TESTS tab. Logs can be visible within the LOGS tab.
Above: View of the TESTS tab within the ALM Octane console.
Above: View of the LOGS tab within the ALM Octane console.
- Provar Automation
- System Requirements
- Browser and Driver Recommendations
- Installing Provar Automation
- Updating Provar Automation
- Licensing Provar
- Granting Org Permissions to Provar Automation
- Optimizing Org and Connection Metadata Processing in Provar
- Using Provar Automation
- API Testing
- Behavior-Driven Development
- Consolidating Multiple Test Execution Reports
- Creating and Importing Projects
- Creating Test Cases
- Custom Table Mapping
- Functions
- Debugging Tests
- Defining a Namespace Prefix on a Connection
- Defining Proxy Settings
- Environment Management
- Exporting Test Cases into a PDF
- Exporting Test Projects
- Japanese Language Support
- Override Auto-Retry for Test Step
- Mapping and Executing the Lightning Article Editor in Provar
- Managing Test Steps
- Namespace Org Testing
- NitroX
- Provar Automation
- Provar Test Builder
- ProvarDX
- Refresh and Recompile
- Reintroduction of CLI License Check
- Reload Org Cache
- Reporting
- Running Tests
- Searching Provar with Find Usages
- Secrets Management and Encryption
- Setup and Teardown Test Cases
- Tags and Service Level Agreements (SLAs)
- Test Cycles
- Test Plans
- Testing Browser Options
- Tooltip Testing
- Using the Test Palette
- Using Custom APIs
- Callable Tests
- Data-Driven Testing
- Page Objects
- Block Locator Strategies
- Introduction to XPaths
- Creating an XPath
- JavaScript Locator Support
- Label Locator Strategies
- Maintaining Page Objects
- Mapping Non-Salesforce fields
- Page Object Operations
- ProvarX™
- Refresh and Reselect Field Locators in Test Builder
- Using Java Method Annotations for Custom Objects
- Applications Testing
- Provar Manager
- How to Use Provar Manager
- Provar Manager Setup
- Provar Manager Integrations
- Release Management
- Test Management
- Test Operations
- Provar Manager and Provar Automation
- Setting Up a Connection to Provar Manager
- Object Mapping Between Automation and Manager
- How to Upload Test Plans, Test Plan Folders, Test Plan Instances, and Test Cases
- Provar Manager Filters
- Uploading Callable Test Cases in Provar Manager
- Uploading Test Steps in Provar Manager
- How to Know if a File in Automation is Linked in Test Manager
- Test Execution Reporting
- Metadata Coverage with Manager
- Provar Grid
- DevOps
- Introduction to Provar DevOps
- Introduction to Test Scheduling
- Apache Ant
- Configuration for Sending Emails via the Automation Command Line Interface
- Continuous Integration
- AutoRABIT Salesforce DevOps in Provar Test
- Azure DevOps
- Running a Provar CI Task in Azure DevOps Pipelines
- Configuring the Automation secrets password in Microsoft Azure Pipelines
- Parallel Execution in Microsoft Azure Pipelines using Multiple build.xml Files
- Parallel Execution in Microsoft Azure Pipelines using Targets
- Parallel execution in Microsoft Azure Pipelines using Test Plans
- Bitbucket Pipelines
- CircleCI
- Copado
- Docker
- Flosum
- Gearset
- GitHub Actions
- Integrating GitHub Actions CI to Run Automation CI Task
- Remote Trigger in GitHub Actions
- Parameterization using Environment Variables in GitHub Actions
- Parallel Execution in GitHub Actions using Multiple build.xml Files
- Parallel Execution in GitHub Actions using Targets
- Parallel Execution in GitHub Actions using Test Plan
- Parallel Execution in GitHub Actions using Job Matrix
- GitLab Continuous Integration
- Travis CI
- Jenkins
- Execution Environment Security Configuration
- Provar Jenkins Plugin
- Parallel Execution
- Running Provar on Linux
- Reporting
- Salesforce DX
- Git
- Version Control
- Masking Provar Credentials on CI
- Salesforce Testing
- Best Practices
- Salesforce Connection Best Practices
- Improve Your Metadata Performance
- Testing Best Practices
- Automation Planning
- Supported Testing Phases
- Provar Naming Standards
- Test Case Design
- Create records via API
- Avoid using static values
- Abort Unused Test Sessions/Runs
- Avoid Metadata performance issues
- Increase auto-retry waits for steps using a global variable
- Create different page objects for different pages
- The Best Ways to Change Callable Test Case Locations
- Working with the .testProject file and .secrets file
- Best practices for the .provarCaches folder
- Best practices for .pageObject files
- Troubleshooting
- How to Use Keytool Command for Importing Certificates
- Browsers
- Configurations and Permissions
- Connections
- DevOps
- Error Messages
- Provar Manager 3.0 Install Error Resolution
- Provar Manager Test Case Upload Resolution
- Administrator has Blocked Access to Client
- JavascriptException: Javascript Error
- macOS Big Sur Upgrade
- Resolving Failed to Create ChromeDriver Error
- Resolving Jenkins License Missing Error
- Resolving Metadata Timeout Errors
- Test Execution Fails – Firefox Not Installed
- Selenium 4 Upgrade
- Licensing, Installation and Firewalls
- Memory
- Test Builder and Test Cases
- Release Notes