Telescope

Introduction

Telescope is an intuitive, easy-to-use tool for the visualisation of project metrics. It adds value to existing reports such as the ones produced by Diffblue Cover and Jacoco, by representing data visually. It also allows you to target development work by showing which areas need further coverage.

In the example below, although the overall coverage percentage is high, one class has a coverage of only 0-40% and two have coverage of 40-70%. Telescope allows the easy identification of classes and methods with lower coverage, and thus allows you to allocate your time and resources effectively.

Please contact Diffblue to obtain a copy of Telescope (at beta release, March 2021).

Pre-requisites

To run Telescope from the executable file:

  • Java version 8 or later

Workflow

Getting Started

To start using Telescope, you need to:

  • Upload an existing jacoco.xmlreport  (or generate and then upload a new jacoco.xml report) AND
  • Upload an existing dcover.json report (or generate and then upload a new dcover.json report).

To generate a new jacoco.xml report:

To use Telescope, you must have a jacoco.xml report. Please see these separate instructions for generating a standard Jacoco report.

You can also filter the results shown in the Jacoco report. You must keep the default DCover test name settings for this to be effective.

  • To generate a Jacoco report which filters out the tests generated by DCover, use the command: mvn test -Dtest=!*DiffblueTest (Please note that in certain environments, you may need to use the following alternative instead: mvn test -Dtest='!*DiffblueTest')
  • To generate a JaCoCo report which filters out all tests apart from those generated by DCover, use the command: mvn test -Dtest=*DiffblueTest

To generate a new dcover.json report:

To use Telescope, you must also have a dcover.json report. Please see these separate instructions for generating a dcover.json report.

Uploading your reports:

1. Click on the Upload Reports button. You can either upload:

  • A dcover.json report and a jacoco.xml report (excluding Diffblue tests)
  • A dcover.json report, a jacoco.xml report (excluding Diffblue tests) and a jacoco.xml report (excluding manual tests)

2. Fill in the following fields:

  • Coverage report name - this is the name you use to refer to your work in Telescope.
  • Diffblue Cover Report - this is the location of the JSON report you want to upload.
  • JaCoCo Report, excluding Diffblue tests - this is the location of the JaCoCo XML report which excludes any tests written by DCover.
  • JaCoCo Report, excluding manual tests - this is the location of the JaCoCo XML report which excludes all manual tests and keeps those written by DCover.

3. Then, click Upload reports.

4. Once you have uploaded your first report, you can see all reports listed by clicking on this icon on the left menu:

Test Coverage Breakdown

Once you have uploaded a report, click on the Dashboard icon to see the Test Coverage Breakdown. An example is shown below:

Coverage

Click on to see more detailed information on coverage. An example is shown below. The innermost circle represents the module, the middle circle represents the classes, and the outer circle represents the methods.

You can hover over any slice of the sunburst to see the coverage percentage.

Insights

Use the icon to see the insights into your report, for example: