#848 dont require javadoc for methods in tests

Author: krzyk

qulice-checkstyle/src/main/resources/com/qulice/checkstyle/checks.xml

@@ -169,9 +169,11 @@
         <property name="fileExtensions" value="java"/>
     </module>
 
-    <!--
-    Enable suppressions
-    -->
+    <module name="SuppressionFilter">
+        <property name="file" value="${project.basedir}/src/main/resources/com/qulice/checkstyle/suppressions.xml"/>
+        <property name="optional" value="false"/>
+    </module>
+
     <module name="TreeWalker">
         <property name="cacheFile" value="${cache.file}" />
 

qulice-checkstyle/src/main/resources/com/qulice/checkstyle/suppressions.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+    <suppress checks="JavadocMethod" files=".+(Test|ITCase|IT).java" />
+</suppressions>

qulice-checkstyle/src/test/java/com/qulice/checkstyle/CheckstyleValidatorTest.java

@@ -53,7 +53,11 @@
  *  exclude `TooManyMethods`. Good candidates for moving out of this class
  *  are all that use `validateCheckstyle` method.
  */
-@SuppressWarnings({ "PMD.TooManyMethods", "PMD.AvoidDuplicateLiterals" })
+@SuppressWarnings(
+    {
+        "PMD.TooManyMethods", "PMD.AvoidDuplicateLiterals", "PMD.GodClass"
+    }
+)
 public final class CheckstyleValidatorTest {
 
     /**
@@ -167,6 +171,16 @@ public void reportsErrorWhenIndentationIsIncorrect() throws Exception {
         );
     }
 
+    /**
+     * CheckstyleValidator does not report an error when there is no JavaDoc
+     * on method in JUnit tests.
+     * @throws Exception when error.
+     */
+    @Test
+    public void doesNotReportErrorWhenMissingJavadocInTests() throws Exception {
+        this.runValidation("MissingJavadocTest.java", true);
+    }
+
     /**
      * CheckstyleValidator reports an error when comment or Javadoc has too
      * long line.

qulice-checkstyle/src/test/resources/com/qulice/checkstyle/MissingJavadocTest.java

@@ -0,0 +1,18 @@
+/*
+ * Hello.
+ */
+package foo;
+
+import org.junit.Test;
+
+/**
+ * Simple.
+ * @since 1.0
+ */
+public class MissingJavadocTest {
+
+    @Test
+    public void testSomething() {
+        return "something";
+    }
+}

qulice-maven-plugin/src/it/checkstyle-violations/verify.groovy

@@ -47,5 +47,5 @@ assert log.text.contains('Violations.java[33]: ArrayList should be initialized w
 assert log.text.contains('Violations.java[34]: ArrayList should be initialized with a size parameter')
 assert log.text.findAll('Pdd.java.*: .todo tag has wrong format').empty
 assert !log.text.contains('Got an exception - java.lang.NullPointerException')
-//assert !log.text.contains('SomeTest.java[5]: This method must be static, because it does not refer to "this"')
+assert log.text.findAll('SomeTest.java .+ (JavadocMethodCheck)').isEmpty()
 assert !log.text.contains('IndentationChecks.java[19]: method call rparen at indentation level 12')