Issue checkstyle#10527: Added support for null in inline config

shashwatj07 · Aug 17, 2021 · 0b64c4d · 0b64c4d
1 parent dd52056
commit 0b64c4d
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 11 deletions.
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java b/src/test/java/com/puppycrawl/tools/checkstyle/bdd/InlineConfigParser.java
@@ -55,6 +55,9 @@ public final class InlineConfigParser {
     private static final Pattern MULTIPLE_VIOLATIONS_PATTERN = Pattern
             .compile(".*//\\s*(\\d) violations(?: .*)?$");
 
+    /** The String "(null)". */
+    private static final String NULL_STRING = "(null)";
+
     /** Stop instances being created. **/
     private InlineConfigParser() {
     }
@@ -121,18 +124,28 @@ private static void setCheckProperties(TestInputConfiguration.Builder inputConfi
             final String key = entry.getKey().toString();
             final String value = entry.getValue().toString();
             if (value.startsWith("(default)")) {
-                inputConfigBuilder.addDefaultProperty(key,
-                        value.substring(value.indexOf(')') + 1));
+                final String defaultValue = value.substring(value.indexOf(')') + 1);
+                if (NULL_STRING.equals(defaultValue)) {
+                    inputConfigBuilder.addDefaultProperty(key, null);
+                }
+                else {
+                    inputConfigBuilder.addDefaultProperty(key, defaultValue);
+                }
             }
             else {
-                inputConfigBuilder.addNonDefaultProperty(key, value);
+                if (NULL_STRING.equals(value)) {
+                    inputConfigBuilder.addNonDefaultProperty(key, null);
+                }
+                else {
+                    inputConfigBuilder.addNonDefaultProperty(key, value);
+                }
             }
         }
     }
 
     private static void setViolations(TestInputConfiguration.Builder inputConfigBuilder,
                                       List<String> lines) {
-        for (int lineNo = 2; lineNo < lines.size(); lineNo++) {
+        for (int lineNo = 0; lineNo < lines.size(); lineNo++) {
             final Matcher violationMatcher = VIOLATION_PATTERN.matcher(lines.get(lineNo));
             final Matcher violationAboveMatcher =
                     VIOLATION_ABOVE_PATTERN.matcher(lines.get(lineNo));

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheckTest.java
@@ -103,7 +103,7 @@ public void testNullCustomMessage()
         final String[] expected = {
             "34:28: " + getCheckMessage(MSG_KEY, "a href"),
         };
-        verify(checkConfig,
+        verifyWithInlineConfigParser(checkConfig,
                 getPath("InputIllegalTokenTextTokens4.java"), expected);
     }
 
@@ -167,7 +167,7 @@ public void testCommentToken()
             "1:3: " + getCheckMessage(MSG_KEY, "a href"),
             "45:28: " + getCheckMessage(MSG_KEY, "a href"),
         };
-        verify(checkConfig,
+        verifyWithInlineConfigParser(checkConfig,
                 getPath("InputIllegalTokenTextTokens5.java"), expected);
     }
 

diff --git a/...pycrawl/tools/checkstyle/checks/coding/illegaltokentext/InputIllegalTokenTextTokens4.java b/...pycrawl/tools/checkstyle/checks/coding/illegaltokentext/InputIllegalTokenTextTokens4.java
@@ -2,7 +2,7 @@
 IllegalTokenText
 format = a href
 ignoreCase = (default)false
-message = (default)
+message = (null)
 tokens = STRING_LITERAL
 
 

diff --git a/...pycrawl/tools/checkstyle/checks/coding/illegaltokentext/InputIllegalTokenTextTokens5.java b/...pycrawl/tools/checkstyle/checks/coding/illegaltokentext/InputIllegalTokenTextTokens5.java
@@ -1,8 +1,8 @@
-/*
+/* // violation
 IllegalTokenText
 format = a href
 ignoreCase = (default)false
-message = (default)
+message = (null)
 tokens = COMMENT_CONTENT
 
 
@@ -41,8 +41,8 @@ public void methodWithLabels() {
             anotherLabel: // some comment href
             do {
                 continue anotherLabel;
-            } while (false);
-            break label; // violation Token text matches the illegal pattern 'a href'.
+            } while (false); // violation below
+            break label; // a href
         }
     }
 }