-
Notifications
You must be signed in to change notification settings - Fork 215
/
Mqtt3RxSubscribingClientTest.java
305 lines (261 loc) · 15.3 KB
/
Mqtt3RxSubscribingClientTest.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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/*
* Copyright (c) 2022 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.mqtt.hivemq.client;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatNullPointerException;
import java.time.Duration;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.stream.Collectors;
import org.apache.pekko.actor.ActorSystem;
import org.apache.pekko.actor.Status;
import org.apache.pekko.stream.javadsl.Sink;
import org.apache.pekko.stream.javadsl.Source;
import org.assertj.core.api.JUnitSoftAssertions;
import org.eclipse.ditto.base.model.common.ByteBufferUtils;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.publish.GenericMqttPublish;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubAck;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubAckStatus;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubscribe;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubscription;
import org.eclipse.ditto.internal.utils.pekko.ActorSystemResource;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import com.hivemq.client.mqtt.MqttGlobalPublishFilter;
import com.hivemq.client.mqtt.datatypes.MqttQos;
import com.hivemq.client.mqtt.datatypes.MqttTopic;
import com.hivemq.client.mqtt.datatypes.MqttTopicFilter;
import com.hivemq.client.mqtt.exceptions.MqttSessionExpiredException;
import com.hivemq.client.mqtt.mqtt3.Mqtt3AsyncClient;
import com.hivemq.client.mqtt.mqtt3.Mqtt3RxClient;
import com.hivemq.client.mqtt.mqtt3.exceptions.Mqtt3SubAckException;
import com.hivemq.client.mqtt.mqtt3.message.publish.Mqtt3Publish;
import com.hivemq.client.mqtt.mqtt3.message.subscribe.Mqtt3Subscribe;
import com.hivemq.client.mqtt.mqtt3.message.subscribe.Mqtt3Subscription;
import com.hivemq.client.mqtt.mqtt3.message.subscribe.suback.Mqtt3SubAck;
import com.hivemq.client.mqtt.mqtt3.message.subscribe.suback.Mqtt3SubAckReturnCode;
import io.reactivex.Flowable;
import io.reactivex.Single;
/**
* Unit test for {@link BaseGenericMqttSubscribingClient} for MQTT protocol version 3.
*/
@RunWith(MockitoJUnitRunner.class)
public final class Mqtt3RxSubscribingClientTest {
@ClassRule
public static final ActorSystemResource ACTOR_SYSTEM_RESOURCE = ActorSystemResource.newInstance();
private static ActorSystem actorSystem;
@Rule public final JUnitSoftAssertions softly = new JUnitSoftAssertions();
@Mock private Mqtt3RxClient mqtt3RxClient;
@Mock private Mqtt3AsyncClient mqtt3AsyncClient;
@BeforeClass
public static void beforeClass() {
actorSystem = ACTOR_SYSTEM_RESOURCE.getActorSystem();
}
@Before
public void before() {
Mockito.when(mqtt3RxClient.toAsync()).thenReturn(mqtt3AsyncClient);
Mockito.when(mqtt3RxClient.publishes(Mockito.eq(MqttGlobalPublishFilter.ALL), Mockito.eq(true))).thenReturn(Flowable.never());
}
@Test
public void ofMqtt3RxClientWithNullClientThrowsException() {
assertThatNullPointerException()
.isThrownBy(() -> BaseGenericMqttSubscribingClient.ofMqtt3RxClient(null, ClientRole.CONSUMER))
.withMessage("The mqtt3RxClient must not be null!")
.withNoCause();
}
@Test
public void ofMqtt3RxClientWithNullClientRoleThrowsException() {
assertThatNullPointerException()
.isThrownBy(() -> BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, null))
.withMessage("The clientRole must not be null!")
.withNoCause();
}
@Test
public void subscribeWithNullGenericMqttSubscribeThrowsException() {
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
assertThatNullPointerException()
.isThrownBy(() -> underTest.subscribe(null))
.withMessage("The genericMqttSubscribe must not be null!")
.withNoCause();
}
@Test
public void subscribeCallsHiveMqtt3RxClient() {
final var mqtt3SubscribeArgumentCaptor = ArgumentCaptor.forClass(Mqtt3Subscribe.class);
Mockito.when(mqtt3RxClient.subscribe(mqtt3SubscribeArgumentCaptor.capture())).thenReturn(Single.never());
final var topicFiltersAndQos = new LinkedHashMap<MqttTopicFilter, MqttQos>();
topicFiltersAndQos.put(MqttTopicFilter.of("source/foo"), MqttQos.AT_LEAST_ONCE);
topicFiltersAndQos.put(MqttTopicFilter.of("source/bar"), MqttQos.AT_MOST_ONCE);
topicFiltersAndQos.put(MqttTopicFilter.of("source/baz"), MqttQos.EXACTLY_ONCE);
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
underTest.subscribe(
GenericMqttSubscribe.of(topicFiltersAndQos.entrySet()
.stream()
.map(entry -> GenericMqttSubscription.newInstance(entry.getKey(), entry.getValue()))
.collect(Collectors.toCollection(LinkedHashSet::new)))
);
softly.assertThat(mqtt3SubscribeArgumentCaptor.getValue())
.isEqualTo(Mqtt3Subscribe.builder()
.addSubscriptions(topicFiltersAndQos.entrySet()
.stream()
.map(entry -> Mqtt3Subscription.builder()
.topicFilter(entry.getKey())
.qos(entry.getValue())
.build()))
.build());
}
@Test
public void subscribeWhenSubAckHasOnlySuccessReturnCodeSucceeds() {
final var mqtt3SubAck = Mockito.mock(Mqtt3SubAck.class);
Mockito.when(mqtt3SubAck.getReturnCodes()).thenReturn(List.of(Mqtt3SubAckReturnCode.SUCCESS_MAXIMUM_QOS_1));
Mockito.when(mqtt3RxClient.subscribe(Mockito.any())).thenReturn(Single.just(mqtt3SubAck));
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
final var genericMqttSubAckSingle = underTest.subscribe(
GenericMqttSubscribe.of(Set.of(GenericMqttSubscription.newInstance(MqttTopicFilter.of("source/status"),
MqttQos.AT_LEAST_ONCE)))
);
softly.assertThat(subscribeForSingleValueResponse(genericMqttSubAckSingle))
.succeedsWithin(Duration.ofMillis(500L))
.isEqualTo(GenericMqttSubAck.ofMqtt3SubAck(mqtt3SubAck));
}
private static <T> CompletableFuture<T> subscribeForSingleValueResponse(final Single<T> singleValueResponse) {
final var result = new CompletableFuture<T>();
singleValueResponse.subscribe(result::complete, result::completeExceptionally);
return result;
}
@Test
public void subscribeWhenSubAckHasOnlyErrorReturnCodeErrors() {
final var mqtt3SubAck = Mockito.mock(Mqtt3SubAck.class);
final var mqtt3SubAckReturnCode = Mqtt3SubAckReturnCode.FAILURE;
Mockito.when(mqtt3SubAck.getReturnCodes()).thenReturn(List.of(mqtt3SubAckReturnCode));
final var mqtt3SubAckException = new Mqtt3SubAckException(mqtt3SubAck, null, null);
Mockito.when(mqtt3RxClient.subscribe(Mockito.any())).thenReturn(Single.error(mqtt3SubAckException));
final var mqttTopicFilter = MqttTopicFilter.of("source/status");
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
final var genericMqttSubAckSingle = underTest.subscribe(
GenericMqttSubscribe.of(Set.of(GenericMqttSubscription.newInstance(mqttTopicFilter,
MqttQos.AT_LEAST_ONCE)))
);
softly.assertThat(subscribeForSingleValueResponse(genericMqttSubAckSingle))
.failsWithin(Duration.ofMillis(500L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isInstanceOfSatisfying(AllSubscriptionsFailedException.class,
exception -> softly.assertThat(exception.failedSubscriptionStatuses())
.containsOnly(SubscriptionStatus.newInstance(
mqttTopicFilter,
GenericMqttSubAckStatus.ofMqtt3SubAckReturnCode(mqtt3SubAckReturnCode)
)))
.withCause(mqtt3SubAckException);
}
@Test
public void subscribeWhenSubAckHasSomeErrorReturnCodeErrors() {
final var topicFiltersAndReturnCodes = new LinkedHashMap<MqttTopicFilter, Mqtt3SubAckReturnCode>();
topicFiltersAndReturnCodes.put(MqttTopicFilter.of("source/foo"), Mqtt3SubAckReturnCode.SUCCESS_MAXIMUM_QOS_1);
topicFiltersAndReturnCodes.put(MqttTopicFilter.of("source/bar"), Mqtt3SubAckReturnCode.FAILURE);
topicFiltersAndReturnCodes.put(MqttTopicFilter.of("source/baz"), Mqtt3SubAckReturnCode.SUCCESS_MAXIMUM_QOS_0);
topicFiltersAndReturnCodes.put(MqttTopicFilter.of("source/yolo"), Mqtt3SubAckReturnCode.FAILURE);
final var mqtt3SubAck = Mockito.mock(Mqtt3SubAck.class);
Mockito.when(mqtt3SubAck.getReturnCodes()).thenReturn(List.copyOf(topicFiltersAndReturnCodes.values()));
Mockito.when(mqtt3RxClient.subscribe(Mockito.any())).thenReturn(Single.just(mqtt3SubAck));
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
final var genericMqttSubAckSingle = underTest.subscribe(
GenericMqttSubscribe.of(topicFiltersAndReturnCodes.keySet()
.stream()
.map(topicFilter -> GenericMqttSubscription.newInstance(topicFilter, MqttQos.AT_LEAST_ONCE))
.collect(Collectors.toCollection(LinkedHashSet::new)))
);
softly.assertThat(subscribeForSingleValueResponse(genericMqttSubAckSingle))
.failsWithin(Duration.ofMillis(500L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isInstanceOfSatisfying(SomeSubscriptionsFailedException.class,
exception -> softly.assertThat(exception.failedSubscriptionStatuses())
.hasSameElementsAs(topicFiltersAndReturnCodes.entrySet()
.stream()
.filter(entry -> entry.getValue().isError())
.map(entry -> SubscriptionStatus.newInstance(
entry.getKey(),
GenericMqttSubAckStatus.ofMqtt3SubAckReturnCode(entry.getValue())
))
.toList()))
.withNoCause();
}
@Test
public void subscribeWhenExceptionOccursBeforeSubscribeMessageWasSent() {
final var illegalStateException = new IllegalStateException("Yolo!");
Mockito.when(mqtt3RxClient.subscribe(Mockito.any())).thenReturn(Single.error(illegalStateException));
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
final var genericMqttSubAckSingle = underTest.subscribe(
GenericMqttSubscribe.of(Set.of(GenericMqttSubscription.newInstance(MqttTopicFilter.of("source/status"),
MqttQos.AT_LEAST_ONCE)))
);
softly.assertThat(subscribeForSingleValueResponse(genericMqttSubAckSingle))
.failsWithin(Duration.ofMillis(500L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isInstanceOfSatisfying(MqttSubscribeException.class,
mqttSubscribeException -> {
softly.assertThat(mqttSubscribeException).hasMessage(illegalStateException.getMessage());
softly.assertThat(mqttSubscribeException).hasCause(illegalStateException);
});
}
@Test
public void consumeSubscribedPublishesWithManualAcknowledgementEmitsExpected() {
final var mqttTopicFilter = MqttTopicFilter.of("source/status");
final var mqttQos = MqttQos.AT_LEAST_ONCE;
final var mqtt3Publish = Mqtt3Publish.builder()
.topic(MqttTopic.of(mqttTopicFilter.toString()))
.qos(mqttQos)
.payload(ByteBufferUtils.fromUtf8String("online"))
.build();
Mockito.when(mqtt3RxClient.publishes(Mockito.eq(MqttGlobalPublishFilter.ALL), Mockito.eq(true)))
.thenReturn(Flowable.just(mqtt3Publish));
final var onCompleteMessage = "done";
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
final var genericMqttPublishFlowable = underTest.consumeSubscribedPublishesWithManualAcknowledgement();
final var mqttPublishSourceTestKit = ACTOR_SYSTEM_RESOURCE.newTestKit();
Source.fromPublisher(genericMqttPublishFlowable)
.to(Sink.actorRef(mqttPublishSourceTestKit.getRef(), onCompleteMessage))
.run(actorSystem);
final var genericMqttPublish = mqttPublishSourceTestKit.expectMsgClass(GenericMqttPublish.class);
mqttPublishSourceTestKit.expectMsg(onCompleteMessage);
assertThat(genericMqttPublish).isEqualTo(GenericMqttPublish.ofMqtt3Publish(mqtt3Publish));
}
@Test
public void consumeSubscribedPublishesWithManualAcknowledgementErrorsIfSessionExpired() {
final var mqttSessionExpiredException = new MqttSessionExpiredException("Your session expired.", null);
Mockito.when(mqtt3RxClient.publishes(Mockito.eq(MqttGlobalPublishFilter.ALL), Mockito.eq(true)))
.thenReturn(Flowable.error(mqttSessionExpiredException));
final var underTest = BaseGenericMqttSubscribingClient.ofMqtt3RxClient(mqtt3RxClient, ClientRole.CONSUMER);
final var genericMqttPublishFlowable = underTest.consumeSubscribedPublishesWithManualAcknowledgement();
final var mqttPublishSourceTestKit = ACTOR_SYSTEM_RESOURCE.newTestKit();
Source.fromPublisher(genericMqttPublishFlowable)
.to(Sink.actorRef(mqttPublishSourceTestKit.getRef(), "done"))
.run(actorSystem);
final var failure = mqttPublishSourceTestKit.expectMsgClass(Status.Failure.class);
mqttPublishSourceTestKit.expectNoMessage();
assertThat(failure.cause()).isEqualTo(mqttSessionExpiredException);
}
}