Merge pull request #178 from Jazzyekim/placeholder-regex

add support for matchesRegex placeholder
xmlunit · May 6, 2020 · ee476a2 · ee476a2
2 parents 4ee9379 + fea1758
commit ee476a2
Show file tree

Hide file tree

Showing 8 changed files with 211 additions and 5 deletions.
diff --git a/xmlunit-placeholders/src/main/java/org/xmlunit/placeholder/IgnorePlaceholderHandler.java b/xmlunit-placeholders/src/main/java/org/xmlunit/placeholder/IgnorePlaceholderHandler.java
@@ -34,7 +34,7 @@ public String getKeyword() {
     }
 
     @Override
-    public ComparisonResult evaluate(String testText) {
+    public ComparisonResult evaluate(String testText, String... param) {
         return ComparisonResult.EQUAL;
     }
 }
diff --git a/xmlunit-placeholders/src/main/java/org/xmlunit/placeholder/IsNumberPlaceholderHandler.java b/xmlunit-placeholders/src/main/java/org/xmlunit/placeholder/IsNumberPlaceholderHandler.java
@@ -33,7 +33,7 @@ public String getKeyword() {
     }
 
     @Override
-    public ComparisonResult evaluate(String testText) {
+    public ComparisonResult evaluate(String testText, String... param) {
         return testText != null && testText.trim().matches(NUMBER_PATTERN) ? EQUAL : DIFFERENT;
     }
 }
diff --git a/...it-placeholders/src/main/java/org/xmlunit/placeholder/MatchesRegexPlaceholderHandler.java b/...it-placeholders/src/main/java/org/xmlunit/placeholder/MatchesRegexPlaceholderHandler.java
@@ -0,0 +1,43 @@
+package org.xmlunit.placeholder;
+
+import org.xmlunit.XMLUnitException;
+import org.xmlunit.diff.ComparisonResult;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
+
+import static org.xmlunit.diff.ComparisonResult.DIFFERENT;
+import static org.xmlunit.diff.ComparisonResult.EQUAL;
+
+/**
+ * Handler for the {@code matchesRegex()} placeholder keyword.
+ */
+public class MatchesRegexPlaceholderHandler implements PlaceholderHandler {
+    private static final String PLACEHOLDER_NAME = "matchesRegex";
+
+    @Override
+    public String getKeyword() {
+        return PLACEHOLDER_NAME;
+    }
+
+    @Override
+    public ComparisonResult evaluate(String testText, String... param) {
+        if (param.length > 0 && param[0] != null && !param[0].equals("")) {
+            try {
+                Pattern pattern = Pattern.compile(param[0].trim());
+                if (testText != null && evaluate(testText.trim(), pattern)) {
+                    return EQUAL;
+                }
+            } catch(PatternSyntaxException e) {
+                throw new XMLUnitException(e.getMessage(), e);
+            }
+        }
+        return DIFFERENT;
+    }
+
+    private boolean evaluate(String testText, Pattern pattern) {
+        Matcher matcher = pattern.matcher(testText);
+        return matcher.find();
+    }
+}
diff --git a/...it-placeholders/src/main/java/org/xmlunit/placeholder/PlaceholderDifferenceEvaluator.java b/...it-placeholders/src/main/java/org/xmlunit/placeholder/PlaceholderDifferenceEvaluator.java
@@ -243,10 +243,23 @@ private ComparisonResult evaluateConsideringPlaceholders(String controlText, Str
     }
 
     private boolean isKnown(String keyword) {
-        return KNOWN_HANDLERS.containsKey(keyword);
+        // extract placeholder name if parameters present
+        Pattern pattern = Pattern.compile("(\\w+)\\(?");
+        Matcher matcher = pattern.matcher(keyword);
+        if (matcher.find()) {
+            return KNOWN_HANDLERS.containsKey(matcher.group(1));
+        }
+        return false;
     }
 
     private ComparisonResult evaluate(String keyword, String testText) {
-        return KNOWN_HANDLERS.get(keyword).evaluate(testText);
+        Pattern pattern = Pattern.compile("^(\\w+)(?:\\((.+)\\))?$");
+        Matcher matcher = pattern.matcher(keyword);
+        String placeholderParam = "";
+        if (matcher.find()) {
+            keyword = matcher.group(1);
+            placeholderParam = matcher.group(2);
+        }
+        return KNOWN_HANDLERS.get(keyword).evaluate(testText, placeholderParam);
     }
 }
