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 的测试提供了所有必要的基础设施:事务管理器、客户端、模板和声明的存储库,包括命令式或反应式变体,
取决于是否存在反应式依赖关系。
测试切片已包含,因此它与 JUnit 5 (JUnit Jupiter) 一起自动运行。@ExtendWith(SpringExtension.class)
@DataNeo4jTest
默认情况下提供命令式和反应式基础结构,并且还添加了隐式基础结构。 然而,在 Spring 测试中总是意味着命令式事务,因为声明式事务需要
返回方法的类型,用于确定是否需要命令式或反应式。@Transactional
@Transactional
PlatformTransactionManager
ReactiveTransactionManager
若要为响应式存储库或服务断言正确的事务行为,需要将 a 注入测试或将域逻辑包装在使用带注释的方法的服务中,这些方法公开了使之成为可能的返回类型
以便基础结构选择正确的事务管理器。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。
@DataNeo4jTest
带 Neo4j 测试线束 3.5
您需要以下依赖项才能运行 Using 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
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。 |
1 | 创建嵌入式 Neo4j 的入口点 |
2 | 这是一个 Spring Boot 注解,允许动态注册 应用程序属性。我们覆盖相应的 Neo4j 设置。 |
3 | 所有测试后关闭 Neo4j。 |
@DataNeo4jTest
带 Neo4j 测试线束 4.x/5.x
您需要以下依赖项才能运行 Using Neo4j 4.x/5.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
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。 |
1 | 创建嵌入式 Neo4j 的入口点 |
2 | 禁用不需要的 Neo4j HTTP 服务器 |
3 | 这是一个 Spring Boot 注解,允许动态注册 应用程序属性。我们覆盖相应的 Neo4j 设置。 |
4 | 所有测试后关闭 Neo4j。 |
@DataNeo4jTest
使用 Testcontainers Neo4j
当然,配置连接的原则与 Testcontainers 相同,如使用测试容器中所示。 您需要以下依赖项:
<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
在某些情况下,上述注释不适合您的用例。 其中之一可能是你希望 100% 控制驱动程序的初始化方式。 运行测试容器后,可以使用嵌套的静态配置类执行此操作,如下所示:
@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());
}
}
}