Spring/spring-pulsar
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Close created client in PulsarConsumerTestUtil (#618)

Browse Source
This commit is contained in:
Chris Bono
2024-03-18 13:37:40 -05:00
committed by GitHub
parent 9bc6bda306
commit 952c8bab53
2 changed files with 62 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
spring-pulsar-test/src/main/java/org/springframework/pulsar/test/support/PulsarConsumerTestUtil.java
View File

@@ -29,6 +29,8 @@ import org.apache.pulsar.client.api.PulsarClientException;
import org.apache.pulsar.client.api.Schema;
import org.apache.pulsar.client.api.SubscriptionInitialPosition;
import org.springframework.core.log.LogAccessor;
import org.springframework.lang.Nullable;
import org.springframework.pulsar.PulsarException;
import org.springframework.pulsar.core.DefaultPulsarConsumerFactory;
import org.springframework.pulsar.core.PulsarConsumerFactory;
@@ -47,6 +49,10 @@ import org.springframework.util.Assert;
*/
public final class PulsarConsumerTestUtil<T> implements TopicSpec<T>, SchemaSpec<T>, ConditionsSpec<T> {
private static final LogAccessor LOG = new LogAccessor(PulsarConsumerTestUtil.class);
private final PulsarClient locallyCreatedPulsarClient;
private final PulsarConsumerFactory<T> consumerFactory;
private ConsumedMessagesCondition<T> condition;
@@ -82,7 +88,9 @@ public final class PulsarConsumerTestUtil<T> implements TopicSpec<T>, SchemaSpec
public static <T> TopicSpec<T> consumeMessages(String url) {
Assert.notNull(url, "url must not be null");
try {
return PulsarConsumerTestUtil.consumeMessages(PulsarClient.builder().serviceUrl(url).build());
var pulsarClient = PulsarClient.builder().serviceUrl(url).build();
return PulsarConsumerTestUtil.consumeMessagesInternal(pulsarClient,
new DefaultPulsarConsumerFactory<>(pulsarClient, List.of()));
}
catch (PulsarClientException ex) {
throw new PulsarException(ex);
@@ -97,7 +105,8 @@ public final class PulsarConsumerTestUtil<T> implements TopicSpec<T>, SchemaSpec
*/
public static <T> TopicSpec<T> consumeMessages(PulsarClient pulsarClient) {
Assert.notNull(pulsarClient, "pulsarClient must not be null");
return PulsarConsumerTestUtil.consumeMessages(new DefaultPulsarConsumerFactory<>(pulsarClient, List.of()));
return PulsarConsumerTestUtil.consumeMessagesInternal(null,
new DefaultPulsarConsumerFactory<>(pulsarClient, List.of()));
}
/**
@@ -107,12 +116,19 @@ public final class PulsarConsumerTestUtil<T> implements TopicSpec<T>, SchemaSpec
* @return the {@link TopicSpec topic step} of the builder
*/
public static <T> TopicSpec<T> consumeMessages(PulsarConsumerFactory<T> pulsarConsumerFactory) {
return new PulsarConsumerTestUtil<>(pulsarConsumerFactory);
return PulsarConsumerTestUtil.consumeMessagesInternal(null, pulsarConsumerFactory);
}
private PulsarConsumerTestUtil(PulsarConsumerFactory<T> consumerFactory) {
private static <T> TopicSpec<T> consumeMessagesInternal(PulsarClient locallyCreatedPulsarClient,
PulsarConsumerFactory<T> pulsarConsumerFactory) {
return new PulsarConsumerTestUtil<>(locallyCreatedPulsarClient, pulsarConsumerFactory);
}
private PulsarConsumerTestUtil(@Nullable PulsarClient locallyCreatedPulsarClient,
PulsarConsumerFactory<T> consumerFactory) {
Assert.notNull(consumerFactory, "PulsarConsumerFactory must not be null");
this.consumerFactory = consumerFactory;
this.locallyCreatedPulsarClient = locallyCreatedPulsarClient;
}
@Override
@@ -173,6 +189,16 @@ public final class PulsarConsumerTestUtil<T> implements TopicSpec<T>, SchemaSpec
catch (PulsarClientException ex) {
throw new PulsarException(ex);
}
finally {
if (this.locallyCreatedPulsarClient != null && !this.locallyCreatedPulsarClient.isClosed()) {
try {
this.locallyCreatedPulsarClient.close();
}
catch (PulsarClientException e) {
LOG.error(e, () -> "Failed to close locally created Pulsar client due to: " + e.getMessage());
}
}
}
if (this.condition != null && !this.condition.meets(messages)) {
throw new ConditionTimeoutException(
"Condition was not met within %d seconds".formatted(timeout.toSeconds()));

48
spring-pulsar-test/src/test/java/org/springframework/pulsar/test/support/PulsarConsumerTestUtilTests.java
View File

@@ -29,6 +29,7 @@ import org.apache.pulsar.client.api.Message;
import org.apache.pulsar.client.api.PulsarClient;
import org.apache.pulsar.client.api.PulsarClientException;
import org.apache.pulsar.client.api.Schema;
import org.assertj.core.api.InstanceOfAssertFactories;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
@@ -78,13 +79,13 @@ class PulsarConsumerTestUtilTests implements PulsarTestContainerSupport {
void whenConditionIsSpecifiedThenMessagesConsumedUntilConditionMet() {
var topic = testTopic("cond");
IntStream.range(0, 5).forEach(i -> pulsarTemplate.send(topic, "message-" + i));
var msgs = PulsarConsumerTestUtil.consumeMessages(pulsarConsumerFactory)
var consumerTestUtil = PulsarConsumerTestUtil.consumeMessages(pulsarConsumerFactory)
.fromTopic(topic)
.withSchema(Schema.STRING)
.awaitAtMost(Duration.ofSeconds(5))
.until(desiredMessageCount(3))
.get();
assertThat(msgs).hasSize(3);
.until(desiredMessageCount(3));
assertThat(consumerTestUtil.get()).hasSize(3);
assertThatLocallyCreatedClientIsNull(consumerTestUtil);
}
@Test
@@ -132,17 +133,18 @@ class PulsarConsumerTestUtilTests implements PulsarTestContainerSupport {
void consumeMessagesWithNoArgsUsesPulsarContainerIfAvailable() {
var topic = testTopic("no-arg");
IntStream.range(0, 2).forEach(i -> pulsarTemplate.send(topic, "message-" + i));
var msgs = PulsarConsumerTestUtil.<String>consumeMessages()
var consumerTestUtil = PulsarConsumerTestUtil.<String>consumeMessages()
.fromTopic(topic)
.withSchema(Schema.STRING)
.awaitAtMost(Duration.ofSeconds(5))
.until(desiredMessageCount(2))
.get();
assertThat(msgs).hasSize(2);
.until(desiredMessageCount(2));
assertThat(consumerTestUtil.get()).hasSize(2);
assertThatLocallyCreatedClientIsClosed(consumerTestUtil);
}
@Test
void consumeMessagesWithNoArgsUsesDefaultUrlWhenPulsarContainerNotAvailable() {
// @formatter::off
try (MockedStatic<PulsarTestContainerSupport> containerSupport = Mockito
.mockStatic(PulsarTestContainerSupport.class)) {
containerSupport.when(PulsarTestContainerSupport::isContainerStarted).thenReturn(false);
@@ -155,32 +157,46 @@ class PulsarConsumerTestUtilTests implements PulsarTestContainerSupport {
.get())
.withStackTraceContaining("Connection refused: localhost");
}
// @formatter:on
}
@Test
void consumeMessagesWithBrokerUrl() {
var topic = testTopic("url-arg");
IntStream.range(0, 2).forEach(i -> pulsarTemplate.send(topic, "message-" + i));
var msgs = PulsarConsumerTestUtil.<String>consumeMessages(PulsarTestContainerSupport.getPulsarBrokerUrl())
var consumerTestUtil = PulsarConsumerTestUtil
.<String>consumeMessages(PulsarTestContainerSupport.getPulsarBrokerUrl())
.fromTopic(topic)
.withSchema(Schema.STRING)
.awaitAtMost(Duration.ofSeconds(5))
.until(desiredMessageCount(2))
.get();
assertThat(msgs).hasSize(2);
.until(desiredMessageCount(2));
assertThat(consumerTestUtil.get()).hasSize(2);
assertThatLocallyCreatedClientIsClosed(consumerTestUtil);
}
@Test
void consumeMessagesWithPulsarClient() {
var topic = testTopic("client-arg");
IntStream.range(0, 2).forEach(i -> pulsarTemplate.send(topic, "message-" + i));
var msgs = PulsarConsumerTestUtil.<String>consumeMessages(this.pulsarClient)
var consumerTestUtil = PulsarConsumerTestUtil.<String>consumeMessages(this.pulsarClient)
.fromTopic(topic)
.withSchema(Schema.STRING)
.awaitAtMost(Duration.ofSeconds(5))
.until(desiredMessageCount(2))
.get();
assertThat(msgs).hasSize(2);
.until(desiredMessageCount(2));
assertThat(consumerTestUtil.get()).hasSize(2);
assertThatLocallyCreatedClientIsNull(consumerTestUtil);
}
private void assertThatLocallyCreatedClientIsNull(ConditionsSpec<?> consumerTestUtil) {
assertThat(consumerTestUtil).extracting("locallyCreatedPulsarClient").isNull();
}
private void assertThatLocallyCreatedClientIsClosed(ConditionsSpec<?> consumerTestUtil) {
assertThat(consumerTestUtil).extracting("locallyCreatedPulsarClient")
.isNotNull()
.asInstanceOf(InstanceOfAssertFactories.type(PulsarClient.class))
.extracting(PulsarClient::isClosed)
.isEqualTo(Boolean.TRUE);
}
@Test