BMC Compuware Xpediter Code Coverage Extension

Overview

The BMC Compuware Xpediter Code Coverage extension allows Azure Devops users to extract code coverage results for COBOL source from a Compuware Code Coverage repository. These results can then be viewed in SonarQube.

Prerequisites

The following are required to use this extension:

• Azure Pipelines - in Azure DevOps Services or Azure DevOps Server
• BMC Common Configuration Extension
• Topaz Workbench CLI 18.2.4 or later. Refer to the Topaz Workbench Install Guide for instructions.
• Xpediter/Code Coverage 17.2, PTF PA01563
• Compuware Shared Services 17.2, PTF CXS527A

Installing in an Azure Pipelines - in Azure DevOps Services or Azure DevOps Server

1. Install the BMC Compuware Xpediter Code Coverage extension according to the Azure Devops Services instructions for installing extensions. Dependent extensions will automatically be installed.
2. Install the Topaz Workbench CLI on the Azure Devops Pipelines instances that will execute the extension. The Topaz Workbench CLI is available in the Topaz Workbench installation package. If you do not have the installation package, please visit support.bmc.com. For Topaz Workbench CLI installation instructions, please refer to the Topaz Workbench Install Guide.

Configuring for Topaz Workbench CLI & Host Connections

In order to use Topaz utilites you will need to point to an installed Topaz Workbench Command Line Interface (CLI). The Topaz Workbench CLI will work with host connection(s) you also need to configure to use Topaz utilities.

• See Configuring for Topaz Workbench CLI & Host Connections

Retrieve Xpediter Code Coverage Statistics

This integration allows downloading of Code Coverage data from a repository.

While creating the new Azure pipeline, we can add a new task "BMC Compuware Xpediter Code Coverage extension" by clicking + sign on Agent Job.

This task has following parameters:

• Host connection : Select the host connection to be used to connect to the z/OS host.

Alternatively, to add a connection,click on BMC Common Configuration extension in application hub.

• User ID : Enter userID to use for logging onto the z/OS host.

• Password : In this feild, please pass pipeline variable name which is storing Password as secret in Azure pipeline. Example $(variablename).

Do one or both of the following:

• Path to analysis properties : Enter the path to an existing ccanalysis.properties file, which is a properties file used to specify the source, repository, system, test, and DDIO override information for the code coverage extraction.

• Analysis properties : Enter the parameters for the code coverage extraction, using the following syntax:

  • cc.sources : Indicate the relative path to the source directories to be used for the code coverage extraction.
  • cc.repos : Indicate the code coverage repository from which to extract code coverage data.
  • cc.system: Indicate the system to be included in the scan.
  • cc.test : Indicate the test ID to be included in the scan.
  • cc.ddio.overrides : Indicate the new location of the program's DDIO file if the file was moved or renamed from what is specified in the repository.

Parameters entered via the Analysis properties box override corresponding parameters in the ccanalysis.properties file.

Click Save.

Run the job, which creates a CodeCoverage.XML file containing the code coverage information for the selected programs. This file is located in a Coverage subdirectory in the Azure Devops Pipeline's Agent workspace. This file can be input into SonarQube to view the code coverage results.

During the Execute SonarQube Scanner Step, add the following property to import the Coverage data into SonarQube. sonar.coverageReportPaths=Coverage/CodeCoverage.xml

Known Limitations

• COBOL is currently the only language supported.
• Source code must be compiled using the Compuware Shared Services(CSS) pre-processor.
  • Other pre-processors can cause changes to the original source file that are undetectable to CSS.
• Nested copybooks within the procedure division are not supported.
• COBOL COPY REPLACING statements in the procedure division may cause source mismatches.

Product Assistance

BMC provides assistance for customers with its documentation, the BMC Support Center web site, and telephone customer support.

BMC Support Center

You can access online information for BMC products via our Support Center site at https://support.bmc.com. Support Center provides access to critical information about your BMC products. You can review frequently asked questions, read or download documentation, access product fixes, or e-mail your questions or comments. The first time you access Support Center, you must register and obtain a password. Registration is free.

Contacting Customer Support

At BMC, we strive to make our products and documentation the best in the industry. Feedback from our customers helps us maintain our quality standards. If you need support services, please obtain the following information before calling BMC's 24-hour telephone support:

• The Azure pipeline job output that contains any error messages or pertinent information.

• The name, release number, and build number of your product. This information is displayed in the installed extensions page. Apply filter: BMC in order to display all of the installed BMC extension.

• Environment information, such as the operating system and release on which the Topaz CLI is installed.

You can contact BMC in one of the following ways:

Web

You can report issues via BMC Support Center: https://support.bmc.com.

Note: Please report all high-priority issues by phone.

Corporate Web Site

To access BMC site on the Web, go to https://www.bmc.com/. The BMC site provides a variety of product and support information.