单元测试MessageListener类

Question

如何对实现spring-kafka MessageListener接口的类进行单元测试？ 我有一个侦听器类，正在使用onMessage函数手动侦听主题。 此功能非常简单，仅接收消息。

我的设置是使用Spring 5.8，Spring-Kafka 2.2.7，Spring-Kafka-Test，JUnit和WITHOUT spring boot。

我一直在尝试从Spring参考文档和其他文章中获得许多不同的示例，但是似乎没有一个示例显示一种简单的方法来测试实现MessageListener的Listener类。

我不确定是否需要设置EmbeddedKafkaBroker或EmbeddedKafkaRule，或者是否有其他测试方法。 当我尝试使用EmbeddedKafkaRule时，出现错误消息NoClassDefFound。

但是我不明白这个测试用例怎么打我的onMessage函数。

@RunWith(SpringJUnit4ClassRunner.class)
@DirtiesContext
public class listenerTest {

    private String topic = "someTopic";

    @ClassRule
    public static EmbeddedKafkaRule embeddedKafka = new EmbeddedKafkaRule(1, true, topic);

    private CountDownLatch countDownLatch;

    @Before
    public void setUpTests (){
        Map<String, Object> sProps = KafkaTestUtils.senderProps(embeddedKafka.getEmbeddedKafka().getBrokersAsString());

        ProducerFactory producer = new DefaultKafkaProducerFactory<String, String> (sProps);

        kafkaTemplate = new KafkaTemplate<>(producer);

        kafkaTemplate.setDefaultTopic(topic);

        countDownLatch = new CountDownLatch (1);

    }

    @Test
    public void testReceiver(){
         kafkaTemplate.sendDefault("message");
         assertEquals(latch.getCount(), 0);
    }

我要单元测试的课程

public class listener implements BatchAcknowledgingMessageListener<String, String>{

    private CallbackInterface callback;

    public listener(CallbackInterface callback){
        this.callbackI = callback;
    }

    @Override
    public void onMessage(List<ConsumerRecord<String, String>> records, Acknowledgment ack){
         this.callbackI.handleMessage();
         ack.acknowledge();
    }
}

这引发了一个奇怪的错误，说这... NoClassDefFound

Answer 1

对于纯单元测试，您不需要嵌入式代理，您应该直接调用侦听器。

注入模拟回调并验证它是否被正确调用。

当我尝试直接调用onMessage函数进行测试时，我收到一条错误消息，指出Container不应该调用onMessage函数。

您正在调用错误的onMessage ...

public interface BatchMessageListener extends MessageListener {

    @Override
    default void onMessage(Message message) {
        throw new UnsupportedOperationException("Should never be called by the container");
    }

    @Override
    void onMessageBatch(List<Message> messages);

}

编辑

public class MyListener implements BatchAcknowledgingMessageListener<String, String> {

    private final MyService service;

    public MyListener(MyService service) {
        this.service = service;
    }

    @Override
    public void onMessage(List<ConsumerRecord<String, String>> data, Acknowledgment acknowledgment) {
        data.forEach(dat -> this.service.call(dat.value()));
        acknowledgment.acknowledge();
    }

    public interface MyService {

        void call(String toCall);

    }

}

和

class So57192362ApplicationTests {

    @Test
    void test() {
        MyService service = mock(MyService.class);
        MyListener listener = new MyListener(service);
        Acknowledgment acknowledgment = mock(Acknowledgment.class);
        listener.onMessage(Collections.singletonList(new ConsumerRecord<>("foo", 0, 0L, null, "bar")), acknowledgment);
        verify(service).call("bar");
        verify(acknowledgment).acknowledge();
        verifyNoMoreInteractions(service, acknowledgment);
    }

}