diff --git a/xmlunit-placeholders/src/main/java/org/xmlunit/placeholder/PlaceholderHandler.java b/xmlunit-placeholders/src/main/java/org/xmlunit/placeholder/PlaceholderHandler.java
@@ -36,5 +36,5 @@ public interface PlaceholderHandler {
      * Evaluate the test value when control contained the placeholder
      * handled by this class.
      */
-    ComparisonResult evaluate(String testText);
+    ComparisonResult evaluate(String testText, String... placeholderParameters);
 }
diff --git a/...ceholders/src/main/resources/META-INF/services/org.xmlunit.placeholder.PlaceholderHandler b/...ceholders/src/main/resources/META-INF/services/org.xmlunit.placeholder.PlaceholderHandler
@@ -1,2 +1,3 @@
 org.xmlunit.placeholder.IgnorePlaceholderHandler
 org.xmlunit.placeholder.IsNumberPlaceholderHandler
+org.xmlunit.placeholder.MatchesRegexPlaceholderHandler
diff --git a/...laceholders/src/test/java/org/xmlunit/placeholder/MatchesRegexPlaceholderHandlerTest.java b/...laceholders/src/test/java/org/xmlunit/placeholder/MatchesRegexPlaceholderHandlerTest.java
@@ -0,0 +1,88 @@
+/*
+  This file is licensed to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+package org.xmlunit.placeholder;
+
+import org.junit.Test;
+import org.xmlunit.diff.ComparisonResult;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.junit.Assert.assertThat;
+
+public class MatchesRegexPlaceholderHandlerTest {
+
+    private PlaceholderHandler placeholderHandler = new MatchesRegexPlaceholderHandler();
+
+    @Test
+    public void shouldGetKeyword() {
+        String expected = "matchesRegex";
+        String keyword = placeholderHandler.getKeyword();
+
+        assertThat(keyword, equalTo(expected));
+    }
+
+    @Test
+    public void shouldEvaluateGivenSimpleRegex() {
+        String testTest = "1234";
+        String regex = "^\\d+$";
+        ComparisonResult comparisonResult = placeholderHandler.evaluate(testTest, regex);
+
+        assertThat(comparisonResult, equalTo(ComparisonResult.EQUAL));
+    }
+
+    @Test
+    public void shouldNotEvaluateGivenNull() {
+        String testTest = null;
+        String regex = "^\\d+$";
+        ComparisonResult comparisonResult = placeholderHandler.evaluate(testTest, regex);
+
+        assertThat(comparisonResult, equalTo(ComparisonResult.DIFFERENT));
+    }
+
+    @Test
+    public void shouldNotEvaluateGivenEmptyString() {
+        String testTest = "";
+        String regex = "^\\d+$";
+        ComparisonResult comparisonResult = placeholderHandler.evaluate(testTest, regex);
+
+        assertThat(comparisonResult, equalTo(ComparisonResult.DIFFERENT));
+    }
+
+    @Test
+    public void shouldNotEvaluateStringDoesNotMatchRegex() {
+        String testTest = "not parsable as a number even though it contains 123 numbers";
+        String regex = "^\\d+$";
+        ComparisonResult comparisonResult = placeholderHandler.evaluate(testTest, regex);
+
+        assertThat(comparisonResult, equalTo(ComparisonResult.DIFFERENT));
+    }
+
+    @Test
+    public void shouldNotEvaluateWithNullRegex() {
+        String testTest = "a string";
+        String regex = null;
+        ComparisonResult comparisonResult = placeholderHandler.evaluate(testTest, regex);
+
+        assertThat(comparisonResult, equalTo(ComparisonResult.DIFFERENT));
+    }
+
+    @Test
+    public void shouldNotEvaluateWithEmptyRegex() {
+        String testTest = "a string";
+        String regex = "";
+        ComparisonResult comparisonResult = placeholderHandler.evaluate(testTest, regex);
+
+        assertThat(comparisonResult, equalTo(ComparisonResult.DIFFERENT));
+    }
+
+}
diff --git a/...laceholders/src/test/java/org/xmlunit/placeholder/PlaceholderDifferenceEvaluatorTest.java b/...laceholders/src/test/java/org/xmlunit/placeholder/PlaceholderDifferenceEvaluatorTest.java
@@ -21,6 +21,7 @@
 import javax.xml.namespace.QName;
 import java.util.Iterator;
 
+import static org.hamcrest.CoreMatchers.containsString;
 import static org.junit.Assert.*;
 
 /**
@@ -353,4 +354,64 @@ public void hasIsNumberPlaceholder_Element_IsNumber() {
 
         assertFalse(diff.hasDifferences());
     }
+
+    @Test
+    public void hasMatchesRegexPlaceholder_Attribute_Matches() {
+        String control = "<elem1 attr='${xmlunit.matchesRegex(^\\d+$)}'>qwert</elem1>";
+        String test = "<elem1 attr='023'>qwert</elem1>";
+        Diff diff = PlaceholderSupport.withPlaceholderSupport(DiffBuilder.compare(control).withTest(test)).build();
+
+        assertFalse(diff.hasDifferences());
+    }
+
+    @Test
+    public void hasMatchesRegexPlaceholder_Attribute_NotMatches() {
+        String control = "<elem1 attr='${xmlunit.matchesRegex(^\\d+$)}'>qwert</elem1>";
+        String test = "<elem1 attr='023asd'>qwert</elem1>";
+        Diff diff = PlaceholderSupport.withPlaceholderSupport(DiffBuilder.compare(control).withTest(test)).build();
+
+        assertTrue(diff.hasDifferences());
+    }
+
+    @Test
+    public void hasMatchesRegexPlaceholder_Element_Matches() {
+        String control = "<elem1>${xmlunit.matchesRegex(^\\d+$)}</elem1>";
+        String test = "<elem1>023</elem1>";
+        Diff diff = PlaceholderSupport.withPlaceholderSupport(DiffBuilder.compare(control).withTest(test)).build();
+
+        assertFalse(diff.hasDifferences());
+    }
+
+    @Test
+    public void hasMatchesRegexPlaceholder_Element_NotMatches() {
+        String control = "<elem1>${xmlunit.matchesRegex(^\\d+$)}</elem1>";
+        String test = "<elem1>23abc</elem1>";
+        Diff diff = PlaceholderSupport.withPlaceholderSupport(DiffBuilder.compare(control).withTest(test)).build();
+
+        assertTrue(diff.hasDifferences());
+    }
+
+    @Test
+    public void hasMatchesRegexPlaceholder_Element_Exception_MalformedRegex() {
+        String control = "<elem1>${xmlunit.matchesRegex(^(\\d+$)}</elem1>";
+        String test = "<elem1>23abc</elem1>";
+        DiffBuilder diffBuilder = DiffBuilder.compare(control).withTest(test)
+                .withDifferenceEvaluator(new PlaceholderDifferenceEvaluator());
+
+        try {
+            diffBuilder.build();
+            fail();
+        } catch (XMLUnitException e) {
+            assertThat(e.getCause().getMessage(), containsString("Unclosed group near index"));
+        }
+    }
+
+    @Test
+    public void hasMalformedPlaceholder_Attribute() {
+        String control = "<elem1 attr='${xmlunit.,}'>qwert</elem1>";
+        String test = "<elem1 attr='023'>qwert</elem1>";
+        Diff diff = PlaceholderSupport.withPlaceholderSupport(DiffBuilder.compare(control).withTest(test)).build();
+
+        assertTrue(diff.hasDifferences());
+    }
 }