Skip to content

Commit

Permalink
fix(#341): Allow comma and brackets in matcher expressions
Browse files Browse the repository at this point in the history
  • Loading branch information
schlathoeltt committed Sep 8, 2023
1 parent 4058578 commit 300295f
Show file tree
Hide file tree
Showing 3 changed files with 151 additions and 12 deletions.
11 changes: 11 additions & 0 deletions src/manual/validation-hamcrest.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ receive("someEndpoint")
.expression("node-set:/TestRequest/OrderType", hasSize(3));
----

NOTE: If you want to match text containing any of the following characters: ' , ( )
You need to enclose the respective string in quotation marks when defining your matcher.
If you intend to match an actual single quote, it should be escaped with a backslash (\').

For example:
[source,xml]
----
anyOf(equalTo('text containing a \\' (quote) and a , (comma) '), anyOf(isEmptyOrNullString()))
anyOf(equalTo('text containing a backslash and quote \\\\' and a , (comma) '), anyOf(isEmptyOrNullString()))
----

.XML
[source,xml,indent=0,role="secondary"]
----
Expand Down
119 changes: 112 additions & 7 deletions .../main/java/org/citrusframework/validation/matcher/hamcrest/HamcrestValidationMatcher.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import org.citrusframework.context.TestContext;
Expand Down Expand Up @@ -84,11 +85,9 @@ public void validate(String fieldName, String value, List<String> controlParamet
}

String matcherName = matcherExpression.trim().substring(0, matcherExpression.trim().indexOf("("));
String[] matcherParameter = matcherExpression.trim().substring(matcherName.length() + 1, matcherExpression.trim().length() - 1).split(",");

for (int i = 0; i < matcherParameter.length; i++) {
matcherParameter[i] = VariableUtils.cutOffSingleQuotes(matcherParameter[i].trim());
}
String[] matcherParameter = determineNestedMatcherParameters(matcherExpression.trim()
.substring(matcherName.length() + 1, matcherExpression.trim().length() - 1));

try {
Matcher matcher = getMatcher(matcherName, matcherParameter, context);
Expand Down Expand Up @@ -174,8 +173,11 @@ private Matcher<?> getMatcher(String matcherName, String[] matcherParameter, Tes
List<Matcher<?>> nestedMatchers = new ArrayList<>();
for (String matcherExpression : matcherParameter) {
String nestedMatcherName = matcherExpression.trim().substring(0, matcherExpression.trim().indexOf("("));
String nestedMatcherParameter = matcherExpression.trim().substring(nestedMatcherName.length() + 1, matcherExpression.trim().length() - 1);
nestedMatchers.add(getMatcher(nestedMatcherName, new String[] { nestedMatcherParameter }, context));
String[] nestedMatcherParameters = determineNestedMatcherParameters(
matcherExpression.trim().substring(nestedMatcherName.length() + 1,
matcherExpression.trim().length() - 1));

nestedMatchers.add(getMatcher(nestedMatcherName, nestedMatcherParameters, context));
}

return (Matcher<?>) matcherMethod.invoke(null, nestedMatchers);
Expand All @@ -190,7 +192,7 @@ private Matcher<?> getMatcher(String matcherName, String[] matcherParameter, Tes
}

if (matcherMethod != null) {
return (Matcher<?>) matcherMethod.invoke(null, matcherParameter[0]);
return (Matcher<?>) matcherMethod.invoke(null, matcherParameter[0].replace("\\'","'"));
}
}

Expand Down Expand Up @@ -362,6 +364,35 @@ public List<String> extractControlValues(String controlExpression, Character del
}
}

/**
* Extracts parameters for a matcher from the raw parameter expression.
* Parameters refer to the contained parameters and matchers (first level),
* excluding nested ones.
* <p/>
* For example, given the expression:<br/>
* {@code "oneOf(greaterThan(5.0), allOf(lessThan(-1.0), greaterThan(-2.0)))"}
* <p/>
* The extracted parameters are:<br/>
* {@code "greaterThan(5.0)", "allOf(lessThan(-1.0), greaterThan(-2.0))"}.
* <p/>
* Note that nested container expressions "allOf(lessThan(-1.0), greaterThan(-2.0))" in
* the second parameter are treated as a single expression. They need to be treated
* separately in a recursive call to this method, when the parameters for the
* respective allOf() expression are extracted.
*
* @param rawExpression the full parameter expression of a container matcher
*/
public String[] determineNestedMatcherParameters(final String rawExpression) {
if (!StringUtils.hasText(rawExpression)) {
return new String[0];
}

Tokenizer tokenizer = new Tokenizer();
String tokenizedExpression = tokenizer.tokenize(rawExpression);
return tokenizer.restoreInto(tokenizedExpression.split(","));

}

/**
* Numeric value comparable automatically converts types to numeric values for
* comparison.
Expand Down Expand Up @@ -418,4 +449,78 @@ public String toString() {
}
}

/**
* Class that provides functionality to replace expressions that match
* {@link Tokenizer#TEXT_PARAMETER_PATTERN} with simple tokens of the form $$n$$.
* The reason for this is, that complex nested expressions
* may contain characters that interfere with further processing - e.g. ''', '(' and ')'
*/
private static class Tokenizer {

/**
* Regular expression with three alternative parts (ored) to match:
* <ol>
* <li> `(sometext)` - Quoted parameter block of a matcher.</li>
* <li> 'sometext' - Quoted text used as a parameter to a string matcher.</li>
* <li> (unquotedtext) - Unquoted text used as a parameter to a string matcher. This expression is non-greedy, meaning the first closing bracket will terminate the match.</li>
* </ol>
* <p/>
* Please note:
* - 'sometext' may contain an escaped quote.
* - 'unquotedtext' must not contain brackets or commas.
* <p/>
* To match quotes, commas, or brackets, you must quote the text. To match a quote, it should be escaped with a backslash.
*/
private static final Pattern TEXT_PARAMETER_PATTERN
= Pattern.compile(
"\\('(?<quoted1>((?:[^']|\\\\')*))[^\\\\]'\\)"
+ "|('(?<quoted2>((?:[^']|\\\\')*))[^\\\\]')"
+ "|\\((?<unquoted>(([^']|\\\\')*?)[^\\\\])\\)");

private final List<String> originalTokenValues = new ArrayList<>();

/**
* Tokenize the given raw expression
*
* @param rawExpression
* @return the expression with all relevant subexpressions replaced by tokens
*/
public String tokenize(String rawExpression) {

String tokenizedExpression = rawExpression;
java.util.regex.Matcher matcher = TEXT_PARAMETER_PATTERN.matcher(rawExpression);
while (matcher.find()) {
String param = matcher.group("quoted1");
param = param != null ? param : matcher.group("quoted2");
param = param != null ? param : matcher.group("unquoted");
originalTokenValues.add(param);
tokenizedExpression = tokenizedExpression.replace(param, "$$" + originalTokenValues.size() + "$$");
}

return tokenizedExpression;
}

/**
* Restore the tokens back into the given expressions.
*
* @param expressions containing strings with tokens, generated by this tokenizer.
* @return expressions with the tokens being replaced with their original values.
*/
public String[] restoreInto(String[] expressions) {

for (int i = 0; i < expressions.length; i++) {
expressions[i] = VariableUtils.cutOffSingleQuotes(
replaceTokens(expressions[i], originalTokenValues).trim());
}

return expressions;
}

private String replaceTokens(String expression, List<String> params) {
for (int i = 0; i < params.size(); i++) {
expression = expression.replace("$$" + (i + 1) + "$$", params.get(i));
}
return expression;
}
}
}
33 changes: 28 additions & 5 deletions ...t/java/org/citrusframework/validation/matcher/hamcrest/HamcrestValidationMatcherTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public String getName() {

@Override
public Matcher<String> provideMatcher(String predicate) {
return new CustomMatcher<String>(String.format("path matching %s", predicate)) {
return new CustomMatcher<>(String.format("path matching %s", predicate)) {
@Override
public boolean matches(Object item) {
return ((item instanceof String) && new AntPathMatcher().match(predicate, (String) item));
Expand All @@ -63,7 +63,7 @@ public boolean matches(Object item) {
}

@Test(dataProvider = "testData")
public void testValidate(String path, String value, List<String> params) throws Exception {
public void testValidate(String path, String value, List<String> params) {
validationMatcher.validate( path, value, params, context);
}

Expand Down Expand Up @@ -127,12 +127,28 @@ public Object[][] testData() {
new Object[]{"foo", "[value1,value2,value3,value4,value5]", Collections.singletonList("contains(value1,value2,value3,value4,value5)") },
new Object[]{"foo", "[value1,value2,value3,value4,value5]", Collections.singletonList("containsInAnyOrder(value2,value4,value1,value3,value5)") },
new Object[]{"foo", "[\"unique_value\",\"different_unique_value\"]", Collections.singletonList("hasSize(2)") },
new Object[]{"foo", "[\"duplicate_value\",\"duplicate_value\"]", Collections.singletonList("hasSize(2)") }
new Object[]{"foo", "[\"duplicate_value\",\"duplicate_value\"]", Collections.singletonList("hasSize(2)") },
new Object[]{"foo", "text containing a , (comma) ", Collections.singletonList("anyOf(equalTo('text containing a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "", Collections.singletonList("anyOf(equalTo('text containing a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", null, Collections.singletonList("anyOf(equalTo('text containing a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "text-equalTo(QA, Max", Collections.singletonList("anyOf(equalTo('text-equalTo(QA, Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "", Collections.singletonList("anyOf(equalTo('text-equalTo(QA, Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", null, Collections.singletonList("anyOf(equalTo('text-equalTo(QA, Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "QA-equalTo(HH), Max", Collections.singletonList("anyOf(equalTo('QA-equalTo(HH), Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "text containing a ' (quote) and a , (comma) ", Collections.singletonList("anyOf(equalTo('text containing a \\' (quote) and a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "text containing a \\' (quote) and a , (comma) ", Collections.singletonList("anyOf(equalTo('text containing a \\\\' (quote) and a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "unquoted text may not include brackets or commas", Collections.singletonList("anyOf(equalTo(unquoted text may not include brackets or commas), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "unquoted \\' text may not include brackets or commas", Collections.singletonList("anyOf(equalTo(unquoted \\\\' text may not include brackets or commas), anyOf(isEmptyOrNullString()))")},

new Object[]{"foo", "INSERT INTO todo_entries (id, title, description, done) values (1, 'Invite for meeting', 'Invite the group for a lunch meeting', 'false')",
Collections.singletonList("allOf(startsWith('INSERT INTO todo_entries (id, title, description, done)'))")},


};
}

@Test(dataProvider = "testDataFailed", expectedExceptions = ValidationException.class)
public void testValidateFailed(String path, String value, List<String> params) throws Exception {
public void testValidateFailed(String path, String value, List<String> params) {
validationMatcher.validate( path, value, params, context);
}

Expand Down Expand Up @@ -190,7 +206,14 @@ public Object[][] testDataFailed() {
new Object[]{"foo", "[value1,value2]", Collections.singletonList("hasItem(value5)") },
new Object[]{"foo", "[value1,value2]", Collections.singletonList("hasItems(value1,value2,value5)") },
new Object[]{"foo", "[value1,value2]", Collections.singletonList("contains(value1)") },
new Object[]{"foo", "[value1,value2]", Collections.singletonList("containsInAnyOrder(value2,value4)") }
new Object[]{"foo", "[value1,value2]", Collections.singletonList("containsInAnyOrder(value2,value4)") },
new Object[]{"foo", "notext-equalTo(QA, Max", Collections.singletonList("anyOf(equalTo('text-equalTo(QA, Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "aa", Collections.singletonList("anyOf(equalTo('text-equalTo(QA, Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "VA-equalTo(HH), Max", Collections.singletonList("anyOf(equalTo('QA-equalTo(HH), Max'),anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "notext containing a ' (quote) and a , (comma) ", Collections.singletonList("anyOf(equalTo('text containing a \\' (quote) and a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "notext containing a \\' (quote) and a , (comma) ", Collections.singletonList("anyOf(equalTo('text containing a \\\\' (quote) and a , (comma) '), anyOf(isEmptyOrNullString()))")},
new Object[]{"foo", "nounquoted text may not include brackets or commas", Collections.singletonList("anyOf(equalTo(unquoted text may not include brackets or commas), anyOf(isEmptyOrNullString()))")},

};
}
}

0 comments on commit 300295f

Please sign in to comment.