测试支持

编写异步应用程序的集成测试比测试更简单的应用程序必然更复杂。当出现诸如 `@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` 关联的 Bean（以支持 `@RabbitListener`）。

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`，它返回 `null` 并对锁进行倒计时。以下示例显示了如何使用 `LatchCountDownAndCallRealMethodAnswer`

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

...

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

第二个，`LambdaAnswer`，提供了一种机制来选择性地调用实际方法，并提供了一个机会根据 `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 注解，会使框架用名为RabbitListenerTestHarness 的子类替换标准的RabbitListenerAnnotationBeanPostProcessor（它还会通过@EnableRabbit启用@RabbitListener 检测）。

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

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

考虑一些示例。

以下示例使用 spy

@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 将 harness 注入测试用例中，以便我们可以访问 spy。
2 获取对 spy 的引用，以便我们可以验证它是否按预期被调用。由于这是一个发送和接收操作，因此无需挂起测试线程，因为它已经在RabbitTemplate中等待回复而被挂起了。
3 在这种情况下，我们只使用发送操作，因此我们需要一个 latch 来等待容器线程上对侦听器的异步调用。我们使用 Answer<?> 实现之一来帮助实现这一点。重要：由于侦听器被监视的方式，使用harness.getLatchAnswerFor() 获取为 spy 正确配置的答案非常重要。
4 配置 spy 以调用Answer。

以下示例使用捕获 advice

@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 将 harness 注入测试用例中，以便我们可以访问 spy。
2 使用harness.getNextInvocationDataFor()检索调用数据 - 在这种情况下，由于它是一个请求/回复场景，因此无需等待任何时间，因为测试线程已在RabbitTemplate中等待结果而被挂起。
3 然后，我们可以验证参数和结果是否符合预期。
4 这次我们需要一些时间来等待数据，因为它是在容器线程上的异步操作，我们需要挂起测试线程。
5 当侦听器抛出异常时，它可以在调用数据的throwable属性中找到。
当使用带有 harness 的自定义Answer<?>时，为了正常运行，此类答案应该继承ForwardsInvocation 并从 harness 获取实际的侦听器（而不是 spy）（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 包包含一些实用程序@Rule 实例，可在运行 JUnit4 测试时使用。有关 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";

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

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

BrokerRunning 还提供了一个名为setEnvironmentVariableOverrides的静态方法，您可以传入包含这些变量的映射。它们会覆盖系统环境变量。如果您希望在多个测试套件中使用不同的配置，这可能很有用。重要：必须在调用创建规则实例的任何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属性中指定变量名。