-
Notifications
You must be signed in to change notification settings - Fork 215
/
DefaultGenericMqttClientTest.java
423 lines (353 loc) · 20.4 KB
/
DefaultGenericMqttClientTest.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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
/*
* 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 java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import org.assertj.core.api.Assertions;
import org.eclipse.ditto.base.model.common.ByteBufferUtils;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.ConnectionId;
import org.eclipse.ditto.connectivity.model.mqtt.IllegalReceiveMaximumValueException;
import org.eclipse.ditto.connectivity.model.mqtt.ReceiveMaximum;
import org.eclipse.ditto.connectivity.service.config.MqttConfig;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.IllegalKeepAliveIntervalSecondsException;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.KeepAliveInterval;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.MqttSpecificConfig;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.connect.GenericMqttConnect;
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.GenericMqttSubscribe;
import org.eclipse.ditto.connectivity.service.messaging.mqtt.hivemq.message.subscribe.GenericMqttSubscription;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.MockitoJUnitRunner;
import com.hivemq.client.mqtt.datatypes.MqttQos;
import com.hivemq.client.mqtt.datatypes.MqttTopic;
import com.hivemq.client.mqtt.datatypes.MqttTopicFilter;
import io.reactivex.Flowable;
import io.reactivex.Single;
/**
* Unit test for {@link DefaultGenericMqttClient}.
*/
@RunWith(MockitoJUnitRunner.class)
public final class DefaultGenericMqttClientTest {
private static final ConnectionId CONNECTION_ID = ConnectionId.generateRandom();
@Mock private BaseGenericMqttSubscribingClient<?> subscribingClient;
@Mock private BaseGenericMqttPublishingClient<?> publishingClient;
@Mock private MqttConfig mqttConfig;
@Mock private MqttSpecificConfig mqttSpecificConfig;
@Mock private HiveMqttClientProperties hiveMqttClientProperties;
@Before
public void before() throws IllegalKeepAliveIntervalSecondsException {
Mockito.when(hiveMqttClientProperties.getConnectionId()).thenReturn(CONNECTION_ID);
Mockito.when(hiveMqttClientProperties.getMqttConfig()).thenReturn(mqttConfig);
Mockito.when(hiveMqttClientProperties.getMqttSpecificConfig()).thenReturn(mqttSpecificConfig);
}
@Test
public void newInstanceWithNullGenericMqttSubscribingClientThrowsException() {
Assertions.assertThatNullPointerException()
.isThrownBy(() -> DefaultGenericMqttClient.newInstance(null,
publishingClient,
hiveMqttClientProperties))
.withMessage("The genericMqttSubscribingClient must not be null!")
.withNoCause();
}
@Test
public void newInstanceWithNullGenericMqttPublishingClientThrowsException() {
Assertions.assertThatNullPointerException()
.isThrownBy(() -> DefaultGenericMqttClient.newInstance(subscribingClient,
null,
hiveMqttClientProperties))
.withMessage("The genericMqttPublishingClient must not be null!")
.withNoCause();
}
@Test
public void newInstanceWithNullHiveMqttClientPropertiesThrowsException() {
Assertions.assertThatNullPointerException()
.isThrownBy(() -> DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, null))
.withMessage("The hiveMqttClientProperties must not be null!")
.withNoCause();
}
@Test
public void connectWithoutArgumentWorksAsExpectedIfConfiguredKeepAliveIntervalIsValid()
throws IllegalKeepAliveIntervalSecondsException, IllegalReceiveMaximumValueException {
Mockito.when(subscribingClient.connect(Mockito.any())).thenReturn(CompletableFuture.completedFuture(null));
Mockito.when(publishingClient.connect(Mockito.any())).thenReturn(CompletableFuture.completedFuture(null));
final var receiveMaximum = ReceiveMaximum.of(22_000);
Mockito.when(mqttConfig.getClientReceiveMaximum()).thenReturn(receiveMaximum);
final var cleanSession = true;
final var keepAliveInterval = KeepAliveInterval.of(Duration.ofSeconds(23L));
Mockito.when(mqttSpecificConfig.cleanSession()).thenReturn(cleanSession);
Mockito.when(mqttSpecificConfig.getKeepAliveIntervalOrDefault()).thenReturn(keepAliveInterval);
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var genericMqttConnect = GenericMqttConnect.newInstance(cleanSession, keepAliveInterval,
Duration.ZERO, receiveMaximum);
underTest.connect();
Mockito.verify(subscribingClient).connect(Mockito.eq(genericMqttConnect));
Mockito.verify(publishingClient).connect(Mockito.eq(genericMqttConnect));
}
@Test
public void connectWithoutArgumentReturnsFailedCompletionStageIfConfiguredKeepAliveIntervalIsInvalid() {
final var connection = Mockito.mock(Connection.class);
final var invalidKeepAliveIntervalSeconds = "-1";
Mockito.when(connection.getSpecificConfig()).thenReturn(Map.of("keepAlive", invalidKeepAliveIntervalSeconds));
final var mqttSpecificConfig = MqttSpecificConfig.fromConnection(connection, Mockito.mock(MqttConfig.class));
Mockito.when(hiveMqttClientProperties.getMqttSpecificConfig()).thenReturn(mqttSpecificConfig);
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var connectFuture = underTest.connect();
assertThat(connectFuture)
.failsWithin(Duration.ofMillis(500L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isInstanceOf(IllegalKeepAliveIntervalSecondsException.class)
.withMessageContaining(invalidKeepAliveIntervalSeconds);
}
@Test
public void connectWithNullGenericMqttConnectThrowsException() {
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
Assertions.assertThatNullPointerException()
.isThrownBy(() -> underTest.connect(null))
.withMessage("The genericMqttConnect must not be null!")
.withNoCause();
}
@Test
public void connectCallsConnectOnSubscribingClient() {
Mockito.when(subscribingClient.connect(Mockito.any())).thenReturn(CompletableFuture.completedFuture(null));
final var genericMqttConnect = GenericMqttConnect.newInstance(false,
KeepAliveInterval.defaultKeepAlive(),
Duration.ZERO,
ReceiveMaximum.defaultReceiveMaximum());
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
underTest.connect(genericMqttConnect);
Mockito.verify(subscribingClient).connect(Mockito.eq(genericMqttConnect));
Mockito.verify(publishingClient).connect(Mockito.any());
Mockito.verify(publishingClient, Mockito.never()).disconnect();
Mockito.verify(subscribingClient, Mockito.never()).disconnect();
}
@Test
public void connectCallsConnectOnPublishingClientIfConnectingSubscribingClientSucceeded() {
Mockito.when(subscribingClient.connect(Mockito.any())).thenReturn(CompletableFuture.completedFuture(null));
Mockito.when(publishingClient.connect(Mockito.any())).thenReturn(CompletableFuture.completedFuture(null));
final var genericMqttConnect = GenericMqttConnect.newInstance(false,
KeepAliveInterval.defaultKeepAlive(),
Duration.ZERO,
ReceiveMaximum.defaultReceiveMaximum());
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
underTest.connect(genericMqttConnect);
Mockito.verify(publishingClient).connect(Mockito.eq(genericMqttConnect));
Mockito.verify(publishingClient, Mockito.never()).disconnect();
Mockito.verify(subscribingClient, Mockito.never()).disconnect();
}
@Test
public void connectDoesNotCallConnectOnPublishingClientIfConnectingSubscribingClientFailed() {
final var illegalStateException = new IllegalStateException("Yolo!");
Mockito.when(subscribingClient.connect(Mockito.any()))
.thenReturn(CompletableFuture.failedFuture(illegalStateException));
final var genericMqttConnect = GenericMqttConnect.newInstance(false,
KeepAliveInterval.defaultKeepAlive(),
Duration.ZERO,
ReceiveMaximum.defaultReceiveMaximum());
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var connectFuture = underTest.connect(genericMqttConnect);
assertThat(connectFuture)
.failsWithin(Duration.ofSeconds(1L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isEqualTo(illegalStateException);
Mockito.verify(publishingClient, Mockito.never()).connect(Mockito.eq(genericMqttConnect));
Mockito.verify(publishingClient, Mockito.never()).disconnect();
Mockito.verify(subscribingClient, Mockito.never()).disconnect();
}
@Test
public void connectDisconnectsSubscribingClientIfConnectingPublishingClientFailed() {
Mockito.when(subscribingClient.connect(Mockito.any())).thenReturn(CompletableFuture.completedFuture(null));
final var illegalStateException = new IllegalStateException("Yolo!");
Mockito.when(publishingClient.connect(Mockito.any()))
.thenReturn(CompletableFuture.failedFuture(illegalStateException));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var connectFuture = underTest.connect(GenericMqttConnect.newInstance(false,
KeepAliveInterval.defaultKeepAlive(),
Duration.ZERO,
ReceiveMaximum.defaultReceiveMaximum()));
assertThat(connectFuture)
.failsWithin(Duration.ofSeconds(1L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isEqualTo(illegalStateException);
Mockito.verify(publishingClient, Mockito.never()).disconnect();
Mockito.verify(subscribingClient).disconnect();
}
@Test
public void disconnectCallsDisconnectOnSubscribingClientAndPublishingClient() {
Mockito.when(subscribingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
Mockito.when(publishingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var disconnectFuture = underTest.disconnect();
assertThat(disconnectFuture).succeedsWithin(Duration.ofSeconds(1L));
Mockito.verify(subscribingClient).disconnect();
Mockito.verify(publishingClient).disconnect();
}
@Test
public void disconnectFailsIfDisconnectOnSubscribingClientFails() {
final var illegalStateException = new IllegalStateException("Yolo!");
Mockito.when(subscribingClient.disconnect()).thenReturn(CompletableFuture.failedFuture(illegalStateException));
Mockito.when(publishingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var disconnectFuture = underTest.disconnect();
assertThat(disconnectFuture)
.failsWithin(Duration.ofSeconds(1L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isEqualTo(illegalStateException);
}
@Test
public void disconnectFailsIfDisconnectOnPublishingClientFails() {
Mockito.when(subscribingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
final var illegalStateException = new IllegalStateException("Yolo!");
Mockito.when(publishingClient.disconnect()).thenReturn(CompletableFuture.failedFuture(illegalStateException));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var disconnectFuture = underTest.disconnect();
assertThat(disconnectFuture)
.failsWithin(Duration.ofSeconds(1L))
.withThrowableOfType(ExecutionException.class)
.havingCause()
.isEqualTo(illegalStateException);
}
@Test
public void disconnectClientRoleWithNullThrowsException() {
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
Assertions.assertThatNullPointerException()
.isThrownBy(() -> underTest.disconnectClientRole(null))
.withMessage("The clientRole must not be null!")
.withNoCause();
}
@Test
public void disconnectClientRoleWithConsumerRoleDisconnectsOnlySubscribingClient() {
Mockito.when(subscribingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var disconnectFuture = underTest.disconnectClientRole(ClientRole.CONSUMER);
assertThat(disconnectFuture).succeedsWithin(Duration.ofSeconds(1L));
Mockito.verify(subscribingClient).disconnect();
Mockito.verify(publishingClient, Mockito.never()).disconnect();
}
@Test
public void disconnectClientRoleWithPublisherRoleDisconnectsOnlyPublishingClient() {
Mockito.when(publishingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var disconnectFuture = underTest.disconnectClientRole(ClientRole.PUBLISHER);
assertThat(disconnectFuture).succeedsWithin(Duration.ofSeconds(1L));
Mockito.verify(subscribingClient, Mockito.never()).disconnect();
Mockito.verify(publishingClient).disconnect();
}
@Test
public void disconnectClientRoleWithConsumerPublisherRoleDisconnectsPublishingClientAndSubscribingClient() {
Mockito.when(subscribingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
Mockito.when(publishingClient.disconnect()).thenReturn(CompletableFuture.completedFuture(null));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var disconnectFuture = underTest.disconnectClientRole(ClientRole.CONSUMER_PUBLISHER);
assertThat(disconnectFuture).succeedsWithin(Duration.ofSeconds(1L));
Mockito.verify(subscribingClient).disconnect();
Mockito.verify(publishingClient).disconnect();
}
@Test
public void subscribeCallsSubscribeOnSubscribingClient() {
final var genericMqttSubscribe = GenericMqttSubscribe.of(
Set.of(GenericMqttSubscription.newInstance(MqttTopicFilter.of("source/status"), MqttQos.AT_LEAST_ONCE))
);
final var genericMqttSubAck = Mockito.mock(GenericMqttSubAck.class);
Mockito.when(subscribingClient.subscribe(Mockito.eq(genericMqttSubscribe)))
.thenReturn(Single.just(genericMqttSubAck));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var genericMqttSubAckSingle = underTest.subscribe(genericMqttSubscribe);
assertThat(subscribeForSingleValueResponse(genericMqttSubAckSingle))
.succeedsWithin(Duration.ofSeconds(1L))
.isEqualTo(genericMqttSubAck);
Mockito.verifyNoInteractions(publishingClient);
}
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 consumeSubscribedPublishesWithManualAcknowledgementDelegatesToSubscribingClient() {
final var genericMqttPublishes = List.of(
GenericMqttPublish.builder(MqttTopic.of("source/status"), MqttQos.AT_LEAST_ONCE)
.payload(ByteBufferUtils.fromUtf8String("offline"))
.build(),
GenericMqttPublish.builder(MqttTopic.of("source/status"), MqttQos.AT_LEAST_ONCE)
.payload(ByteBufferUtils.fromUtf8String("maybe online"))
.build(),
GenericMqttPublish.builder(MqttTopic.of("source/status"), MqttQos.AT_LEAST_ONCE)
.payload(ByteBufferUtils.fromUtf8String("definitively online"))
.build()
);
Mockito.when(subscribingClient.consumeSubscribedPublishesWithManualAcknowledgement())
.thenReturn(Flowable.fromIterable(genericMqttPublishes));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
final var genericMqttMqttPublishFlowable = underTest.consumeSubscribedPublishesWithManualAcknowledgement();
assertThat(subscribeForFlowableValueResponse(genericMqttMqttPublishFlowable))
.succeedsWithin(Duration.ofSeconds(1L))
.isEqualTo(genericMqttPublishes);
Mockito.verifyNoInteractions(publishingClient);
}
private static <T> CompletableFuture<List<T>> subscribeForFlowableValueResponse(
final Flowable<T> flowableValueResponse
) {
final var result = new CompletableFuture<List<T>>();
final var elements = new ArrayList<T>();
flowableValueResponse.subscribe(elements::add, result::completeExceptionally, () -> result.complete(elements));
return result;
}
@Test
public void publishDelegatesToPublishingClient() {
final var genericMqttPublish = GenericMqttPublish.builder(MqttTopic.of("target/status"), MqttQos.AT_MOST_ONCE)
.payload(ByteBufferUtils.fromUtf8String("offline"))
.retain(true)
.build();
final var genericMqttPublishResult = GenericMqttPublishResult.success(genericMqttPublish);
Mockito.when(publishingClient.publish(Mockito.eq(genericMqttPublish)))
.thenReturn(CompletableFuture.completedFuture(genericMqttPublishResult));
final var underTest =
DefaultGenericMqttClient.newInstance(subscribingClient, publishingClient, hiveMqttClientProperties);
assertThat(underTest.publish(genericMqttPublish))
.succeedsWithin(Duration.ofSeconds(1L))
.isEqualTo(genericMqttPublishResult);
Mockito.verifyNoInteractions(subscribingClient);
}
}