2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2024 Nordix Foundation
4 * Modifications Copyright (C) 2022 Bell Canada
5 * ================================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.cps.ncmp.api.impl.inventory.sync
24 import static org.onap.cps.ncmp.api.impl.inventory.LockReasonCategory.MODULE_SYNC_FAILED
25 import static org.onap.cps.ncmp.api.impl.inventory.LockReasonCategory.MODULE_UPGRADE_FAILED
27 import ch.qos.logback.classic.Level
28 import ch.qos.logback.classic.Logger
29 import ch.qos.logback.classic.spi.ILoggingEvent
30 import ch.qos.logback.core.read.ListAppender
31 import com.hazelcast.config.Config
32 import com.hazelcast.instance.impl.HazelcastInstanceFactory
33 import com.hazelcast.map.IMap
34 import org.onap.cps.ncmp.api.impl.events.lcm.LcmEventsCmHandleStateHandler
35 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle
36 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState
37 import org.onap.cps.ncmp.api.impl.inventory.CompositeState
38 import org.onap.cps.ncmp.api.impl.inventory.CompositeStateBuilder
39 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence
40 import org.onap.cps.ncmp.api.impl.inventory.LockReasonCategory
41 import org.onap.cps.spi.model.DataNode
42 import org.slf4j.LoggerFactory
43 import spock.lang.Specification
44 import java.util.concurrent.atomic.AtomicInteger
46 class ModuleSyncTasksSpec extends Specification {
48 def logger = Spy(ListAppender<ILoggingEvent>)
51 ((Logger) LoggerFactory.getLogger(ModuleSyncTasks.class)).addAppender(logger)
56 ((Logger) LoggerFactory.getLogger(ModuleSyncTasks.class)).detachAndStopAllAppenders()
59 def mockInventoryPersistence = Mock(InventoryPersistence)
61 def mockSyncUtils = Mock(ModuleOperationsUtils)
63 def mockModuleSyncService = Mock(ModuleSyncService)
65 def mockLcmEventsCmHandleStateHandler = Mock(LcmEventsCmHandleStateHandler)
67 IMap<String, Object> moduleSyncStartedOnCmHandles = HazelcastInstanceFactory
68 .getOrCreateHazelcastInstance(new Config('hazelcastInstanceName'))
69 .getMap('mapInstanceName')
71 def batchCount = new AtomicInteger(5)
73 def objectUnderTest = new ModuleSyncTasks(mockInventoryPersistence, mockSyncUtils, mockModuleSyncService,
74 mockLcmEventsCmHandleStateHandler, moduleSyncStartedOnCmHandles)
76 def 'Module Sync ADVISED cm handles.'() {
77 given: 'cm handles in an ADVISED state'
78 def cmHandle1 = cmHandleAsDataNodeByIdAndState('cm-handle-1', CmHandleState.ADVISED)
79 def cmHandle2 = cmHandleAsDataNodeByIdAndState('cm-handle-2', CmHandleState.ADVISED)
80 and: 'the inventory persistence cm handle returns a ADVISED state for the any handle'
81 mockInventoryPersistence.getCmHandleState(_) >> new CompositeState(cmHandleState: CmHandleState.ADVISED)
82 when: 'module sync poll is executed'
83 objectUnderTest.performModuleSync([cmHandle1, cmHandle2], batchCount)
84 then: 'module sync service deletes schemas set of each cm handle if it already exists'
85 1 * mockModuleSyncService.deleteSchemaSetIfExists('cm-handle-1')
86 1 * mockModuleSyncService.deleteSchemaSetIfExists('cm-handle-2')
87 and: 'module sync service is invoked for each cm handle'
88 1 * mockModuleSyncService.syncAndCreateSchemaSetAndAnchor(_) >> { args -> assert args[0].id == 'cm-handle-1' }
89 1 * mockModuleSyncService.syncAndCreateSchemaSetAndAnchor(_) >> { args -> assert args[0].id == 'cm-handle-2' }
90 and: 'the state handler is called for the both cm handles'
91 1 * mockLcmEventsCmHandleStateHandler.updateCmHandleStateBatch(_) >> { args ->
92 assertBatch(args, ['cm-handle-1', 'cm-handle-2'], CmHandleState.READY)
94 and: 'batch count is decremented by one'
95 assert batchCount.get() == 4
98 def 'Module Sync ADVISED cm handle with failure during sync.'() {
99 given: 'a cm handle in an ADVISED state'
100 def cmHandle = cmHandleAsDataNodeByIdAndState('cm-handle', CmHandleState.ADVISED)
101 and: 'the inventory persistence cm handle returns a ADVISED state for the cm handle'
102 def cmHandleState = new CompositeState(cmHandleState: CmHandleState.ADVISED)
103 1 * mockInventoryPersistence.getCmHandleState('cm-handle') >> cmHandleState
104 and: 'module sync service attempts to sync the cm handle and throws an exception'
105 1 * mockModuleSyncService.syncAndCreateSchemaSetAndAnchor(*_) >> { throw new Exception('some exception') }
106 when: 'module sync is executed'
107 objectUnderTest.performModuleSync([cmHandle], batchCount)
108 then: 'update lock reason, details and attempts is invoked'
109 1 * mockSyncUtils.updateLockReasonDetailsAndAttempts(cmHandleState, MODULE_SYNC_FAILED, 'some exception')
110 and: 'the state handler is called to update the state to LOCKED'
111 1 * mockLcmEventsCmHandleStateHandler.updateCmHandleStateBatch(_) >> { args ->
112 assertBatch(args, ['cm-handle'], CmHandleState.LOCKED)
114 and: 'batch count is decremented by one'
115 assert batchCount.get() == 4
118 def 'Failed cm handle during #scenario.'() {
119 given: 'a cm handle in LOCKED state'
120 def cmHandle = cmHandleAsDataNodeByIdAndState('cm-handle', CmHandleState.LOCKED)
121 and: 'the inventory persistence cm handle returns a LOCKED state with reason for the cm handle'
122 def expectedCmHandleState = new CompositeState(cmHandleState: cmHandleState, lockReason: CompositeState
123 .LockReason.builder().lockReasonCategory(lockReasonCategory).details(lockReasonDetails).build())
124 1 * mockInventoryPersistence.getCmHandleState('cm-handle') >> expectedCmHandleState
125 and: 'module sync service attempts to sync/upgrade the cm handle and throws an exception'
126 mockModuleSyncService.syncAndCreateSchemaSetAndAnchor(*_) >> { throw new Exception('some exception') }
127 mockModuleSyncService.syncAndUpgradeSchemaSet(*_) >> { throw new Exception('some exception') }
128 when: 'module sync is executed'
129 objectUnderTest.performModuleSync([cmHandle], batchCount)
130 then: 'update lock reason, details and attempts is invoked'
131 1 * mockSyncUtils.updateLockReasonDetailsAndAttempts(expectedCmHandleState, expectedLockReasonCategory, 'some exception')
133 scenario | cmHandleState | lockReasonCategory | lockReasonDetails || expectedLockReasonCategory
134 'module upgrade' | CmHandleState.LOCKED | MODULE_UPGRADE_FAILED | 'Upgrade to ModuleSetTag: some-module-set-tag' || MODULE_UPGRADE_FAILED
135 'module sync' | CmHandleState.LOCKED | MODULE_SYNC_FAILED | 'some lock details' || MODULE_SYNC_FAILED
138 def 'Reset failed CM Handles #scenario.'() {
139 given: 'cm handles in an locked state'
140 def lockedState = new CompositeStateBuilder().withCmHandleState(CmHandleState.LOCKED)
141 .withLockReason(LockReasonCategory.MODULE_SYNC_FAILED, '').withLastUpdatedTimeNow().build()
142 def yangModelCmHandle1 = new YangModelCmHandle(id: 'cm-handle-1', compositeState: lockedState)
143 def yangModelCmHandle2 = new YangModelCmHandle(id: 'cm-handle-2', compositeState: lockedState)
144 def expectedCmHandleStatePerCmHandle = [(yangModelCmHandle1): CmHandleState.ADVISED]
145 and: 'clear in progress map'
146 resetModuleSyncStartedOnCmHandles(moduleSyncStartedOnCmHandles)
147 and: 'add cm handle entry into progress map'
148 moduleSyncStartedOnCmHandles.put('cm-handle-1', 'started')
149 moduleSyncStartedOnCmHandles.put('cm-handle-2', 'started')
150 and: 'sync utils retry locked cm handle returns #isReadyForRetry'
151 mockSyncUtils.needsModuleSyncRetryOrUpgrade(lockedState) >>> isReadyForRetry
152 when: 'resetting failed cm handles'
153 objectUnderTest.resetFailedCmHandles([yangModelCmHandle1, yangModelCmHandle2])
154 then: 'updated to state "ADVISED" from "READY" is called as often as there are cm handles ready for retry'
155 expectedNumberOfInvocationsToUpdateCmHandleState * mockLcmEventsCmHandleStateHandler.updateCmHandleStateBatch(expectedCmHandleStatePerCmHandle)
156 and: 'after reset performed size of in progress map'
157 assert moduleSyncStartedOnCmHandles.size() == inProgressMapSize
159 scenario | isReadyForRetry | inProgressMapSize || expectedNumberOfInvocationsToUpdateCmHandleState
160 'retry locked cm handle' | [true, false] | 1 || 1
161 'do not retry locked cm handle' | [false, false] | 2 || 0
164 def 'Module Sync ADVISED cm handle without entry in progress map.'() {
165 given: 'cm handles in an ADVISED state'
166 def cmHandle1 = cmHandleAsDataNodeByIdAndState('cm-handle-1', CmHandleState.ADVISED)
167 and: 'the inventory persistence cm handle returns a ADVISED state for the any handle'
168 mockInventoryPersistence.getCmHandleState(_) >> new CompositeState(cmHandleState: CmHandleState.ADVISED)
169 and: 'entry in progress map for other cm handle'
170 moduleSyncStartedOnCmHandles.put('other-cm-handle', 'started')
171 when: 'module sync poll is executed'
172 objectUnderTest.performModuleSync([cmHandle1], batchCount)
173 then: 'module sync service is invoked for cm handle'
174 1 * mockModuleSyncService.syncAndCreateSchemaSetAndAnchor(_) >> { args -> assertYamgModelCmHandleArgument(args, 'cm-handle-1') }
175 and: 'the entry for other cm handle is still in the progress map'
176 assert moduleSyncStartedOnCmHandles.get('other-cm-handle') != null
179 def 'Remove already processed cm handle id from hazelcast map'() {
180 given: 'hazelcast map contains cm handle id'
181 moduleSyncStartedOnCmHandles.put('ch-1', 'started')
182 when: 'remove cm handle entry'
183 objectUnderTest.removeResetCmHandleFromModuleSyncMap('ch-1')
184 then: 'an event is logged with level INFO'
185 def loggingEvent = getLoggingEvent()
186 assert loggingEvent.level == Level.INFO
187 and: 'the log indicates the cm handle entry is removed successfully'
188 assert loggingEvent.formattedMessage == 'ch-1 removed from in progress map'
191 def 'Remove non-existing cm handle id from hazelcast map'() {
192 given: 'hazelcast map does not contains cm handle id'
193 def result = moduleSyncStartedOnCmHandles.get('non-existing-cm-handle')
194 assert result == null
195 when: 'remove cm handle entry from hazelcast map'
196 objectUnderTest.removeResetCmHandleFromModuleSyncMap('non-existing-cm-handle')
197 then: 'no event is logged'
198 def loggingEvent = getLoggingEvent()
199 assert loggingEvent == null
202 def cmHandleAsDataNodeByIdAndState(cmHandleId, cmHandleState) {
203 return new DataNode(anchorName: cmHandleId, leaves: ['id': cmHandleId, 'cm-handle-state': cmHandleState])
206 def assertBatch(args, expectedCmHandleStatePerCmHandleIds, expectedCmHandleState) {
208 Map<YangModelCmHandle, CmHandleState> actualCmHandleStatePerCmHandle = args[0]
209 assert actualCmHandleStatePerCmHandle.size() == expectedCmHandleStatePerCmHandleIds.size()
210 actualCmHandleStatePerCmHandle.each {
211 assert expectedCmHandleStatePerCmHandleIds.contains(it.key.id)
212 assert it.value == expectedCmHandleState
218 def resetModuleSyncStartedOnCmHandles(moduleSyncStartedOnCmHandles) {
219 moduleSyncStartedOnCmHandles.clear();
222 def getLoggingEvent() {
223 return logger.list[0]