Send automated test run results to ALM Octane

You can incorporate your automated test results into ALM Octane even if you do not connect ALM Octane to a CI server.

Overview

ALM Octane provides CLI tools that you can use to send automated test run results to ALM Octane. ALM Octane creates automated test entities associated with the results it receives. If a relevant automated test already exists, the results are associated with that test.

In ALM Octane, associate the tests with ALM Octane users and application modules so you can view the test results in context. This enables you to analyze the progress and quality of your release and product.

You can create rules that automatically assign automated tests to application modules and/or test owners using filter conditions. For details, see Create and manage test assignment rules.

Choose a Test Result Collection tool from ALM Octane

Choose the CLI Test Results Collection Tool that is suitable for your needs:

  • The Test Results Collection Tool.

    Sends automated test results that you stored in an XML file that meets specific requirements to ALM Octane.

    Requires an ALM Octane user name and password for authentication.

  • The ALM Test Result Collection Tool.

    Retrieves the test results directly from ALM and sends them to ALM Octane.

    Enables you to define filters that specify the test runs whose results you want to retrieve.

    Requires connection information for both an ALM project and an ALM Octane workspace.

To download a Test Result Collection Tool:

DevOps admin permissions are required.

  1. In Settings , click Workspaces and select a workspace.

  2. Click the DevOps tab. On the left side of the pane, select CI Servers.

  3. Click the link for downloading the Test Result Collection tool or the ALM Test Result Collection tool and save it.

  4. The readme file downloaded with the tool provides details on using the tool.

Back to top

Test Result Collection Tool

Prerequisite - prepare the test results

Store your automated test results in a valid XML file. The XML can be one of the following:

  • A jUnit test results XML file, like this one: Test results XML sample.

    Provide additional information about the tests (test type, environment details, release...) in a metadata file or by using the tool's command line options.

  • For complex cases, use an XML file that meets the requirements of the ALM Octane API . For details, see the information about test-results in the ALM Octane Developer Guide.

    In this case, the file must contain all relevant data.

Use the Test Results Collection tool

  1. Run the tool: java –jar <downloaded file.jar>

  2. Use the CLI interface that opens to push your results to ALM Octane.

    • Run the following command: results-push {options} <file name> {additional file name)

      Provide a file with the results, and optionally, metadata and configuration files.

      Examples:

      result-push -t OS:Windows -t db:Oracle -r 1001 --build-server UUID-1235-555555-1411 --build-job full-root --build-number 123 -s failed --user admin --password changeit junit.xml
      result-push --user admin --password -i --release 1001 -b UUID-1235-555555-1411 -j full-root -n 123 -s passed internal-format.xml
    • For help on the tool's various options run: results-push -h

Back to top

ALM Test Result Collection Tool

Supported ALM versions: ALM 12.*

Prerequisite: Obtain API access

Ask your shared space admin for an API access Client ID and Client secret. The tool uses these for authentication when communicating with ALM Octane. The access keys do not have to be assigned any special role. For details, see Set up API access for integration.

Use the ALM Test Results Collection tool

Run the tool: java –jar <downloaded file.jar>

In a configuration file or using the command line options, provide the following information:

  • The ALM URL, user name, password, and project.

  • The ALM Octane URL, access keys. and workspace.

  • A filter specifying the ALM test runs to retrieve.

Read the readme downloaded with the ALM Test Results Collection tool for detailed instructions on using the tool.

Complete the picture

To continuously track your ALM test results in ALM Octane, use automation to run the tool periodically and bring in any new test results from ALM.

One way to do this is to have a Jenkins job run the tool periodically, using the LAST_SENT filter option to always retrieve only the test results that were not previously collected.

Set up test assignment rules to continuously assign any retrieved test results to the relevant application modules and ALM Octane users.

Back to top

Next steps: