[java] Renderers output wrong class qualified name for nested classes

[cowwoc]

Affects PMD Version: 7.0.0

Rule: AbstractClassWithoutAbstractMethod

Description: The AbstractClassWithoutAbstractMethod reports the wrong class

Code Sample demonstrating the issue:

package com.github.cowwoc.lumina;

public final class Form
{
	public static abstract class Property    // <----- Rule is triggering on this line
	{
		// ...
	}

	// ...
}

(https://github.com/cowwoc/lumina/blob/main/java/src/main/java/com/github/cowwoc/lumina/Form.java#L38)

Expected outcome: Violation message with class name com.github.cowwoc.lumina.Form.Property
Actual outcome: [INFO] PMD Failure: com.github.cowwoc.lumina.Property:38 Rule:AbstractClassWithoutAbstractMethod Priority:3 This abstract class does not have any abstract methods.

Running PMD through: Maven

[cowwoc]

PS: The rule is triggering on this line: private final JsonNode value;

[oowekyala]

The rule is actually triggered on the following place: https://github.com/cowwoc/lumina/blob/main/java/src/main/java/com/github/cowwoc/lumina/Form.java#L38

There is a problem with the renderer as it just takes the simple name of the class and prepends the package name. This of course is wrong when the type is a nested class like here. The name of the class is com.github.cowwoc.lumina.Form.Property and not com.github.cowwoc.lumina.Property. Since you have the latter in the package the renderer output is confusing.

I think the renderer should output file names and not class names, for instance:

src/main/java/com/github/cowwoc/lumina/Form.java:38 Rule:AbstractClassWithoutAbstractMethod Priority:3 This abstract class does not have any abstract methods.

instead of the current output now (broken)

com.github.cowwoc.lumina.Property:38 Rule:AbstractClassWithoutAbstractMethod Priority:3 This abstract class does not have any abstract methods.

or "fixed", but it is not obvious which file the line number is for:

com.github.cowwoc.lumina.Form.Property:38 Rule:AbstractClassWithoutAbstractMethod Priority:3 This abstract class does not have any abstract methods.

[oowekyala]

Here is the problem in the Maven renderer:

https://github.com/apache/maven-pmd-plugin/blob/c54170707cfd0aec4b5d9ee6083230f2551cdaa4/src/main/java/org/apache/maven/plugins/pmd/PmdViolationCheckMojo.java#L96-L104

But other renderers in PMD have the same problem, eg

pmd/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextColorRenderer.java

Lines 217 to 219 in e5f55c0

	String packageName = rv.getAdditionalInfo().getOrDefault(RuleViolation.PACKAGE_NAME, "");
	String className = rv.getAdditionalInfo().getOrDefault(RuleViolation.CLASS_NAME, "");
	return StringUtils.isNotBlank(packageName) ? packageName + '.' + className : "";

[jsotuyod]

@adangel I'm unsure this holds for the 3.22.0 plugin version, but you may want to take this to the maven plugin's JIRA.

[adangel]

For nested classes, what are the expected values in additionalinfo of rule violations?

pmd/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/internal/JavaViolationDecorator.java

Lines 41 to 42 in 6a328d6

	setIfNonNull(RuleViolation.CLASS_NAME, getClassName(javaNode), additionalInfo);
	setIfNonNull(RuleViolation.PACKAGE_NAME, javaNode.getRoot().getPackageName(), additionalInfo);

https://docs.pmd-code.org/latest/pmd_languages_java.html#violation-decorators

Do we miss something here? Like something like "FULLY_QUALIFIED_CLASS_NAME"?

[oowekyala]

Do we miss something here? Like something like "FULLY_QUALIFIED_CLASS_NAME"?

Yes. Maybe we can specify CLASS_NAME to mean eg here Form.Property for nested classes though.