GH-16 - Add an example how to combine autoconfig with OGM and TestHarness.

Author: michael-simons

examples/ogm-integration/pom.xml

@@ -18,10 +18,22 @@
 	<properties>
 		<java.version>1.8</java.version>
 		<neo4j-java-driver-spring-boot-starter.version>${revision}${sha1}${changelist}</neo4j-java-driver-spring-boot-starter.version>
+		<!-- Change to 4.0.0 if needed and if on JDK 11 + -->
 		<neo4j-ogm.version>3.2.7</neo4j-ogm.version>
+		<neo4j.version>3.5.14</neo4j.version>
 		<testcontainers.version>1.12.4</testcontainers.version>
 	</properties>
 
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.neo4j.test</groupId>
+				<artifactId>neo4j-harness</artifactId>
+				<version>${neo4j.version}</version>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+
 	<dependencies>
 		<dependency>
 			<groupId>com.github.ben-manes.caffeine</groupId>
@@ -32,6 +44,12 @@
 			<artifactId>neo4j-java-driver-spring-boot-starter</artifactId>
 			<version>${neo4j-java-driver-spring-boot-starter.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>org.neo4j.driver</groupId>
+			<artifactId>neo4j-java-driver-test-harness-spring-boot-autoconfigure</artifactId>
+			<version>${neo4j-java-driver-spring-boot-starter.version}</version>
+			<scope>test</scope>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-actuator</artifactId>

examples/ogm-integration/src/main/java/org/neo4j/doc/driver/springframework/boot/ogm_integration/domain/MovieRepository.java

@@ -18,7 +18,11 @@
  */
 package org.neo4j.doc.driver.springframework.boot.ogm_integration.domain;
 
+import java.util.Optional;
+
 import org.springframework.data.repository.CrudRepository;
 
 public interface MovieRepository extends CrudRepository<MovieEntity, Long> {
+
+	Optional<MovieEntity> findByTitle(String title);
 }

examples/ogm-integration/src/test/java/org/neo4j/doc/driver/springframework/boot/ogm_integration/domain/TestSliceTestWithHarness.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2019-2020 "Neo4j,"
+ * Neo4j Sweden AB [https://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * 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
+ *
+ *     https://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.neo4j.doc.driver.springframework.boot.ogm_integration.domain;
+
+import static org.assertj.core.api.Assertions.*;
+
+import java.util.Optional;
+
+import org.junit.jupiter.api.Test;
+import org.neo4j.driver.Driver;
+import org.neo4j.driver.springframework.boot.autoconfigure.Neo4jDriverAutoConfiguration;
+import org.neo4j.driver.springframework.boot.test.autoconfigure.Neo4jTestHarnessAutoConfiguration;
+import org.neo4j.harness.ServerControls;
+import org.neo4j.harness.TestServerBuilders;
+import org.neo4j.ogm.drivers.bolt.driver.BoltDriver;
+import org.neo4j.ogm.session.SessionFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+
+/**
+ * This tests shows that the Neo4j-OGM with the Java Driver autoconfiguration + test harness works fine with test slices.
+ *
+ * @author Michael J. Simons
+ * @soundtrack Katey Sagal - Covered
+ */
+@DataNeo4jTest
+// This is necessary, as the test slice cannot know about it
+@ImportAutoConfiguration({ Neo4jTestHarnessAutoConfiguration.class, Neo4jDriverAutoConfiguration.class })
+class TestSliceTestWithHarness {
+
+	@TestConfiguration
+	static class TestHarnessConfig {
+
+		@Bean
+		public ServerControls neo4j() {
+			return TestServerBuilders.newInProcessBuilder()
+				.withFixture(""
+					+ "CREATE (TheMatrix:Movie {title:'The Matrix', released:1999, tagline:'Welcome to the Real World'})\n"
+					+ "CREATE (TheMatrixReloaded:Movie {title:'The Matrix Reloaded', released:2003, tagline:'Free your mind'})\n"
+					+ "CREATE (TheMatrixRevolutions:Movie {title:'The Matrix Revolutions', released:2003, tagline:'Everything that has a beginning has an end'})\n"
+				)
+				.newServer();
+		}
+	}
+
+	@Test
+	public void sessionFactoryShouldUseOGMBoltDriver(@Autowired Driver driver,
+		@Autowired SessionFactory sessionFactory) {
+		assertThat(sessionFactory.unwrap(org.neo4j.ogm.driver.Driver.class)).isInstanceOf(BoltDriver.class);
+
+		BoltDriver boltDriver = (BoltDriver) sessionFactory.unwrap(org.neo4j.ogm.driver.Driver.class);
+		assertThat(boltDriver.unwrap(Driver.class)).isSameAs(driver);
+	}
+
+	@Test
+	public void repositoriesShouldWork(@Autowired MovieRepository movieRepository) {
+
+		MovieEntity movieEntity = movieRepository.save(new MovieEntity("Life of Brian"));
+		assertThat(movieEntity.getId()).isNotNull();
+
+		String title = "The Matrix";
+		Optional<MovieEntity> theMatrix = movieRepository.findByTitle(title);
+		assertThat(theMatrix).isPresent().map(MovieEntity::getTitle).hasValue(title);
+	}
+}

examples/simple/src/main/java/org/neo4j/doc/driver/springframework/boot/simple/DisplayMoviesComponent.java

@@ -24,6 +24,7 @@
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Session;
 import org.neo4j.driver.SessionConfig;
+import org.neo4j.driver.Transaction;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.CommandLineRunner;
@@ -51,6 +52,7 @@ public void run(String... args) {
 		SessionConfig sessionConfig = SessionConfig.builder().withDefaultAccessMode(AccessMode.READ).build();
 		LOGGER.info("All the movies:");
 		try (Session session = driver.session(sessionConfig)) {
+
 			session.run("MATCH (m:Movie) RETURN m ORDER BY m.name ASC").stream()
 				.map(r -> r.get("m").asNode())
 				.map(n -> n.get("title").asString())