Add coverage into ALM Octane (technical preview)

When working with a CI other than Jenkins (whose plugin supports coverage) you can use a PUT operation to inject coverage into ALM Octane. For information about the plugin, see Install and configure the ALM Octane CI plugin on your CI server.

Flow

You can manually inject coverage created by your CI tool to the ALM Octane server.

To manually inject the CI coverage:

  1. Authenticate and sign in as a user with the necessary permissions.

  2. Inject the coverage using the coverage custom resource into ALM Octane.

  3. Check the status of the PUT operation.

Back to top

Inject the coverage into ALM Octane

Use the PUT operation to add a payload containing the coverage from your CI.

http[s]://<server>:<port>/internal-api/shared_spaces/1001/analytics/ci/coverage?ci-server-identity={{ciServerIdentity}}&ci-job-id={{ciJobId}}&ci-build-id={{ciBuildId}}&file-type={{fileType}}

Use the following parameters:

  • ciServerIdentity: A string representing the CI server id, which is the instance_id field in the ci_server entity.
  • ciJobId: A string representing the CI job id, which is the ci_id field in the ci_job entity.
  • ciBuildId: A string representing the CI build id, which is the build_ci_id field in the ci_build entity.
  • fileType: A string representing the format of the coverage report, LCOV or JACOCOXML depending on the coverage file format.

Back to top

Check the status

Make sure the coverage was successfully added into ALM Octane.

To check if the coverage was added to ALM Octane:

  1. Check the return code. A return code of 200 indicates success.
  2. Check if the coverage exists in ALM Octane. For details, see View code coverage data in ALM Octane.

Back to top

See also: