结合 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` 的替代方案