add feature to include/exclude testSourceSet to checkstyle configuration

Author: alexeytereshchenko

README.md

@@ -31,7 +31,7 @@ exit $status
 
 ```gradle
 plugins {
-    id 'io.github.alexeytereshchenko.guardian' version '1.2.2'
+    id 'io.github.alexeytereshchenko.guardian' version '1.2.5'
 }
 ```
 
@@ -53,6 +53,7 @@ guardian {
     errorThreshold = 0 // Threshold for the number of errors to tolerate before failing the build.
     showViolations = true // Whether to display the details of style violations.
     version = '10.12.6' // Specifies the version of CheckStyle to use.
+    includeTest = false // add test sourceSet to checkstyle
   }
 }
 

plugin/build.gradle

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = 'io.github.alexeytereshchenko.guardian'
-version = '1.2.2'
+version = '1.2.5'
 
 dependencies {
     implementation 'net.ltgt.errorprone:net.ltgt.errorprone.gradle.plugin:3.0.1'

plugin/src/main/java/io/github/alexeytereshchenko/guardian/GuardianPlugin.java

@@ -7,7 +7,7 @@
 import io.github.alexeytereshchenko.guardian.task.DownloadCheckstyleFile;
 import java.io.File;
 import java.net.URL;
-import java.util.List;
+import java.util.ArrayList;
 import java.util.Set;
 import net.ltgt.gradle.errorprone.CheckSeverity;
 import net.ltgt.gradle.errorprone.ErrorProneCompilerArgumentProvider;
@@ -21,6 +21,7 @@
 import org.gradle.api.plugins.quality.CheckstyleExtension;
 import org.gradle.api.tasks.Copy;
 import org.gradle.api.tasks.Delete;
+import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.SourceSetContainer;
 import org.gradle.api.tasks.compile.JavaCompile;
 import org.gradle.language.base.internal.plugins.CleanRule;
@@ -126,29 +127,13 @@ private void configureValidateStyleTask(Project project) {
   }
 
   private void configureCheckstyle(Project project, GuardianExtension guardianExtension) {
-    GuardianCheckStyleExtension checkStyleExtension = guardianExtension.getCheckStyle();
-    String fileUrl = checkStyleExtension.getFileUrl();
-    String filePath = fileUrl == null ? getGuardianCheckStyleFilePath(project) : getCustomCheckStyleFilePath(project);
-
-    int errorThreshold = checkStyleExtension.getErrorThreshold();
-    boolean showViolations = checkStyleExtension.isShowViolations();
-    String version = checkStyleExtension.getVersion();
+    GuardianCheckStyleExtension guardianCheckStyleExtension = guardianExtension.getCheckStyle();
 
     CheckstyleExtension checkstyleExtension = project.getExtensions()
         .findByType(CheckstyleExtension.class);
 
     if (checkstyleExtension != null) {
-      checkstyleExtension.setToolVersion(version);
-      checkstyleExtension.setMaxErrors(errorThreshold);
-      checkstyleExtension.setShowViolations(showViolations);
-      checkstyleExtension.setMaxWarnings(0);
-      checkstyleExtension.setIgnoreFailures(false);
-      checkstyleExtension.setConfigFile(new File(filePath));
-
-      SourceSetContainer sourceSets = (SourceSetContainer) project.getProperties()
-          .get("sourceSets");
-      checkstyleExtension.setSourceSets(
-          List.of(sourceSets.getByName("main"), sourceSets.getByName("test")));
+      configureCheckStyleExtension(project, checkstyleExtension, guardianCheckStyleExtension);
     }
 
     // it's bug in a checkstyle plugin https://github.com/gradle/gradle/issues/27035#issuecomment-1814589243
@@ -165,6 +150,36 @@ private void configureCheckstyle(Project project, GuardianExtension guardianExte
     });
   }
 
+  private void configureCheckStyleExtension(
+      Project project,
+      CheckstyleExtension checkstyleExtension,
+      GuardianCheckStyleExtension guardianCheckStyleExtension
+  ) {
+    String fileUrl = guardianCheckStyleExtension.getFileUrl();
+    String filePath = fileUrl == null ? getGuardianCheckStyleFilePath(project) : getCustomCheckStyleFilePath(project);
+
+    int errorThreshold = guardianCheckStyleExtension.getErrorThreshold();
+    boolean showViolations = guardianCheckStyleExtension.isShowViolations();
+    String version = guardianCheckStyleExtension.getVersion();
+    boolean includeTest = guardianCheckStyleExtension.isIncludeTest();
+
+    checkstyleExtension.setToolVersion(version);
+    checkstyleExtension.setMaxErrors(errorThreshold);
+    checkstyleExtension.setShowViolations(showViolations);
+    checkstyleExtension.setMaxWarnings(0);
+    checkstyleExtension.setIgnoreFailures(false);
+    checkstyleExtension.setConfigFile(new File(filePath));
+
+    SourceSetContainer sourceSetContainer = (SourceSetContainer) project.getProperties().get("sourceSets");
+    ArrayList<SourceSet> sourceSets = new ArrayList<>();
+    sourceSets.add(sourceSetContainer.getByName("main"));
+    if (includeTest) {
+      sourceSets.add(sourceSetContainer.getByName("test"));
+    }
+
+    checkstyleExtension.setSourceSets(sourceSets);
+  }
+
   private String getGuardianCheckStyleFilePath(Project project) {
     URL url = getClass().getClassLoader().getResource("guardian-checkstyle.xml");
     if (url != null) {

plugin/src/main/java/io/github/alexeytereshchenko/guardian/extention/GuardianCheckStyleExtension.java

@@ -6,6 +6,15 @@ public class GuardianCheckStyleExtension {
   private int errorThreshold = 0;
   private boolean showViolations = true;
   private String version = "10.12.6";
+  private boolean includeTest = false;
+
+  public boolean isIncludeTest() {
+    return includeTest;
+  }
+
+  public void setIncludeTest(boolean includeTest) {
+    this.includeTest = includeTest;
+  }
 
   public String getVersion() {
     return version;