使用 Spring Boot 和 `@DataNeo4jTest`

Spring Boot 通过 `org.springframework.boot:spring-boot-starter-test` 提供 `@DataNeo4jTest` 注解。后者包含 `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 测试切片。该测试切片为使用 Neo4j 的测试提供了所有必要的底层结构：事务管理器、客户端、模板和声明的仓库 (其命令式或响应式变体，取决于是否存在响应式依赖项)。测试切片已包含 `@ExtendWith(SpringExtension.class)`，以便它可以自动与 JUnit 5 (JUnit Jupiter) 一起运行。

`@DataNeo4jTest` 默认情况下提供命令式和响应式基础结构，并添加隐式 `@Transactional`。但是，Spring 测试中的 `@Transactional` 始终意味着命令式事务，因为声明式事务需要方法的返回类型来决定是否需要命令式 `PlatformTransactionManager` 或响应式 `ReactiveTransactionManager`。

要断言响应式仓库或服务的正确事务行为，需要将 `TransactionalOperator` 注入到测试中，或者将域逻辑包装在使用带注解的方法的服务中，这些方法公开的返回类型使基础结构能够选择正确的事务管理器。

测试切片不包含嵌入式数据库或任何其他连接设置。使用合适的连接取决于您自己。

我们推荐以下两种选择之一：使用 Neo4j Testcontainers 模块或 Neo4j 测试工具。Testcontainers 是一个已知的项目，它有很多不同服务的模块，而 Neo4j 测试工具则鲜为人知。它是一个嵌入式实例，在测试存储过程时特别有用，如测试基于 Neo4j 的 Java 应用程序中所述。但是，测试工具也可以用于测试应用程序。因为它在与应用程序相同的 JVM 中启动数据库，因此性能和计时可能与生产环境设置不符。

为了方便起见，我们提供了三种可能的方案，Neo4j 测试工具 3.5 和 4.x/5.x 以及 Testcontainers Neo4j。我们为 3.5 和 4.x/5.x 提供了不同的示例，因为测试工具在这两个版本之间发生了变化。此外，4.0 需要 JDK 11。

使用 Neo4j 测试工具 3.5 的 `@DataNeo4jTest`

运行使用 Neo4j 3.5 测试工具需要以下依赖项

Neo4j 3.5 测试工具依赖项

<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 测试工具

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 测试工具 4.x/5.x 的 `@DataNeo4jTest`

运行使用 Neo4j 4.x/5.x 测试工具需要以下依赖项

Neo4j 4.x 测试工具依赖项

<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 测试工具

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

在某些情况下，上述注解不适合您的用例。其中一种情况可能是您希望完全控制驱动程序的初始化方式。使用运行的测试容器，您可以使用这样的嵌套静态配置类来实现：

@TestConfiguration(proxyBeanMethods = false)
static class TestNeo4jConfig {

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

如果要使用属性但不能使用 `@DynamicPropertySource`，可以使用初始化器：

动态属性的替代注入方式

@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());
        }
    }
}