Issue #13345: Enabled DesignForExtensionCheckExamplesTest

checkstyle · Apr 4, 2024 · 05f0371 · 05f0371
1 parent 681a1d7
commit 05f0371
Show file tree

Hide file tree

Showing 7 changed files with 76 additions and 62 deletions.
diff --git a/...va/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheckExamplesTest.java b/...va/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheckExamplesTest.java
@@ -19,12 +19,12 @@
 
 package com.puppycrawl.tools.checkstyle.checks.design;
 
-import org.junit.jupiter.api.Disabled;
+import static com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck.MSG_KEY;
+
 import org.junit.jupiter.api.Test;
 
 import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
 
-@Disabled("until https://github.com/checkstyle/checkstyle/issues/13345")
 public class DesignForExtensionCheckExamplesTest extends AbstractExamplesModuleTestSupport {
     @Override
     protected String getPackageLocation() {
@@ -34,36 +34,46 @@ protected String getPackageLocation() {
     @Test
     public void testExample1() throws Exception {
         final String[] expected = {
-
+            "14:3: " + getCheckMessage(MSG_KEY, "Example1", "m1"),
+            "16:3: " + getCheckMessage(MSG_KEY, "Example1", "m2"),
+            "41:3: " + getCheckMessage(MSG_KEY, "Example1", "toString"),
         };
 
-        verifyWithInlineConfigParser(getPath("Example1.txt"), expected);
+        verifyWithInlineConfigParser(getPath("Example1.java"), expected);
     }
 
     @Test
     public void testExample2() throws Exception {
         final String[] expected = {
-
+            "16:3: " + getCheckMessage(MSG_KEY, "Example2", "m1"),
+            "18:3: " + getCheckMessage(MSG_KEY, "Example2", "m2"),
         };
 
-        verifyWithInlineConfigParser(getPath("Example2.txt"), expected);
+        verifyWithInlineConfigParser(getPath("Example2.java"), expected);
     }
 
     @Test
     public void testExample3() throws Exception {
         final String[] expected = {
-
+            "16:3: " + getCheckMessage(MSG_KEY, "Example3", "m1"),
+            "18:3: " + getCheckMessage(MSG_KEY, "Example3", "m2"),
+            "35:3: " + getCheckMessage(MSG_KEY, "Example3", "m7"),
+            "41:3: " + getCheckMessage(MSG_KEY, "Example3", "m8"),
+            "43:3: " + getCheckMessage(MSG_KEY, "Example3", "toString"),
         };
 
-        verifyWithInlineConfigParser(getPath("Example3.txt"), expected);
+        verifyWithInlineConfigParser(getPath("Example3.java"), expected);
     }
 
     @Test
     public void testExample4() throws Exception {
         final String[] expected = {
-
+            "17:3: " + getCheckMessage(MSG_KEY, "Example4", "m1"),
+            "19:3: " + getCheckMessage(MSG_KEY, "Example4", "m2"),
+            "36:3: " + getCheckMessage(MSG_KEY, "Example4", "m7"),
+            "44:3: " + getCheckMessage(MSG_KEY, "Example4", "toString"),
         };
 
-        verifyWithInlineConfigParser(getPath("Example4.txt"), expected);
+        verifyWithInlineConfigParser(getPath("Example4.java"), expected);
     }
 }
diff --git a/...ks/design/designforextension/Example1.txt → ...s/design/designforextension/Example1.java b/...ks/design/designforextension/Example1.txt → ...s/design/designforextension/Example1.java
@@ -5,14 +5,15 @@
   </module>
 </module>
 */
+package com.puppycrawl.tools.checkstyle.checks.design.designforextension;
 
 // xdoc section -- start
-public abstract class Foo {
+public abstract class Example1 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}  // OK. Private method.
 
@@ -37,8 +38,8 @@ protected void m4() { }  // OK. No implementation.
    */
   public int m8() {return 2;}  // OK. Have javadoc on overridable method.
 
-  @Override
-  public String toString() {  // Violation. No javadoc for @Override method.
+  @Override                   // violation
+  public String toString() {
     return "";
   }
 }

diff --git a/...ks/design/designforextension/Example2.txt → ...s/design/designforextension/Example2.java b/...ks/design/designforextension/Example2.txt → ...s/design/designforextension/Example2.java
@@ -7,14 +7,15 @@
   </module>
 </module>
 */
+package com.puppycrawl.tools.checkstyle.checks.design.designforextension;
 
 // xdoc section -- start
-public abstract class Foo {
+public abstract class Example2 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}  // OK. Private method.
 
@@ -40,7 +41,7 @@ protected void m4() { }  // OK. No implementation.
   public int m8() {return 2;}  // OK. Have javadoc on overridable method.
 
   @Override
-  public String toString() {  // OK. Have javadoc on overridable method.
+  public String toString() {
     return "";
   }
 }

diff --git a/...ks/design/designforextension/Example3.txt → ...s/design/designforextension/Example3.java b/...ks/design/designforextension/Example3.txt → ...s/design/designforextension/Example3.java
@@ -7,14 +7,15 @@
   </module>
 </module>
 */
+package com.puppycrawl.tools.checkstyle.checks.design.designforextension;
 
 // xdoc section -- start
-public abstract class Foo {
+public abstract class Example3 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}  // OK. Private method.
 
@@ -31,16 +32,16 @@ protected void m4() { }  // OK. No implementation.
   /**
    * Some comments ...
    */
-  public int m7() {return 1;}  // Violation. No required javadoc.
+  public int m7() {return 1;}  // violation
 
   /**
    * This
    * implementation ...
    */
-  public int m8() {return 2;}  // Violation. No required javadoc.
+  public int m8() {return 2;}  // violation
 
-  @Override
-  public String toString() {  // Violation. No required javadoc.
+  @Override                    // violation
+  public String toString() {
     return "";
   }
 }

diff --git a/...ks/design/designforextension/Example4.txt → ...s/design/designforextension/Example4.java b/...ks/design/designforextension/Example4.txt → ...s/design/designforextension/Example4.java
@@ -8,14 +8,15 @@
   </module>
 </module>
 */
+package com.puppycrawl.tools.checkstyle.checks.design.designforextension;
 
 // xdoc section -- start
-public abstract class Foo {
+public abstract class Example4 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}
 
@@ -32,16 +33,16 @@ protected void m4() { }  // OK. No implementation.
   /**
    * Some comments ...
    */
-  public int m7() {return 1;}  // Violation. No required javadoc.
+  public int m7() {return 1;}  // violation
 
   /**
    * This
    * implementation ...
    */
   public int m8() {return 2;}  // OK. Have required javadoc.
 
-  @Override
-  public String toString() {  // Violation. No required javadoc.
+  @Override                    // violation
+  public String toString() {
     return "";
   }
 }

diff --git a/src/xdocs/checks/design/designforextension.xml b/src/xdocs/checks/design/designforextension.xml
@@ -169,12 +169,12 @@ public abstract class Plant {
         </source>
         <p id="Example1-code">Example:</p>
         <source>
-public abstract class Foo {
+public abstract class Example1 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}  // OK. Private method.
 
@@ -199,8 +199,8 @@ public abstract class Foo {
    */
   public int m8() {return 2;}  // OK. Have javadoc on overridable method.
 
-  @Override
-  public String toString() {  // Violation. No javadoc for @Override method.
+  @Override                   // violation
+  public String toString() {
     return &quot;&quot;;
   }
 }
@@ -221,12 +221,12 @@ public abstract class Foo {
         </source>
         <p id="Example2-code">Example:</p>
         <source>
-public abstract class Foo {
+public abstract class Example2 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}  // OK. Private method.
 
@@ -252,7 +252,7 @@ public abstract class Foo {
   public int m8() {return 2;}  // OK. Have javadoc on overridable method.
 
   @Override
-  public String toString() {  // OK. Have javadoc on overridable method.
+  public String toString() {
     return &quot;&quot;;
   }
 }
@@ -273,12 +273,12 @@ public abstract class Foo {
         </source>
         <p id="Example3-code">Example:</p>
         <source>
-public abstract class Foo {
+public abstract class Example3 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}  // OK. Private method.
 
@@ -295,16 +295,16 @@ public abstract class Foo {
   /**
    * Some comments ...
    */
-  public int m7() {return 1;}  // Violation. No required javadoc.
+  public int m7() {return 1;}  // violation
 
   /**
    * This
    * implementation ...
    */
-  public int m8() {return 2;}  // Violation. No required javadoc.
+  public int m8() {return 2;}  // violation
 
-  @Override
-  public String toString() {  // Violation. No required javadoc.
+  @Override                    // violation
+  public String toString() {
     return &quot;&quot;;
   }
 }
@@ -326,12 +326,12 @@ public abstract class Foo {
         </source>
         <p id="Example4-code">Example:</p>
         <source>
-public abstract class Foo {
+public abstract class Example4 {
   private int bar;
 
-  public int m1() {return 2;}  // Violation. No javadoc.
+  public int m1() {return 2;}  // violation
 
-  public int m2() {return 8;}  // Violation. No javadoc.
+  public int m2() {return 8;}  // violation
 
   private void m3() {m4();}
 
@@ -348,16 +348,16 @@ public abstract class Foo {
   /**
    * Some comments ...
    */
-  public int m7() {return 1;}  // Violation. No required javadoc.
+  public int m7() {return 1;}  // violation
 
   /**
    * This
    * implementation ...
    */
   public int m8() {return 2;}  // OK. Have required javadoc.
 
-  @Override
-  public String toString() {  // Violation. No required javadoc.
+  @Override                    // violation
+  public String toString() {
     return &quot;&quot;;
   }
 }

diff --git a/src/xdocs/checks/design/designforextension.xml.template b/src/xdocs/checks/design/designforextension.xml.template
@@ -143,13 +143,13 @@ public abstract class Plant {
         </p>
         <macro name="example">
           <param name="path"
-                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example1.txt"/>
+                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example1.java"/>
           <param name="type" value="config"/>
         </macro>
         <p id="Example1-code">Example:</p>
         <macro name="example">
           <param name="path"
-                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example1.txt"/>
+                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example1.java"/>
             <param name="type" value="code"/>
         </macro>
 
@@ -159,13 +159,13 @@ public abstract class Plant {
         </p>
         <macro name="example">
           <param name="path"
-                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example2.txt"/>
+                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example2.java"/>
           <param name="type" value="config"/>
         </macro>
         <p id="Example2-code">Example:</p>
         <macro name="example">
           <param name="path"
-                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example2.txt"/>
+                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example2.java"/>
             <param name="type" value="code"/>
         </macro>
 
@@ -175,13 +175,13 @@ public abstract class Plant {
         </p>
         <macro name="example">
           <param name="path"
-                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example3.txt"/>
+                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example3.java"/>
           <param name="type" value="config"/>
         </macro>
         <p id="Example3-code">Example:</p>
         <macro name="example">
           <param name="path"
-                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example3.txt"/>
+                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example3.java"/>
             <param name="type" value="code"/>
         </macro>
 
@@ -191,13 +191,13 @@ public abstract class Plant {
         </p>
         <macro name="example">
           <param name="path"
-                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example4.txt"/>
+                 value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example4.java"/>
           <param name="type" value="config"/>
         </macro>
         <p id="Example4-code">Example:</p>
         <macro name="example">
           <param name="path"
-                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example4.txt"/>
+                   value="resources/com/puppycrawl/tools/checkstyle/checks/design/designforextension/Example4.java"/>
             <param name="type" value="code"/>
         </macro>
       </subsection>