[MCHECKSTYLE-99] <includeTestSourceDirectory> should use default test sources xref output dir: ${project.reporting.outputDirectory}/xref-test

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.2
• Fix Version/s: 3.2.0
• Component/s: checkstyle:checkstyle
• Environment: Linux (but I assume it happens in all environs)
• Assignee: Sylwester Lachiewicz
• Reporter: Dan Rollo
• Created: 31/Jul/08 19:59
• Updated: 17/Jul/21 19:32
• Resolved: 05/Apr/21 20:12

Description

The xref link to the Source pages in the checkstyle report page is
broken. The source xref link for Unit Test Source files is not using the
default value of the destDir for jxr test sources. From the jxr plugin docs
for jxr:test-jxr:

destDir

Folder where the Xref files will be copied to.

• Type: java.lang.String
• Required: No
• Expression: ${project.reporting.outputDirectory}/xref-test

I think the checkstyle plugin should:

• assume the default dir for jxr:test-jxr
• provide it's own additional override setting (similar to xrefLocation,
  but for test sources). like: testXrefLocation.

A pom file exhibiting this problem is attached.

Dan Rollo

Issue Links

• is related to: MCHECKSTYLE-100 Using <includeTestSourceDirectory> element truncates xref link to "production" (non-test) classes
• links to: GitHub Pull Request #34