DATACMNS-1258 - Added infrastructure for SpEL handling in queries.
The goal is to extract the parts of query parsing that are generic into commons in order to avoid slightly different behavior in modules.
Extracted the QuotationMap from Spring Data JPA as well as the part of the parser that deals with extracting SpEL expressions.
Added the SpelEvaluator for evaluating the SpEL expressions.
Added enough configurability to satisfy the needs of Neo4j and JPA.
Mainly to support the different formats for bind parameter :name vs {name}.
This commit is contained in:
Jens Schauder
committed by
Oliver Gierke
Oliver Gierke
parent
a6215fbe0f
commit
1fdf77aed7
@@ -0,0 +1,124 @@
|
||||
/*
|
||||
* Copyright 2018 the original author or authors.
|
||||
*
|
||||
* Licensed 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.springframework.data.repository.query.parser;
|
||||
|
||||
import static org.assertj.core.api.Assertions.*;
|
||||
|
||||
import org.assertj.core.api.SoftAssertions;
|
||||
import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Unit tests for {@link QuotationMap}.
|
||||
*
|
||||
* @author Jens Schauder
|
||||
*/
|
||||
public class QuotationMapUnitTests {
|
||||
|
||||
SoftAssertions softly = new SoftAssertions();
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void emptyStringDoesNotContainQuotes() {
|
||||
isNotQuoted("", "empty String", -1, 0, 1);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void nullStringDoesNotContainQuotes() {
|
||||
isNotQuoted(null, "null String", -1, 0, 1);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void simpleStringDoesNotContainQuotes() {
|
||||
String query = "something";
|
||||
isNotQuoted(query, "simple String", -1, 0, query.length() - 1, query.length(), query.length() + 1);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void fullySingleQuotedStringDoesContainQuotes() {
|
||||
|
||||
String query = "'something'";
|
||||
isNotQuoted(query, "quoted String", -1, query.length());
|
||||
isQuoted(query, "quoted String", 0, 1, 5, query.length() - 1);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void fullyDoubleQuotedStringDoesContainQuotes() {
|
||||
|
||||
String query = "\"something\"";
|
||||
isNotQuoted(query, "double quoted String", -1, query.length());
|
||||
isQuoted(query, "double quoted String", 0, 1, 5, query.length() - 1);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void stringWithEmptyQuotes() {
|
||||
|
||||
String query = "abc''def";
|
||||
isNotQuoted(query, "zero length quote", -1, 0, 1, 2, 5, 6, 7);
|
||||
isQuoted(query, "zero length quote", 3, 4);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void doubleInSingleQuotes() {
|
||||
|
||||
String query = "abc'\"'def";
|
||||
isNotQuoted(query, "double inside single quote", -1, 0, 1, 2, 6, 7, 8);
|
||||
isQuoted(query, "double inside single quote", 3, 4, 5);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void singleQuotesInDoubleQuotes() {
|
||||
|
||||
String query = "abc\"'\"def";
|
||||
isNotQuoted(query, "single inside double quote", -1, 0, 1, 2, 6, 7, 8);
|
||||
isQuoted(query, "single inside double quote", 3, 4, 5);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void escapedQuotes() {
|
||||
|
||||
String query = "a'b''cd''e'f";
|
||||
isNotQuoted(query, "escaped quote", -1, 0, 11, 12);
|
||||
isQuoted(query, "escaped quote", 1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
|
||||
}
|
||||
|
||||
@Test // DATAJPA-1235
|
||||
public void openEndedQuoteThrowsException() {
|
||||
|
||||
assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> new QuotationMap("a'b"));
|
||||
}
|
||||
|
||||
private void isNotQuoted(String query, Object label, int... indexes) {
|
||||
|
||||
QuotationMap quotationMap = new QuotationMap(query);
|
||||
|
||||
for (int index : indexes) {
|
||||
|
||||
assertThat(quotationMap.isQuoted(index))
|
||||
.describedAs(String.format("(%s) %s does not contain a quote at %s", label, query, index)) //
|
||||
.isFalse();
|
||||
}
|
||||
}
|
||||
|
||||
private void isQuoted(String query, Object label, int... indexes) {
|
||||
|
||||
QuotationMap quotationMap = new QuotationMap(query);
|
||||
|
||||
for (int index : indexes) {
|
||||
|
||||
assertThat(quotationMap.isQuoted(index))
|
||||
.describedAs(String.format("(%s) %s does contain a quote at %s", label, query, index)).isTrue();
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,145 @@
|
||||
/*
|
||||
* Copyright 2018 the original author or authors.
|
||||
*
|
||||
* Licensed 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.springframework.data.repository.query.parser;
|
||||
|
||||
import static org.assertj.core.api.Assertions.*;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.function.BiFunction;
|
||||
|
||||
import org.assertj.core.api.SoftAssertions;
|
||||
import org.assertj.core.groups.Tuple;
|
||||
import org.junit.Test;
|
||||
|
||||
/**
|
||||
* Unit tests for {@link SpelQueryContext} and
|
||||
* {@link org.springframework.data.repository.query.parser.SpelQueryContext.SpelExtractor}
|
||||
*
|
||||
* @author Jens Schauder
|
||||
*/
|
||||
public class SpelExtractorUnitTests {
|
||||
|
||||
static final String EXPRESSION_PARAMETER_PREFIX = "EPP";
|
||||
static final BiFunction<Integer, String, String> PARAMETER_NAME_SOURCE = (index, spel) -> EXPRESSION_PARAMETER_PREFIX + index;
|
||||
static final BiFunction<String, String, String> REPLACEMENT_SOURCE = (prefix, name) -> prefix + name;
|
||||
final SoftAssertions softly = new SoftAssertions();
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void nullQueryThrowsException() {
|
||||
|
||||
assertThatExceptionOfType(IllegalArgumentException.class) //
|
||||
.isThrownBy(() -> new SpelQueryContext( //
|
||||
PARAMETER_NAME_SOURCE, //
|
||||
REPLACEMENT_SOURCE) //
|
||||
.parse(null) //
|
||||
);
|
||||
}
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void nullParameterNameSourceThrowsException() {
|
||||
|
||||
assertThatExceptionOfType(IllegalArgumentException.class) //
|
||||
.isThrownBy(() -> new SpelQueryContext( //
|
||||
null, //
|
||||
REPLACEMENT_SOURCE) //
|
||||
);
|
||||
}
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void nullReplacementSourceThrowsException() {
|
||||
|
||||
assertThatExceptionOfType(IllegalArgumentException.class) //
|
||||
.isThrownBy( //
|
||||
() -> new SpelQueryContext( //
|
||||
PARAMETER_NAME_SOURCE, //
|
||||
null) //
|
||||
);
|
||||
}
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void emptyStringGetsParsedCorrectly() {
|
||||
|
||||
SpelQueryContext.SpelExtractor extractor = new SpelQueryContext( //
|
||||
PARAMETER_NAME_SOURCE, //
|
||||
REPLACEMENT_SOURCE //
|
||||
).parse("");
|
||||
|
||||
softly.assertThat(extractor.query()).isEqualTo("");
|
||||
softly.assertThat(extractor.parameterNameToSpelMap()).isEmpty();
|
||||
|
||||
softly.assertAll();
|
||||
}
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void findsAndReplacesExpressions() {
|
||||
|
||||
SpelQueryContext.SpelExtractor extractor = new SpelQueryContext( //
|
||||
PARAMETER_NAME_SOURCE, //
|
||||
REPLACEMENT_SOURCE //
|
||||
).parse(":#{one} ?#{two}");
|
||||
|
||||
softly.assertThat(extractor.query()).isEqualTo(":EPP0 ?EPP1");
|
||||
softly.assertThat(extractor.parameterNameToSpelMap().entrySet()) //
|
||||
.extracting(Map.Entry::getKey, Map.Entry::getValue) //
|
||||
.containsExactlyInAnyOrder( //
|
||||
Tuple.tuple("EPP0", "one"), //
|
||||
Tuple.tuple("EPP1", "two") //
|
||||
);
|
||||
|
||||
softly.assertAll();
|
||||
}
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void keepsStringWhenNoMatchIsFound() {
|
||||
|
||||
SpelQueryContext.SpelExtractor extractor = new SpelQueryContext( //
|
||||
PARAMETER_NAME_SOURCE, //
|
||||
REPLACEMENT_SOURCE //
|
||||
).parse("abcdef");
|
||||
|
||||
softly.assertThat(extractor.query()).isEqualTo("abcdef");
|
||||
softly.assertThat(extractor.parameterNameToSpelMap()).isEmpty();
|
||||
|
||||
softly.assertAll();
|
||||
}
|
||||
|
||||
@Test // DATACMNS-1258
|
||||
public void spelsInQuotesGetIgnored() {
|
||||
|
||||
List<String> queries = Arrays.asList("a'b:#{one}cd'ef", "a'b:#{o'ne}cdef", "ab':#{one}'cdef", "ab:'#{one}cd'ef",
|
||||
"ab:#'{one}cd'ef", "a'b:#{o'ne}cdef");
|
||||
|
||||
for (String query : queries) {
|
||||
checkNoSpelIsFound(query);
|
||||
}
|
||||
|
||||
softly.assertAll();
|
||||
}
|
||||
|
||||
private void checkNoSpelIsFound(String query) {
|
||||
|
||||
SpelQueryContext.SpelExtractor extractor = new SpelQueryContext( //
|
||||
PARAMETER_NAME_SOURCE, //
|
||||
REPLACEMENT_SOURCE //
|
||||
).parse(query);
|
||||
|
||||
softly.assertThat(extractor.query()).describedAs(query).isEqualTo(query);
|
||||
softly.assertThat(extractor.parameterNameToSpelMap()).describedAs(query).isEmpty();
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user