GH-39946: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 #39694

vibhatha · 2024-01-19T01:59:59Z

Rationale for this change

This PR was created in place of #39202 to integrate the puppycrawl.tools.checkstyle upgrade.

What changes are included in this PR?

Style changes in Java classes and core changes to the style format itself.
Some unsupported attributes have been removed. And some attributes have
been reorganized upon the provided guidelines in the documentation.

Are these changes tested?

N/A
Tested by existing checkstyle guideline.

Are there any user-facing changes?

No

Closes: [Java] Bump checkstyle to latest version supporting Java 8 #39946

vibhatha · 2024-01-19T02:02:10Z

@github-actions crossbow submit java

vibhatha · 2024-01-19T02:03:04Z

java/dev/checkstyle/checkstyle.xml

@@ -223,14 +224,14 @@
        <module name="JavadocMethod">
            <property name="scope" value="public"/>
            <property name="allowMissingParamTags" value="true"/>
-            <property name="allowMissingThrowsTags" value="true"/>
+<!--            <property name="allowMissingThrowsTags" value="true"/>-->


will remove these once CIs are verified.

Is this ready or not ready? Please keep PRs in draft until they are ready.

This should have been on draft. Sorry about the mistake.

github-actions · 2024-01-19T02:04:44Z

Revision: 671b530eceb7b629d979b09306faa9637fa0127e

Submitted crossbow builds: ursacomputing/crossbow @ actions-dd3d152807

Task	Status
java-jars
verify-rc-source-java-linux-almalinux-8-amd64
verify-rc-source-java-linux-conda-latest-amd64
verify-rc-source-java-linux-ubuntu-20.04-amd64
verify-rc-source-java-linux-ubuntu-22.04-amd64
verify-rc-source-java-macos-amd64

vibhatha · 2024-01-19T03:10:33Z

@github-actions crossbow submit java

vibhatha · 2024-01-19T03:11:34Z

Not sure if there is such a line though:
https://github.com/ursacomputing/crossbow/actions/runs/7578473688/job/20641129446#step:7:35880

github-actions · 2024-01-19T03:12:50Z

Revision: 671b530eceb7b629d979b09306faa9637fa0127e

Submitted crossbow builds: ursacomputing/crossbow @ actions-7d4c086df1

Task	Status
java-jars
verify-rc-source-java-linux-almalinux-8-amd64
verify-rc-source-java-linux-conda-latest-amd64
verify-rc-source-java-linux-ubuntu-20.04-amd64
verify-rc-source-java-linux-ubuntu-22.04-amd64
verify-rc-source-java-macos-amd64

vibhatha · 2024-01-22T12:36:26Z

@github-actions crossbow submit java

github-actions · 2024-01-22T12:39:21Z

Revision: e07b4453c3d2639f453c46b50c4664b132f7b977

Submitted crossbow builds: ursacomputing/crossbow @ actions-5f3cb7c61a

Task	Status
java-jars
verify-rc-source-java-linux-almalinux-8-amd64
verify-rc-source-java-linux-conda-latest-amd64
verify-rc-source-java-linux-ubuntu-20.04-amd64
verify-rc-source-java-linux-ubuntu-22.04-amd64
verify-rc-source-java-macos-amd64

vibhatha · 2024-01-23T07:45:34Z

@github-actions crossbow submit java

github-actions · 2024-01-23T07:47:56Z

Revision: 3a74b4dcd16894b2599e830e114590665bb43a94

Submitted crossbow builds: ursacomputing/crossbow @ actions-4f8459f26a

Task	Status
java-jars
verify-rc-source-java-linux-almalinux-8-amd64
verify-rc-source-java-linux-conda-latest-amd64
verify-rc-source-java-linux-ubuntu-20.04-amd64
verify-rc-source-java-linux-ubuntu-22.04-amd64
verify-rc-source-java-macos-amd64

vibhatha · 2024-01-23T09:28:02Z

@lidavidm the file noted in the error seems to be generated https://github.com/ursacomputing/crossbow/actions/runs/7622553317/job/20760815369#step:7:35295
Should we omit such generated resources from checkstyles?

lidavidm · 2024-01-23T14:42:36Z

Yes

lidavidm · 2024-01-24T14:46:25Z

