测试支持
Spring Integration 提供了许多实用程序和注释来帮助您测试应用程序。测试支持由两个模块提供：
-
spring-integration-test-support包含核心项目和共享实用程序 -
spring-integration-test为集成测试提供模拟和应用程序上下文配置组件
spring-integration-test-support（spring-integration-test在 5.0 之前的版本中）为单元测试提供基本的、独立的实用程序、规则和匹配器。（它也不依赖于 Spring Integration 本身，并且在框架测试中内部使用）。
spring-integration-test旨在帮助进行集成测试，并提供一个全面的高级 API 来模拟集成组件并验证单个组件的行为，包括整个集成流或仅部分集成流。
对企业测试的彻底处理超出了本参考手册的范围。请参阅Gregor Hohpe 和 Wendy Istvanick 撰写的“企业集成项目中的测试驱动开发”一文，了解测试目标集成解决方案的想法和原则。
Spring 集成测试框架和测试实用程序完全基于现有的 JUnit、Hamcrest 和 Mockito 库。应用程序上下文交互基于Spring 测试框架。有关更多信息，请参阅这些项目的文档。
由于 Spring Integration Framework 中 EIP 的规范实现及其一等公民（例如MessageChannel和）、抽象Endpoint和MessageHandler松散耦合原则，您可以实现任何复杂的集成解决方案。使用用于流定义的 Spring Integration API，您可以改进、修改甚至替换流的某些部分，而不会影响（大部分）集成解决方案中的其他组件。测试这样的集成解决方案仍然是一个挑战，无论是从端到端方法还是从隔离方法来看。一些现有的工具可以帮助测试或模拟一些集成协议，并且它们与 Spring Integration 通道适配器一起工作得很好。此类工具的示例包括：
-
Spring
MockMVC及其MockRestServiceServer可用于测试HTTP。 -
一些 RDBMS 供应商为 JDBC 或 JPA 支持提供嵌入式数据库。
-
可以嵌入 ActiveMQ 以测试 JMS 或 STOMP 协议。
-
有用于嵌入式 MongoDB 和 Redis 的工具。
-
Tomcat 和 Jetty 具有嵌入式库来测试真正的 HTTP、Web 服务或 WebSocket。
-
来自 Apache Mina 项目的
FtpServer和SshServer可用于测试 FTP 和 SFTP 协议。 -
Gemfire 和 Hazelcast 可以在测试中作为真实数据网格节点运行。
-
Curator Framework 提供了一个
TestingServer用于 Zookeeper 的交互。 -
Apache Kafka 提供了在测试中嵌入 Kafka Broker 的管理工具。
-
GreenMail 是一个开源、直观且易于使用的电子邮件服务器测试套件，用于测试目的。
大多数这些工具和库都用于 Spring 集成测试。此外，从 GitHub存储库（在test每个模块的目录中），您可以发现有关如何为集成解决方案构建自己的测试的想法。
本章的其余部分描述了 Spring Integration 提供的测试工具和实用程序。
测试工具
该spring-integration-test-support模块为单元测试提供实用程序和帮助程序。
测试工具
该类TestUtils主要用于 JUnit 测试中的属性断言，如以下示例所示：
@Test
public void loadBalancerRef() {
MessageChannel channel = channels.get("lbRefChannel");
LoadBalancingStrategy lbStrategy = TestUtils.getPropertyValue(channel,
"dispatcher.loadBalancingStrategy", LoadBalancingStrategy.class);
assertTrue(lbStrategy instanceof SampleLoadBalancingStrategy);
}TestUtils.getPropertyValue()基于 Spring 的DirectFieldAccessor，并提供从目标私有属性中获取值的能力。如前面的示例所示，它还支持使用点分表示法访问嵌套属性。
createTestApplicationContext()工厂方法使用提供的 Spring Integration 环境生成一个实例TestApplicationContext。
有关此类的更多信息，请参阅其他方法的Javadoc 。TestUtils
使用OnlyOnceTrigger
OnlyOnceTrigger当您只需要生成一条测试消息并验证行为而不影响其他周期消息时，它对于轮询端点很有用。以下示例显示了如何配置OnlyOnceTrigger：
<bean id="testTrigger" class="org.springframework.integration.test.util.OnlyOnceTrigger" />
<int:poller id="jpaPoller" trigger="testTrigger">
<int:transactional transaction-manager="transactionManager" />
</int:poller>以下示例显示了如何使用上述配置OnlyOnceTrigger进行测试：
@Autowired
@Qualifier("jpaPoller")
PollerMetadata poller;
@Autowired
OnlyOnceTrigger testTrigger;
@Test
@DirtiesContext
public void testWithEntityClass() throws Exception {
this.testTrigger.reset();
...
JpaPollingChannelAdapter jpaPollingChannelAdapter = new JpaPollingChannelAdapter(jpaExecutor);
SourcePollingChannelAdapter adapter = JpaTestUtils.getSourcePollingChannelAdapter(
jpaPollingChannelAdapter, this.outputChannel, this.poller, this.context,
this.getClass().getClassLoader());
adapter.start();
...
}JUnit 规则和条件
LongRunningIntegrationTest存在 JUnit 4 测试规则以指示是否应在环境RUN_LONG_INTEGRATION_TESTS或系统属性设置为 时运行测试true。否则将被跳过。出于同样的原因，从 5.1 版开始，@LongRunningTest为 JUnit 5 测试提供了条件注释。
Hamcrest 和 Mockito Matchers
该org.springframework.integration.test.matcher包包含几个Matcher实现断言Message及其在单元测试中的属性。以下示例显示了如何使用这样的匹配器 ( PayloadMatcher)：
import static org.springframework.integration.test.matcher.PayloadMatcher.hasPayload;
...
@Test
public void transform_withFilePayload_convertedToByteArray() throws Exception {
Message<?> result = this.transformer.transform(message);
assertThat(result, is(notNullValue()));
assertThat(result, hasPayload(is(instanceOf(byte[].class))));
assertThat(result, hasPayload(SAMPLE_CONTENT.getBytes(DEFAULT_ENCODING)));
}MockitoMessageMatchers工厂可用于模拟存根和验证，如以下示例所示：
static final Date SOME_PAYLOAD = new Date();
static final String SOME_HEADER_VALUE = "bar";
static final String SOME_HEADER_KEY = "test.foo";
...
Message<?> message = MessageBuilder.withPayload(SOME_PAYLOAD)
.setHeader(SOME_HEADER_KEY, SOME_HEADER_VALUE)
.build();
MessageHandler handler = mock(MessageHandler.class);
handler.handleMessage(message);
verify(handler).handleMessage(messageWithPayload(SOME_PAYLOAD));
verify(handler).handleMessage(messageWithPayload(is(instanceOf(Date.class))));
...
MessageChannel channel = mock(MessageChannel.class);
when(channel.send(messageWithHeaderEntry(SOME_HEADER_KEY, is(instanceOf(Short.class)))))
.thenReturn(true);
assertThat(channel.send(message), is(false));Spring 集成和测试上下文
通常，Spring 应用程序的测试使用 Spring Test Framework。由于 Spring Integration 基于 Spring Framework 基础，我们可以使用 Spring Test Framework 执行的所有操作也适用于测试集成流。该org.springframework.integration.test.context软件包提供了一些组件来增强集成需求的测试上下文。首先，我们使用@SpringIntegrationTest注解配置我们的测试类以启用 Spring Integration Test Framework，如以下示例所示：
@RunWith(SpringRunner.class)
@SpringIntegrationTest(noAutoStartup = {"inboundChannelAdapter", "*Source*"})
public class MyIntegrationTests {
@Autowired
private MockIntegrationContext mockIntegrationContext;
}@SpringIntegrationTest注释填充了一个MockIntegrationContextbean，您可以将其自动装配到测试类以访问其方法。使用该noAutoStartup选项，Spring 集成测试框架会阻止通常autoStartup=true启动的端点。端点与提供的模式匹配，这些模式支持以下简单模式样式：xxx*、xxx、*xxx和xxx*yyy.
当我们不希望从入站通道适配器（例如 AMQP 入站网关、JDBC 轮询通道适配器、客户端模式下的 WebSocket 消息生产者等）与目标系统建立真正的连接时，这很有用。
这MockIntegrationContext意味着在目标测试用例中用于修改真实应用程序上下文中的 bean。例如，可以用模拟替换已autoStartup覆盖的端点，如以下示例所示：false
@Test
public void testMockMessageSource() {
MessageSource<String> messageSource = () -> new GenericMessage<>("foo");
this.mockIntegrationContext.substituteMessageSourceFor("mySourceEndpoint", messageSource);
Message<?> receive = this.results.receive(10_000);
assertNotNull(receive);
}
这里mySourceEndpoint指的是我们用我们的模拟SourcePollingChannelAdapter替换真实的bean名称。MessageSource类似地，MockIntegrationContext.substituteMessageHandlerFor()期望 bean 名称IntegrationConsumer，它将 a 包装MessageHandler为端点。
|
执行测试后，您可以使用以下命令将端点 bean 的状态恢复为真实配置MockIntegrationContext.resetBeans()：
@After
public void tearDown() {
this.mockIntegrationContext.resetBeans();
}有关更多信息，请参阅Javadoc。
集成模拟
该org.springframework.integration.test.mock包提供了用于模拟、存根和验证 Spring 集成组件上的活动的工具和实用程序。模拟功能完全基于众所周知的 Mockito 框架并与之兼容。（当前的 Mockito 传递依赖于 2.5.x 或更高版本。）
模拟集成
工厂提供了一个 API 来为作为集成流（、、、和）MockIntegration一部分的 Spring 集成 bean 构建模拟。您可以在配置阶段以及在目标测试方法中使用目标模拟来在执行验证和断言之前替换真实端点，如以下示例所示：MessageSourceMessageProducerMessageHandlerMessageChannel
<int:inbound-channel-adapter id="inboundChannelAdapter" channel="results">
<bean class="org.springframework.integration.test.mock.MockIntegration" factory-method="mockMessageSource">
<constructor-arg value="a"/>
<constructor-arg>
<array>
<value>b</value>
<value>c</value>
</array>
</constructor-arg>
</bean>
</int:inbound-channel-adapter>以下示例展示了如何使用 Java Configuration 来实现与前面示例相同的配置：
@InboundChannelAdapter(channel = "results")
@Bean
public MessageSource<Integer> testingMessageSource() {
return MockIntegration.mockMessageSource(1, 2, 3);
}
...
StandardIntegrationFlow flow = IntegrationFlows
.from(MockIntegration.mockMessageSource("foo", "bar", "baz"))
.<String, String>transform(String::toUpperCase)
.channel(out)
.get();
IntegrationFlowRegistration registration = this.integrationFlowContext.registration(flow)
.register();为此，MockIntegrationContext应从测试中使用上述内容，如以下示例所示：
this.mockIntegrationContext.substituteMessageSourceFor("mySourceEndpoint",
MockIntegration.mockMessageSource("foo", "bar", "baz"));
Message<?> receive = this.results.receive(10_000);
assertNotNull(receive);
assertEquals("FOO", receive.getPayload());与 MockitoMessageSource模拟对象不同，它是一个带有链 APIMockMessageHandler的常规扩展，用于对传入消息进行存根处理。AbstractMessageProducingHandler提供MockMessageHandler为handleNext(Consumer<Message<?>>)下一个请求消息指定单向存根。它用于模拟不产生回复的消息处理程序。提供handleNextAndReply(Function<Message<?>, ?>)用于为下一个请求消息执行相同的存根逻辑并为其生成回复。它们可以链接起来模拟所有预期请求消息变体的任意请求-回复场景。这些消费者和函数应用于传入的消息，从堆栈一次一个，直到最后一个，然后用于所有剩余的消息。该行为类似于 MockitoAnswer或doReturn()API。
此外，您可以在构造函数参数中提供一个ArgumentCaptor<Message<?>>Mockito MockMessageHandler。的每个请求消息MockMessageHandler都由 that 捕获ArgumentCaptor。在测试期间，您可以使用它的getValue()和getAllValues()方法来验证和断言那些请求消息。
它MockIntegrationContext提供了一个substituteMessageHandlerFor()API，可让您在被测端点MessageHandler中用 a替换实际配置。MockMessageHandler
下面的例子展示了一个典型的使用场景：
ArgumentCaptor<Message<?>> messageArgumentCaptor = ArgumentCaptor.forClass(Message.class);
MessageHandler mockMessageHandler =
mockMessageHandler(messageArgumentCaptor)
.handleNextAndReply(m -> m.getPayload().toString().toUpperCase());
this.mockIntegrationContext.substituteMessageHandlerFor("myService.serviceActivator",
mockMessageHandler);
GenericMessage<String> message = new GenericMessage<>("foo");
this.myChannel.send(message);
Message<?> received = this.results.receive(10000);
assertNotNull(received);
assertEquals("FOO", received.getPayload());
assertSame(message, messageArgumentCaptor.getValue());有关详细信息，请参阅MockIntegration和MockMessageHandlerJavadoc。
其他资源
除了探索框架本身的测试用例外，Spring Integration Samples 存储库还有一些专门用于展示测试的示例应用程序，例如testing-examples和advanced-testing-examples. 在某些情况下，样本本身具有全面的端到端测试，例如file-split-ftp样本。