测试支持

编写异步应用程序的集成测试比测试更简单的应用程序要复杂得多。当 @RabbitListener 这样的抽象概念出现时，情况会更加复杂。问题是如何验证在发送消息后，监听器是否按预期接收了消息。

框架本身有许多单元测试和集成测试。一些使用模拟，而另一些则使用与实时 RabbitMQ 代理的集成测试。您可以参考这些测试，以获取一些测试场景的思路。

Spring AMQP 1.6 版本引入了 spring-rabbit-test jar 包，它为测试一些更复杂的场景提供了支持。预计该项目会随着时间的推移而扩展，但我们需要社区的反馈来提出测试所需功能的建议。请使用 JIRA 或 GitHub Issues 提供此类反馈。

@SpringRabbitTest

使用此注解将基础设施 bean 添加到 Spring 测试 ApplicationContext 中。当使用例如 @SpringBootTest 时，这并非必需，因为 Spring Boot 的自动配置会添加这些 bean。

注册的 bean 包括

  • CachingConnectionFactory（autoConnectionFactory）。如果存在@RabbitEnabled，则使用其连接工厂。

  • RabbitTemplate（autoRabbitTemplate）

  • RabbitAdmin（autoRabbitAdmin）

  • RabbitListenerContainerFactory（autoContainerFactory）

此外，还添加了与@EnableRabbit（以支持@RabbitListener）关联的 bean。

Junit5 示例
@SpringJUnitConfig
@SpringRabbitTest
public class MyRabbitTests {

	@Autowired
	private RabbitTemplate template;

	@Autowired
	private RabbitAdmin admin;

	@Autowired
	private RabbitListenerEndpointRegistry registry;

	@Test
	void test() {
        ...
	}

	@Configuration
	public static class Config {

        ...

	}

}

对于 JUnit4，请将@SpringJUnitConfig 替换为@RunWith(SpringRunnner.class)。

Mockito Answer<?> 实现

目前有两个Answer<?> 实现可以帮助进行测试。

第一个，LatchCountDownAndCallRealMethodAnswer，提供了一个Answer<Void>，它返回null 并减少闩锁计数。以下示例演示了如何使用LatchCountDownAndCallRealMethodAnswer

LatchCountDownAndCallRealMethodAnswer answer = this.harness.getLatchAnswerFor("myListener", 2);
doAnswer(answer)
    .when(listener).foo(anyString(), anyString());

...

assertThat(answer.await(10)).isTrue();

第二个，LambdaAnswer<T> 提供了一种机制，可以选择调用实际方法，并提供根据InvocationOnMock 和结果（如果有）返回自定义结果的机会。

考虑以下 POJO

public class Thing {

    public String thing(String thing) {
        return thing.toUpperCase();
    }

}

以下类测试Thing POJO

Thing thing = spy(new Thing());

doAnswer(new LambdaAnswer<String>(true, (i, r) -> r + r))
    .when(thing).thing(anyString());
assertEquals("THINGTHING", thing.thing("thing"));

doAnswer(new LambdaAnswer<String>(true, (i, r) -> r + i.getArguments()[0]))
    .when(thing).thing(anyString());
assertEquals("THINGthing", thing.thing("thing"));

doAnswer(new LambdaAnswer<String>(false, (i, r) ->
    "" + i.getArguments()[0] + i.getArguments()[0])).when(thing).thing(anyString());
assertEquals("thingthing", thing.thing("thing"));

从版本 2.2.3 开始，答案会捕获测试方法抛出的任何异常。使用answer.getExceptions() 获取对它们的引用。

当与@RabbitListenerTest 和 RabbitListenerTestHarness 结合使用时，使用harness.getLambdaAnswerFor("listenerId", true, …​) 获取为侦听器正确构造的答案。

@RabbitListenerTest 和 RabbitListenerTestHarness

在您的一个@Configuration 类上使用@RabbitListenerTest 注解会导致框架将标准RabbitListenerAnnotationBeanPostProcessor 替换为名为RabbitListenerTestHarness 的子类（它还通过@EnableRabbit 启用@RabbitListener 检测）。

RabbitListenerTestHarness 以两种方式增强侦听器。首先，它将侦听器包装在一个Mockito Spy 中，从而启用正常的Mockito 存根和验证操作。它还可以向侦听器添加一个Advice，从而能够访问参数、结果和抛出的任何异常。您可以使用@RabbitListenerTest 上的属性来控制启用这些功能中的哪一个（或两者）。后者用于访问有关调用的更低级别数据。它还支持阻塞测试线程，直到异步侦听器被调用。

