Merge pull request #184 from gradle/sg/checkstyle-api

big-guy · web-flow · commit dad0847a4de0 · 2025-03-26T11:53:37.000-04:00
Add fixed Checkstyle API to Java application and library prototypes
diff --git a/unified-prototype/config/checkstyle.xml b/unified-prototype/config/checkstyle.xml
diff --git a/unified-prototype/testbed-java-application/build.gradle.dcl b/unified-prototype/testbed-java-application/build.gradle.dcl
@@ -4,6 +4,12 @@ javaApplication {
     mainClass = "com.example.App"
     jvmArguments = listOf("-Xmx2G", "-XX:+HeapDumpOnOutOfMemoryError")
 
+    checkstyle {
+        checkstyleVersion = "9.3"
+        configDirectory = layout.settingsDirectory.dir("config")
+        configFile = layout.settingsDirectory.file("config/checkstyle.xml")
+    }
+
     dependencies {
         implementation(project(":java-util"))
         implementation("com.google.guava:guava:32.1.3-jre")
diff --git a/unified-prototype/testbed-java-application/src/main/java/com/example/App.java b/unified-prototype/testbed-java-application/src/main/java/com/example/App.java
@@ -3,7 +3,15 @@
 import com.example.utils.Utils;
 import com.google.common.collect.ImmutableList;
 
+/**
+ * Example Java class.
+ */
 public class App {
+    /**
+     * Entry point.
+     *
+     * @param args command-line arguments
+     */
     public static void main(String[] args) {
         // Verify that Guava is available
         ImmutableList.Builder<String> builder = ImmutableList.builder();
diff --git a/unified-prototype/testbed-java-library/src/main/java/com/example/lib/Library.java b/unified-prototype/testbed-java-library/src/main/java/com/example/lib/Library.java
@@ -3,7 +3,15 @@
 import com.example.utils.Utils;
 import com.google.common.collect.ImmutableList;
 
+/**
+ * Example Java class.
+ */
 public class Library {
+    /**
+     * Example Java method.
+     *
+     * @return collection of messages
+     */
     public Iterable<String> getMessages() {
         // Verify that Guava is available
         ImmutableList.Builder<String> builder = ImmutableList.builder();
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/JavaApplication.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/JavaApplication.java
@@ -2,6 +2,7 @@
 
 import org.gradle.api.Action;
 import org.gradle.api.experimental.common.HasCliExecutables;
+import org.gradle.api.experimental.java.checkstyle.HasCheckstyle;
 import org.gradle.api.experimental.jvm.HasJavaTarget;
 import org.gradle.api.experimental.jvm.HasJvmApplication;
 import org.gradle.api.experimental.jvm.extensions.testing.Testing;
@@ -11,7 +12,7 @@
 /**
  * An application implemented using a single version of Java.
  */
-public interface JavaApplication extends HasJavaTarget, HasJvmApplication, HasCliExecutables {
+public interface JavaApplication extends HasJavaTarget, HasJvmApplication, HasCliExecutables, HasCheckstyle {
     @Nested
     Testing getTesting();
 
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/JavaLibrary.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/JavaLibrary.java
@@ -1,6 +1,7 @@
 package org.gradle.api.experimental.java;
 
 import org.gradle.api.Action;
+import org.gradle.api.experimental.java.checkstyle.HasCheckstyle;
 import org.gradle.api.experimental.jvm.HasJavaTarget;
 import org.gradle.api.experimental.common.HasLibraryDependencies;
 import org.gradle.api.experimental.jvm.extensions.testing.Testing;
@@ -10,7 +11,7 @@
 /**
  * A library implemented using a single version of Java.
  */
-public interface JavaLibrary extends HasJavaTarget, HasLibraryDependencies {
+public interface JavaLibrary extends HasJavaTarget, HasLibraryDependencies, HasCheckstyle {
     @Nested
     Testing getTesting();
 
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/StandaloneJavaApplicationPlugin.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/StandaloneJavaApplicationPlugin.java
@@ -7,6 +7,7 @@
 import org.gradle.api.internal.plugins.software.SoftwareType;
 import org.gradle.api.plugins.ApplicationPlugin;
 import org.gradle.api.plugins.jvm.JvmTestSuite;
+import org.gradle.api.plugins.quality.CheckstylePlugin;
 import org.gradle.jvm.toolchain.JavaToolchainService;
 import org.gradle.testing.base.TestingExtension;
 
@@ -32,6 +33,12 @@ public void apply(Project project) {
 
         project.getExtensions().getByType(TestingExtension.class).getSuites().withType(JvmTestSuite.class).named("test").configure(JvmTestSuite::useJUnitJupiter);
 
+        dslModel.checkstyle(checkstyleDefinition -> {
+            checkstyleDefinition.getCheckstyleVersion().convention(CheckstylePlugin.DEFAULT_CHECKSTYLE_VERSION);
+            checkstyleDefinition.getConfigDirectory().convention(project.getLayout().getSettingsDirectory().dir("config"));
+            checkstyleDefinition.getConfigFile().convention(checkstyleDefinition.getConfigDirectory().file("checkstyle.xml"));
+        });
+
         linkDslModelToPlugin(project, dslModel);
     }
 
@@ -44,6 +51,7 @@ private void linkDslModelToPlugin(Project project, JavaApplication dslModel) {
         JvmPluginSupport.linkMainSourceSourceSetDependencies(project, dslModel.getDependencies());
         JvmPluginSupport.linkTestJavaVersion(project, getJavaToolchainService(), dslModel.getTesting());
         JvmPluginSupport.linkTestSourceSourceSetDependencies(project, dslModel.getTesting().getDependencies());
+        JvmPluginSupport.linkCheckstyle(project, dslModel.getCheckstyle());
 
         dslModel.getRunTasks().add(project.getTasks().named("run"));
     }
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/StandaloneJavaLibraryPlugin.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/StandaloneJavaLibraryPlugin.java
@@ -6,6 +6,7 @@
 import org.gradle.api.internal.plugins.software.SoftwareType;
 import org.gradle.api.plugins.JavaLibraryPlugin;
 import org.gradle.api.plugins.jvm.JvmTestSuite;
+import org.gradle.api.plugins.quality.CheckstylePlugin;
 import org.gradle.jvm.toolchain.JavaToolchainService;
 import org.gradle.testing.base.TestingExtension;
 
@@ -30,6 +31,12 @@ public void apply(Project project) {
 
         project.getExtensions().getByType(TestingExtension.class).getSuites().withType(JvmTestSuite.class).named("test").configure(JvmTestSuite::useJUnitJupiter);
 
+        dslModel.checkstyle(checkstyleDefinition -> {
+            checkstyleDefinition.getCheckstyleVersion().convention(CheckstylePlugin.DEFAULT_CHECKSTYLE_VERSION);
+            checkstyleDefinition.getConfigDirectory().convention(project.getLayout().getSettingsDirectory().dir("config"));
+            checkstyleDefinition.getConfigFile().convention(checkstyleDefinition.getConfigDirectory().file("checkstyle.xml"));
+        });
+
         linkDslModelToPlugin(project, dslModel);
     }
 
@@ -41,5 +48,6 @@ private void linkDslModelToPlugin(Project project, JavaLibrary dslModel) {
         JvmPluginSupport.linkMainSourceSourceSetDependencies(project, dslModel.getDependencies());
         JvmPluginSupport.linkTestJavaVersion(project, getJavaToolchainService(), dslModel.getTesting());
         JvmPluginSupport.linkTestSourceSourceSetDependencies(project, dslModel.getTesting().getDependencies());
+        JvmPluginSupport.linkCheckstyle(project, dslModel.getCheckstyle());
     }
 }
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/checkstyle/CheckstyleDefinition.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/checkstyle/CheckstyleDefinition.java
@@ -0,0 +1,17 @@
+package org.gradle.api.experimental.java.checkstyle;
+
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.provider.Property;
+import org.gradle.declarative.dsl.model.annotations.Restricted;
+
+public interface CheckstyleDefinition {
+    @Restricted
+    Property<String> getCheckstyleVersion();
+
+    @Restricted
+    DirectoryProperty getConfigDirectory();
+
+    @Restricted
+    RegularFileProperty getConfigFile();
+}
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/checkstyle/HasCheckstyle.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/java/checkstyle/HasCheckstyle.java
@@ -0,0 +1,15 @@
+package org.gradle.api.experimental.java.checkstyle;
+
+import org.gradle.api.Action;
+import org.gradle.api.tasks.Nested;
+import org.gradle.declarative.dsl.model.annotations.Configuring;
+
+public interface HasCheckstyle {
+    @Nested
+    CheckstyleDefinition getCheckstyle();
+
+    @Configuring
+    default void checkstyle(Action<? super CheckstyleDefinition> action) {
+        action.execute(getCheckstyle());
+    }
+}
diff --git a/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/jvm/internal/JvmPluginSupport.java b/unified-prototype/unified-plugin/plugin-jvm/src/main/java/org/gradle/api/experimental/jvm/internal/JvmPluginSupport.java
@@ -1,24 +1,32 @@
 package org.gradle.api.experimental.jvm.internal;
 
+import org.gradle.api.NamedDomainObjectProvider;
 import org.gradle.api.Project;
+import org.gradle.api.artifacts.DependencyScopeConfiguration;
+import org.gradle.api.artifacts.ResolvableConfiguration;
 import org.gradle.api.experimental.common.ApplicationDependencies;
 import org.gradle.api.experimental.common.BasicDependencies;
 import org.gradle.api.experimental.common.LibraryDependencies;
+import org.gradle.api.experimental.java.checkstyle.CheckstyleDefinition;
 import org.gradle.api.experimental.jvm.HasJavaTarget;
 import org.gradle.api.experimental.jvm.HasJavaTargets;
 import org.gradle.api.experimental.jvm.HasJvmApplication;
 import org.gradle.api.experimental.jvm.JavaTarget;
 import org.gradle.api.experimental.jvm.extensions.testing.TestDependencies;
 import org.gradle.api.experimental.jvm.extensions.testing.Testing;
 import org.gradle.api.file.Directory;
+import org.gradle.api.file.FileCollection;
 import org.gradle.api.plugins.JavaApplication;
 import org.gradle.api.plugins.JavaPluginExtension;
 import org.gradle.api.plugins.internal.JavaPluginHelper;
+import org.gradle.api.plugins.quality.Checkstyle;
 import org.gradle.api.tasks.SourceSet;
+import org.gradle.api.tasks.SourceSetContainer;
 import org.gradle.api.tasks.compile.JavaCompile;
 import org.gradle.api.tasks.testing.Test;
 import org.gradle.jvm.toolchain.JavaLanguageVersion;
 import org.gradle.jvm.toolchain.JavaToolchainService;
+import org.gradle.language.base.plugins.LifecycleBasePlugin;
 
 import java.util.Collections;
 
@@ -119,4 +127,37 @@ public static void linkTestJavaVersion(Project project, JavaToolchainService too
             task.getJavaLauncher().set(toolchains.launcherFor(spec -> spec.getLanguageVersion().set(testing.getTestJavaVersion().map(JavaLanguageVersion::of))));
         });
     }
+
+    public static void linkCheckstyle(Project project, CheckstyleDefinition checkstyleDefinition) {
+        // Half implementation of org.gradle.checkstyle
+        NamedDomainObjectProvider<DependencyScopeConfiguration> checkstyleTool = project.getConfigurations().dependencyScope("checkstyleTool", conf -> {
+            conf.getDependencies().addLater(checkstyleDefinition.getCheckstyleVersion().map(v -> project.getDependencies().create("com.puppycrawl.tools:checkstyle:" + v)));
+        });
+        NamedDomainObjectProvider<ResolvableConfiguration> checkstyleClasspath = project.getConfigurations().resolvable("checkstyleClasspath", conf -> {
+            conf.extendsFrom(checkstyleTool.get());
+        });
+
+        SourceSetContainer sourceSets = project.getExtensions().getByType(SourceSetContainer.class);
+        sourceSets.all(sourceSet -> createCheckstyleForSourceSet(project, checkstyleDefinition, checkstyleClasspath.get(), sourceSet));
+    }
+
+    private static void createCheckstyleForSourceSet(Project project, CheckstyleDefinition checkstyleDefinition, FileCollection checkstyleClasspath, SourceSet sourceSet) {
+        project.getTasks().register(sourceSet.getTaskName("checkstyle", null), Checkstyle.class, task -> {
+            task.setDescription(String.format("Runs Checkstyle for source set '%s'.", sourceSet.getName()));
+            task.setGroup(LifecycleBasePlugin.VERIFICATION_GROUP);
+
+            task.setSource(sourceSet.getAllJava());
+            task.setClasspath(sourceSet.getRuntimeClasspath());
+
+            task.getConfigDirectory().convention(checkstyleDefinition.getConfigDirectory());
+            task.setCheckstyleClasspath(checkstyleClasspath);
+            task.setConfigFile(checkstyleDefinition.getConfigFile().getAsFile().get());
+
+            task.getReports().getHtml().getRequired().convention(true);
+            task.getReports().getHtml().getOutputLocation().convention(project.getLayout().getBuildDirectory().file("reports/checkstyle/" + sourceSet.getName() + ".html"));
+
+            task.getReports().getXml().getRequired().convention(task.getReports().getHtml().getRequired());
+            task.getReports().getXml().getOutputLocation().convention(project.getLayout().getBuildDirectory().file("reports/checkstyle/" + sourceSet.getName() + ".xml"));
+        });
+    }
 }
