Merge "RTD change to document migration to Spring Boot 3.0"
[cps.git] / cps-ncmp-service / src / test / groovy / org / onap / cps / ncmp / api / inventory / sync / ModuleSyncWatchdogSpec.groovy
index dd989bf..94ee6ea 100644 (file)
@@ -1,6 +1,6 @@
 /*
  *  ============LICENSE_START=======================================================
- *  Copyright (C) 2022 Nordix Foundation
+ *  Copyright (C) 2022-2023 Nordix Foundation
  *  Modifications Copyright (C) 2022 Bell Canada
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
 
 package org.onap.cps.ncmp.api.inventory.sync
 
+import com.hazelcast.map.IMap
+import org.onap.cps.ncmp.api.impl.inventory.sync.ModuleSyncTasks
+import org.onap.cps.ncmp.api.impl.inventory.sync.ModuleSyncWatchdog
+import org.onap.cps.ncmp.api.impl.inventory.sync.SyncUtils
 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle
-import org.onap.cps.ncmp.api.inventory.sync.executor.AsyncTaskExecutor
+import org.onap.cps.ncmp.api.impl.inventory.sync.executor.AsyncTaskExecutor
 import java.util.concurrent.ArrayBlockingQueue
-import java.util.concurrent.BlockingQueue
 import org.onap.cps.spi.model.DataNode
 import spock.lang.Specification
 
@@ -36,17 +39,16 @@ class ModuleSyncWatchdogSpec extends Specification {
 
     def moduleSyncWorkQueue = new ArrayBlockingQueue(testQueueCapacity)
 
-    def moduleSyncStartedOnCmHandles = [:]
+    def mockModuleSyncStartedOnCmHandles = Mock(IMap<String, Object>)
 
     def mockModuleSyncTasks = Mock(ModuleSyncTasks)
 
     def spiedAsyncTaskExecutor = Spy(AsyncTaskExecutor)
 
-    def objectUnderTest = new ModuleSyncWatchdog(mockSyncUtils, moduleSyncWorkQueue , moduleSyncStartedOnCmHandles,
-            mockModuleSyncTasks, spiedAsyncTaskExecutor)
+    def objectUnderTest = new ModuleSyncWatchdog(mockSyncUtils, moduleSyncWorkQueue , mockModuleSyncStartedOnCmHandles, mockModuleSyncTasks, spiedAsyncTaskExecutor)
 
     void setup() {
-        spiedAsyncTaskExecutor.setupThreadPool();
+        spiedAsyncTaskExecutor.setupThreadPool()
     }
 
     def 'Module sync advised cm handles with #scenario.'() {
@@ -58,7 +60,7 @@ class ModuleSyncWatchdogSpec extends Specification {
             objectUnderTest.moduleSyncAdvisedCmHandles()
         then: 'it performs #expectedNumberOfTaskExecutions tasks'
             expectedNumberOfTaskExecutions * spiedAsyncTaskExecutor.executeTask(*_)
-        where: ' the following parameter are used'
+        where: 'the following parameter are used'
             scenario              | numberOfAdvisedCmHandles                                          || expectedNumberOfTaskExecutions
             'less then 1 batch'   | 1                                                                 || 1
             'exactly 1 batch'     | ModuleSyncWatchdog.MODULE_SYNC_BATCH_SIZE                         || 1
@@ -67,11 +69,48 @@ class ModuleSyncWatchdogSpec extends Specification {
             'over queue capacity' | testQueueCapacity + 2 * ModuleSyncWatchdog.MODULE_SYNC_BATCH_SIZE || 3
     }
 
+    def 'Module sync advised cm handles starts with no available threads.'() {
+        given: 'sync utilities returns a advise cm handles'
+            mockSyncUtils.getAdvisedCmHandles() >> createDataNodes(1)
+        and: 'the executor first has no threads but has one thread on the second attempt'
+            spiedAsyncTaskExecutor.getAsyncTaskParallelismLevel() >>> [ 0, 1 ]
+        when: ' module sync is started'
+            objectUnderTest.moduleSyncAdvisedCmHandles()
+        then: 'it performs one task'
+            1 * spiedAsyncTaskExecutor.executeTask(*_)
+    }
+
+    def 'Module sync advised cm handles already handled.'() {
+        given: 'sync utilities returns a advise cm handles'
+            mockSyncUtils.getAdvisedCmHandles() >> createDataNodes(1)
+        and: 'the executor has a thread available'
+            spiedAsyncTaskExecutor.getAsyncTaskParallelismLevel() >> 1
+        and: 'the semaphore cache indicates the cm handle is already being processed'
+            mockModuleSyncStartedOnCmHandles.putIfAbsent(*_) >> 'Started'
+        when: ' module sync is started'
+            objectUnderTest.moduleSyncAdvisedCmHandles()
+        then: 'it does NOT execute a task to process the (empty) batch'
+            0 * spiedAsyncTaskExecutor.executeTask(*_)
+    }
+
+    def 'Module sync with previous cm handle(s) left in work queue.'() {
+        given: 'there is still a cm handle in the queue'
+            moduleSyncWorkQueue.offer(new DataNode())
+        and: 'sync utilities returns many advise cm handles'
+            mockSyncUtils.getAdvisedCmHandles() >> createDataNodes(500)
+        and: 'the executor has plenty threads available'
+            spiedAsyncTaskExecutor.getAsyncTaskParallelismLevel() >> 10
+        when: ' module sync is started'
+            objectUnderTest.moduleSyncAdvisedCmHandles()
+        then: 'it does executes only one task to process the remaining handle in the queue'
+            1 * spiedAsyncTaskExecutor.executeTask(*_)
+    }
+
     def 'Reset failed cm handles.'() {
         given: 'sync utilities returns failed cm handles'
             def failedCmHandles = [new YangModelCmHandle()]
             mockSyncUtils.getModuleSyncFailedCmHandles() >> failedCmHandles
-        when: ' reset failed cm handles is started'
+        when: 'reset failed cm handles is started'
             objectUnderTest.resetPreviouslyFailedCmHandles()
         then: 'it is delegated to the module sync task (service)'
             1 * mockModuleSyncTasks.resetFailedCmHandles(failedCmHandles)