12. Reports Topic

The Reports topic provides access to a number of reports related to project source code, and enables you to explicitly launch report calculation. The Reports topic provides access to the following reports:

Source Code Reports and Documentation

The sub-topics under the Reports topic provide access to the available source code reports and source code documentation.

Maven Site

This sub-topic provides access to the latest update of any Maven Site build artifacts of the project. You can use the Calculate Report to explicitly invoke calculation of the report to get an up-to-the-minute version.

The Maven Site page contains a list of build artifacts, if any have been configured for the project. (See Administrator's Guide: Basic Build Management for information). You can drill down into the generated Maven reports for any listed build artifact by clicking on its name. The following reports are generated:

  • Checkstyle: Report on coding style conventions

  • CPD Report: Duplicate code detection

  • PMD Report: Verification of coding rules

  • Source Xref: HTML based cross-reference version of Java source code

  • Test Source Xref: HTML based cross-reference version of Java test source code

Click on the name of any of these reports to drill down into the content.

Unit Test Coverage

This sub-topic provides access to the latest update of the unit test coverage report, which provides information on how much of the project source code is covered by unit tests. You can use the Calculate Report to explicitly invoke calculation of the report to get an up-to-the-minute version.

The Unit Test Coverage page contains a list of build artifacts, if any have been configured for the project. (See Administrator's Guide: Basic Build Management for information). You can drill down into the generated code coverage reports for any listed build artifact by clicking on its name. The report appears in three frames, with various links that drill down into more detail... into specific packages or classes, for example.

Figure 12.1. Reports - Unit Test Coverage

Reports - Unit Test Coverage

Top-level Unit Test Coverage Report

Unit Tests

This sub-topic provides access to the latest update of the unit tests report, which provides information about and access to the project's unit tests. You can use the Calculate Report to explicitly invoke calculation of the report to get an up-to-the-minute version.

The Unit Tests page contains a list of build artifacts, if any have been configured for the project. (See Administrator's Guide: Basic Build Management for information). You can drill down into the generated unit tests report for any listed build artifact by clicking on its name. The report is built and formatted by Maven (Surefire report). The report has 3 main sections:

  • Summary: provides statistics about the project unit tests

  • Package List: Lists the project packages and the test classes for those packages.

  • Test Cases: Lists the test cases in the project and enables you to access the sources.

Javadoc

This sub-topic provides access to the latest update of the project's Javadoc (for projects implemented in Java). You can use the Calculate Report to explicitly invoke calculation of the report to get an up-to-the-minute version.

The Javadoc page contains a list of build artifacts, if any have been configured for the project. (See Administrator's Guide: Basic Build Management for information). You can drill down into the generated Javadoc for any listed build artifact by clicking on its name.

Xref

This sub-topic provides access to the latest update of the project's source code Xref report. You can use the Calculate Report to explicitly invoke calculation of the report to get an up-to-the-minute version.

The Xref page contains a list of build artifacts, if any have been configured for the project. (See Administrator's Guide: Basic Build Management for information). You can drill down into the generated Javadoc for any listed build artifact by clicking on its name. The generated report is a framed, cross-linked HTML report of the project source code. You can look at specific packages to see the classes and drill down into the actual source code of any class. The access is read-only. You cannot modify any source code.