Add support for Gradle to PCT #795

aaravmahajanofficial · 2025-08-16T18:26:54Z

Hello everyone 👋, as part of GSoC project Gradle Convention Plugin for Developing Jenkins Plugins, our aim is to recover the Gradle developer flow for Jenkins. I have been developing a Convention Plugin (which uses Gradle-JPI-Plugin under the hood, but adds new functionality and patches over it, like code-quality tools, support for Jenkins BOM, easy config. etc.).

In continuation of this, next target is to add Native Gradle support in Jenkins PCT.

Focus is to not disturb the already existing Maven logic; instead is to reuse the same logic. As valid pom.xml is required for PCT, I have added ability to make use of generated POM file by gradle-jpi-plugin.

Want to gather valuable feedback from Jenkins community & my GSoC mentors @oleg-nenashev @rahulsom @sghill.
Would be happy to discuss, ideate & improve further.

Thank you! 😄

Testing done

Build Successful when run with:

mvn clean install

java -jar .\target\plugins-compat-tester-cli.jar test-plugins --war .\target\jenkins-war-2.524.war --local-checkout-dir ${insert-gradle-plugin-repo} --working-dir "$(pwd)/pct-work"

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

…iles

…o-pct

oleg-nenashev

Looks pretty good so far!

src/main/java/org/jenkins/tools/test/PluginCompatTesterCli.java

src/main/java/org/jenkins/tools/test/PluginCompatTester.java

src/main/java/org/jenkins/tools/test/gradle/ExternalGradleRunner.java

oleg-nenashev · 2025-08-17T08:33:11Z

src/main/java/org/jenkins/tools/test/gradle/ExternalGradleRunner.java

+        private final Process p;
+
+        @CheckForNull
+        private final File buildLogFile;


Do you also consider taking Problem Reports, Configuration Cacher reports, and other utility files?
Maybe for the next iteration, but they could be added to the aggregated PCT report

Yeah, that would be a great addition ✅
I tried to find aggregated PCT report generation functionality, but didn't find one though. May need to implement one in future IMHO

src/main/java/org/jenkins/tools/test/util/BuildSystem.java

oleg-nenashev

Sorry, it took me some time to return to the PR. I added some comments about the code that could be improved.

IMHO this PR could be merged after the following conditions are met:

