SONARJAVA-1171 Custom rules for test files

Author: pawlakm

its/plugin/plugins/java-extension-plugin/pom.xml

@@ -28,7 +28,7 @@
       <groupId>org.codehaus.sonar-plugins.java</groupId>
       <artifactId>sonar-java-plugin</artifactId>
       <type>sonar-plugin</type>
-      <version>3.1</version>
+      <version>3.4-SNAPSHOT</version>
       <scope>provided</scope>
     </dependency>
   </dependencies>

its/plugin/plugins/java-extension-plugin/src/main/java/org/sonar/samples/java/JavaExtensionPlugin.java

@@ -20,15 +20,16 @@
 package org.sonar.samples.java;
 
 import com.google.common.collect.ImmutableList;
-import org.sonar.api.SonarPlugin;
-
 import java.util.List;
+import org.sonar.api.SonarPlugin;
 
 public class JavaExtensionPlugin extends SonarPlugin {
 
   @Override
   public List getExtensions() {
-    return ImmutableList.of(JavaExtensionRulesDefinition.class, JavaExtensionsCheckRegistrar.class);
+    return ImmutableList.of(
+      JavaExtensionRulesDefinition.class,
+      JavaExtensionsCheckRegistrar.class);
   }
 
 }

its/plugin/plugins/java-extension-plugin/src/main/java/org/sonar/samples/java/JavaExtensionRulesDefinition.java

@@ -32,10 +32,13 @@ public void define(Context context) {
     repo.setName(REPOSITORY_KEY);
 
     // We could use a XML or JSON file to load all rule metadata, but
-    // we prefer use annotations in order to have all information in a single place
+    // we prefer use annotations in order to have all information in a
+    // single place
     RulesDefinitionAnnotationLoader annotationLoader = new RulesDefinitionAnnotationLoader();
+    // Load custom check classes
     annotationLoader.load(repo, JavaExtensionsCheckRegistrar.checkClasses());
+    // Load custom test check classes
+    annotationLoader.load(repo, JavaExtensionsCheckRegistrar.testCheckClasses());
     repo.done();
   }
 }
-

its/plugin/plugins/java-extension-plugin/src/main/java/org/sonar/samples/java/JavaExtensionsCheckRegistrar.java

@@ -19,24 +19,28 @@
  */
 package org.sonar.samples.java;
 
-
+import java.util.Arrays;
 import org.sonar.plugins.java.api.CheckRegistrar;
 import org.sonar.plugins.java.api.JavaCheck;
 
-import java.util.Arrays;
-
 public class JavaExtensionsCheckRegistrar implements CheckRegistrar {
   /**
    * Lists all the checks provided by the plugin
    */
   public static Class<? extends JavaCheck>[] checkClasses() {
-    return new Class[]{ExampleCheck.class, SubscriptionExampleCheck.class};
+    return new Class[] {ExampleCheck.class, SubscriptionExampleCheck.class};
+  }
+
+  /**
+   * Lists all the test checks provided by the plugin
+   */
+  public static Class<? extends JavaCheck>[] testCheckClasses() {
+    return new Class[] {SubscriptionExampleTestCheck.class};
   }
 
   @Override
   public void register(RegistrarContext registrarContext) {
-    registrarContext.registerClassesForRepository(JavaExtensionRulesDefinition.REPOSITORY_KEY, Arrays.asList(checkClasses()));
+    registrarContext.registerClassesForRepository(JavaExtensionRulesDefinition.REPOSITORY_KEY, Arrays.asList(checkClasses()), Arrays.asList(testCheckClasses()));
   }
 
 }
-

its/plugin/plugins/java-extension-plugin/src/main/java/org/sonar/samples/java/SubscriptionExampleCheck.java

@@ -20,13 +20,12 @@
 package org.sonar.samples.java;
 
 import com.google.common.collect.ImmutableList;
+import java.util.List;
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.tree.Tree;
 
-import java.util.List;
-
 @Rule(key = "subscriptionexamplecheck", priority = Priority.MINOR, name = "SubscriptionExampleCheck", description = "SubscriptionExampleCheck")
 public class SubscriptionExampleCheck extends IssuableSubscriptionVisitor {
 

its/plugin/plugins/java-extension-plugin/src/main/java/org/sonar/samples/java/SubscriptionExampleTestCheck.java

@@ -0,0 +1,22 @@
+package org.sonar.samples.java;
+
+import com.google.common.collect.ImmutableList;
+import java.util.List;
+import org.sonar.check.Priority;
+import org.sonar.check.Rule;
+import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
+import org.sonar.plugins.java.api.tree.Tree;
+
+@Rule(key = "subscriptionexampletestcheck", priority = Priority.MINOR, name = "SubscriptionExampleTestCheck", description = "SubscriptionExampleTestCheck")
+public class SubscriptionExampleTestCheck extends IssuableSubscriptionVisitor {
+
+  @Override
+  public List<Tree.Kind> nodesToVisit() {
+    return ImmutableList.of(Tree.Kind.METHOD);
+  }
+
+  @Override
+  public void visitNode(Tree tree) {
+    addIssue(tree, "Issue on test methods");
+  }
+}

java-squid/src/main/java/org/sonar/java/SonarComponents.java

@@ -37,6 +37,7 @@
 
 import javax.annotation.Nullable;
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
 
@@ -49,30 +50,34 @@ public class SonarComponents implements BatchExtension {
   private final FileSystem fs;
   private final JavaClasspath javaClasspath;
   private final List<Checks<JavaCheck>> checks;
-  private Checks<JavaCheck> testChecks;
+  private final List<Checks<JavaCheck>> testChecks;
 
   public SonarComponents(FileLinesContextFactory fileLinesContextFactory, ResourcePerspectives resourcePerspectives, FileSystem fs,
-                         JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath,
-                         CheckFactory checkFactory) {
+    JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath,
+    CheckFactory checkFactory) {
     this(fileLinesContextFactory, resourcePerspectives, fs, javaClasspath, javaTestClasspath, checkFactory, null);
   }
 
   public SonarComponents(FileLinesContextFactory fileLinesContextFactory, ResourcePerspectives resourcePerspectives, FileSystem fs,
-                         JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath, CheckFactory checkFactory,
-                         @Nullable CheckRegistrar[] checkRegistrars) {
+    JavaClasspath javaClasspath, JavaTestClasspath javaTestClasspath, CheckFactory checkFactory,
+    @Nullable CheckRegistrar[] checkRegistrars) {
     this.fileLinesContextFactory = fileLinesContextFactory;
     this.resourcePerspectives = resourcePerspectives;
     this.fs = fs;
     this.javaClasspath = javaClasspath;
     this.javaTestClasspath = javaTestClasspath;
     this.checkFactory = checkFactory;
-    checks = Lists.newArrayList();
+    this.checks = Lists.newArrayList();
+    this.testChecks = Lists.newArrayList();
 
-    if(checkRegistrars != null) {
+    if (checkRegistrars != null) {
       CheckRegistrar.RegistrarContext registrarContext = new CheckRegistrar.RegistrarContext();
       for (CheckRegistrar checkClassesRegister : checkRegistrars) {
         checkClassesRegister.register(registrarContext);
-        registerCheckClasses(registrarContext.repositoryKey(), Lists.newArrayList(registrarContext.checkClasses()));
+        Iterable<Class<? extends JavaCheck>> checkClasses = registrarContext.checkClasses();
+        Iterable<Class<? extends JavaCheck>> testCheckClasses = registrarContext.testCheckClasses();
+        registerCheckClasses(registrarContext.repositoryKey(), Lists.newArrayList(checkClasses != null ? checkClasses : new ArrayList<Class<? extends JavaCheck>>()));
+        registerTestCheckClasses(registrarContext.repositoryKey(), Lists.newArrayList(testCheckClasses != null ? testCheckClasses : new ArrayList<Class<? extends JavaCheck>>()));
       }
     }
   }
@@ -108,14 +113,17 @@ public ResourcePerspectives getResourcePerspectives() {
     return resourcePerspectives;
   }
 
-  public void registerCheckClasses(String repositoryKey, Collection<Class<? extends JavaCheck>> checkClasses) {
+  public void registerCheckClasses(String repositoryKey, List<Class<? extends JavaCheck>> checkClasses) {
     checks.add(checkFactory.<JavaCheck>create(repositoryKey).addAnnotatedChecks(checkClasses));
   }
 
   public CodeVisitor[] checkClasses() {
     List<CodeVisitor> visitors = Lists.newArrayList();
-    for (Checks<JavaCheck> check : checks) {
-      visitors.addAll(check.all());
+    for (Checks<JavaCheck> checksElement : checks) {
+      Collection<JavaCheck> checksCollection = checksElement.all();
+      if (!checksCollection.isEmpty()) {
+        visitors.addAll(checksCollection);
+      }
     }
     return visitors.toArray(new CodeVisitor[visitors.size()]);
   }
@@ -124,17 +132,19 @@ public Iterable<Checks<JavaCheck>> checks() {
     return Iterables.concat(checks, Lists.newArrayList(testChecks));
   }
 
-  public void registerTestCheckClasses(String repositoryKey, List<Class<? extends JavaCheck>> javaTestChecks) {
-    testChecks = checkFactory.<JavaCheck>create(repositoryKey).addAnnotatedChecks(javaTestChecks);
+  public void registerTestCheckClasses(String repositoryKey, List<Class<? extends JavaCheck>> checkClasses) {
+    testChecks.add(checkFactory.<JavaCheck>create(repositoryKey).addAnnotatedChecks(checkClasses));
   }
 
   public Collection<JavaCheck> testCheckClasses() {
-    if(testChecks == null) {
-      return Lists.newArrayList();
+    List<JavaCheck> visitors = Lists.newArrayList();
+    for (Checks<JavaCheck> checksElement : testChecks) {
+      Collection<JavaCheck> checksCollection = checksElement.all();
+      if (!checksCollection.isEmpty()) {
+        visitors.addAll(checksCollection);
+      }
     }
-    return testChecks.all();
+    return visitors;
   }
 
-
-
 }

java-squid/src/main/java/org/sonar/plugins/java/api/CheckRegistrar.java

@@ -27,6 +27,7 @@
 /**
  * This batch extension should be extended to provide the classes to be used to instantiate checks.
  * The register method has to be implemented and the registrarContext should register the repository keys.
+ *
  * <pre>
  *   {@code
  *   public void register(RegistrarContext registrarContext) {
@@ -47,11 +48,13 @@ public interface CheckRegistrar extends BatchExtension {
   class RegistrarContext {
     private String repositoryKey;
     private Iterable<Class<? extends JavaCheck>> checkClasses;
+    private Iterable<Class<? extends JavaCheck>> testCheckClasses;
 
-    public void registerClassesForRepository(String repositoryKey, Iterable<Class<? extends JavaCheck>> checkClasses){
+    public void registerClassesForRepository(String repositoryKey, Iterable<Class<? extends JavaCheck>> checkClasses, Iterable<Class<? extends JavaCheck>> testCheckClasses) {
       Preconditions.checkArgument(StringUtils.isNotBlank(repositoryKey), "Please specify a valid repository key to register your custom rules");
       this.repositoryKey = repositoryKey;
       this.checkClasses = checkClasses;
+      this.testCheckClasses = testCheckClasses;
     }
 
     public String repositoryKey() {
@@ -62,6 +65,10 @@ public Iterable<Class<? extends JavaCheck>> checkClasses() {
       return checkClasses;
     }
 
+    public Iterable<Class<? extends JavaCheck>> testCheckClasses() {
+      return testCheckClasses;
+    }
+
   }
 
 }