From d15f5efc56bfb2738582ac2cccb320bfc5f390d0 Mon Sep 17 00:00:00 2001
From: Jens Schauder <jschauder@pivotal.io>
Date: Mon, 1 Apr 2019 15:18:42 +0200
Subject: [PATCH] DATAJPA-1522 - Now also escaping the escape character.

Related tickets: DATAJPA-1519.
---
 .../jpa/repository/query/EscapeCharacter.java |  5 ++-
 .../repository/UserRepositoryFinderTests.java | 21 ++++++++-
 .../query/EscapeCharacterUnitTests.java       | 43 +++++++++++++++++++
 3 files changed, 65 insertions(+), 4 deletions(-)
 create mode 100644 src/test/java/org/springframework/data/jpa/repository/query/EscapeCharacterUnitTests.java

diff --git a/src/main/java/org/springframework/data/jpa/repository/query/EscapeCharacter.java b/src/main/java/org/springframework/data/jpa/repository/query/EscapeCharacter.java
index f1bc0fd5f..15570d8ad 100644
--- a/src/main/java/org/springframework/data/jpa/repository/query/EscapeCharacter.java
+++ b/src/main/java/org/springframework/data/jpa/repository/query/EscapeCharacter.java
@@ -19,6 +19,7 @@ import lombok.Value;
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.stream.Stream;
 
 import org.springframework.lang.Nullable;
 
@@ -43,11 +44,11 @@ public class EscapeCharacter {
 	 * @return
 	 */
 	@Nullable
-	public String escape(String value) {
+	public String escape(@Nullable String value) {
 
 		return value == null //
 				? null //
-				: TO_REPLACE.stream() //
+				: Stream.concat(Stream.of(String.valueOf(escapeCharacter)), TO_REPLACE.stream()) //
 						.reduce(value, (it, character) -> it.replace(character, this.escapeCharacter + character));
 	}
 }
diff --git a/src/test/java/org/springframework/data/jpa/repository/UserRepositoryFinderTests.java b/src/test/java/org/springframework/data/jpa/repository/UserRepositoryFinderTests.java
index a368ad210..c2f65e051 100644
--- a/src/test/java/org/springframework/data/jpa/repository/UserRepositoryFinderTests.java
+++ b/src/test/java/org/springframework/data/jpa/repository/UserRepositoryFinderTests.java
@@ -209,8 +209,25 @@ public class UserRepositoryFinderTests {
 		User extra = new User("extra", "Matt_ew", "extra");
 		userRepository.save(extra);
 
-		List<User> result = userRepository.findContainingEscaped("att_");
-		assertThat(result, containsInAnyOrder(extra));
+		assertThat(userRepository.findContainingEscaped("att_"), contains(extra));
+	}
+
+	@Test // DATAJPA-1522
+	public void escapingInLikeSpelsInThePresenceOfEscapeCharacters() {
+
+		User withEscapeCharacter = userRepository.save(new User("extra", "Matt\\xew", "extra1"));
+		userRepository.save(new User("extra", "Matt\\_ew", "extra2"));
+
+		assertThat(userRepository.findContainingEscaped("att\\x"), contains(withEscapeCharacter));
+	}
+
+	@Test // DATAJPA-1522
+	public void escapingInLikeSpelsInThePresenceOfEscapedWildcards() {
+
+		userRepository.save(new User("extra", "Matt\\xew", "extra1"));
+		User withEscapedWildcard = userRepository.save(new User("extra", "Matt\\_ew", "extra2"));
+
+		assertThat(userRepository.findContainingEscaped("att\\_"), contains(withEscapedWildcard));
 	}
 
 	@Test // DATAJPA-829
diff --git a/src/test/java/org/springframework/data/jpa/repository/query/EscapeCharacterUnitTests.java b/src/test/java/org/springframework/data/jpa/repository/query/EscapeCharacterUnitTests.java
new file mode 100644
index 000000000..fa248426a
--- /dev/null
+++ b/src/test/java/org/springframework/data/jpa/repository/query/EscapeCharacterUnitTests.java
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2019 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.jpa.repository.query;
+
+import static org.assertj.core.api.Assertions.*;
+
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link EscapeCharacter}.
+ *
+ * @author Jens Schauder
+ */
+public class EscapeCharacterUnitTests {
+
+	@Test // DATAJPA-1522
+	public void nothingToEscape() {
+		assertThat(EscapeCharacter.of('x').escape("alpha")).isEqualTo("alpha");
+	}
+
+	@Test // DATAJPA-1522
+	public void wildcardGetsEscaped() {
+		assertThat(EscapeCharacter.of('x').escape("alp_ha")).isEqualTo("alpx_ha");
+	}
+
+	@Test // DATAJPA-1522
+	public void escapeCharacterGetsEscaped() {
+		assertThat(EscapeCharacter.of('x').escape("axlpx_ha")).isEqualTo("axxlpxxx_ha");
+	}
+}