From 9ed948933ef0280337b92bf9e454be8a9acfe3c5 Mon Sep 17 00:00:00 2001
From: Sergey Matvienko <smatvienko@thingsboard.io>
Date: Thu, 6 May 2021 11:48:42 +0300
Subject: [PATCH] test: added init stop test for DefaultTbQueueRequestTemplate

---
 .../common/DefaultTbQueueRequestTemplate.java |  22 ++--
 .../DefaultTbQueueRequestTemplateTest.java    | 113 ++++++++++++++++++
 2 files changed, 123 insertions(+), 12 deletions(-)
 create mode 100644 common/queue/src/test/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplateTest.java

diff --git a/common/queue/src/main/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplate.java b/common/queue/src/main/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplate.java
index 2c779d5d5a..a51e143e26 100644
--- a/common/queue/src/main/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplate.java
+++ b/common/queue/src/main/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplate.java
@@ -31,6 +31,7 @@ import org.thingsboard.server.queue.TbQueueProducer;
 import org.thingsboard.server.queue.TbQueueRequestTemplate;
 import org.thingsboard.server.common.stats.MessagesStats;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
@@ -47,14 +48,14 @@ public class DefaultTbQueueRequestTemplate<Request extends TbQueueMsg, Response
     private final TbQueueProducer<Request> requestTemplate;
     private final TbQueueConsumer<Response> responseTemplate;
     private final ConcurrentMap<UUID, DefaultTbQueueRequestTemplate.ResponseMetaData<Response>> pendingRequests;
-    private final boolean internalExecutor;
+    final boolean internalExecutor;
     private final ExecutorService executor;
     private final long maxRequestTimeout;
     private final long maxPendingRequests;
     private final long pollInterval;
-    private volatile long tickTs = 0L;
-    private volatile long tickSize = 0L;
-    private volatile boolean stopped = false;
+    volatile long tickTs = 0L;
+    volatile long tickSize = 0L;
+    volatile boolean stopped = false;
 
     private MessagesStats messagesStats;
 
@@ -65,7 +66,7 @@ public class DefaultTbQueueRequestTemplate<Request extends TbQueueMsg, Response
                                          long maxRequestTimeout,
                                          long maxPendingRequests,
                                          long pollInterval,
-                                         ExecutorService executor) {
+                                         @Nullable ExecutorService executor) {
         this.queueAdmin = queueAdmin;
         this.requestTemplate = requestTemplate;
         this.responseTemplate = responseTemplate;
@@ -73,13 +74,10 @@ public class DefaultTbQueueRequestTemplate<Request extends TbQueueMsg, Response
         this.maxRequestTimeout = maxRequestTimeout;
         this.maxPendingRequests = maxPendingRequests;
         this.pollInterval = pollInterval;
-        if (executor != null) {
-            internalExecutor = false;
-            this.executor = executor;
-        } else {
-            internalExecutor = true;
-            this.executor = Executors.newSingleThreadExecutor(ThingsBoardThreadFactory.forName("tb-queue-request-template-" + responseTemplate.getTopic()));
-        }
+        this.internalExecutor = (executor == null);
+        this.executor = internalExecutor
+                ? Executors.newSingleThreadExecutor(ThingsBoardThreadFactory.forName("tb-queue-request-template-" + responseTemplate.getTopic()))
+                : executor;
     }
 
     @Override
