Skip to content

Add integration test for @Headers annotation #3844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged

Add integration test for @Headers annotation #3844

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 74 additions & 1 deletion ...kafka/src/test/java/org/springframework/kafka/annotation/EnableKafkaIntegrationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
import org.apache.kafka.common.errors.TopicExistsException;
import org.apache.kafka.common.serialization.ByteArrayDeserializer;
import org.apache.kafka.common.serialization.ByteArraySerializer;
import org.awaitility.Awaitility;
import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -141,6 +142,7 @@
import org.springframework.messaging.converter.AbstractMessageConverter;
import org.springframework.messaging.converter.SmartMessageConverter;
import org.springframework.messaging.handler.annotation.Header;
import org.springframework.messaging.handler.annotation.Headers;
import org.springframework.messaging.handler.annotation.Payload;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.handler.annotation.support.MethodArgumentNotValidException;
Expand Down Expand Up @@ -181,6 +183,7 @@
* @author Soby Chacko
* @author Wang Zhiyang
* @author Borahm Lee
* @author Sean Sullivan
*/
@SpringJUnitConfig
@DirtiesContext
Expand All @@ -196,7 +199,7 @@
"annotated29", "annotated30", "annotated30reply", "annotated31", "annotated32", "annotated33",
"annotated34", "annotated35", "annotated36", "annotated37", "foo", "manualStart", "seekOnIdle",
"annotated38", "annotated38reply", "annotated39", "annotated40", "annotated41", "annotated42",
"annotated43", "annotated43reply", "seekToComputeFn"})
"annotated43", "annotated43reply", "seekToComputeFn", "headerMapTopic"})
@TestPropertySource(properties = "spel.props=fetch.min.bytes=420000,max.poll.records=10")
public class EnableKafkaIntegrationTests {

Expand Down Expand Up @@ -242,6 +245,9 @@ public class EnableKafkaIntegrationTests {
@Autowired
public MultiJsonListenerBean multiJsonListener;

@Autowired
public HeaderMapListenerBean headerMapListener;

@Autowired
public MultiListenerNoDefault multiNoDefault;

Expand Down Expand Up @@ -584,6 +590,50 @@ public void testMultiJson() throws Exception {
assertThat(this.multiJsonListener.validated.valCount).isEqualTo(1);
}

@Test
public void testHeadersAnnotation() throws Exception {
template.setDefaultTopic("headerMapTopic");

template.send(new GenericMessage<>("message1", Collections.emptyMap()));
Awaitility.await().untilAsserted(() -> {
assertThat(this.headerMapListener.invocationCount.get()).isEqualTo(1);
});
assertThat(this.headerMapListener.text).isEqualTo("message1");
assertThat(this.headerMapListener.headers)
.isNotNull()
.containsOnlyKeys(
"kafka_offset",
"kafka_consumer",
"kafka_timestampType",
"kafka_receivedPartitionId",
"kafka_receivedTopic",
"kafka_receivedTimestamp",
"kafka_groupId");

template.send(new GenericMessage<>("message2",
Map.of("akey", "avalue",
"bkey", "bvalue")));
Awaitility.await().untilAsserted(() -> {
assertThat(this.headerMapListener.invocationCount.get()).isEqualTo(2);
});
assertThat(this.headerMapListener.text).isEqualTo("message2");
assertThat(this.headerMapListener.headers)
.isNotNull()
.containsOnlyKeys(
"kafka_offset",
"kafka_consumer",
"kafka_timestampType",
"kafka_receivedPartitionId",
"kafka_receivedTopic",
"kafka_receivedTimestamp",
"kafka_groupId",
"akey",
"bkey")
.contains(
Map.entry("akey", "avalue"),
Map.entry("bkey", "bvalue"));
}

@Test
public void testMultiValidateNoDefaultHandler() throws Exception {
this.kafkaJsonTemplate.setDefaultTopic("annotated40");
Expand Down Expand Up @@ -1545,6 +1595,11 @@ public MultiJsonListenerBean multiJsonListener() {
return new MultiJsonListenerBean();
}

@Bean
public HeaderMapListenerBean headerMapListener() {
return new HeaderMapListenerBean();
}

@Bean
public MultiListenerNoDefault multiNoDefault() {
return new MultiListenerNoDefault();
Expand Down Expand Up @@ -2742,6 +2797,24 @@ public void defaultHandler(Bar bar) {

}

@KafkaListener(id = "headerMap", topics = "headerMapTopic")
static class HeaderMapListenerBean {

final AtomicInteger invocationCount = new AtomicInteger();

private String text;

private Map<String, Object> headers;

@KafkaHandler(isDefault = true)
public void defaultHandler(@Payload String text, @Headers Map<String, Object> headers) {
this.text = text;
this.headers = headers;
this.invocationCount.incrementAndGet();
}

}

@KafkaListener(id = "multiNoDefault", topics = "annotated40", containerFactory = "kafkaJsonListenerContainerFactory2")
static class MultiListenerNoDefault {

Expand Down