final @RabbitListener 方法不能被间谍或建议。此外，只有具有id 属性的侦听器才能被间谍或建议。

考虑一些示例。

以下示例使用间谍

@Configuration
@RabbitListenerTest
public class Config {

    @Bean
    public Listener listener() {
        return new Listener();
    }

    ...

}

public class Listener {

    @RabbitListener(id="foo", queues="#{queue1.name}")
    public String foo(String foo) {
        return foo.toUpperCase();
    }

    @RabbitListener(id="bar", queues="#{queue2.name}")
    public void foo(@Payload String foo, @Header("amqp_receivedRoutingKey") String rk) {
        ...
    }

}

public class MyTests {

    @Autowired
    private RabbitListenerTestHarness harness; (1)

    @Test
    public void testTwoWay() throws Exception {
        assertEquals("FOO", this.rabbitTemplate.convertSendAndReceive(this.queue1.getName(), "foo"));

        Listener listener = this.harness.getSpy("foo"); (2)
        assertNotNull(listener);
        verify(listener).foo("foo");
    }

    @Test
    public void testOneWay() throws Exception {
        Listener listener = this.harness.getSpy("bar");
        assertNotNull(listener);

        LatchCountDownAndCallRealMethodAnswer answer = this.harness.getLatchAnswerFor("bar", 2); (3)
        doAnswer(answer).when(listener).foo(anyString(), anyString()); (4)

        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "bar");
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "baz");

        assertTrue(answer.await(10));
        verify(listener).foo("bar", this.queue2.getName());
        verify(listener).foo("baz", this.queue2.getName());
    }

}
1 将测试用例注入到测试套件中，以便我们可以访问间谍。
2 获取对间谍的引用，以便我们可以验证它是否按预期调用。由于这是一个发送和接收操作，因此无需挂起测试线程，因为它已经在 `RabbitTemplate` 中等待回复而被挂起。
3 在本例中，我们只使用发送操作，因此我们需要一个闩锁来等待对容器线程上的侦听器的异步调用。我们使用其中一个 Answer<?> 实现来帮助实现这一点。重要提示：由于侦听器被间谍的方式，使用 `harness.getLatchAnswerFor()` 获取为间谍正确配置的答案非常重要。
4 配置间谍以调用 `Answer`。

以下示例使用捕获建议

@Configuration
@ComponentScan
@RabbitListenerTest(spy = false, capture = true)
public class Config {

}

@Service
public class Listener {

    private boolean failed;

    @RabbitListener(id="foo", queues="#{queue1.name}")
    public String foo(String foo) {
        return foo.toUpperCase();
    }

    @RabbitListener(id="bar", queues="#{queue2.name}")
    public void foo(@Payload String foo, @Header("amqp_receivedRoutingKey") String rk) {
        if (!failed && foo.equals("ex")) {
            failed = true;
            throw new RuntimeException(foo);
        }
        failed = false;
    }

}

public class MyTests {

    @Autowired
    private RabbitListenerTestHarness harness; (1)

    @Test
    public void testTwoWay() throws Exception {
        assertEquals("FOO", this.rabbitTemplate.convertSendAndReceive(this.queue1.getName(), "foo"));

        InvocationData invocationData =
            this.harness.getNextInvocationDataFor("foo", 0, TimeUnit.SECONDS); (2)
        assertThat(invocationData.getArguments()[0], equalTo("foo"));     (3)
        assertThat((String) invocationData.getResult(), equalTo("FOO"));
    }

