Issue #957: Updating docker Script to Use Latest Groovy5 by AmitKumarDeoghoria · Pull Request #974 · checkstyle/contribution

AmitKumarDeoghoria · 2025-10-07T15:57:09Z

part of : #957

romani

Item

romani · 2025-10-07T18:02:23Z

checkstyle-tester/diff.groovy

 import java.nio.file.Paths
+import java.nio.file.Path
 import java.util.regex.Pattern
+import groovy.cli.picocli.CliBuilder


Is this class part of groovy?
How system understand what jar to download to use this class?

We used Grape .

I think we can use @grab, still testing some things, let me test and get back.

reference : https://issues.apache.org/jira/browse/GROOVY-9432

We should avoid grape if possible.

Did you run this groovy on your local?
I just need some proof that this import is available.

Can we apply this patch to run on groovy 4? If yes, let's migrate off Ant sooner, before migration to groovy 5

No, If you remember from last time we were also in process of upgrading groovy, but we find out that below groovy 4 we have clibuilder() and antbuilder() included in groovy all jar but from 4+ these are excluded.

In local they are available given If we use
@GrabConfig(systemClassLoader=true) @Grab('info.picocli:picocli:4.2.0')

so I researched how these grab mechanism work , It
automatically download and add a dependency (JAR) to the classpath when the script runs in real-time, without mentioning it in pom.xml or adding extra dependencies.
But I am interested in knowing why you want to avoid grab engine mechanism used in groovy? are we making tradeoffs here, Isn't is more resilient like BOM?

back in time this still required some config file. But if all works without extra file , it is good.

@AmitKumarDeoghoria , did you run it on your local? Just to be sure it works.

AmitKumarDeoghoria · 2025-10-07T18:57:00Z

@romani Plz review:
details of changes :
-used static ref as was gettig this error:

Caught: groovy.lang.MissingMethodException: No signature of static method: getCliOptions for class: diff is applicable for argument types: ([Ljava.lang.String;) values: [[-l, projects-to-test-on.properties, -bc, my_check.xml, -pc, my_check.xml, -b, master, ...]]
Possible solutions: getCliOptions(java.lang.Object)
groovy.lang.MissingMethodException: No signature of static method: getCliOptions for class: diff is applicable for argument types: ([Ljava.lang.String;) values: [[-l, projects-to-test-on.properties, -bc, my_check.xml, -pc, my_check.xml, -b, master, ...]]
Possible solutions: getCliOptions(java.lang.Object)
        at diff.main(diff.groovy:11)

Exited with code exit status 1

Used picoli as clibuilder was not part of groovy core and should be used via picoli
was getting some error during the import used this for ref : https://issues.apache.org/jira/browse/GROOVY-9432
Removed Ant builder and replaced it

romani · 2025-10-07T20:30:34Z

Can you describe a problem?
What classes need to be changed? I see you refactoring in ant , not sure why we dealing with CLI builder now.

AmitKumarDeoghoria · 2025-10-09T04:48:52Z

Hey @romani It's because cli builder class is not found as the import is no longer part of groovy all-jar, so we have to use picoli import if we want to use clibuilder for more refernce : https://stackoverflow.com/questions/73862425/groovy-clibuilder-class-not-exists

romani · 2025-10-11T13:45:46Z

based on stackoverflow , such CLI class is already in groovy4 , so we can migrate to it wihout migration to groovy 5.

as we already use groovy4 images in other places, lets migrate to "info.picocli:picocli" now, test that all works.
and separate PR upgrade only goovy version to 5, so we update all images in all repos just for version bump (no groovy code changes).

Does it sounds good to you ?

AmitKumarDeoghoria · 2025-10-19T10:15:21Z

Hey @romani as far as I have remember we are using 3.0.21 groovy Image in the docker file which is being used in majority of the CI's, this was precisely the reason we went for 3.0.21 ( missing cli builder) and not 4.0. I understand your view, just all CLI changes and next we can go for only version bump. Yeah I can do that, but for this picoli changes must be backward compatible, let me check.

AmitKumarDeoghoria · 2025-10-19T10:44:08Z

Ok It's not , info.picoli will be compatible with 4+ only, anyways we have to go for upgrading to 4.0 why not5.0 directly, or do u want to go step by step, first 4 and then 5. Let me know.

AmitKumarDeoghoria · 2025-10-19T10:44:33Z

devops/docker/no-exception-build-image/jdk-21-groovy-git-mvn-ant-jq/Dockerfile

 # Install Java 21, Groovy, Maven via SDKMAN
 RUN bash -c "source $SDKMAN_DIR/bin/sdkman-init.sh && \
    sdk install java 21.0.4-tem && \
-    sdk install groovy 3.0.21 && \


this is the version we are using

romani · 2025-10-21T12:33:06Z

if smooth migration is not possible, ok, lets migrate to 5.0 directly. I just tried to make PRs smaller and easily to approve

AmitKumarDeoghoria · 2026-01-05T19:14:19Z

rebased with latest changes @romani

romani · 2026-01-06T01:50:19Z

CI failure:

C:\projects\contribution\checkstyle-tester\diff.groovy: 11: unable to resolve class groovy.cli.picocli.CliBuilder
 @ line 11, column 1.
   @GrabConfig(systemClassLoader=true)
   ^
1 error

AmitKumarDeoghoria mentioned this pull request Oct 7, 2025

Issue #957: Updating docker Script to Use Groovy5 #969

Closed

AmitKumarDeoghoria force-pushed the groov6 branch 2 times, most recently from 4298e26 to 3232038 Compare October 7, 2025 17:54

romani reviewed Oct 7, 2025

View reviewed changes

AmitKumarDeoghoria force-pushed the groov6 branch 6 times, most recently from 91c4881 to 76bdb63 Compare October 7, 2025 18:48

AmitKumarDeoghoria commented Oct 19, 2025

View reviewed changes

AmitKumarDeoghoria force-pushed the groov6 branch from 76bdb63 to 106cb0f Compare October 19, 2025 11:27

AmitKumarDeoghoria force-pushed the groov6 branch from 106cb0f to 65ccec1 Compare January 5, 2026 18:50

AmitKumarDeoghoria mentioned this pull request Jan 5, 2026

Upgrade all scripts to groovy 3.0.17 or 5.x #957

Open

Issue checkstyle#957: Updating docker Script to Use Latest Groovy5

a29f36b

AmitKumarDeoghoria force-pushed the groov6 branch from 65ccec1 to a29f36b Compare January 8, 2026 15:50

Conversation

AmitKumarDeoghoria commented Oct 7, 2025

Uh oh!

romani left a comment

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!

Choose a reason for hiding this comment

Uh oh!

AmitKumarDeoghoria commented Oct 7, 2025

Uh oh!

romani commented Oct 7, 2025

Uh oh!

AmitKumarDeoghoria commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

romani commented Oct 11, 2025

Uh oh!

AmitKumarDeoghoria commented Oct 19, 2025

Uh oh!

AmitKumarDeoghoria commented Oct 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

romani commented Oct 21, 2025

Uh oh!

AmitKumarDeoghoria commented Jan 5, 2026

Uh oh!

romani commented Jan 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AmitKumarDeoghoria commented Oct 9, 2025 •

edited

Loading