java/dev/checkstyle/checkstyle.xml

-            <property name="allowMissingThrowsTags" value="true"/>
            <property name="allowMissingReturnTag" value="true"/>
-            <property name="minLineCount" value="2"/>
            <property name="allowedAnnotations" value="Override, Test"/>
-            <property name="allowThrowsTagsForSubclasses" value="true"/>
-            <!-- This seems partially broken under JDK >= 9. -->
-            <property name="suppressLoadErrors" value="true"/>
-            <property name="ignoreMethodNamesRegex" value="main"/>


Are these checks no longer supported?

It showed up errors when running with those configs. I didn't log them, but I can reproduce the errors and post here?

Yes, let's just take a look and make sure - I don't care too much either way but perhaps some of these will still be useful even after google-java-format (since many of these seem more like lint things)

Yes I agree, let me log one by one here.

Listing compile errors for the removed attributes

<property name="allowMissingThrowsTags" value="true"/>

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (validate) on project arrow-maven-plugins: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'allowMissingThrowsTags' does not exist, please check the documentation -> [Help 1]

<property name="minLineCount" value="2"/>

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (validate) on project arrow-maven-plugins: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'minLineCount' does not exist, please check the documentation -> [Help 1]

<property name="allowThrowsTagsForSubclasses" value="true"/>

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (validate) on project arrow-maven-plugins: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'allowThrowsTagsForSubclasses' does not exist, please check the documentation -> [Help 1]

<property name="suppressLoadErrors" value="true"/>

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (validate) on project arrow-maven-plugins: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'suppressLoadErrors' does not exist, please check the documentation -> [Help 1]

<property name="ignoreMethodNamesRegex" value="main"/>

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (validate) on project arrow-maven-plugins: Failed during checkstyle configuration: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'ignoreMethodNamesRegex' does not exist, please check the documentation -> [Help 1]

@lidavidm these are the errors I saw when each of these properties were used.

https://github.com/checkstyle/checkstyle/issues/7329

allowMissingThrowsTags, allowThrowsTagsForSubclasses, suppressLoadErrors are now basically the default

https://github.com/checkstyle/checkstyle/issues/6703

minLineCount and ignoreMethodNamesRegex were moved to a new check called MissingJavadocMethodCheck, can you configure that to behave like our old one?

Ah I see. Let me check.

@lidavidm I added the MissingJavadocMethodCheck

Latest version: https://checkstyle.sourceforge.io/version/8.29/config_javadoc.html#JavadocMethod

Previous version: https://checkstyle.sourceforge.io/version/8.19/config_javadoc.html#JavadocMethod

allowMissingThrowsTags, allowThrowsTagsForSubclasses, suppressLoadErrors are now basically the default

These are not explicit properties in 8.29 but were in 8.19 but I couldn't find whether they are the defaults in 8.29.

vibhatha · 2024-02-05T14:05:32Z

@github-actions crossbow submit java

github-actions · 2024-02-05T14:07:49Z

Revision: ca838fb

Submitted crossbow builds: ursacomputing/crossbow @ actions-d6ad59a58d

Task	Status
java-jars
verify-rc-source-java-linux-almalinux-8-amd64
verify-rc-source-java-linux-conda-latest-amd64
verify-rc-source-java-linux-ubuntu-20.04-amd64
verify-rc-source-java-linux-ubuntu-22.04-amd64
verify-rc-source-java-macos-amd64

github-actions · 2024-02-05T16:51:24Z

⚠️ GitHub issue #39946 has been automatically assigned in GitHub to PR creator.

conbench-apache-arrow · 2024-02-05T22:05:09Z

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit cb5c109.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.