    @Test
    public void testOneWay() throws Exception {
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "bar");
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "baz");
        this.rabbitTemplate.convertAndSend(this.queue2.getName(), "ex");

        InvocationData invocationData =
            this.harness.getNextInvocationDataFor("bar", 10, TimeUnit.SECONDS); (4)
        Object[] args = invocationData.getArguments();
        assertThat((String) args[0], equalTo("bar"));
        assertThat((String) args[1], equalTo(queue2.getName()));

        invocationData = this.harness.getNextInvocationDataFor("bar", 10, TimeUnit.SECONDS);
        args = invocationData.getArguments();
        assertThat((String) args[0], equalTo("baz"));

        invocationData = this.harness.getNextInvocationDataFor("bar", 10, TimeUnit.SECONDS);
        args = invocationData.getArguments();
        assertThat((String) args[0], equalTo("ex"));
        assertEquals("ex", invocationData.getThrowable().getMessage()); (5)
    }

}
1 将测试用例注入到测试套件中，以便我们可以访问间谍。
2 使用 `harness.getNextInvocationDataFor()` 检索调用数据 - 在这种情况下，由于它是一个请求/回复场景，因此无需等待任何时间，因为测试线程已在 `RabbitTemplate` 中等待结果而被挂起。
3 然后，我们可以验证参数和结果是否符合预期。
4 这次我们需要一些时间来等待数据，因为它是在容器线程上的异步操作，我们需要挂起测试线程。
5 当侦听器抛出异常时，它在调用数据的 `throwable` 属性中可用。
当使用自定义 `Answer<?>` 与测试套件一起使用时，为了正常运行，此类答案应子类化 `ForwardsInvocation` 并从测试套件（`getDelegate("myListener")`）获取实际侦听器（而不是间谍），并调用 `super.answer(invocation)`。有关示例，请参阅提供的 Mockito `Answer<?>` 实现 源代码。

使用 `TestRabbitTemplate`

提供 `TestRabbitTemplate` 用于执行一些基本的集成测试，而无需代理。当您将其作为 `@Bean` 添加到测试用例中时，它会发现上下文中的所有侦听器容器，无论它们是作为 `@Bean` 或 `<bean/>` 声明的，还是使用 `@RabbitListener` 注释声明的。它目前仅支持按队列名称进行路由。模板从容器中提取消息侦听器，并在测试线程上直接调用它。请求-回复消息传递（`sendAndReceive` 方法）支持返回回复的侦听器。

以下测试用例使用模板

@RunWith(SpringRunner.class)
public class TestRabbitTemplateTests {

    @Autowired
    private TestRabbitTemplate template;

    @Autowired
    private Config config;

    @Test
    public void testSimpleSends() {
        this.template.convertAndSend("foo", "hello1");
        assertThat(this.config.fooIn, equalTo("foo:hello1"));
        this.template.convertAndSend("bar", "hello2");
        assertThat(this.config.barIn, equalTo("bar:hello2"));
        assertThat(this.config.smlc1In, equalTo("smlc1:"));
        this.template.convertAndSend("foo", "hello3");
        assertThat(this.config.fooIn, equalTo("foo:hello1"));
        this.template.convertAndSend("bar", "hello4");
        assertThat(this.config.barIn, equalTo("bar:hello2"));
        assertThat(this.config.smlc1In, equalTo("smlc1:hello3hello4"));

        this.template.setBroadcast(true);
        this.template.convertAndSend("foo", "hello5");
        assertThat(this.config.fooIn, equalTo("foo:hello1foo:hello5"));
        this.template.convertAndSend("bar", "hello6");
        assertThat(this.config.barIn, equalTo("bar:hello2bar:hello6"));
        assertThat(this.config.smlc1In, equalTo("smlc1:hello3hello4hello5hello6"));
    }

    @Test
    public void testSendAndReceive() {
        assertThat(this.template.convertSendAndReceive("baz", "hello"), equalTo("baz:hello"));
    }
    @Configuration
    @EnableRabbit
    public static class Config {

        public String fooIn = "";

        public String barIn = "";

        public String smlc1In = "smlc1:";

        @Bean
        public TestRabbitTemplate template() throws IOException {
            return new TestRabbitTemplate(connectionFactory());
        }

        @Bean
        public ConnectionFactory connectionFactory() throws IOException {
            ConnectionFactory factory = mock(ConnectionFactory.class);
            Connection connection = mock(Connection.class);
            Channel channel = mock(Channel.class);
            willReturn(connection).given(factory).createConnection();
            willReturn(channel).given(connection).createChannel(anyBoolean());
            given(channel.isOpen()).willReturn(true);
            return factory;
        }

        @Bean
        public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory() throws IOException {
            SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
            factory.setConnectionFactory(connectionFactory());
            return factory;
        }

        @RabbitListener(queues = "foo")
        public void foo(String in) {
            this.fooIn += "foo:" + in;
        }

        @RabbitListener(queues = "bar")
        public void bar(String in) {
            this.barIn += "bar:" + in;
        }

        @RabbitListener(queues = "baz")
        public String baz(String in) {
            return "baz:" + in;
        }

