Pull #18529: Fix wrong test scope for `PMD` by Pankraz76 · Pull Request #18529 · checkstyle/checkstyle

Pankraz76 · 2026-01-06T15:07:34Z

Pull #18529: Fix wrong test scope for `PMD` #18470

Pankraz76 · 2026-01-09T11:39:23Z

reopen after enabler:

Pull #18530: Fix PMD violations #18470 #18530

Pankraz76 · 2026-01-11T09:36:50Z

@romani

please execute PMD locally the correct way!!

RIGHT!!!

./mvnw -e --no-transfer-progress clean pmd:check

WRONG !!!

./mvnw -e --no-transfer-progress clean test-compile pmd:check

romani · 2026-01-11T21:37:34Z

New pmd violations:
[�[1;33mWARNING�[m] PMD Failure: com.puppycrawl.tools.checkstyle.AbstractAutomaticBean:243 Rule:ExceptionAsFlowControl Priority:3 Exception thrown at line 237 is caught in this block..

PMD Failure: com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter:80 Rule:UnusedPrivateMethod Priority:3 Avoid unused private methods such as 'parseJavadocAsDetailNode(String)'..

romani · 2026-01-11T21:56:50Z

CI job should stay as is we can do two mvn commands under ci command to run spotbugs and pmd separately

Pankraz76 · 2026-01-12T09:35:37Z

i dont think so. Why having this coupled for no reason?

please conaider dedication and seperation principle to see each job upfront like we for other SCA tool as well:

https://github.com/checkstyle/checkstyle/pull

Pankraz76 · 2026-01-12T11:58:37Z

CI job should stay as is we can do two mvn commands under ci command to run spotbugs and pmd separately

yes kind of to fix now. but why having this coupling?

Pankraz76 · 2026-01-12T12:03:35Z

item:

Command: ./mvnw -e --no-transfer-progress clean pmd:check

New pmd violations:
[�[1;33mWARNING�[m] PMD Failure: com.puppycrawl.tools.checkstyle.AbstractAutomaticBean:243 Rule:ExceptionAsFlowControl Priority:3 Exception thrown at line 237 is caught in this block..

PMD Failure: com.puppycrawl.tools.checkstyle.DetailNodeTreeStringPrinter:80 Rule:UnusedPrivateMethod Priority:3 Avoid unused private methods such as 'parseJavadocAsDetailNode(String)'..

Pankraz76 · 2026-01-12T12:11:51Z

CI job should stay as is we can do two mvn commands under ci command to run spotbugs and pmd separately

yes now its your style. actually its just the test scope issue.

…heckstyle#18470

Pankraz76 · 2026-01-12T14:01:18Z

item

01:58
[INFO] --- compiler:3.14.1:compile (default-compile) @ equalsverifier-testhelpers ---01:58
[INFO] Recompiling the module because of changed source code.01:59
[INFO] Compiling 83 source files with javac [forked debug release 17] to target/classes01:59
[INFO] -------------------------------------------------------------01:59
[ERROR] COMPILATION ERROR : 01:59
[INFO] -------------------------------------------------------------01:59
[ERROR] 	at jdk.compiler/com.sun.tools.javac.api.BasicJavacTask.initPlugins(BasicJavacTask.java:232)01:59
	at jdk.compiler/com.sun.tools.javac.main.Main.compile(Main.java:294)01:59
	at jdk.compiler/com.sun.tools.javac.main.Main.compile(Main.java:178)01:59
	at jdk.compiler/com.sun.tools.javac.Main.compile(Main.java:64)01:59
	at jdk.compiler/com.sun.tools.javac.Main.main(Main.java:50)01:59
Caused by: com.google.errorprone.InvalidCommandLineOptionException: -XDaddTypeAnnotationsToSymbol=true is required by Error Prone on JDK 2101:59
	at com.google.errorprone.BaseErrorProneJavaCompiler.checkAddTypeAnnotationsToSymbol(BaseErrorProneJavaCompiler.java:243)01:59
	at com.google.errorprone.BaseErrorProneJavaCompiler.addTaskListener(BaseErrorProneJavaCompiler.java:91)01:59
	at com.google.errorprone.ErrorProneJavacPlugin.init(ErrorProneJavacPlugin.java:34)01:59
	at jdk.compiler/com.sun.tools.javac.api.BasicJavacTask.initPlugin(BasicJavacTask.java:256)01:59
	at jdk.compiler/com.sun.tools.javac.api.BasicJavacTask.initPlugins(BasicJavacTask.java:230)01:59
	... 4 more01:59
[INFO] 1 error01:59
[INFO] ----------------------------------

…heckstyle#18470

romani

Items

romani · 2026-01-13T03:29:49Z

    <exclude name="DataClass"/>
    <!-- Too many alarms on the check classes, we will never move logic out of the check,
         each check is an independent logic container. -->
+    <exclude name="ExceptionAsFlowControl"/>


You might share it before.
Please share one more time violation that we suppressing I need to double check

you also found it

[�[1;33mWARNING�[m] PMD Failure: com.puppycrawl.tools.checkstyle. AbstractAutomaticBean:243 Rule:ExceptionAsFlowControl Priority:3 Exception thrown at line 237 is caught in this block..

lets just go. in PMD we trust.

yes, this rule is not working well, ok to disable

no the rule is working fine kind of, but its the way its done in java since day one.

isnt´t it? @adangel

I don't know what you mean with "its done in java since day one"...

So, PMD claims that

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/AbstractAutomaticBean.java

Line 243 in b8d7e30

catch (final InvocationTargetException | IllegalAccessException

catches the exception thrown at

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/AbstractAutomaticBean.java

Line 237 in b8d7e30

throw new CheckstyleException(message);

. If that is true, then this would be indeed an instance of ExceptionAsFlowControl.

But this doesn't look to be the case:

checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/api/CheckstyleException.java

Line 31 in b8d7e30

public class CheckstyleException extends Exception {

is just an Exception and not related to any of "InvocationTargetException | IllegalAccessException | NoSuchMethodException".

This leads to the conclusion: Either PMD is wrong or PMD is not called correctly. I suspect that latter, as figuring out the relation of types requires a correct auxclasspath, see the comment above in "validation.sh".

I don't know what you mean with "its done in java since day one"...

Being in the industry for 15 years, i learned from day one Exception As Flow Control is bad, still it was done every since in all the codebases around.

So PMD is correctly working, yes.

if this is so fragile then better extract the tool calls to avoid any unwanted interconnection.

actually consider the comment it feels strange that PMD and spot are connected even the commen stated it needs to run alone.

coupling is always bad software design so lets avoid in CI as well.

checkstyle/.circleci/config.yml

Line 205 in b8d7e30

# why we need execution of spotbugs without any other maven plugins which can change binaries

…heckstyle#18470

Pankraz76 · 2026-01-14T10:26:21Z

rdy 2 merge.

…heckstyle#18470

Pankraz76 · 2026-01-15T10:22:47Z

lets fix and pick this low hanging fruit @romani

romani · 2026-01-18T01:11:49Z

please do #18529 (comment)

…heckstyle#18470

adangel · 2026-01-18T11:17:40Z

  CHECKSTYLE_DIR=$(pwd)
  export MAVEN_OPTS='-Xmx2g'
-  ./mvnw -e --no-transfer-progress clean test-compile pmd:check spotbugs:check
+  ./mvnw -e --no-transfer-progress clean pmd:check spotbugs:check


This call of pmd and spotbugs most likely won't work correctly now: PMD and spotbugs require that the project under analysis is compiled. These tools need access to the bytecode (aka. auxclasspath). Hence there was "test-compile" added before...
Without this, these tools could produce false positive and/or negatives.

with this the tool did not worked properly ether, so its kind of strange, as the copse was limited to test.

rewrite is able to call the compile phase itself is this something PMD can adjust as well? this is kind of error prone.

if this is important then we should call both compile goals, which would hopefully also fix the scope issue.

This call of pmd and spotbugs most likely won't work correctly now: PMD and spotbugs require that the project under analysis is compiled. These tools need access to the bytecode (aka. auxclasspath). Hence there was "test-compile" added before... Without this, these tools could produce false positive and/or negatives.

idk but actually adding the compile phase is in both cases wrong having tried it only the one WITHOUT is failing like expected to call PMD just like rewrite tool:goal without any prefix goal imposing unwanted coupling and config burden to user;

Pankraz76 · 2026-01-20T09:46:18Z

lets merge. Looking into the facts PMD is working fine, as without the change its definitely not good working not at all.

…heckstyle#18470

Pankraz76 · 2026-01-20T11:23:33Z

  export MAVEN_OPTS='-Xmx2g'
-  ./mvnw -e --no-transfer-progress clean test-compile pmd:check spotbugs:check
+  ./mvnw -e --no-transfer-progress clean pmd:check
+  ./mvnw -e --no-transfer-progress clean spotbugs:check


only spot bugs need this ....

…heckstyle#18470

romani

I am ok to run tools separately.

They are too advanced now and conflicting with each other or with previous tools (jacoco).

checker, pitest, error-prone already fully separate.

Pankraz76 · 2026-01-20T16:01:47Z

I am ok to run tools separately.

then suggest to fully split. not only in some command.

romani · 2026-01-20T16:09:06Z

No , same CI Job, two tasks in it.
Container starting time is longer than action execution.

Pankraz76 commented Jan 6, 2026

View reviewed changes

Comment thread .circleci/config.yml Outdated

Pankraz76 force-pushed the fix-pmd branch from 561e3f9 to 5e56baa Compare January 6, 2026 15:18

Pankraz76 commented Jan 6, 2026

View reviewed changes

Comment thread .ci/validation.sh

Pankraz76 commented Jan 6, 2026

View reviewed changes

Comment thread .ci/validation.sh

Pankraz76 mentioned this pull request Jan 6, 2026

Pull #18532: Add EmptyNewlineAtEndOfFile #18532

Merged

Pankraz76 closed this Jan 9, 2026

Pankraz76 reopened this Jan 11, 2026

Pankraz76 mentioned this pull request Jan 11, 2026

Pull #18530: Fix PMD violations #18470 #18530

Closed

Pankraz76 changed the title ~~Issue #18470: Fix PMD CI config~~ Issue #18470: Activate PMD gatekeeper Jan 11, 2026

Pankraz76 force-pushed the fix-pmd branch from 5e56baa to 2205553 Compare January 12, 2026 12:10

Pankraz76 changed the title ~~Issue #18470: Activate PMD gatekeeper~~ Issue #18470: Fix wrong test scope for PMD and spotbugs Jan 12, 2026

Pankraz76 marked this pull request as ready for review January 12, 2026 12:11

Pankraz76 changed the title ~~Issue #18470: Fix wrong test scope for PMD and spotbugs~~ Pull #18529: Fix wrong test scope for PMD and spotbugs #18470 Jan 12, 2026

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 12, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

a235136

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from 2205553 to a235136 Compare January 12, 2026 13:21

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 12, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

d75c022

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from a235136 to d75c022 Compare January 12, 2026 21:27

romani requested changes Jan 13, 2026

View reviewed changes

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 13, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

dedc03a

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from d75c022 to dedc03a Compare January 13, 2026 16:15

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 14, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

6516f34

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from dedc03a to 6516f34 Compare January 14, 2026 10:26

Pankraz76 requested a review from romani January 14, 2026 10:26

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 15, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

6ad3a26

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from 6516f34 to 6ad3a26 Compare January 15, 2026 10:22

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 18, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

c061b49

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from 6ad3a26 to c061b49 Compare January 18, 2026 10:21

Pankraz76 mentioned this pull request Jan 18, 2026

Pull #18682: Remove obsolete pmd task #18470 #18529 #18682

Closed

adangel reviewed Jan 18, 2026

View reviewed changes

Pankraz76 mentioned this pull request Jan 18, 2026

Pull #18681: Remove obsolete redundant compile phase #18681

Closed

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 20, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

462ee7d

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from c061b49 to 462ee7d Compare January 20, 2026 11:22

Pankraz76 requested a review from adangel January 20, 2026 11:22

Pankraz76 commented Jan 20, 2026

View reviewed changes

Pankraz76 pushed a commit to Pankraz76/checkstyle that referenced this pull request Jan 20, 2026

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

6c9ac66

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from 462ee7d to 6c9ac66 Compare January 20, 2026 11:25

Pull checkstyle#18529: Fix wrong test scope for PMD and spotbugs c…

36653d9

…heckstyle#18470

Pankraz76 force-pushed the fix-pmd branch from 6c9ac66 to 36653d9 Compare January 20, 2026 11:27

Pankraz76 changed the title ~~Pull #18529: Fix wrong test scope for PMD and spotbugs #18470~~ Pull #18529: Fix wrong test scope for PMD #18470 Jan 20, 2026

romani approved these changes Jan 20, 2026

View reviewed changes

romani merged commit 23715ef into checkstyle:master Jan 20, 2026
119 checks passed

romani changed the title ~~Pull #18529: Fix wrong test scope for PMD #18470~~ Pull #18529: Fix wrong test scope for PMD Jan 20, 2026

romani added the miscellaneous label Jan 20, 2026

github-actions Bot added this to the 13.1.0 milestone Jan 20, 2026

Uh oh!

Conversation

Pankraz76 commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull #18529: Fix wrong test scope for PMD #18470

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Pankraz76 commented Jan 9, 2026

Uh oh!

Pankraz76 commented Jan 11, 2026

Uh oh!

romani commented Jan 11, 2026

Uh oh!

romani commented Jan 11, 2026

Uh oh!

Pankraz76 commented Jan 12, 2026

Uh oh!

Pankraz76 commented Jan 12, 2026

Uh oh!

Pankraz76 commented Jan 12, 2026

Uh oh!

Pankraz76 commented Jan 12, 2026

Uh oh!

Pankraz76 commented Jan 12, 2026

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pankraz76 Jan 13, 2026 • edited by romani Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pankraz76 commented Jan 14, 2026

Uh oh!

Pankraz76 commented Jan 15, 2026

Uh oh!

romani commented Jan 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Pankraz76 commented Jan 20, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pankraz76 commented Jan 20, 2026

Uh oh!

romani commented Jan 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

Pankraz76 commented Jan 6, 2026 •

edited

Loading

Pull #18529: Fix wrong test scope for `PMD` #18470

Pankraz76 Jan 13, 2026 •

edited by romani

Loading