結合 Spring Boot 和 `@DataNeo4jTest`

Spring Boot 透過 @DataNeo4jTest 提供了 org.springframework.boot:spring-boot-starter-test。後者引入了 org.springframework.boot:spring-boot-test-autoconfigure，其中包含了該註解和所需的底層基礎程式碼。

在 Maven 構建中包含 Spring Boot Starter Test

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

在 Gradle 構建中包含 Spring Boot Starter Test

dependencies {
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

@DataNeo4jTest 是一個 Spring Boot 測試切片（test slice）。該測試切片為使用 Neo4j 的測試提供了所有必要的基礎設施：事務管理器、客戶端、模板以及宣告的倉庫（Repositories），根據是否存在響應式依賴，可以是命令式或響應式變體。該測試切片已包含 @ExtendWith(SpringExtension.class)，以便它可以與 JUnit 5 (JUnit Jupiter) 自動執行。

預設情況下，@DataNeo4jTest 提供命令式和響應式兩種基礎設施，同時還隱式添加了 @Transactional。然而，Spring 測試中的 @Transactional 總是指命令式事務，因為宣告式事務需要方法的返回型別來決定是使用命令式的 PlatformTransactionManager 還是響應式的 ReactiveTransactionManager。

要斷言響應式倉庫或服務的正確事務行為，您需要在測試中注入一個 TransactionalOperator，或者將您的領域邏輯封裝在使用帶有註解方法的服務中，這些方法暴露的返回型別使得基礎設施能夠選擇正確的事務管理器。

測試切片不引入嵌入式資料庫或任何其他連線設定。使用適當的連線取決於您自己。

我們推薦兩種方案之一：要麼使用 Neo4j Testcontainers 模組，要麼使用 Neo4j test harness。Testcontainers 是一個知名的專案，為許多不同的服務提供了模組，而 Neo4j test harness 則相對不太為人所知。它是一個嵌入式例項，在測試儲存過程時特別有用，如測試你的基於 Neo4j 的 Java 應用中所述。但是，test harness 也可以用於測試應用程式。由於它在與應用程式相同的 JVM 內啟動資料庫，其效能和時序可能與您的生產環境設定不同。

為了方便您，我們提供了三種可能的場景：Neo4j test harness 3.5、4.x/5.x 版本以及 Testcontainers Neo4j。由於 test harness 在這些版本之間發生了變化，我們提供了針對 3.5 和 4.x/5.x 的不同示例。此外，4.0 版本需要 JDK 11。

結合 Neo4j test harness 3.5 使用 `@DataNeo4jTest`

您需要以下依賴項來執行使用 Neo4j 3.5 test harness

Neo4j 3.5 test harness 依賴項

<dependency>
    <groupId>org.neo4j.test</groupId>
    <artifactId>neo4j-harness</artifactId>
    <version>3.5.33</version>
    <scope>test</scope>
</dependency>

Neo4j 3.5 企業版所需的依賴項可在 com.neo4j.test:neo4j-harness-enterprise 下獲取，並需要相應的倉庫配置。

使用 Neo4j 3.5 test harness

import static org.assertj.core.api.Assertions.assertThat;

import java.util.Optional;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.neo4j.harness.ServerControls;
import org.neo4j.harness.TestServerBuilders;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;
import org.springframework.data.neo4j.core.Neo4jClient;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;

@DataNeo4jTest
class MovieRepositoryTest {

	private static ServerControls embeddedDatabaseServer;

	@BeforeAll
	static void initializeNeo4j() {

		embeddedDatabaseServer = TestServerBuilders.newInProcessBuilder() (1)
			.newServer();
	}

	@AfterAll
	static void stopNeo4j() {

		embeddedDatabaseServer.close(); (2)
	}

	@DynamicPropertySource  (3)
	static void neo4jProperties(DynamicPropertyRegistry registry) {

		registry.add("spring.neo4j.uri", embeddedDatabaseServer::boltURI);
		registry.add("spring.neo4j.authentication.username", () -> "neo4j");
		registry.add("spring.neo4j.authentication.password", () -> null);
	}

	@Test
	public void findSomethingShouldWork(@Autowired Neo4jClient client) {

		Optional<Long> result = client.query("MATCH (n) RETURN COUNT(n)")
			.fetchAs(Long.class)
			.one();
		assertThat(result).hasValue(0L);
	}
}

1	建立嵌入式 Neo4j 的入口點
2	這是一個 Spring Boot 註解，允許動態註冊應用程式屬性。我們覆蓋相應的 Neo4j 設定。
3	所有測試完成後關閉 Neo4j。

結合 Neo4j test harness 4.x/5.x 使用 `@DataNeo4jTest`

您需要以下依賴項來執行使用 Neo4j 4.x/5.x test harness

Neo4j 4.x test harness 依賴項

<dependency>
    <groupId>org.neo4j.test</groupId>
    <artifactId>neo4j-harness</artifactId>
    <version>4.4.25</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-nop</artifactId>
        </exclusion>
    </exclusions>
</dependency>

Neo4j 4.x/5.x 企業版所需的依賴項可在 com.neo4j.test:neo4j-harness-enterprise 下獲取，並需要相應的倉庫配置。

使用 Neo4j 4.x/5.x test harness

import static org.assertj.core.api.Assertions.assertThat;

import java.util.Optional;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.neo4j.harness.Neo4j;
import org.neo4j.harness.Neo4jBuilders;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;
import org.springframework.data.neo4j.core.Neo4jClient;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;

@DataNeo4jTest
class MovieRepositoryTest {

	private static Neo4j embeddedDatabaseServer;

	@BeforeAll
	static void initializeNeo4j() {

		embeddedDatabaseServer = Neo4jBuilders.newInProcessBuilder() (1)
			.withDisabledServer() (2)
			.build();
	}

	@DynamicPropertySource (3)
	static void neo4jProperties(DynamicPropertyRegistry registry) {

		registry.add("spring.neo4j.uri", embeddedDatabaseServer::boltURI);
		registry.add("spring.neo4j.authentication.username", () -> "neo4j");
		registry.add("spring.neo4j.authentication.password", () -> null);
	}

	@AfterAll
	static void stopNeo4j() {

		embeddedDatabaseServer.close(); (4)
	}

	@Test
	public void findSomethingShouldWork(@Autowired Neo4jClient client) {

		Optional<Long> result = client.query("MATCH (n) RETURN COUNT(n)")
			.fetchAs(Long.class)
			.one();
		assertThat(result).hasValue(0L);
	}
}

1	建立嵌入式 Neo4j 的入口點
2	停用不需要的 Neo4j HTTP 伺服器
3	這是一個 Spring Boot 註解，允許動態註冊應用程式屬性。我們覆蓋相應的 Neo4j 設定。
4	所有測試完成後關閉 Neo4j。

結合 Testcontainers Neo4j 使用 `@DataNeo4jTest`

正如使用 Testcontainers中所示，配置連線的原理在使用 Testcontainers 時當然也是一樣的。您需要以下依賴項

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>neo4j</artifactId>
    <version>1.17.6</version>
    <scope>test</scope>
</dependency>

以及一個完整的測試

使用 Testcontainers

import static org.assertj.core.api.Assertions.assertThat;

import java.util.Optional;

import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.data.neo4j.DataNeo4jTest;
import org.springframework.data.neo4j.core.Neo4jClient;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import org.testcontainers.containers.Neo4jContainer;

@DataNeo4jTest
class MovieRepositoryTCTest {

	private static Neo4jContainer<?> neo4jContainer;

	@BeforeAll
	static void initializeNeo4j() {

		neo4jContainer = new Neo4jContainer<>()
			.withAdminPassword("somePassword");
		neo4jContainer.start();
	}

	@AfterAll
	static void stopNeo4j() {

		neo4jContainer.close();
	}

	@DynamicPropertySource
	static void neo4jProperties(DynamicPropertyRegistry registry) {

		registry.add("spring.neo4j.uri", neo4jContainer::getBoltUrl);
		registry.add("spring.neo4j.authentication.username", () -> "neo4j");
		registry.add("spring.neo4j.authentication.password", neo4jContainer::getAdminPassword);
	}

	@Test
	public void findSomethingShouldWork(@Autowired Neo4jClient client) {

		Optional<Long> result = client.query("MATCH (n) RETURN COUNT(n)")
			.fetchAs(Long.class)
			.one();
		assertThat(result).hasValue(0L);
	}
}

`@DynamicPropertySource` 的替代方案

在某些場景下，上述註解可能不適合您的用例。其中一種情況是您希望 100% 控制驅動程式的初始化方式。在測試容器執行的情況下，您可以使用這樣的巢狀靜態配置類來實現這一點

@TestConfiguration(proxyBeanMethods = false)
static class TestNeo4jConfig {

    @Bean
    Driver driver() {
        return GraphDatabase.driver(
        		neo4jContainer.getBoltUrl(),
        		AuthTokens.basic("neo4j", neo4jContainer.getAdminPassword())
        );
    }
}

如果您想使用屬性但無法使用 @DynamicPropertySource，則可以使用初始化器（initializer）

動態屬性的替代注入方法

@ContextConfiguration(initializers = PriorToBoot226Test.Initializer.class)
@DataNeo4jTest
class PriorToBoot226Test {

    private static Neo4jContainer<?> neo4jContainer;

    @BeforeAll
    static void initializeNeo4j() {

        neo4jContainer = new Neo4jContainer<>()
            .withAdminPassword("somePassword");
        neo4jContainer.start();
    }

    @AfterAll
    static void stopNeo4j() {

        neo4jContainer.close();
    }

    static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
            TestPropertyValues.of(
                "spring.neo4j.uri=" + neo4jContainer.getBoltUrl(),
                "spring.neo4j.authentication.username=neo4j",
                "spring.neo4j.authentication.password=" + neo4jContainer.getAdminPassword()
            ).applyTo(configurableApplicationContext.getEnvironment());
        }
    }
}

結合 Spring Boot 和 @DataNeo4jTest

結合 Neo4j test harness 3.5 使用 @DataNeo4jTest

結合 Neo4j test harness 4.x/5.x 使用 @DataNeo4jTest

結合 Testcontainers Neo4j 使用 @DataNeo4jTest

@DynamicPropertySource 的替代方案

結合 Spring Boot 和 `@DataNeo4jTest`

結合 Neo4j test harness 3.5 使用 `@DataNeo4jTest`

結合 Neo4j test harness 4.x/5.x 使用 `@DataNeo4jTest`

結合 Testcontainers Neo4j 使用 `@DataNeo4jTest`

`@DynamicPropertySource` 的替代方案