Issue checkstyle#10548: Migrate to Inline Config Parser in ArrayTrail…

…ingCommaCheckTest
shashwatj07 · Aug 5, 2021 · 7ef53e3 · 7ef53e3
1 parent c350a32
commit 7ef53e3
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 44 deletions.
diff --git a/pom.xml b/pom.xml
@@ -1706,7 +1706,6 @@
 
                 <exclude>**/NoWhitespaceAfterCheckTest.class</exclude>
 
-                <exclude>**/ArrayTrailingCommaCheckTest.class</exclude>
 
                 <exclude>**/HideUtilityClassConstructorCheckTest.class</exclude>
 

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java b/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java
@@ -40,7 +40,7 @@ public final class InlineConfigParser {
 
     /** A pattern to find the string: "// violation". */
     private static final Pattern VIOLATION_PATTERN = Pattern
-            .compile(".*//\\s*violation(?:\\W+(.*))?$");
+            .compile(".*//\\s*violation(?:\\W+\'(.*)\')?$");
 
     /** Stop instances being created. **/
     private InlineConfigParser() {

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheckTest.java
@@ -46,7 +46,8 @@ public void testDefault()
             "80:9: " + getCheckMessage(MSG_KEY),
             "82:12: " + getCheckMessage(MSG_KEY),
         };
-        verify(checkConfig, getPath("InputArrayTrailingComma.java"), expected);
+        verifyWithInlineConfigParser(checkConfig,
+                getPath("InputArrayTrailingComma.java"), expected);
     }
 
     @Test
@@ -74,7 +75,7 @@ public void testAlwaysDemandTrailingComma() throws Exception {
             "54:17: " + getCheckMessage(MSG_KEY),
             "56:13: " + getCheckMessage(MSG_KEY),
         };
-        verify(checkConfig,
+        verifyWithInlineConfigParser(checkConfig,
             getPath("InputArrayTrailingCommaAlwaysDemandTrailingComma.java"), expected);
     }
 

diff --git a/...tools/checkstyle/checks/annotation/missingoverride/InputMissingOverrideBadAnnotation.java b/...tools/checkstyle/checks/annotation/missingoverride/InputMissingOverrideBadAnnotation.java
@@ -14,13 +14,13 @@ public class InputMissingOverrideBadAnnotation
         /**
          * {@inheritDoc}
          */
