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.FetchDescendantsOption
30 import org.onap.cps.spi.model.DataNode
31 import org.onap.cps.api.CpsDataService
32 import org.onap.cps.api.CpsModuleService
33 import org.onap.cps.spi.model.DataNodeBuilder
34 import org.onap.cps.ncmp.api.impl.operations.DmiModelOperations
35 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle
36 import org.onap.cps.ncmp.api.impl.inventory.CmHandleQueries
37 import org.onap.cps.ncmp.api.impl.inventory.CompositeStateBuilder
38 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
39 import org.onap.cps.spi.CascadeDeleteAllowed
40 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException
41 import org.onap.cps.spi.model.ModuleReference
42 import org.onap.cps.utils.JsonObjectMapper
43 import spock.lang.Specification
45 class ModuleSyncServiceSpec extends Specification {
47 def mockCpsModuleService = Mock(CpsModuleService)
48 def mockDmiModelOperations = Mock(DmiModelOperations)
49 def mockCpsAnchorService = Mock(CpsAnchorService)
50 def mockCmHandleQueries = Mock(CmHandleQueries)
51 def mockCpsDataService = Mock(CpsDataService)
52 def mockJsonObjectMapper = Mock(JsonObjectMapper)
54 def objectUnderTest = new ModuleSyncService(mockDmiModelOperations, mockCpsModuleService,
55 mockCmHandleQueries, mockCpsDataService, mockCpsAnchorService, mockJsonObjectMapper)
57 def expectedDataspaceName = NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME
58 def static cmHandleWithModuleSetTag = new DataNodeBuilder().withXpath("//cm-handles[@module-set-tag='tag-1'][@id='otherId']").withAnchor('otherId').build()
60 def 'Upgrading model sets using module set tags: #scenario.'() {
61 given: 'a ready cm handle'
62 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
63 ncmpServiceCmHandle.setCompositeState(new CompositeStateBuilder().withCmHandleState(CmHandleState.READY).build())
64 ncmpServiceCmHandle.cmHandleId = 'ch-1'
65 def yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle('some service name', '', '', ncmpServiceCmHandle, moduleSetTag, '')
66 and: 'DMI operations returns some module references'
67 def moduleReferences = [ new ModuleReference('module1','1'), new ModuleReference('module2','2') ]
68 mockDmiModelOperations.getModuleReferences(yangModelCmHandle) >> moduleReferences
69 and: 'DMI-Plugin returns resource(s) for "new" module(s)'
70 mockDmiModelOperations.getNewYangResourcesFromDmi(yangModelCmHandle, [new ModuleReference('module1', '1')]) >> newModuleNameContentToMap
71 and: 'the module service identifies #identifiedNewModuleReferences.size() new modules'
72 mockCpsModuleService.identifyNewModuleReferences(moduleReferences) >> toModuleReferences(identifiedNewModuleReferences)
73 and: 'system contains other cm handle with "same tag" (that is READY)'
74 mockCmHandleQueries.queryNcmpRegistryByCpsPath(*_) >> existingCmHandlesWithSameTag
75 mockCmHandleQueries.cmHandleHasState('otherId', CmHandleState.READY) >> true
76 when: 'module sync is triggered'
77 objectUnderTest.syncAndCreateOrUpgradeSchemaSetAndAnchor(yangModelCmHandle)
78 then: 'create schema set from modules is only invoked when the model changes'
79 expectedCallsToCreateSchemaSet * mockCpsModuleService.createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'ch-1', newModuleNameContentToMap, moduleReferences)
80 and: 'anchor is created with the correct parameters'
81 1 * mockCpsAnchorService.createAnchor(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'ch-1', 'ch-1')
82 where: 'the following parameters are used'
83 scenario | existingModuleResourcesInCps | identifiedNewModuleReferences | newModuleNameContentToMap | moduleSetTag | existingCmHandlesWithSameTag || expectedCallsToCreateSchemaSet
84 'one new module, new tag' | [['module2': '2'], ['module3': '3']] | [['module1': '1']] | [module1: 'some yang source'] | '' | [] || 1
85 'no new module, new tag' | [['module1': '1'], ['module2': '2']] | [] | [:] | 'new-tag-1' | [] || 1
86 'same tag' | [['module1': '1'], ['module2': '2']] | [] | [:] | 'same-tag' | [cmHandleWithModuleSetTag] || 0
89 def 'Upgrade model for an existing cm handle with Module Set Tag where the modules are #scenario.'() {
90 given: 'a cm handle being upgraded to module set tag: tag-1'
91 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
92 ncmpServiceCmHandle.setCompositeState(new CompositeStateBuilder().withLockReason(MODULE_UPGRADE, 'Upgrade to ModuleSetTag: tag-1').build())
93 def dmiServiceName = 'some service name'
94 ncmpServiceCmHandle.cmHandleId = 'upgraded-ch'
95 def yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle(dmiServiceName, '', '', ncmpServiceCmHandle,'tag-1', '')
96 and: 'some module references'
97 def moduleReferences = [ new ModuleReference('module1','1') ]
98 and: 'cache or DMI operations returns some module references for upgraded cm handle'
99 mockDmiModelOperations.getModuleReferences(yangModelCmHandle) >> moduleReferences
100 and: 'none of these module references are new (unknown to the system)'
101 mockCpsModuleService.identifyNewModuleReferences(moduleReferences) >> []
102 and: 'CPS-Core returns list of existing module resources for TBD'
103 mockCpsModuleService.getYangResourcesModuleReferences(*_) >> [ new ModuleReference('module1','1') ]
104 and: 'system contains #existingCmHandlesWithSameTag.size() cm handles with same tag'
105 mockCmHandleQueries.queryNcmpRegistryByCpsPath("//cm-handles[@module-set-tag='tag-1']", FetchDescendantsOption.OMIT_DESCENDANTS) >> existingCmHandlesWithSameTag
106 and: 'the other cm handle is a state ready'
107 mockCmHandleQueries.cmHandleHasState('otherId', CmHandleState.READY) >> true
108 when: 'module sync is triggered'
109 objectUnderTest.syncAndCreateOrUpgradeSchemaSetAndAnchor(yangModelCmHandle)
110 then: 'update schema set from module is invoked for the upgraded cm handle'
111 expectedCallsToUpgradeSchemaSet * mockCpsModuleService.upgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'upgraded-ch', [:], moduleReferences)
112 and: 'create schema set from module is invoked for the upgraded cm handle'
113 expectedCallsToCeateSchemaSet * mockCpsModuleService.createSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'upgraded-ch', [:], moduleReferences)
114 and: 'No anchor is created for the upgraded cm handle'
115 0 * mockCpsAnchorService.createAnchor(*_)
116 where: 'the following parameters are used'
117 scenario | existingCmHandlesWithSameTag || expectedCallsToUpgradeSchemaSet | expectedCallsToCeateSchemaSet
119 'in database' | [cmHandleWithModuleSetTag] || 1 | 0
122 def 'upgrade model for a existing cm handle'() {
123 given: 'a cm handle that is ready but locked for upgrade'
124 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
125 ncmpServiceCmHandle.setCompositeState(new CompositeStateBuilder()
126 .withLockReason(MODULE_UPGRADE, 'Upgrade to ModuleSetTag: targetModuleSetTag').build())
127 ncmpServiceCmHandle.setCmHandleId('cmHandleId-1')
128 def yangModelCmHandle = YangModelCmHandle.toYangModelCmHandle('some service name', '', '', ncmpServiceCmHandle, 'targetModuleSetTag', '')
129 mockCmHandleQueries.cmHandleHasState('cmHandleId-1', CmHandleState.READY) >> true
130 and: 'the module service returns some module references'
131 def moduleReferences = [new ModuleReference('module1', '1'), new ModuleReference('module2', '2')]
132 mockCpsModuleService.getYangResourcesModuleReferences(*_)>> moduleReferences
133 and: 'a cm handle with the same moduleSetTag can be found in the registry'
134 mockCmHandleQueries.queryNcmpRegistryByCpsPath("//cm-handles[@module-set-tag='targetModuleSetTag']",
135 FetchDescendantsOption.OMIT_DESCENDANTS) >> [new DataNode(xpath: '/dmi-registry/cm-handles[@id=\'cmHandleId-1\']', leaves: ['id': 'cmHandleId-1', 'cm-handle-state': 'READY'])]
136 when: 'module upgrade is triggered'
137 objectUnderTest.syncAndCreateOrUpgradeSchemaSetAndAnchor(yangModelCmHandle)
138 then: 'the upgrade is delegated to the module service (with the correct parameters)'
139 1 * mockCpsModuleService.upgradeSchemaSetFromModules(NFP_OPERATIONAL_DATASTORE_DATASPACE_NAME, 'cmHandleId-1', Collections.emptyMap(), moduleReferences)
142 def 'Delete Schema Set for CmHandle'() {
143 when: 'delete schema set if exists is called'
144 objectUnderTest.deleteSchemaSetIfExists('some-cmhandle-id')
145 then: 'the module service is invoked to delete the correct schema set'
146 1 * mockCpsModuleService.deleteSchemaSet(expectedDataspaceName, 'some-cmhandle-id', CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED)
149 def 'Delete a non-existing Schema Set for CmHandle' () {
150 given: 'the DB throws an exception because its Schema Set does not exist'
151 mockCpsModuleService.deleteSchemaSet(*_) >> { throw new SchemaSetNotFoundException('some-dataspace-name', 'some-cmhandle-id') }
152 when: 'delete schema set if exists is called'
153 objectUnderTest.deleteSchemaSetIfExists('some-cmhandle-id')
154 then: 'the exception from the DB is ignored; there are no exceptions'
158 def 'Delete Schema Set for CmHandle with other exception' () {
159 given: 'an exception other than SchemaSetNotFoundException is thrown'
160 UnsupportedOperationException unsupportedOperationException = new UnsupportedOperationException();
161 1 * mockCpsModuleService.deleteSchemaSet(*_) >> { throw unsupportedOperationException }
162 when: 'delete schema set if exists is called'
163 objectUnderTest.deleteSchemaSetIfExists('some-cmhandle-id')
164 then: 'an exception is thrown'
165 def result = thrown(UnsupportedOperationException)
166 result == unsupportedOperationException
169 def toModuleReferences(moduleReferenceAsMap) {
170 def moduleReferences = [].withDefault { [:] }
171 moduleReferenceAsMap.forEach(property ->
172 property.forEach((moduleName, revision) -> {
173 moduleReferences.add(new ModuleReference('moduleName' : moduleName, 'revision' : revision))
175 return moduleReferences