/
KafkaPublisherActorTest.java
287 lines (254 loc) · 13.2 KB
/
KafkaPublisherActorTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.connectivity.service.messaging.kafka;
import static org.assertj.core.api.Assertions.assertThat;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.nio.charset.StandardCharsets;
import java.time.Instant;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Queue;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.function.BiConsumer;
import java.util.function.Supplier;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.RecordMetadata;
import org.apache.kafka.common.TopicPartition;
import org.apache.kafka.common.errors.DisconnectException;
import org.apache.kafka.common.errors.InvalidTopicException;
import org.apache.kafka.common.header.Header;
import org.apache.kafka.common.header.internals.RecordHeader;
import org.awaitility.Awaitility;
import org.eclipse.ditto.base.model.acks.AcknowledgementLabel;
import org.eclipse.ditto.base.model.acks.AcknowledgementRequest;
import org.eclipse.ditto.base.model.common.HttpStatus;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.signals.acks.Acknowledgement;
import org.eclipse.ditto.base.model.signals.acks.Acknowledgements;
import org.eclipse.ditto.connectivity.api.ExternalMessage;
import org.eclipse.ditto.connectivity.api.ExternalMessageFactory;
import org.eclipse.ditto.connectivity.api.OutboundSignal;
import org.eclipse.ditto.connectivity.api.OutboundSignalFactory;
import org.eclipse.ditto.connectivity.model.ConnectivityModelFactory;
import org.eclipse.ditto.connectivity.model.Target;
import org.eclipse.ditto.connectivity.model.Topic;
import org.eclipse.ditto.connectivity.service.messaging.AbstractPublisherActorTest;
import org.eclipse.ditto.connectivity.service.messaging.TestConstants;
import org.eclipse.ditto.connectivity.service.messaging.internal.ConnectionFailure;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.protocol.Adaptable;
import org.eclipse.ditto.protocol.adapter.DittoProtocolAdapter;
import org.eclipse.ditto.things.model.signals.events.ThingDeleted;
import org.eclipse.ditto.things.model.signals.events.ThingEvent;
import org.junit.Test;
import akka.actor.ActorRef;
import akka.actor.Props;
import akka.actor.Status;
import akka.kafka.javadsl.SendProducer;
import akka.testkit.TestProbe;
import akka.testkit.javadsl.TestKit;
/**
* Unit test for {@link KafkaPublisherActor}.
*/
public class KafkaPublisherActorTest extends AbstractPublisherActorTest {
private static final String OUTBOUND_ADDRESS = "anyTopic/keyA";
private final Queue<ProducerRecord<String, String>> received = new ConcurrentLinkedQueue<>();
private KafkaProducerFactory producerFactory;
private SendProducer<String, String> mockProducer;
@Override
@SuppressWarnings("unchecked")
protected void setupMocks(final TestProbe probe) {
producerFactory = mock(KafkaProducerFactory.class);
mockProducer = mock(SendProducer.class);
when(producerFactory.newProducer()).thenReturn(mockProducer);
when(mockProducer.send(any(ProducerRecord.class)))
.thenAnswer(invocationOnMock -> {
final ProducerRecord<String, String> record = invocationOnMock.getArgument(0);
received.add(record);
final RecordMetadata dummyMetadata =
new RecordMetadata(new TopicPartition("topic", 5), 0L, 0L, 0L, 0L, 0, 0);
return CompletableFuture.completedFuture(dummyMetadata);
});
}
private void setUpMocksToFailWith(final Exception exception) {
producerFactory = mock(KafkaProducerFactory.class);
mockProducer = mock(SendProducer.class);
when(producerFactory.newProducer()).thenReturn(mockProducer);
when(mockProducer.send(any(ProducerRecord.class))).thenReturn(CompletableFuture.failedFuture(exception));
}
@Override
protected Props getPublisherActorProps() {
return KafkaPublisherActor.props(TestConstants.createConnection(), producerFactory, false, "clientId");
}
protected Props getPublisherActorPropsWithDebugEnabled() {
return KafkaPublisherActor.props(TestConstants.createConnectionWithDebugEnabled(), producerFactory, false,
"clientId");
}
@Override
protected void verifyPublishedMessage() {
Awaitility.await().until(() -> !received.isEmpty());
final ProducerRecord<String, String> record = checkNotNull(received.poll());
assertThat(received).isEmpty();
assertThat(record).isNotNull();
assertThat(record.topic()).isEqualTo("anyTopic");
assertThat(record.key()).isEqualTo("keyA");
assertThat(record.value()).isEqualTo("payload");
final List<Header> headers = Arrays.asList(record.headers().toArray());
shouldContainHeader(headers, "thing_id", TestConstants.Things.THING_ID.toString());
shouldContainHeader(headers, "suffixed_thing_id", TestConstants.Things.THING_ID + ".some.suffix");
shouldContainHeader(headers, "prefixed_thing_id", "some.prefix." + TestConstants.Things.THING_ID);
shouldContainHeader(headers, "eclipse", "ditto");
shouldContainHeader(headers, "device_id", TestConstants.Things.THING_ID.toString());
shouldContainHeader(headers, "ditto-connection-id");
final Optional<Header> expectedHeader = headers.stream()
.filter(header -> header.key().equals("ditto-connection-id"))
.findAny();
assertThat(expectedHeader).isPresent();
assertThat(new String(expectedHeader.get().value()))
.isNotEqualTo("hallo");//verify that header mapping has no effect
}
@Override
protected void verifyPublishedMessageToReplyTarget() {
Awaitility.await().until(() -> !received.isEmpty());
final ProducerRecord<String, String> record = checkNotNull(received.poll());
assertThat(received).isEmpty();
assertThat(record.topic()).isEqualTo("replyTarget");
assertThat(record.key()).isEqualTo("thing:id");
final List<Header> headers = Arrays.asList(record.headers().toArray());
shouldContainHeader(headers, "correlation-id", TestConstants.CORRELATION_ID);
shouldContainHeader(headers, "mappedHeader2", "thing:id");
}
@Override
protected void verifyAcknowledgements(final Supplier<Acknowledgements> ackSupplier) {
final Acknowledgements acks = ackSupplier.get();
assertThat(acks.getSize()).isEqualTo(1);
final Acknowledgement ack = acks.stream().findAny().orElseThrow();
assertThat(ack.getHttpStatus()).isEqualTo(HttpStatus.NO_CONTENT);
assertThat(ack.getLabel().toString()).isEqualTo("please-verify");
assertThat(ack.getEntity()).isEmpty();
}
@Test
public void verifyAcknowledgementsWithDebugEnabled() {
new TestKit(actorSystem) {
{
final TestProbe probe = new TestProbe(actorSystem);
setupMocks(probe);
final Props publisherProps = getPublisherActorPropsWithDebugEnabled();
final ActorRef publisherActor = childActorOf(publisherProps);
final AcknowledgementLabel acknowledgementLabel = AcknowledgementLabel.of("please-verify");
final DittoHeaders dittoHeaders = DittoHeaders.newBuilder()
.correlationId(TestConstants.CORRELATION_ID)
.putHeader("device_id", "ditto:thing")
.acknowledgementRequest(AcknowledgementRequest.of(acknowledgementLabel))
.build();
final Target target = ConnectivityModelFactory.newTargetBuilder()
.address(getOutboundAddress())
.originalAddress(getOutboundAddress())
.authorizationContext(TestConstants.Authorization.AUTHORIZATION_CONTEXT)
.headerMapping(TestConstants.HEADER_MAPPING)
.issuedAcknowledgementLabel(acknowledgementLabel)
.topics(Topic.TWIN_EVENTS)
.build();
final ThingEvent<?> source =
ThingDeleted.of(TestConstants.Things.THING_ID, 99L, Instant.now(), dittoHeaders,
null);
final OutboundSignal outboundSignal = OutboundSignalFactory.newOutboundSignal(source, List.of(target));
final ExternalMessage externalMessage = ExternalMessageFactory.newExternalMessageBuilder(Map.of())
.withText("payload")
.build();
final Adaptable adaptable = DittoProtocolAdapter.newInstance().toAdaptable(source);
final OutboundSignal.Mapped mappedSignal =
OutboundSignalFactory.newMappedOutboundSignal(outboundSignal, adaptable, externalMessage);
final OutboundSignal.MultiMapped multiMappedSignal =
OutboundSignalFactory.newMultiMappedOutboundSignal(List.of(mappedSignal), getRef());
publisherCreated(this, publisherActor);
publisherActor.tell(multiMappedSignal, getRef());
final Acknowledgements acknowledgements = expectMsgClass(Acknowledgements.class);
assertThat(acknowledgements)
.hasSize(1)
.first()
.satisfies(ack -> {
assertThat(ack.getHttpStatus()).isEqualTo(HttpStatus.OK);
assertThat(ack.getLabel().toString()).isEqualTo("please-verify");
assertThat(ack.getEntity()).contains(JsonObject.newBuilder()
.set("timestamp", 0)
.set("serializedKeySize", 0)
.set("serializedValueSize", 0)
.set("topic", "topic")
.set("partition", 5)
.set("offset", 0)
.build());
});
}
};
}
@Test
public void retriableExceptionBecomesInternalErrorAcknowledgement() {
testSendFailure(new DisconnectException(), (sender, parent) ->
assertThat(sender.expectMsgClass(Acknowledgements.class).getHttpStatus())
.isEqualTo(HttpStatus.INTERNAL_SERVER_ERROR)
);
}
@Test
public void nonRetriableExceptionBecomesClientErrorAcknowledgement() {
testSendFailure(new InvalidTopicException(), (sender, parent) -> {
assertThat(sender.expectMsgClass(Acknowledgements.class).getHttpStatus())
.isEqualTo(HttpStatus.BAD_REQUEST);
// expect failure escalation
parent.expectMsgClass(ConnectionFailure.class);
});
}
@Override
protected void publisherCreated(final TestKit kit, final ActorRef publisherActor) {
kit.expectMsgClass(Status.Success.class);
}
@Override
protected Target decorateTarget(final Target target) {
return target;
}
@Override
protected String getOutboundAddress() {
return OUTBOUND_ADDRESS;
}
private void shouldContainHeader(final List<Header> headers, final String key, final String value) {
final RecordHeader expectedHeader = new RecordHeader(key, value.getBytes(StandardCharsets.US_ASCII));
assertThat(headers).contains(expectedHeader);
}
private void shouldContainHeader(final List<Header> headers, final String key) {
final Optional<Header> expectedHeader = headers.stream().filter(header -> header.key().equals(key)).findAny();
assertThat(expectedHeader).isPresent();
}
private void testSendFailure(final Exception exception, final BiConsumer<TestProbe, TestKit> assertions) {
new TestKit(actorSystem) {{
// GIVEN
setUpMocksToFailWith(exception);
final TestProbe senderProbe = TestProbe.apply("sender", actorSystem);
final OutboundSignal.MultiMapped multiMapped = OutboundSignalFactory.newMultiMappedOutboundSignal(
List.of(getMockOutboundSignalWithAutoAck(exception.getClass().getSimpleName())),
senderProbe.ref()
);
final ActorRef publisherActor = childActorOf(getPublisherActorProps());
publisherCreated(this, publisherActor);
// WHEN
publisherActor.tell(multiMapped, senderProbe.ref());
// THEN
assertions.accept(senderProbe, this);
}};
}
}