|
此版本仍在开发中,目前尚不被视为稳定版本。如需最新稳定版本,请使用 Spring Data Neo4j 8.0.4! |
使用 Spring Boot 和 @DataNeo4jTest
Spring Boot 提供 @DataNeo4jTest 到 org.springframework.boot:spring-boot-starter-test。后者引入了 org.springframework.boot:spring-boot-test-autoconfigure,其中包含注解和所需的基础设施代码。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
dependencies {
testImplementation 'org.springframework.boot:spring-boot-starter-test'
}
@DataNeo4jTest 是一个 Spring Boot 测试切片。该测试切片为使用 Neo4j 的测试提供了所有必要的基础设施:事务管理器、客户端、模板以及已声明的仓库,其可选为命令式或响应式变体,具体取决于是否存在响应式依赖项。该测试切片已包含 @ExtendWith(SpringExtension.class),以便在 JUnit 5(JUnit Jupiter)中自动运行。
@DataNeo4jTest 默认同时提供命令式和响应式基础设施,并且还隐式添加了 @Transactional。@Transactional 在 Spring 测试中则始终表示命令式事务,因为声明式事务需要根据方法的返回类型来决定是需要命令式的 PlatformTransactionManager 还是响应式的 ReactiveTransactionManager。
为了断言响应式仓库或服务的正确事务行为,您需要在测试中注入一个 TransactionalOperator,或者将您的领域逻辑包装在使用注解方法的服务中,这些方法返回可使基础设施选择正确事务管理器的类型。
测试切片不会引入嵌入式数据库或其他任何连接设置。</p><p>您需要自行使用适当的连接。
我们推荐以下两种方案之一:要么使用 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。
@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 及相应的仓库配置下获取。
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。 |
@DataNeo4jTest与 Neo4j 测试工具包 4.x/5.x
运行 使用 Neo4j 4.x/5.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 及相应的仓库配置下获取。
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。 |
@DataNeo4jTest使用 Testcontainers Neo4j
配置连接的主要原则当然与 Testcontainers 的使用方式相同,如 使用 Test containers 所示。您需要以下依赖项:
<dependency>
<groupId>org.testcontainers</groupId>
<artifactId>neo4j</artifactId>
<version>1.17.6</version>
<scope>test</scope>
</dependency>
并进行完整的测试:
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());
}
}
}