diff --git a/common/queue/src/test/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplateTest.java b/common/queue/src/test/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplateTest.java
new file mode 100644
index 0000000000..769b66fcd4
--- /dev/null
+++ b/common/queue/src/test/java/org/thingsboard/server/queue/common/DefaultTbQueueRequestTemplateTest.java
@@ -0,0 +1,113 @@
+/**
+ * ThingsBoard, Inc. ("COMPANY") CONFIDENTIAL
+ *
+ * Copyright © 2016-2021 ThingsBoard, Inc. All Rights Reserved.
+ *
+ * NOTICE: All information contained herein is, and remains
+ * the property of ThingsBoard, Inc. and its suppliers,
+ * if any.  The intellectual and technical concepts contained
+ * herein are proprietary to ThingsBoard, Inc.
+ * and its suppliers and may be covered by U.S. and Foreign Patents,
+ * patents in process, and are protected by trade secret or copyright law.
+ *
+ * Dissemination of this information or reproduction of this material is strictly forbidden
+ * unless prior written permission is obtained from COMPANY.
+ *
+ * Access to the source code contained herein is hereby forbidden to anyone except current COMPANY employees,
+ * managers or contractors who have executed Confidentiality and Non-disclosure agreements
+ * explicitly covering such access.
+ *
+ * The copyright notice above does not evidence any actual or intended publication
+ * or disclosure  of  this source code, which includes
+ * information that is confidential and/or proprietary, and is a trade secret, of  COMPANY.
+ * ANY REPRODUCTION, MODIFICATION, DISTRIBUTION, PUBLIC  PERFORMANCE,
+ * OR PUBLIC DISPLAY OF OR THROUGH USE  OF THIS  SOURCE CODE  WITHOUT
+ * THE EXPRESS WRITTEN CONSENT OF COMPANY IS STRICTLY PROHIBITED,
+ * AND IN VIOLATION OF APPLICABLE LAWS AND INTERNATIONAL TREATIES.
+ * THE RECEIPT OR POSSESSION OF THIS SOURCE CODE AND/OR RELATED INFORMATION
+ * DOES NOT CONVEY OR IMPLY ANY RIGHTS TO REPRODUCE, DISCLOSE OR DISTRIBUTE ITS CONTENTS,
+ * OR TO MANUFACTURE, USE, OR SELL ANYTHING THAT IT  MAY DESCRIBE, IN WHOLE OR IN PART.
+ */
+package org.thingsboard.server.queue.common;
+
+import org.junit.After;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.BDDMockito;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.internal.util.reflection.Whitebox;
+import org.mockito.runners.MockitoJUnitRunner;
+import org.thingsboard.server.queue.TbQueueAdmin;
+import org.thingsboard.server.queue.TbQueueConsumer;
+import org.thingsboard.server.queue.TbQueueMsg;
+import org.thingsboard.server.queue.TbQueueProducer;
+
+import java.util.concurrent.ExecutorService;
+
+import static org.junit.Assert.*;
+import static org.mockito.BDDMockito.willDoNothing;
+import static org.mockito.BDDMockito.willReturn;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+@RunWith(MockitoJUnitRunner.class)
+public class DefaultTbQueueRequestTemplateTest {
+
+    @Mock
+    TbQueueAdmin queueAdmin;
+    @Mock
+    ExecutorService executor;
+    @Mock
+    TbQueueProducer<TbQueueMsg> requestTemplate;
+    @Mock
+    TbQueueConsumer<TbQueueMsg> responseTemplate;
+
+    long maxRequestTimeout = 20;
+    long maxPendingRequests = 10000;
+    long pollInterval = 25;
+    String topic = "js-responses-tb-node-0";
+
+    DefaultTbQueueRequestTemplate inst;
+
+    @Before
+    public void setUp() throws Exception {
+        willReturn(topic).given(responseTemplate).getTopic();
+        inst = new DefaultTbQueueRequestTemplate(
+                queueAdmin, requestTemplate, responseTemplate,
+                maxRequestTimeout, maxPendingRequests, pollInterval, executor);
+
+    }
+
+    @Test
+    public void givenExternalExecutor_whenStop_thenDoNotShutdownExecutor() {
+        inst = Mockito.spy(inst);
+        willDoNothing().given(inst).fetchAndProcessResponses();
+        Assert.assertFalse(inst.stopped);
+
+        inst.init();
+        Assert.assertNotEquals(inst.tickTs, 0);
+        Assert.assertFalse(inst.internalExecutor);
+        verify(queueAdmin, times(1)).createTopicIfNotExists(topic);
+        verify(requestTemplate, times(1)).init();
+        verify(responseTemplate, times(1)).subscribe();
+        verify(executor, times(1)).submit(any(Runnable.class));
+
+        inst.stop();
+        Assert.assertTrue(inst.stopped);
+        verify(responseTemplate, times(1)).unsubscribe();
+        verify(requestTemplate, times(1)).stop();
+        verify(executor, never()).shutdownNow();
+    }
+
+    @Test
+    public void fetchAndProcessResponses() {
+        inst.init();
+
+        inst.stop();
+    }
+}
\ No newline at end of file