2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2022-2024 Nordix Foundation
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api.impl.inventory.sync
23 import org.onap.cps.api.CpsAnchorService
25 import static org.onap.cps.ncmp.api.impl.ncmppersistence.NcmpPersistence.NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME
26 import static org.onap.cps.ncmp.api.impl.inventory.LockReasonCategory.MODULE_UPGRADE
28 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState
29 import org.onap.cps.spi.model.DataNode
30 import org.onap.cps.api.CpsDataService
31 import org.onap.cps.api.CpsModuleService
32 import org.onap.cps.spi.model.DataNodeBuilder
33 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations
34 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle
35 import org.onap.cps.ncmp.api.impl.inventory.CmHandleQueries
36 import org.onap.cps.ncmp.api.impl.inventory.CompositeStateBuilder
37 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
38 import org.onap.cps.spi.CascadeDeleteAllowed
39 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException
40 import org.onap.cps.spi.model.ModuleReference
41 import org.onap.cps.utils.JsonObjectMapper
42 import spock.lang.Specification
44 class ModuleSyncServiceSpec extends Specification {
46 def mockCpsModuleService = Mock(CpsModuleService)
47 def mockDmiModelOperations = Mock(DmiModelOperations)
48 def mockCpsAnchorService = Mock(CpsAnchorService)
49 def mockCmHandleQueries = Mock(CmHandleQueries)
50 def mockCpsDataService = Mock(CpsDataService)
51 def mockJsonObjectMapper = Mock(JsonObjectMapper)
53 def objectUnderTest = new ModuleSyncService(mockDmiModelOperations, mockCpsModuleService,
54 mockCmHandleQueries, mockCpsDataService, mockCpsAnchorService, mockJsonObjectMapper)
56 def expectedDataspaceName = NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME
57 def static cmHandleWithModuleSetTag = new DataNodeBuilder()
58 .withXpath("/dmi-registry/cm-handles[@id='otherId']")
59 .withLeaves(['id': 'otherId', 'module-set-tag': 'tag-1'])
60 .withAnchor('otherId').build()
62 def 'Sync model for a NEW cm handle using module set tags: #scenario.'() {
63 given: 'a cm handle state to be synced'
64 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
65 ncmpServiceCmHandle.setCompositeState(new CompositeStateBuilder().withCmHandleState(CmHandleState.ADVISED).build())
66 ncmpServiceCmHandle.cmHandleId = 'ch-1'
67 def yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle('some service name', '', '', ncmpServiceCmHandle, moduleSetTag, '')
68 and: 'DMI operations returns some module references'
69 def moduleReferences = [ new ModuleReference('module1','1'), new ModuleReference('module2','2') ]
70 mockDmiModelOperations.getModuleReferences(yangModelCmHandle) >> moduleReferences
71 and: 'DMI-Plugin returns resource(s) for "new" module(s)'
72 mockDmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle, identifiedNewModuleReferences) >> newModuleNameContentToMap
73 and: 'the module service identifies #identifiedNewModuleReferences.size() new modules'
74 mockCpsModuleService.identifyNewModuleReferences(moduleReferences) >> identifiedNewModuleReferences
75 and: 'system contains other cm handle with "same tag" (that is READY)'
76 mockCmHandleQueries.queryNcmpRegistryByCpsPath(*_) >> existingCmHandlesWithSameTag
77 when: 'module sync is triggered'
78 objectUnderTest.syncAndCreateSchemaSetAndAnchor(yangModelCmHandle)
79 then: 'create schema set from module is invoked with correct parameters'
80 1 * mockCpsModuleService.createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'ch-1', newModuleNameContentToMap, moduleReferences)
81 and: 'anchor is created with the correct parameters'
82 1 * mockCpsAnchorService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'ch-1', 'ch-1')
83 where: 'the following parameters are used'
84 scenario | existingModuleResourcesInCps | identifiedNewModuleReferences | newModuleNameContentToMap | moduleSetTag | existingCmHandlesWithSameTag
85 'one new module, new tag' | [['module2': '2'], ['module3': '3']] | [new ModuleReference('module1', '1')] | [module1: 'some yang source'] | '' | []
86 'no new module, new tag' | [['module1': '1'], ['module2': '2']] | [] | [:] | 'new-tag-1' | []
87 'same tag' | [['module1': '1'], ['module2': '2']] | [] | [:] | 'same-tag' | [cmHandleWithModuleSetTag]
90 def 'Upgrade model for an existing cm handle with Module Set Tag where the modules are #scenario'() {
91 given: 'a cm handle being upgraded to module set tag: tag-1'
92 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
93 ncmpServiceCmHandle.setCompositeState(new CompositeStateBuilder().withLockReason(MODULE_UPGRADE, 'Upgrade to ModuleSetTag: tag-1').build())
94 def dmiServiceName = 'some service name'
95 ncmpServiceCmHandle.cmHandleId = 'upgraded-ch'
96 def yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle(dmiServiceName, '', '', ncmpServiceCmHandle,'tag-1', '')
97 and: 'some module references'
98 def moduleReferences = [ new ModuleReference('module1','1') ]
99 and: 'DMI operations returns some module references for upgraded cm handle'
100 mockDmiModelOperations.getModuleReferences(yangModelCmHandle) >> moduleReferences
101 mockDmiModelOperations.getNewYangResourcesFromDmi(_, []) >> [:]
102 and: 'none of these module references are new (unknown to the system)'
103 mockCpsModuleService.identifyNewModuleReferences(_) >> []
104 and: 'CPS-Core returns list of existing module resources for TBD'
105 mockCpsModuleService.getYangResourcesModuleReferences(*_) >> [ new ModuleReference('module1','1') ]
106 and: 'system contains #existingCmHandlesWithSameTag.size() cm handles with same tag'
107 mockCmHandleQueries.queryNcmpRegistryByCpsPath(*_) >> existingCmHandlesWithSameTag
108 and: 'the other cm handle is a state ready'
109 mockCmHandleQueries.cmHandleHasState('otherId', CmHandleState.READY) >> true
110 when: 'module sync is triggered'
111 objectUnderTest.syncAndUpgradeSchemaSet(yangModelCmHandle)
112 then: 'update schema set from module is invoked for the upgraded cm handle'
113 1 * mockCpsModuleService.upgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'upgraded-ch', [:], moduleReferences)
114 and: 'create schema set from module is not invoked for the upgraded cm handle'
115 0 * mockCpsModuleService.createSchemaSetFromModules(*_)
116 and: 'No anchor is created for the upgraded cm handle'
117 0 * mockCpsAnchorService.createAnchor(*_)
118 where: 'the following parameters are used'
119 scenario | existingCmHandlesWithSameTag
121 'in database' | [cmHandleWithModuleSetTag]
124 def 'upgrade model for a existing cm handle'() {
125 given: 'a cm handle that is ready but locked for upgrade'
126 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
127 ncmpServiceCmHandle.setCompositeState(new CompositeStateBuilder()
128 .withLockReason(MODULE_UPGRADE, 'Upgrade to ModuleSetTag: targetModuleSetTag').build())
129 ncmpServiceCmHandle.setCmHandleId('cmHandleId-1')
130 def yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle('some service name', '', '', ncmpServiceCmHandle, 'targetModuleSetTag', '')
131 mockCmHandleQueries.cmHandleHasState('cmHandleId-1', CmHandleState.READY) >> true
132 and: 'the module service returns some module references'
133 def moduleReferences = [new ModuleReference('module1', '1'), new ModuleReference('module2', '2')]
134 mockCpsModuleService.getYangResourcesModuleReferences(*_)>> moduleReferences
135 and: 'a cm handle with the same moduleSetTag can be found in the registry'
136 mockCmHandleQueries.queryNcmpRegistryByCpsPath(*_) >> [new DataNode(xpath: '/dmi-registry/cm-handles[@id=\'cmHandleId-1\']', leaves: ['id': 'cmHandleId-1'],
137 childDataNodes: [new DataNode(xpath: '/dmi-registry/cm-handles[@id=\'cmHandleId-1\']/state', leaves: ['cm-handle-state': 'READY'])])]
138 when: 'module upgrade is triggered'
139 objectUnderTest.syncAndUpgradeSchemaSet(yangModelCmHandle)
140 then: 'the upgrade is delegated to the module service (with the correct parameters)'
141 1 * mockCpsModuleService.upgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'cmHandleId-1', Collections.emptyMap(), moduleReferences)
144 def 'Delete Schema Set for CmHandle'() {
145 when: 'delete schema set if exists is called'
146 objectUnderTest.deleteSchemaSetIfExists('some-cmhandle-id')
147 then: 'the module service is invoked to delete the correct schema set'
148 1 * mockCpsModuleService.deleteSchemaSet(expectedDataspaceName, 'some-cmhandle-id', CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED)
151 def 'Delete a non-existing Schema Set for CmHandle' () {
152 given: 'the DB throws an exception because its Schema Set does not exist'
153 mockCpsModuleService.deleteSchemaSet(*_) >> { throw new SchemaSetNotFoundException('some-dataspace-name', 'some-cmhandle-id') }
154 when: 'delete schema set if exists is called'
155 objectUnderTest.deleteSchemaSetIfExists('some-cmhandle-id')
156 then: 'the exception from the DB is ignored; there are no exceptions'
160 def 'Delete Schema Set for CmHandle with other exception' () {
161 given: 'an exception other than SchemaSetNotFoundException is thrown'
162 UnsupportedOperationException unsupportedOperationException = new UnsupportedOperationException();
163 1 * mockCpsModuleService.deleteSchemaSet(*_) >> { throw unsupportedOperationException }
164 when: 'delete schema set if exists is called'
165 objectUnderTest.deleteSchemaSetIfExists('some-cmhandle-id')
166 then: 'an exception is thrown'
167 def result = thrown(UnsupportedOperationException)
168 result == unsupportedOperationException