        @Bean
        public SimpleMessageListenerContainer smlc1() throws IOException {
            SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(connectionFactory());
            container.setQueueNames("foo", "bar");
            container.setMessageListener(new MessageListenerAdapter(new Object() {

                public void handleMessage(String in) {
                    smlc1In += in;
                }

            }));
            return container;
        }

    }

}

JUnit4 `@Rules`

Spring AMQP 1.7 及更高版本提供了一个名为 spring-rabbit-junit 的额外 jar 包。该 jar 包包含一些用于运行 JUnit4 测试的实用程序 @Rule 实例。有关 JUnit5 测试，请参阅 JUnit5 条件。

使用 BrokerRunning

BrokerRunning 提供了一种机制，允许测试在代理未运行时（默认情况下在 localhost 上）成功。

它还具有用于初始化和清空队列以及删除队列和交换机的实用程序方法。

以下示例展示了它的用法

@ClassRule
public static BrokerRunning brokerRunning = BrokerRunning.isRunningWithEmptyQueues("foo", "bar");

@AfterClass
public static void tearDown() {
    brokerRunning.removeTestQueues("some.other.queue.too") // removes foo, bar as well
}

有几个 isRunning…​ 静态方法，例如 isBrokerAndManagementRunning()，它验证代理是否启用了管理插件。

配置规则

有时您希望测试在没有代理的情况下失败，例如夜间 CI 构建。要禁用运行时的规则，请将名为 RABBITMQ_SERVER_REQUIRED 的环境变量设置为 true。

您可以使用 setter 或环境变量覆盖代理属性，例如主机名

以下示例展示了如何使用 setter 覆盖属性

@ClassRule
public static BrokerRunning brokerRunning = BrokerRunning.isRunningWithEmptyQueues("foo", "bar");

static {
    brokerRunning.setHostName("10.0.0.1")
}

@AfterClass
public static void tearDown() {
    brokerRunning.removeTestQueues("some.other.queue.too") // removes foo, bar as well
}

您也可以通过设置以下环境变量来覆盖属性

public static final String BROKER_ADMIN_URI = "RABBITMQ_TEST_ADMIN_URI";
public static final String BROKER_HOSTNAME = "RABBITMQ_TEST_HOSTNAME";
public static final String BROKER_PORT = "RABBITMQ_TEST_PORT";
public static final String BROKER_USER = "RABBITMQ_TEST_USER";
public static final String BROKER_PW = "RABBITMQ_TEST_PASSWORD";
public static final String BROKER_ADMIN_USER = "RABBITMQ_TEST_ADMIN_USER";
public static final String BROKER_ADMIN_PW = "RABBITMQ_TEST_ADMIN_PASSWORD";

这些环境变量会覆盖默认设置（localhost:5672 用于 amqp，localhost:15672/api/ 用于管理 REST API）。

更改主机名会影响 amqp 和 management REST API 连接（除非显式设置了管理 URI）。

BrokerRunning 还提供了一个名为 setEnvironmentVariableOverrides 的 static 方法，允许您传入包含这些变量的映射。它们会覆盖系统环境变量。如果您希望在多个测试套件中使用不同的配置，这可能很有用。重要提示：必须在调用创建规则实例的任何 isRunning() 静态方法之前调用该方法。变量值将应用于此调用后创建的所有实例。调用 clearEnvironmentVariableOverrides() 将规则重置为使用默认值（包括任何实际环境变量）。

在您的测试用例中，您可以在创建连接工厂时使用 brokerRunning；getConnectionFactory() 返回规则的 RabbitMQ ConnectionFactory。以下示例展示了如何操作

@Bean
public CachingConnectionFactory rabbitConnectionFactory() {
    return new CachingConnectionFactory(brokerRunning.getConnectionFactory());
}

使用 LongRunningIntegrationTest

LongRunningIntegrationTest 是一条禁用长时间运行测试的规则。您可能希望在开发系统上使用它，但请确保在例如夜间 CI 构建中禁用该规则。

以下示例展示了它的用法

@Rule
public LongRunningIntegrationTest longTests = new LongRunningIntegrationTest();

要禁用运行时的规则，请将名为 RUN_LONG_INTEGRATION_TESTS 的环境变量设置为 true。

JUnit5 条件

版本 2.0.2 引入了对 JUnit5 的支持。

使用 @RabbitAvailable 注解

此类级别注释类似于JUnit4 @Rules中讨论的BrokerRunning @Rule。它由RabbitAvailableCondition处理。