… to 8.29 (apache#39694) ### Rationale for this change This PR was created in place of apache#39202 to integrate the `puppycrawl.tools.checkstyle` upgrade. ### What changes are included in this PR? Style changes in Java classes and core changes to the style format itself. Some unsupported attributes have been removed. And some attributes have been reorganized upon the provided guidelines in the documentation. ### Are these changes tested? N/A Tested by existing checkstyle guideline. ### Are there any user-facing changes? No * Closes: apache#39946 Lead-authored-by: Vibhatha Lakmal Abeykoon <vibhatha@gmail.com> Co-authored-by: vibhatha <vibhatha@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>

github-actions bot added Component: Java awaiting review Awaiting review labels Jan 19, 2024

vibhatha commented Jan 19, 2024

View reviewed changes

github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Jan 19, 2024

This was referenced Jan 19, 2024

MINOR: [Java] Bump org.codehaus.mojo:exec-maven-plugin from 1.6.0 to 3.1.1 in /java #39374

Closed

MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 in /java/maven #39202

Closed

vibhatha marked this pull request as ready for review January 19, 2024 03:10

vibhatha requested a review from lidavidm as a code owner January 19, 2024 03:10

vibhatha changed the title ~~MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 in /java/maven V2~~ [Java] Bump org.codehaus.mojo:exec-maven-plugin from 1.6.0 to 3.1.1 Jan 22, 2024

vibhatha changed the title ~~[Java] Bump org.codehaus.mojo:exec-maven-plugin from 1.6.0 to 3.1.1~~ MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 in /java/maven V2 Jan 22, 2024

vibhatha changed the title ~~MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 in /java/maven V2~~ [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 Jan 22, 2024

vibhatha force-pushed the feat-puppycrawl-update-8.29 branch from 671b530 to e07b445 Compare January 22, 2024 11:58

github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Jan 22, 2024

vibhatha marked this pull request as draft January 23, 2024 06:48

vibhatha force-pushed the feat-puppycrawl-update-8.29 branch from e07b445 to 3a74b4d Compare January 23, 2024 07:45

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 23, 2024

lidavidm approved these changes Jan 24, 2024

View reviewed changes

github-actions bot added awaiting merge Awaiting merge awaiting changes Awaiting changes and removed awaiting change review Awaiting change review awaiting merge Awaiting merge labels Jan 24, 2024

vibhatha added 6 commits February 5, 2024 18:38

feat: initial test pending

4a84c5e

feat: updating styles

4d1129f

fix: gandiva formatting issues

4dab33c

fix: cleanup deprecated properties

30b1063

feat: adding linelength suppression for flight properties

2bb01c9

fix: addressing reviews

ca838fb

vibhatha force-pushed the feat-puppycrawl-update-8.29 branch from 0ded732 to ca838fb Compare February 5, 2024 13:34

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Feb 5, 2024

lidavidm approved these changes Feb 5, 2024

View reviewed changes

github-actions bot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Feb 5, 2024

lidavidm changed the title ~~[Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29~~ MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 Feb 5, 2024

lidavidm changed the title ~~MINOR: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29~~ GH-39946: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 Feb 5, 2024

lidavidm merged commit cb5c109 into apache:main Feb 5, 2024

lidavidm removed the awaiting merge Awaiting merge label Feb 5, 2024

vibhatha mentioned this pull request Feb 14, 2024

[Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 #39735

Closed

GH-39946: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 #39694

GH-39946: [Java] Bump com.puppycrawl.tools:checkstyle from 8.19 to 8.29 #39694

Uh oh!

Conversation

vibhatha commented Jan 19, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

Uh oh!

vibhatha commented Jan 19, 2024

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!

github-actions bot commented Jan 19, 2024

Uh oh!

vibhatha commented Jan 19, 2024

Uh oh!

vibhatha commented Jan 19, 2024

Uh oh!

github-actions bot commented Jan 19, 2024

Uh oh!

vibhatha commented Jan 22, 2024

Uh oh!

github-actions bot commented Jan 22, 2024

Uh oh!

vibhatha commented Jan 23, 2024

Uh oh!

github-actions bot commented Jan 23, 2024

Uh oh!

vibhatha commented Jan 23, 2024

Uh oh!

lidavidm commented Jan 23, 2024

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vibhatha Feb 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vibhatha Feb 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vibhatha commented Feb 5, 2024

Uh oh!

github-actions bot commented Feb 5, 2024

Uh oh!

github-actions bot commented Feb 5, 2024

Uh oh!

conbench-apache-arrow bot commented Feb 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vibhatha commented Jan 19, 2024 •

edited by github-actions bot

Loading

vibhatha Feb 5, 2024 •

edited

Loading

vibhatha Feb 5, 2024 •

edited

Loading