feat: add support for not equals queries in datastore integration (#3635)

* chore: add support for NOT_EQUALS in datastore integration

* update docs

* remove debug config

* restore product repository

* correct whitespace

Author: diegomarquezp

docs/src/main/asciidoc/datastore.adoc

@@ -965,6 +965,8 @@ public interface TradeRepository extends DatastoreRepository<Trade, String[]> {
   List<TestEntity> findBySymbol(String symbol, Sort sort);
 
   Stream<TestEntity> findBySymbol(String symbol);
+
+  Stream<TestEntity> findBySymbolIsNot(String symbol);
 }
 ----
 
@@ -975,6 +977,7 @@ NOTE: You can refer to nested fields using https://docs.spring.io/spring-data/jp
 Cloud Datastore only supports filter components joined by AND, and the following operations:
 
 * `equals`
+* `not equals`
 * `greater than or equals`
 * `greater than`
 * `less than or equals`

spring-cloud-gcp-data-datastore/src/main/java/com/google/cloud/spring/data/datastore/repository/query/PartTreeDatastoreQuery.java

@@ -20,6 +20,7 @@
 import static org.springframework.data.repository.query.parser.Part.Type.GREATER_THAN_EQUAL;
 import static org.springframework.data.repository.query.parser.Part.Type.LESS_THAN;
 import static org.springframework.data.repository.query.parser.Part.Type.LESS_THAN_EQUAL;
+import static org.springframework.data.repository.query.parser.Part.Type.NEGATING_SIMPLE_PROPERTY;
 import static org.springframework.data.repository.query.parser.Part.Type.SIMPLE_PROPERTY;
 
 import com.google.cloud.datastore.Cursor;
@@ -92,6 +93,7 @@ public class PartTreeDatastoreQuery<T> extends AbstractDatastoreQuery<T> {
           .put(GREATER_THAN, PropertyFilter::gt)
           .put(LESS_THAN_EQUAL, PropertyFilter::le)
           .put(LESS_THAN, PropertyFilter::lt)
+          .put(NEGATING_SIMPLE_PROPERTY, PropertyFilter::neq)
           .build();
 
   /**

spring-cloud-gcp-data-datastore/src/test/java/com/google/cloud/spring/data/datastore/it/DatastoreIntegrationTests.java

@@ -178,6 +178,17 @@ void saveEntities() {
         .untilAsserted(() -> assertThat(this.testEntityRepository.countBySize(1L)).isEqualTo(3));
   }
 
+  @Test
+  void testNotEquals() {
+    Pet linux = new Dog("Linux");
+    Pet lukas = new Dog("Lukas");
+    petRepository.save(linux);
+    petRepository.save(lukas);
+    List<Pet> result = petRepository.findByNameNot("Linux");
+    assertThat(result).hasSize(1);
+    assertThat(result.get(0).getName()).isEqualTo("Lukas");
+  }
+
   @Test
   void testFindByExampleReference() {
     Store store1 = new Store("store1");
@@ -693,7 +704,8 @@ void ancestorsTest() {
   void referenceTest() {
     ReferenceEntity parent = saveReferenceEntitiesGraph();
 
-    ReferenceEntity loadedParent = this.datastoreTemplate.findById(parent.id, ReferenceEntity.class);
+    ReferenceEntity loadedParent =
+        this.datastoreTemplate.findById(parent.id, ReferenceEntity.class);
     assertThat(loadedParent).isEqualTo(parent);
 
     parent.name = "parent updated";
@@ -718,7 +730,8 @@ void referenceTest() {
   void lazyReferenceCollectionTest() {
     ReferenceLazyEntity parent = saveEntitiesGraph();
 
-    ReferenceLazyEntity lazyParent = this.datastoreTemplate.findById(parent.id, ReferenceLazyEntity.class);
+    ReferenceLazyEntity lazyParent =
+        this.datastoreTemplate.findById(parent.id, ReferenceLazyEntity.class);
 
     // Saving an entity with not loaded lazy field
     this.datastoreTemplate.save(lazyParent);
@@ -766,7 +779,8 @@ void lazyReferenceTransactionTest() {
 
     // Exception should be produced if a lazy loaded property accessed outside of the initial
     // transaction
-    ReferenceLazyEntity finalLoadedParent = this.transactionalTemplateService.findByIdLazy(parent.id);
+    ReferenceLazyEntity finalLoadedParent =
+        this.transactionalTemplateService.findByIdLazy(parent.id);
     assertThatThrownBy(() -> finalLoadedParent.children.size())
         .isInstanceOf(DatastoreDataException.class)
         .hasMessage("Lazy load should be invoked within the same transaction");
@@ -1016,8 +1030,6 @@ void sameClassDescendantsTest() {
     assertThat(readCompany.leaders.get(0).id).isEqualTo(entity1.id);
   }
 
-
-
   @Test
   void testPageableGqlEntityProjectionsPage() {
     Page<TestEntityProjection> page =

spring-cloud-gcp-data-datastore/src/test/java/com/google/cloud/spring/data/datastore/it/testdomains/Pet.java

@@ -32,4 +32,8 @@ public abstract class Pet {
   }
 
   public abstract String speak();
+
+  public String getName() {
+    return name;
+  }
 }

spring-cloud-gcp-data-datastore/src/test/java/com/google/cloud/spring/data/datastore/it/testdomains/PetRepository.java

@@ -21,4 +21,6 @@
 
 public interface PetRepository extends DatastoreRepository<Pet, Long> {
   List<Pet> findByName(String s);
+
+  List<Pet> findByNameNot(String s);
 }

spring-cloud-gcp-data-datastore/src/test/java/com/google/cloud/spring/data/datastore/repository/query/PartTreeDatastoreQueryTests.java

@@ -152,6 +152,49 @@ private ProjectionInformation getProjectionInformationMock() {
     return mock;
   }
 
+  @Test
+  void notEqualsSupportTest() throws NoSuchMethodException {
+    queryWithMockResult(
+        "findBySymbolNotAndSymbolIsNot",
+        null,
+        getClass()
+            .getMethod(
+                "tradeMethodNotEquals",
+                String.class,
+                String.class));
+
+    Object[] params =
+        new Object[] {
+            "abcd",
+            "abcde",
+        };
+
+    when(this.datastoreTemplate.queryKeysOrEntities(any(), any()))
+        .thenAnswer(
+            invocation -> {
+              EntityQuery statement = invocation.getArgument(0);
+
+              EntityQuery expected =
+                  StructuredQuery.newEntityQueryBuilder()
+                      .setFilter(
+                          CompositeFilter.and(
+                              PropertyFilter.neq("ticker", "abcd"),
+                              PropertyFilter.neq("ticker", "abcde")
+                              ))
+                      .setKind("trades")
+                      .build();
+
+              assertThat(statement).isEqualTo(expected);
+
+              return EMPTY_RESPONSE;
+            });
+
+    when(this.queryMethod.getCollectionReturnType()).thenReturn(List.class);
+
+    this.partTreeDatastoreQuery.execute(params);
+    verify(this.datastoreTemplate).queryKeysOrEntities(any(), any());
+  }
+
   @Test
   void compoundNameConventionTest() throws NoSuchMethodException {
     queryWithMockResult(
@@ -1126,6 +1169,11 @@ public List<Trade> tradeMethod(
     return null;
   }
 
+  public List<Trade> tradeMethodNotEquals(
+      String symbolNeq, String symbolNeq2) {
+    return null;
+  }
+
   public int traderAndPrice() {
     return 0;
   }

spring-cloud-gcp-samples/spring-cloud-gcp-data-datastore-basic-sample/src/main/java/com/example/BookController.java

@@ -57,6 +57,13 @@ public String findByAuthor(@RequestParam("author") String author) {
     return books.toString();
   }
 
+  @GetMapping("/findByAuthorNotEquals")
+  public String findByAuthorNotEquals(
+      @RequestParam("author") String author) {
+    List<Book> books = this.bookRepository.findByAuthorNot(author);
+    return books.toString();
+  }
+
   @GetMapping("/findByYearGreaterThan")
   public String findByYearGreaterThan(@RequestParam("year") Optional<Integer> year) {
     List<Book> books = this.bookRepository.findByYearGreaterThan(year.orElse(0));

spring-cloud-gcp-samples/spring-cloud-gcp-data-datastore-basic-sample/src/main/java/com/example/BookRepository.java

@@ -30,4 +30,6 @@ public interface BookRepository extends DatastoreRepository<Book, Long> {
   List<Book> findByYearGreaterThan(int year);
 
   List<Book> findByAuthorAndYear(String author, int year);
+
+  List<Book> findByAuthorNot(String author);
 }

spring-cloud-gcp-samples/spring-cloud-gcp-data-datastore-basic-sample/src/test/java/com/example/DatastoreBookshelfExampleIntegrationTests.java

@@ -143,6 +143,16 @@ void removeAllBooksTest() {
     });
   }
 
+  @Test
+  void findByAuthorNotEqualsTest() {
+    String responseBody = sendRequest("/findByAuthorNotEquals?author=Philip K. Dick", null, HttpMethod.GET);
+    assertThat(responseBody)
+        .contains("title='The Moon Is a Harsh Mistress', author='Robert A. Heinlein', year=1966")
+        .contains("title='Stranger in a Strange Land', author='Robert A. Heinlein', year=1961")
+        .doesNotContain("title='The Crack in Space', author='Philip K. Dick', year=1966")
+        .doesNotContain("title='Ubik', author='Philip K. Dick', year=1969");
+  }
+
   private String sendRequest(String url, String json, HttpMethod method) {
     MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
     map.add("Content-Type", "application/json");