DevOps CI server integration flow

This flow describes how to collect information from your CI server and use it in ALM Octane to measure your release and product quality and to follow your build progress.

Overview

ALM Octane integrates with your CI/CD processes, enabling you to:

Set up integration with a CI server

DevOps admin permissions are required.

To integrate ALM Octane with your CI server, install and configure an ALM Octane CI plugin.

The steps necessary to setup this integration are described briefly below. For details, see Install and configure the ALM Octane CI plugin on your CI server.

Prerequisites

  • Obtain API Access. Ask your shared space admin for an API access Client ID and Client secret. The plugin uses these for authentication when communicating with ALM Octane.

    The shared 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.

  • Obtain access to a CI server that meets the necessary requirements. For the CI servers that are supported by the ALM Octane CI plugins, see CI Servers.

    For a list of plugins that must be installed on the Jenkins server to enable ALM Octane integration, as well as plugins that are supported by the ALM Octane integration but not required, see HPE Application Automation Tools wiki page.

  • If you are working with Jenkins or Bamboo, decide which CI server user ALM Octane will use to execute jobs on the CI server.

Download, install, and configure the plugin on your CI server

Plugins for Jenkins, TeamCity, Bamboo, and TFS are available online. For Jenkins, this functionality is part of the HPE Application Automation Tools plugin.

  1. Download the relevant plugin from the Internet and install it on your CI server.
  2. Configure the plugin to connect to ALM Octane.

Define a CI server in ALM Octane

  1. In ALM Octane, in Settings , click Spaces and select the workspace where you want to define a CI server.

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

  3. Click + to add a CI server.

  4. Name the CI server.

  5. Select a URL from the list of available servers. The list displays all servers that are set up via an ALM Octane CI plugin to access your ALM Octane.

Back to top

Create a pipeline and explore it

Once connected to a CI server, you can create a pipeline in ALM Octane. Specify the root job for the pipeline, and ALM Octane builds a pipeline that represents the job flow starting from that root job.

In ALM Octane, you can use these pipelines to analyze results, commits, and code coverage information from your pipeline runs.

In a pipeline's Topology tab, you can see a visual representation of the job flow. For Jenkins and Bamboo pipelines, the hierarchy of the job flow is shown as well.

Create a pipeline:

DevOps admin permissions are required.

  1. In the ALM Octane Pipelines module, select the Pipelines tab and click + to add a pipeline.

  2. Select a CI server from the list. The list displays all servers created on the CI servers settings page of the current workspace.

  3. Select the root job from which you want ALM Octane to start the pipeline. The list displays the jobs defined on the CI server you selected. If communication with the server fails, the list is not available.

  4. Enter a name for the pipeline and, optionally, assign it to a release.

  5. Select whether to send email notifications about build and test failures to relevant ALM Octane users.

Explore the pipeline

After a pipeline is created, click its ID to open the pipeline.

In the Topology tab, you can graphically see the job steps and their flow, starting from the root job of the pipeline. For details, see Explore a pipeline's graphical representation.

Note: If you are working with Jenkins: You can similarly create pipelines using the HPE Application Automation Tools plugin on the Jenkins CI server. For details, see the section on creating and configuring pipelines on the HPE Application Automation Tools wiki page.

Back to top

Configure the pipeline (Topology tab)

DevOps admin permissions are required.

After creating a pipeline, you can label and tag it:

  • Labels indicate the job type of a pipeline step. This helps you understand the pipeline flow. In the flat pipeline view, you can also filter the pipeline to show only steps with specific labels.

    When the pipeline runs, the labels are added to the resulting builds. When analyzing failures in the Failed Builds tab, the labels help you understand the context of the builds.

  • Tags provide testing details and environment information about automated tests that run as part of your pipeline.

Configure tags on pipeline steps that run tests. When the tests run as part of the pipeline, the tests, test runs, and builds are tagged accordingly. You can then filter builds and test run results according to these tags when you analyze the quality of your build, release, or product in ALM Octane.

If a step runs tests that you do not want to track in ALM Octane, simply configure the step to Ignore test run results.

Label a pipeline step:

  1. Open the pipeline by clicking its ID and select the Topology tab.

  2. Click the label at the top right of a step, and select a job type for the step.

    Job types include: Compile, Package, Deploy, and Test.

Configure a pipeline step:

  1. Open the pipeline by clicking its ID and select the Topology tab.

  2. Click Configuration on the bottom right of a step. Add information such as testing framework, test type, testing tool, operating system, browser, and so on. For details, see Configure steps: Define test and test run information.

Note: If you are working with Jenkins: You can similarly configure pipelines using the on the Jenkins CI server.

Back to top

Run pipelines from ALM Octane

DevOps admin permissions are required.

After you create a pipeline, you can trigger a pipeline run on the CI server from ALM Octane.

  1. In the ALM Octane Pipelines module, open the Pipelines tab and select a pipeline.

  2. Click Run pipeline.

    On Jenkins and Bamboo, the pipeline steps run under the CI server user that you specified when configuring the plugin. The pipeline run is limited by the permissions assigned to this user.

You can see your CI server steps and their results, in a graphical way. For details, see Run and analyze pipelines.

ALM Octane collects the results of the automated tests that run as part of the pipeline. ALM Octane creates automated test entities associated with the test run results it collects. If a relevant automated test already exists, the results are associated with that test.

For details, see How ALM Octane creates automated test and test run entities from test run results.

Back to top

Assign tests to ALM Octane entities

Assigning automated tests to application modules and backlog items in ALM Octane lets you view the test results in context. You can then use these results to analyze the progress and quality of your release and product.

Assigning owners to automated tests helps accelerate problem resolution. You can configure a pipeline to notify test owners when their test runs fail.

For details, see Assign tests to application modules and backlog items.

Back to top

Configure SCM Settings

DevOps admin permissions are required.

If your CI server is set up to work with a Source Control Management (SCM) system, such as Git or Subversion (SVN), ALM Octane can help you track committed changes. See also Source Code Management (SCM) integrations.

For details, see Track changes committed to your Source Control Management system.

See Set up your SCM system to learn about settings you can configure to gain more from this integration with your SCM system.

Analyze your build and release quality

After you create, configure, and run pipelines, you can Reflect your build, product, and release quality based on the collected information.

Analyze the product and release quality based on the automated test run results in ALM Octane's dashboards, overview widgets, and grids. For details, see Analyze release, product, and build quality.

Analyze your build quality by learning more about the build runs and analyzing failed automated tests.

Open the Pipelines module and select the Pipelines tab. Select a pipeline from the list of pipelines on the left.

ALM Octane provides an overall look at the pipeline's status and history. You can also see changes related to this pipeline, and related application modules, and more.

  • To view details about the last run, click the pipeline run number.
  • To view information about all the build runs of this pipeline and about changes made to the pipeline, click the pipeline ID to the left of the pipeline name.

    In the pipeline's Runs tab, you can see all pipeline runs, dating back to when you added the pipeline to ALM Octane. Click the ID of a specific run to view its details.

Details of a pipeline run include, for example:

Back to top

Next steps: