SONARJAVA-1181 Migrate to javaCheckverifier

Author: benzonico

java-checks/src/test/files/checks/UndocumentedApi.java

@@ -2,20 +2,20 @@
  * some documentation
  */
 public class UndocumentedApi { // Compliant - documented
-  public String p; // Non-Compliant
+  public String p; // Noncompliant
   private String key; // Compliant - private
 
   public UndocumentedApi() { // Compliant - empty constructor
   }
 
-  public UndocumentedApi(String key) { // Non-Compliant
+  public UndocumentedApi(String key) { // Noncompliant
     this.key = key;
   }
 
-  public void run() { // Non-Compliant
+  public void run() { // Noncompliant
   }
 
-  public interface InnerUndocumentedInterface { // Non-Compliant
+  public interface InnerUndocumentedInterface { // Noncompliant
   }
 
   /**
@@ -43,20 +43,20 @@ public String toString() { // Compliant - method with override annotation
 
 }
 
-public enum FooEnum { // Non-Compliant
+public enum FooEnum { // Noncompliant {{Document this public enum.}}
 }
 
-public interface Ainterface { // Non-Compliant
+public interface Ainterface { // Noncompliant {{Document this public interface.}}
 }
 
-public @interface FooAnnotation { // Non-Compliant
+public @interface FooAnnotation { // Noncompliant {{Document this public annotation.}}
 }
 
-public class AClass { // Non-Compliant
+public class AClass { // Noncompliant {{Document this public class.}}
 
-  public int a; // Non-Compliant
+  public int a; // Noncompliant {{Document this public field.}}
 
-  public A() { // Non-Compliant
+  public A() { // Noncompliant {{Document this public constructor.}}
     System.out.println();
   }
 
@@ -65,7 +65,7 @@ public A() { // Non-Compliant
 /**
  * This is a Javadoc comment
  */
-public class MyClass<T> implements Runnable {    // Non-Compliant - missing '@param <T>'
+public class MyClass<T> implements Runnable {    // Noncompliant {{Document the parameter(s): <T>}}
 
  private int status;                            // Compliant - not public
 
@@ -74,7 +74,7 @@ public class MyClass<T> implements Runnable {    // Non-Compliant - missing '@pa
    */
  public String message;                         // Compliant - well documented
 
- public MyClass() {                             // Non-Compliant - missing documentation
+ public MyClass() {                             // Noncompliant
    this.status = 0;
  }
 
@@ -98,13 +98,13 @@ public void doSomething(int value) {           // Compliant
  /**
   * @return foo
    */
- public int doSomething(int value) {            // Non-Compliant - missing '@param value'
+ public int doSomething(int value) {            // Noncompliant {{Document the parameter(s): value}}
    return value;
  }
 
  /** plop
   *  */
- public int doSomething() {                     // Non-Compliant - missing '@return'
+ public int doSomething() {                     // Noncompliant {{Document this method return value.}}
    return value;
  }
 }
@@ -118,7 +118,7 @@ interface FooInterface {
 
   /**
    * bar. */
-  int foo(); // Non-Compliant
+  int foo(); // Noncompliant
 
   /**
    * @return
@@ -127,7 +127,7 @@ interface FooInterface {
 
   /** plop.
    */
-  void foo(int a); // Non-Compliant
+  void foo(int a); // Noncompliant {{Document the parameter(s): a}}
 }
 
 /**
@@ -136,7 +136,7 @@ interface FooInterface {
 class FooClass {
   /** constructor.
    */
-  public FooClass(int a) { // Non-Compliant
+  public FooClass(int a) { // Noncompliant {{Document the parameter(s): a}}
     System.out.println(a);
   }
 
@@ -159,12 +159,12 @@ class FooPackage { // Compliant - non public
 public class Foo { // Compliant
   /** foo.
    */
-  public int foo(int a, int b, int c) { // Non-Compliant - single issue for parameters, + one for return value
+  public int foo(int a, int b, int c) { // Noncompliant 2
     return 0;
   }
 
 
-  public int foo(int a, int b, int c) { // Non-Compliant - single issue for complete method
+  public int foo(int a, int b, int c) { // Noncompliant {{Document this public method.}}
     return 0;
   }
 
@@ -174,13 +174,13 @@ public int foo(int a, int b, int c) { // Non-Compliant - single issue for comple
   public <T> void foo() { // Compliant - does not return anything
   }
 
-  public <T> void foo() { // Noncompliant - must document <T>
+  public <T> void foo() { // Noncompliant {{Document this public method.}}
   }
 
   /**
    * @param <T> foo
    */
-  public <T> int foo() { // Noncompliant - must document return value
+  public <T> int foo() { // Noncompliant {{Document this method return value.}}
   }
 
   /**
@@ -195,7 +195,7 @@ public void getThisThingDone() { //false negative this is interpreted as a gette
 }
 /**
  * */
-public interface bar { // Noncompliant empty documentation
+public interface bar { // Noncompliant {{Document this public interface.}}
   /**
   * @param <A>  the annotation type
   * @param annotationType  the <tt>Class</tt> object corresponding to
@@ -205,7 +205,7 @@ public interface bar { // Noncompliant empty documentation
   * @see #getAnnotationMirrors()
   */
   <A extends Annotation> A getAnnotation(Class<A> annotationType);
-  static class A{}
+  static class A{} // Noncompliant {{Document this public class.}}
   public int i = 0;
 
   /**
@@ -220,7 +220,7 @@ default void method(){
   /**
    *
    */
-  static final class DEFAULT {}
+  static final class DEFAULT {} // Noncompliant {{Document this public class.}}
   public int i = 0;
 }
 /**
@@ -250,7 +250,7 @@ public class MyRunner extends Foo {
   /**
    * {@inheritDoc}
    */
-  public int foo(int a, int b, int c) { // Non-Compliant - single issue for parameters, + one for return value
+  public int foo(int a, int b, int c) { // Compliant
     return 0;
   }
 
@@ -259,7 +259,7 @@ private interface Bar {
   }
 
   public void foo
-  (
+  ( // Noncompliant
   )
   {
   }
@@ -268,21 +268,21 @@ private interface Bar {
    */
   public interface Foo {
 
-    public foo();
+    public foo(); // Noncompliant
 
   }
 
   @Target({METHOD})
   @Retention(RUNTIME)
-  public @interface Transient {
-      boolean value() default true;
+  public @interface Transient { // Noncompliant
+      boolean value() default true; // Noncompliant
   }
 }
 class AnonymousInnerClass {
   Comparator<String> doJob(){
     return new Comparator<String>() { // anon-inner-class
       class Hello { // inner-class
-        public void doJob() { // false-positive
+        public void doJob() {
         }
       }
 

java-checks/src/test/java/org/sonar/java/checks/UndocumentedApiCheckTest.java

@@ -19,9 +19,9 @@
  */
 package org.sonar.java.checks;
 
-import org.junit.Rule;
 import org.junit.Test;
 import org.sonar.java.ast.JavaAstScanner;
+import org.sonar.java.checks.verifier.JavaCheckVerifier;
 import org.sonar.java.model.VisitorsBridge;
 import org.sonar.squidbridge.api.SourceFile;
 import org.sonar.squidbridge.checks.CheckMessagesVerifierRule;
@@ -32,54 +32,19 @@
 
 public class UndocumentedApiCheckTest {
 
-  @Rule
-  public CheckMessagesVerifierRule checkMessagesVerifier = new CheckMessagesVerifierRule();
-
   @Test
   public void test() {
     UndocumentedApiCheck check = new UndocumentedApiCheck();
     assertThat(check.forClasses).isEqualTo("**");
-
-    SourceFile file = JavaAstScanner.scanSingleFile(new File("src/test/files/checks/UndocumentedApi.java"), new VisitorsBridge(check));
-    checkMessagesVerifier.verify(file.getCheckMessages())
-      .next().atLine(5)
-      .next().atLine(11)
-      .next().atLine(15)
-      .next().atLine(18)
-      .next().atLine(46).withMessage("Document this public enum.")
-      .next().atLine(49).withMessage("Document this public interface.")
-      .next().atLine(52).withMessage("Document this public annotation.")
-      .next().atLine(55).withMessage("Document this public class.")
-      .next().atLine(57).withMessage("Document this public field.")
-      .next().atLine(59).withMessage("Document this public constructor.")
-      .next().atLine(68).withMessage("Document the parameter(s): <T>")
-      .next().atLine(77)
-      .next().atLine(101).withMessage("Document the parameter(s): value")
-      .next().atLine(107).withMessage("Document this method return value.")
-      .next().atLine(121).withMessage("Document this method return value.")
-      .next().atLine(130).withMessage("Document the parameter(s): a")
-      .next().atLine(139).withMessage("Document the parameter(s): a")
-      .next().atLine(162).withMessage("Document the parameter(s): a, b, c")
-      .next().atLine(162).withMessage("Document this method return value.")
-      .next().atLine(167).withMessage("Document this public method.")
-      .next().atLine(177).withMessage("Document this public method.")
-      .next().atLine(183).withMessage("Document this method return value.")
-      .next().atLine(198).withMessage("Document this public interface.")
-      .next().atLine(208).withMessage("Document this public class.")
-      .next().atLine(223).withMessage("Document this public class.")
-      .next().atLine(262)
-      .next().atLine(271)
-      .next().atLine(277)
-      .next().atLine(278);
+    JavaCheckVerifier.verify("src/test/files/checks/UndocumentedApi.java", check);
   }
 
   @Test
   public void custom() {
     UndocumentedApiCheck check = new UndocumentedApiCheck();
     check.forClasses = "";
-
     SourceFile file = JavaAstScanner.scanSingleFile(new File("src/test/files/checks/UndocumentedApi.java"), new VisitorsBridge(check));
-    checkMessagesVerifier.verify(file.getCheckMessages());
+    new CheckMessagesVerifierRule().verify(file.getCheckMessages());
   }
 
 }