From 6b9dd2114c7ed2458735673499e393701936023c Mon Sep 17 00:00:00 2001 From: mpriyank Date: Tue, 30 Aug 2022 23:23:53 +0100 Subject: Performance Improvement: Enhance state handler - Introduced batch handling capability to state handler - Refactored methods in CompositeStateUtils - Renamed saveCmHandleStates to saveCmHandleStateBatch - Decoupled processing of events in bulk - Test scenarios for the new functionality Issue-ID: CPS-1231 Issue-ID: CPS-1126 Change-Id: Ifacdeb7bbed14712ecf4f5e2a4d9b324bae278d8 Signed-off-by: mpriyank --- .../LcmEventsCmHandleStateHandlerImplSpec.groovy | 69 +++++++++++++ .../impl/yangmodels/YangModelCmHandleSpec.groovy | 110 +++++++++++++++++++++ .../api/inventory/InventoryPersistenceSpec.groovy | 2 +- .../ncmp/api/models/YangModelCmHandleSpec.groovy | 82 --------------- 4 files changed, 180 insertions(+), 83 deletions(-) create mode 100644 cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/yangmodels/YangModelCmHandleSpec.groovy delete mode 100644 cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangModelCmHandleSpec.groovy (limited to 'cps-ncmp-service/src/test/groovy/org') diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/event/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/event/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy index 3d2e9950a..ddede6639 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/event/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/event/lcm/LcmEventsCmHandleStateHandlerImplSpec.groovy @@ -139,4 +139,73 @@ class LcmEventsCmHandleStateHandlerImplSpec extends Specification { and: 'the method to publish Lcm event is called once' 1 * mockLcmEventsService.publishLcmEvent(cmHandleId, _) } + + def 'No state change and no event to be published'() { + given: 'Cm Handle batch with same state transition as before' + def cmHandleStateMap = setupBatch('NO_CHANGE') + when: 'updating a batch of changes' + objectUnderTest.updateCmHandleStateBatch(cmHandleStateMap) + then: 'batch is empty and nothing to update' + 1 * mockInventoryPersistence.saveCmHandleBatch(_) >> { + args -> { + assert (args[0] as Collection).size() == 0 + } + } + and: 'no event will be published' + 0 * mockLcmEventsService.publishLcmEvent(*_) + } + + def 'Batch of new cm handles provided'() { + given: 'A batch of new cm handles' + def cmHandleStateMap = setupBatch('NEW') + when: 'updating a batch of changes' + objectUnderTest.updateCmHandleStateBatch(cmHandleStateMap) + then: 'new cm handles are saved using inventory persistence' + 1 * mockInventoryPersistence.saveCmHandleBatch(_) >> { + args -> { + assert (args[0] as Collection).id.containsAll('cmhandle1', 'cmhandle2') + } + } + and: 'event service is called to publish event' + 2 * mockLcmEventsService.publishLcmEvent(_, _) + + } + + def 'Batch of existing cm handles is updated'() { + given: 'A batch of updated cm handles' + def cmHandleStateMap = setupBatch('UPDATE') + when: 'updating a batch of changes' + objectUnderTest.updateCmHandleStateBatch(cmHandleStateMap) + then : 'existing cm handles composite state is persisted' + 1 * mockInventoryPersistence.saveCmHandleStateBatch(_) >> { + args -> { + assert (args[0] as Map).keySet().containsAll(['cmhandle1','cmhandle2']) + } + } + and: 'event service is called to publish event' + 2 * mockLcmEventsService.publishLcmEvent(_, _) + + } + + def setupBatch(type) { + + def yangModelCmHandle1 = new YangModelCmHandle(id: 'cmhandle1', dmiProperties: [], publicProperties: []) + def yangModelCmHandle2 = new YangModelCmHandle(id: 'cmhandle2', dmiProperties: [], publicProperties: []) + + if ('NEW' == type) { + return [(yangModelCmHandle1): ADVISED, (yangModelCmHandle2): ADVISED] + } + + if ('UPDATE' == type) { + yangModelCmHandle1.compositeState = new CompositeState(cmHandleState: ADVISED) + yangModelCmHandle2.compositeState = new CompositeState(cmHandleState: READY) + return [(yangModelCmHandle1): READY, (yangModelCmHandle2): DELETING] + } + + if ('NO_CHANGE' == type) { + yangModelCmHandle1.compositeState = new CompositeState(cmHandleState: ADVISED) + yangModelCmHandle2.compositeState = new CompositeState(cmHandleState: READY) + return [(yangModelCmHandle1): ADVISED, (yangModelCmHandle2): READY] + } + } } \ No newline at end of file diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/yangmodels/YangModelCmHandleSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/yangmodels/YangModelCmHandleSpec.groovy new file mode 100644 index 000000000..5fe266024 --- /dev/null +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/yangmodels/YangModelCmHandleSpec.groovy @@ -0,0 +1,110 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021-2022 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.impl.yangmodels + +import org.onap.cps.ncmp.api.inventory.CmHandleState +import org.onap.cps.ncmp.api.inventory.CompositeState +import org.onap.cps.ncmp.api.inventory.CompositeStateBuilder +import org.onap.cps.ncmp.api.inventory.LockReasonCategory +import org.onap.cps.ncmp.api.inventory.DataStoreSyncState +import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle +import spock.lang.Specification + +import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.DATA +import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.MODEL + +class YangModelCmHandleSpec extends Specification { + + def 'Creating yang model cm handle from a service api cm handle.'() { + given: 'a cm handle with properties' + def ncmpServiceCmHandle = new NcmpServiceCmHandle() + ncmpServiceCmHandle.cmHandleId = 'cm-handle-id01' + ncmpServiceCmHandle.dmiProperties = [myDmiProperty:'value1'] + ncmpServiceCmHandle.publicProperties = [myPublicProperty:'value2'] + and: 'with a composite state' + def compositeState = new CompositeStateBuilder() + .withCmHandleState(CmHandleState.LOCKED) + .withLastUpdatedTime('some-update-time') + .withLockReason(LockReasonCategory.LOCKED_MODULE_SYNC_FAILED, 'locked details') + .withOperationalDataStores(DataStoreSyncState.SYNCHRONIZED, 'some-sync-time').build() + ncmpServiceCmHandle.setCompositeState(compositeState) + when: 'it is converted to a yang model cm handle' + def objectUnderTest = YangModelCmHandle.toYangModelCmHandle('', '', '', ncmpServiceCmHandle) + then: 'the result has the right size' + assert objectUnderTest.dmiProperties.size() == 1 + and: 'the DMI property in the result has the correct name and value' + assert objectUnderTest.dmiProperties[0].name == 'myDmiProperty' + assert objectUnderTest.dmiProperties[0].value == 'value1' + and: 'the public property in the result has the correct name and value' + assert objectUnderTest.publicProperties[0].name == 'myPublicProperty' + assert objectUnderTest.publicProperties[0].value == 'value2' + and: 'the composite state matches the composite state of the ncmpServiceCmHandle' + objectUnderTest.getCompositeState().cmHandleState == CmHandleState.LOCKED + objectUnderTest.getCompositeState() == ncmpServiceCmHandle.getCompositeState() + } + + def 'Resolve DMI service name: #scenario and #requiredService service require.'() { + given: 'a yang model cm handle' + def objectUnderTest = YangModelCmHandle.toYangModelCmHandle(dmiServiceName, dmiDataServiceName, dmiModelServiceName, new NcmpServiceCmHandle(cmHandleId: 'cm-handle-id-1')) + expect: + assert objectUnderTest.resolveDmiServiceName(requiredService) == expectedService + where: + scenario | dmiServiceName | dmiDataServiceName | dmiModelServiceName | requiredService || expectedService + 'common service registered' | 'common service' | 'does not matter' | 'does not matter' | DATA || 'common service' + 'common service registered' | 'common service' | 'does not matter' | 'does not matter' | MODEL || 'common service' + 'common service empty' | '' | 'data service' | 'does not matter' | DATA || 'data service' + 'common service empty' | '' | 'does not matter' | 'model service' | MODEL || 'model service' + 'common service blank' | ' ' | 'data service' | 'does not matter' | DATA || 'data service' + 'common service blank' | ' ' | 'does not matter' | 'model service' | MODEL || 'model service' + 'common service null ' | null | 'data service' | 'does not matter' | DATA || 'data service' + 'common service null' | null | 'does not matter' | 'model service' | MODEL || 'model service' + 'only model service registered' | null | null | 'does not matter' | DATA || null + 'only data service registered' | null | 'does not matter' | null | MODEL || null + } + + def 'Yang Model Cm Handle Deep Copy'() { + given: 'a yang model cm handle' + def currentYangModelCmHandle = new YangModelCmHandle(id: 'cmhandle', + publicProperties: [new YangModelCmHandle.Property('publicProperty1', 'value1')], + dmiProperties: [new YangModelCmHandle.Property('dmiProperty1', 'value1')], + compositeState: new CompositeState(cmHandleState: CmHandleState.ADVISED, dataSyncEnabled: false)) + when: 'a deep copy is created' + def yangModelCmhandleDeepCopy = YangModelCmHandle.deepCopyOf(currentYangModelCmHandle) + and: 'we try to mutate current yang model cm handle' + currentYangModelCmHandle.id = 'cmhandle-changed' + currentYangModelCmHandle.dmiProperties = [new YangModelCmHandle.Property('updatedPublicProperty1', 'value1')] + currentYangModelCmHandle.publicProperties = [new YangModelCmHandle.Property('updatedDmiProperty1', 'value1')] + currentYangModelCmHandle.compositeState.cmHandleState = CmHandleState.READY + currentYangModelCmHandle.compositeState.dataSyncEnabled = true + then: 'there is no change in the deep copied object' + assert yangModelCmhandleDeepCopy.id == 'cmhandle' + assert yangModelCmhandleDeepCopy.dmiProperties == [new YangModelCmHandle.Property('dmiProperty1', 'value1')] + assert yangModelCmhandleDeepCopy.publicProperties == [new YangModelCmHandle.Property('publicProperty1', 'value1')] + assert yangModelCmhandleDeepCopy.compositeState.cmHandleState == CmHandleState.ADVISED + assert yangModelCmhandleDeepCopy.compositeState.dataSyncEnabled == false + and: 'equality on reference and hashcode behave as expected' + assert currentYangModelCmHandle.hashCode() != yangModelCmhandleDeepCopy.hashCode() + assert currentYangModelCmHandle != yangModelCmhandleDeepCopy + + } + + +} diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/inventory/InventoryPersistenceSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/inventory/InventoryPersistenceSpec.groovy index 76f10de83..19c8ae81c 100644 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/inventory/InventoryPersistenceSpec.groovy +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/inventory/InventoryPersistenceSpec.groovy @@ -159,7 +159,7 @@ class InventoryPersistenceSpec extends Specification { def compositeState2 = new CompositeState(cmHandleState: cmHandleState, lastUpdateTime: formattedDateAndTime) when: 'update cm handle state is invoked with the #scenario state' def cmHandleStateMap = ['Some-Cm-Handle1' : compositeState1, 'Some-Cm-Handle2' : compositeState2] - objectUnderTest.saveCmHandleStates(cmHandleStateMap) + objectUnderTest.saveCmHandleStateBatch(cmHandleStateMap) then: 'update node leaves is invoked with the correct params' 1 * mockCpsDataService.updateDataNodesAndDescendants('NCMP-Admin', 'ncmp-dmi-registry', cmHandlesJsonDataMap, _ as OffsetDateTime) where: 'the following states are used' diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangModelCmHandleSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangModelCmHandleSpec.groovy deleted file mode 100644 index 09f42e4b9..000000000 --- a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/models/YangModelCmHandleSpec.groovy +++ /dev/null @@ -1,82 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (C) 2021-2022 Nordix Foundation - * ================================================================================ - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - * SPDX-License-Identifier: Apache-2.0 - * ============LICENSE_END========================================================= - */ - -package org.onap.cps.ncmp.api.models - -import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle -import org.onap.cps.ncmp.api.inventory.CmHandleState -import org.onap.cps.ncmp.api.inventory.CompositeStateBuilder -import org.onap.cps.ncmp.api.inventory.LockReasonCategory -import org.onap.cps.ncmp.api.inventory.DataStoreSyncState -import spock.lang.Specification - -import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.DATA -import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.MODEL - -class YangModelCmHandleSpec extends Specification { - - def 'Creating yang model cm handle from a service api cm handle.'() { - given: 'a cm handle with properties' - def ncmpServiceCmHandle = new NcmpServiceCmHandle() - ncmpServiceCmHandle.cmHandleId = 'cm-handle-id01' - ncmpServiceCmHandle.dmiProperties = [myDmiProperty:'value1'] - ncmpServiceCmHandle.publicProperties = [myPublicProperty:'value2'] - and: 'with a composite state' - def compositeState = new CompositeStateBuilder() - .withCmHandleState(CmHandleState.LOCKED) - .withLastUpdatedTime('some-update-time') - .withLockReason(LockReasonCategory.LOCKED_MODULE_SYNC_FAILED, 'locked details') - .withOperationalDataStores(DataStoreSyncState.SYNCHRONIZED, 'some-sync-time').build() - ncmpServiceCmHandle.setCompositeState(compositeState) - when: 'it is converted to a yang model cm handle' - def objectUnderTest = YangModelCmHandle.toYangModelCmHandle('', '', '', ncmpServiceCmHandle) - then: 'the result has the right size' - assert objectUnderTest.dmiProperties.size() == 1 - and: 'the DMI property in the result has the correct name and value' - assert objectUnderTest.dmiProperties[0].name == 'myDmiProperty' - assert objectUnderTest.dmiProperties[0].value == 'value1' - and: 'the public property in the result has the correct name and value' - assert objectUnderTest.publicProperties[0].name == 'myPublicProperty' - assert objectUnderTest.publicProperties[0].value == 'value2' - and: 'the composite state matches the composite state of the ncmpServiceCmHandle' - objectUnderTest.getCompositeState().cmHandleState == CmHandleState.LOCKED - objectUnderTest.getCompositeState() == ncmpServiceCmHandle.getCompositeState() - } - - def 'Resolve DMI service name: #scenario and #requiredService service require.'() { - given: 'a yang model cm handle' - def objectUnderTest = YangModelCmHandle.toYangModelCmHandle(dmiServiceName, dmiDataServiceName, dmiModelServiceName, new NcmpServiceCmHandle(cmHandleId: 'cm-handle-id-1')) - expect: - assert objectUnderTest.resolveDmiServiceName(requiredService) == expectedService - where: - scenario | dmiServiceName | dmiDataServiceName | dmiModelServiceName | requiredService || expectedService - 'common service registered' | 'common service' | 'does not matter' | 'does not matter' | DATA || 'common service' - 'common service registered' | 'common service' | 'does not matter' | 'does not matter' | MODEL || 'common service' - 'common service empty' | '' | 'data service' | 'does not matter' | DATA || 'data service' - 'common service empty' | '' | 'does not matter' | 'model service' | MODEL || 'model service' - 'common service blank' | ' ' | 'data service' | 'does not matter' | DATA || 'data service' - 'common service blank' | ' ' | 'does not matter' | 'model service' | MODEL || 'model service' - 'common service null ' | null | 'data service' | 'does not matter' | DATA || 'data service' - 'common service null' | null | 'does not matter' | 'model service' | MODEL || 'model service' - 'only model service registered' | null | null | 'does not matter' | DATA || null - 'only data service registered' | null | 'does not matter' | null | MODEL || null - } - -} -- cgit 1.2.3-korg