-        public void run() { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+        public void run() { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
             Throwable t = new Throwable() {
 
                 /**
                  * {@inheritDoc}
                  */
-                public String toString() { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+                public String toString() { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
                     return "junk";
                 }
             };
@@ -33,13 +33,13 @@ void doFoo(Runnable r) {
             /**
              * {@inheritDoc}
              */
-            public void run() { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+            public void run() { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
                 Throwable t = new Throwable() {
 
                     /**
                      * {@inheritDoc}
                      */
-                    public String toString() { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+                    public String toString() { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
                         return "junk";
                     }
                 };

diff --git a/...eckstyle/checks/annotation/missingoverride/InputMissingOverrideBadOverrideFromObject.java b/...eckstyle/checks/annotation/missingoverride/InputMissingOverrideBadOverrideFromObject.java
@@ -12,7 +12,7 @@ public class InputMissingOverrideBadOverrideFromObject
     /**
      * {@inheritDoc}
      */
-    public boolean equals(Object obj) { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public boolean equals(Object obj) { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
         return false;
     }
 
@@ -32,7 +32,7 @@ class Junk {
         /**
          * {@inheritDoc}
          */
-        protected void finalize() throws Throwable {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+        protected void finalize() throws Throwable {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
     }
 }
 
@@ -41,7 +41,7 @@ interface HashEq2 {
     /**
      * {@inheritDoc}
      */
-    public int hashCode(); // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public int hashCode(); // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 }
 
 enum enum3 {
@@ -50,7 +50,7 @@ enum enum3 {
     /**
      * {@inheritDoc}
      */
-    public String toString() { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public String toString() { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
         return "B";
     }
 

diff --git a/...yle/checks/annotation/missingoverride/InputMissingOverrideBadOverrideFromObjectJava5.java b/...yle/checks/annotation/missingoverride/InputMissingOverrideBadOverrideFromObjectJava5.java
@@ -12,7 +12,7 @@ public class InputMissingOverrideBadOverrideFromObjectJava5
     /**
      * {@inheritDoc}
      */
-    public boolean equals(Object obj) { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public boolean equals(Object obj) { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
         return false;
     }
 
@@ -32,7 +32,7 @@ class Junk {
         /**
          * {@inheritDoc}
          */
-        protected void finalize() throws Throwable {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+        protected void finalize() throws Throwable {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
     }
 }
 
@@ -41,7 +41,7 @@ interface HashEq2Java5 {
     /**
      * {@inheritDoc}
      */
-    public int hashCode(); // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public int hashCode(); // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 }
 
 enum enum3Java5 {
@@ -50,7 +50,7 @@ enum enum3Java5 {
     /**
      * {@inheritDoc}
      */
-    public String toString() { // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public String toString() { // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
         return "B";
     }
 

diff --git a/...heckstyle/checks/annotation/missingoverride/InputMissingOverrideBadOverrideFromOther.java b/...heckstyle/checks/annotation/missingoverride/InputMissingOverrideBadOverrideFromOther.java
@@ -14,7 +14,7 @@ public class InputMissingOverrideBadOverrideFromOther implements IFoo2
     /**
      * {@inheritDoc}
      */
-    public void doFoo() {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public void doFoo() {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 
     public void doFoo2() {}
 
@@ -30,32 +30,32 @@ interface IBar2 extends IFoo2 {
     /**
      * {@inheritDoc}
      */
-    public void doFoo(); // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public void doFoo(); // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 }
 
 class MoreJunk2 extends InputMissingOverrideBadOverrideFromOther {
 
     /**
      * {@inheritDoc}
      */
-    public void doFoo() {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public void doFoo() {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 
     /**
      * {@inheritDoc}
      */
-    public void doFoo2() {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public void doFoo2() {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 
     class EvenMoreJunk extends MoreJunk2 implements Serializable {
 
         /**
          * {@inheritDoc}
          */
-        public void doFoo() {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+        public void doFoo() {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 
         /**
          * {@inheritDoc}
          */
-        public void doFoo2() {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+        public void doFoo2() {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
     }
 }
 
@@ -65,5 +65,5 @@ enum Football2 implements IFoo2, IBar2 {
     /**
      * {@inheritDoc}
      */
-    public void doFoo() {} // violation Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.
+    public void doFoo() {} // violation 'Must include @java.lang.Override annotation when {@inheritDoc} Javadoc tag exists.'
 }
diff --git a/...l/tools/checkstyle/checks/annotation/missingoverride/InputMissingOverrideNotOverride.java b/...l/tools/checkstyle/checks/annotation/missingoverride/InputMissingOverrideNotOverride.java
@@ -12,12 +12,12 @@ public class InputMissingOverrideNotOverride
     /**
      * {@inheritDoc}
      */
-    private void bleh() {} // violation The Javadoc {@inheritDoc} tag is not valid at this location.
+    private void bleh() {} // violation 'The Javadoc {@inheritDoc} tag is not valid at this location.'
 
     /**
      * {@inheritDoc}
      */
-    public static void eh() {} // violation The Javadoc {@inheritDoc} tag is not valid at this location.
+    public static void eh() {} // violation 'The Javadoc {@inheritDoc} tag is not valid at this location.'
 
     /**
      * {@inheritDoc}

diff --git a/...puppycrawl/tools/checkstyle/checks/coding/arraytrailingcomma/InputArrayTrailingComma.java b/...puppycrawl/tools/checkstyle/checks/coding/arraytrailingcomma/InputArrayTrailingComma.java
@@ -20,7 +20,7 @@ public class InputArrayTrailingComma
     {
         1,
         2,
-        3 // violation
+        3 // violation 'Array should contain trailing comma.'
     };
 
     int[] b1 = new int[] {1, 2, 3,};
@@ -40,7 +40,7 @@ public class InputArrayTrailingComma
         {1,
          2},
         {3, 3,},
-        {5, 6,} // violation
+        {5, 6,} // violation 'Array should contain trailing comma.'
     };
 
     int[] e1 = new int[] {
@@ -77,8 +77,8 @@ public class InputArrayTrailingComma
     Object[][] g2 = new Object[][]
     {
         { 1, 1 },
-        {
+        { // violation 'Array should contain trailing comma.'
            null,
-           new int[] { 2,
-                   3 } } }; // violation
+           new int[] { 2, // violation 'Array should contain trailing comma.'
+                   3 } } };
 }
diff --git a/...le/checks/coding/arraytrailingcomma/InputArrayTrailingCommaAlwaysDemandTrailingComma.java b/...le/checks/coding/arraytrailingcomma/InputArrayTrailingCommaAlwaysDemandTrailingComma.java
@@ -12,48 +12,48 @@ public int[] test() {
         if (true) {
             return new int[]{0,};
         }
-        return new int[]{0}; // violation
+        return new int[]{0}; // violation 'Array should contain trailing comma.'
     }
 
     public int[] test2() {
         if (true) {
             return new int[]{0, 1,};
         }
-        return new int[]{0, 1}; // violation
+        return new int[]{0, 1}; // violation 'Array should contain trailing comma.'
     }
 
     public void test3() {
         int[] a = new int[]
-            {0}; // violation
+            {0}; // violation 'Array should contain trailing comma.'
         int[] b = new int[]
-            {0, 1}; // violation
+            {0, 1}; // violation 'Array should contain trailing comma.'
         int[] c = new int[]
             {0, 1,
-                2, 3
-            }; // violation
+                2, 3 // violation 'Array should contain trailing comma.'
+            };
         int[] d = new int[]
             {
                 1,
                 2,
-                3
-            }; // violation
+                3 // violation 'Array should contain trailing comma.'
+            };
         int[] e = new int[]
             {
                 1,
                 5,
                 6,
             };
         int[] f = {1,
-            2
-        }; // violation
+            2 // violation 'Array should contain trailing comma.'
+        };
         int[] g = {1,
             2,
         };
-        int[][] empty2d = {{}}; // violation
+        int[][] empty2d = {{}}; // violation 'Array should contain trailing comma.'
         int[][] multiDimensionalArray = {
-            {1, 2}, // violation
+            {1, 2}, // violation 'Array should contain trailing comma.'
             {1,},
-            {3, 2, 1,}
-        }; // violation
+            {3, 2, 1,} // violation 'Array should contain trailing comma.'
+        };
     }
 }