Add reporting to CircleCI

This section guides you through adding Perfecto Smart Reporting to CircleCI.

Group tests by job and build in the Report Library

To view tests grouped by continuous integration system job and build, you need to provide the job name and build number into reporting as system variables. This enables you to group your test executions in reporting first by job name and then by build number, providing you a complete overview of the build quality.

Add Job Name and Build Number parameters

CircleCI provides some default variables. For the complete list of CircleCI variables, see here. You can use variables to pass the Job Name and Job Number parameters to Smart Reporting.

To access these variables, use the following format within your code: 

Copy
${variableName}

Add Maven or Ivy parameters

If you run your tests using Maven or Ivy, add the following JVM parameters and (optionally) the Report-tags parameter:

Copy
-Dreportium-job-name=${CIRCLE_PROJECT_REPONAME} -Dreportium-job-number=${CIRCLE_BUILD_NUM} -Dreportium-job-branch=${myBranch} -Dreportium-tags=${myTag}

You need to provide the myTag and myBranch values (see the CircleCI documentation here for information on adding variables). CircleCI automatically supplies the CIRCLE_PROJECT_REPONAME and CIRCLE_BUILD_NUM values.

To add CustomField pairs, use the following format:

Copy
-DReportiumCustomFields=customField1=value1,customField2=value2