The PR is updated to the new location of https://github.com/aaravmahajanofficial/jenkins-gradle-convention-plugin after hosting and, possibly, renaming
There is some documentation added on Gradle Support, e.g. to README. This documentation can indicate the experimental status of the support, and referencing to the requirements (e.g. using the convention plugin)
- NOTE: I Know that the current documentation is not very sufficient (e.g. I created #800 ). For now it should be enough to just add a "Support for Gradle Build Tool" section before useful links
There is a review/approval from at least one @jenkinsci/plugin-compat-tester-developers except me - I have been on sabbatical and it would not be totally appropriate if I come back and start merging things

oleg-nenashev · 2025-09-01T06:54:28Z

src/main/java/org/jenkins/tools/test/util/BuildSystem.java

+
+public enum BuildSystem {
+    MAVEN("pom.xml"),
+    GRADLE("build.gradle", "build.gradle.kts", "settings.gradle", "settings.gradle.kts");


Maybe , GRADLE_BUILD_TOOL to follow the formal name

Thanks Oleg, fixed this in new commit 👍

oleg-nenashev · 2025-09-01T06:56:52Z

src/main/java/org/jenkins/tools/test/util/BuildSystemUtils.java

+
+@SuppressFBWarnings(value = "PATH_TRAVERSAL_IN", justification = "intended behavior")
+public class BuildSystemUtils {
+    public static BuildSystem detectBuildSystem(File cloneDir) {


You could implement a more universal logic that iterates though the build systems and tries to apply them. For that, Java also allows implementing methods right inside enums.

That said, none of that is strictly needed now as we do not have any other reasonably maintained build tool for Jenkins as of now.

oleg-nenashev · 2025-09-01T06:59:16Z

.../java/org/jenkins/tools/test/model/plugin_metadata/LocalCheckoutPluginMetadataExtractor.java

+        this.isGradlePom = !pomFile.getName().equals("pom.xml");
+    }
+
+    private static File resolvePomFile(File baseDir, PluginCompatTesterConfig config) {


Does it have to happen in the constructor? Having complex logic in it, especially with a risk of exceptions, is rather an anti-pattern.

Extracted this logic out of the constructor as a new method in the new commit.

oleg-nenashev · 2025-09-01T07:00:46Z

.../java/org/jenkins/tools/test/model/plugin_metadata/LocalCheckoutPluginMetadataExtractor.java

        this.config = config;
        this.runner = runner;
+        this.pomFile = resolvePomFile(localCheckoutDir, config);
+        this.isGradlePom = !pomFile.getName().equals("pom.xml");


This is some dark magic. How do you determine it just by name equation?
Maybe, returning a tuple from the previous method would be more resilient

Thanks Oleg, I have added an enum PomInfo & PomFile class {File, type of pom file}.

jtnord · 2025-09-01T11:29:22Z

src/main/java/org/jenkins/tools/test/gradle/ExternalGradleRunner.java

+        File gradleWrapper = new File(baseDirectory, SystemUtils.IS_OS_WINDOWS ? "gradlew.bat" : "gradlew");
+        if (externalGradle != null) {
+            cmd.add(externalGradle.getAbsolutePath());
+        } else if (gradleWrapper.exists() && gradleWrapper.canExecute()) {


this conflicts with the help for --gradle-path which says the platform default will be used if the arg is not supplied.

I would argue we should not be using wrappers for executing the tools (we do not attempt to honor an mvnwrapper).

Thanks for this suggestion, fixed this in new commit. Simplified the logic to use only the installed gradle or externally provided one.

jtnord · 2025-09-01T11:31:19Z

src/main/java/org/jenkins/tools/test/gradle/ExternalGradleRunner.java

+        }
+    }
+
+    private static class GradleGobbler extends Thread {


this appears to be unescescary cut-and-paste of https://github.com/jenkinsci/plugin-compat-tester/pull/795/files#diff-3da4b28add832c598dc7f84a32def72cb0376b7c0b34a10edfc489a517fcff41R143
refactor the existing code so that it is shared?

Thanks 👍, I have introduced a ProcessOutputGobbler class in new commit to reduce the duplication

jtnord · 2025-09-01T11:34:25Z

src/main/java/org/jenkins/tools/test/hook/JenkinsTestHarnessHook.java

+                || BuildSystemUtils.detectBuildSystem(context.getCloneDirectory())
+                        .equals(BuildSystem.GRADLE)) {


how do we perform the same functionality for gradle? Additionally why is this disabled but JenkinsTestHarnessHook2 remains?

There are three hooks that are presently not compatible with Gradle builds, ServletApiWorkaround, JenkinsTestHarnessHook2, HPIPluginHook & JenkinsTestHarnessHook. So, I have disabled all four. For the first three, I have disabled them in the base class that they extend.

PropertyVersionHook.java

Ref to build logs, before disabling any of these

There are three hooks that are presently not compatible with Gradle builds, ServletApiWorkaround, JenkinsTestHarnessHook2, HPIPluginHook & JenkinsTestHarnessHook

Right, but they provide functionality that is needed.
You could say that all of the Gradle plugins do not currently need these, but in the future if we need to update the HPIPlugin (which IIUC the gradle code still uses) how would we do that?
I do not see any (example or otherwise) hooks that would do things that could be needed for gradle?

… class

aaravmahajanofficial added 6 commits August 10, 2025 05:37

Add ExternalGradleRunner and GradleExecutionException for Gradle support

88f7732

feat: Add support for extracting metadata from Gradle-generated POM f…

d9435db

…iles

feat: disable-unrelated-to-gradle-hooks

f44f2e1

Merge branch 'jenkinsci:master' into feat/add-native-gradle-support-t…

851c028

…o-pct

feat: auto-generate pom in gradle

39ebc3b

feat: remove redundant Maven build file check in BuildSystemUtils

1bccc0a

oleg-nenashev self-requested a review August 17, 2025 08:26

oleg-nenashev reviewed Aug 17, 2025

View reviewed changes

oleg-nenashev added the enhancement label Aug 17, 2025

oleg-nenashev changed the title ~~feat: add native gradle support to pct~~ Add support for Gradle to PCT Aug 17, 2025

oleg-nenashev self-requested a review August 17, 2025 08:40

aaravmahajanofficial added 2 commits August 17, 2025 15:38

fix: remove the star imports & minor improvements

ab6a6b6

feat: streamline gradle properties

a5f422d

oleg-nenashev reviewed Sep 1, 2025

View reviewed changes

aaravmahajanofficial mentioned this pull request Sep 4, 2025

Ensure Gradle Convention Plugin follows Jenkins build conventions jenkinsci/gradle-convention-plugin#214

Open

jtnord reviewed Sep 6, 2025

View reviewed changes

aaravmahajanofficial added 4 commits September 6, 2025 20:01

Merge branch 'master' into feat/add-native-gradle-support-to-pct

9db3094

refactor: enhance POM file resolution for Gradle support

ff6527e

refactor: reduce code duplication by introducing ProcessOutputGobbler…

3377335

… class

refactor: do not use gradle wrappers for execution

0a33024

aaravmahajanofficial mentioned this pull request Sep 7, 2025

[WIP] Add support for Gradle in Jenkins PCT jenkinsci/gradle-convention-plugin#229

Open

aaravmahajanofficial added 2 commits September 8, 2025 01:06

docs: add support for gradle build tool

bad5b5e

Merge branch 'master' into feat/add-native-gradle-support-to-pct

963aadf

		\|\| BuildSystemUtils.detectBuildSystem(context.getCloneDirectory())
		.equals(BuildSystem.GRADLE)) {

Add support for Gradle to PCT #795

Are you sure you want to change the base?

Add support for Gradle to PCT #795

Uh oh!

Conversation

aaravmahajanofficial commented Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing done

Submitter checklist

Uh oh!

oleg-nenashev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

oleg-nenashev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaravmahajanofficial Sep 6, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aaravmahajanofficial Sep 6, 2025 • 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!

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!

aaravmahajanofficial Sep 6, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aaravmahajanofficial commented Aug 16, 2025 •

edited

Loading

aaravmahajanofficial Sep 6, 2025 •

edited

Loading

aaravmahajanofficial Sep 6, 2025 •

edited

Loading

aaravmahajanofficial Sep 6, 2025 •

edited

Loading