该注释具有三个属性

  • queues：在每个测试之前声明（并清除）的队列数组，并在所有测试完成后删除。

  • management：如果您的测试还需要在代理上安装管理插件，请将其设置为true。

  • purgeAfterEach：（从版本 2.2 开始）当为true（默认值）时，queues将在测试之间被清除。

它用于检查代理是否可用，如果不可用则跳过测试。如配置规则中所述，如果环境变量RABBITMQ_SERVER_REQUIRED为true，则如果不存在代理，测试将快速失败。您可以使用环境变量配置条件，如配置规则中所述。

此外，RabbitAvailableCondition支持参数化测试构造函数和方法的参数解析。支持两种参数类型

  • BrokerRunningSupport：实例（在 2.2 之前，这是一个 JUnit 4 BrokerRunning 实例）

  • ConnectionFactory：BrokerRunningSupport 实例的 RabbitMQ 连接工厂

以下示例展示了这两种情况

@RabbitAvailable(queues = "rabbitAvailableTests.queue")
public class RabbitAvailableCTORInjectionTests {

    private final ConnectionFactory connectionFactory;

    public RabbitAvailableCTORInjectionTests(BrokerRunningSupport brokerRunning) {
        this.connectionFactory = brokerRunning.getConnectionFactory();
    }

    @Test
    public void test(ConnectionFactory cf) throws Exception {
        assertSame(cf, this.connectionFactory);
        Connection conn = this.connectionFactory.newConnection();
        Channel channel = conn.createChannel();
        DeclareOk declareOk = channel.queueDeclarePassive("rabbitAvailableTests.queue");
        assertEquals(0, declareOk.getConsumerCount());
        channel.close();
        conn.close();
    }

}

前面的测试在框架本身中，并验证了参数注入以及条件是否正确创建了队列。

一个实际的用户测试可能是这样的

@RabbitAvailable(queues = "rabbitAvailableTests.queue")
public class RabbitAvailableCTORInjectionTests {

    private final CachingConnectionFactory connectionFactory;

    public RabbitAvailableCTORInjectionTests(BrokerRunningSupport brokerRunning) {
        this.connectionFactory =
            new CachingConnectionFactory(brokerRunning.getConnectionFactory());
    }

    @Test
    public void test() throws Exception {
        RabbitTemplate template = new RabbitTemplate(this.connectionFactory);
        ...
    }
}

当您在测试类中使用 Spring 注释应用程序上下文时，您可以通过名为RabbitAvailableCondition.getBrokerRunning()的静态方法获取对条件连接工厂的引用。

从版本 2.2 开始，getBrokerRunning() 返回一个BrokerRunningSupport 对象；以前，返回的是 JUnit 4 BrokerRunnning 实例。新类具有与BrokerRunning相同的 API。

以下测试来自框架，演示了用法

@RabbitAvailable(queues = {
        RabbitTemplateMPPIntegrationTests.QUEUE,
        RabbitTemplateMPPIntegrationTests.REPLIES })
@SpringJUnitConfig
@DirtiesContext(classMode = ClassMode.AFTER_EACH_TEST_METHOD)
public class RabbitTemplateMPPIntegrationTests {

    public static final String QUEUE = "mpp.tests";

    public static final String REPLIES = "mpp.tests.replies";

    @Autowired
    private RabbitTemplate template;

    @Autowired
    private Config config;

    @Test
    public void test() {

        ...

    }

    @Configuration
    @EnableRabbit
    public static class Config {

        @Bean
        public CachingConnectionFactory cf() {
            return new CachingConnectionFactory(RabbitAvailableCondition
                    .getBrokerRunning()
                    .getConnectionFactory());
        }

        @Bean
        public RabbitTemplate template() {

            ...

        }

        @Bean
        public SimpleRabbitListenerContainerFactory
                            rabbitListenerContainerFactory() {

            ...

        }

        @RabbitListener(queues = QUEUE)
        public byte[] foo(byte[] in) {
            return in;
        }

    }

}

使用@LongRunning 注释

类似于LongRunningIntegrationTest JUnit4 @Rule，此注释会导致测试被跳过，除非环境变量（或系统属性）设置为true。以下示例展示了如何使用它

@RabbitAvailable(queues = SimpleMessageListenerContainerLongTests.QUEUE)
@LongRunning
public class SimpleMessageListenerContainerLongTests {

    public static final String QUEUE = "SimpleMessageListenerContainerLongTests.queue";

...

}

默认情况下，变量为RUN_LONG_INTEGRATION_TESTS，但您可以在注释的value属性中指定变量名。