2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2021-2023 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.yangmodels
23 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState
24 import org.onap.cps.ncmp.api.impl.inventory.CompositeState
25 import org.onap.cps.ncmp.api.impl.inventory.CompositeStateBuilder
26 import org.onap.cps.ncmp.api.impl.inventory.LockReasonCategory
27 import org.onap.cps.ncmp.api.impl.inventory.DataStoreSyncState
28 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle
29 import spock.lang.Specification
31 import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.DATA
32 import static org.onap.cps.ncmp.api.impl.operations.RequiredDmiService.MODEL
34 class YangModelCmHandleSpec extends Specification {
36 def 'Creating yang model cm handle from a service api cm handle.'() {
37 given: 'a cm handle with properties'
38 def ncmpServiceCmHandle = new NcmpServiceCmHandle()
39 ncmpServiceCmHandle.cmHandleId = 'cm-handle-id01'
40 ncmpServiceCmHandle.dmiProperties = [myDmiProperty:'value1']
41 ncmpServiceCmHandle.publicProperties = [myPublicProperty:'value2']
42 and: 'with a composite state'
43 def compositeState = new CompositeStateBuilder()
44 .withCmHandleState(CmHandleState.LOCKED)
45 .withLastUpdatedTime('some-update-time')
46 .withLockReason(LockReasonCategory.MODULE_SYNC_FAILED, 'locked details')
47 .withOperationalDataStores(DataStoreSyncState.SYNCHRONIZED, 'some-sync-time').build()
48 ncmpServiceCmHandle.setCompositeState(compositeState)
49 when: 'it is converted to a yang model cm handle'
50 def objectUnderTest = YangModelCmHandle.toYangModelCmHandle('', '', '', ncmpServiceCmHandle,'')
51 then: 'the result has the right size'
52 assert objectUnderTest.dmiProperties.size() == 1
53 and: 'the DMI property in the result has the correct name and value'
54 assert objectUnderTest.dmiProperties[0].name == 'myDmiProperty'
55 assert objectUnderTest.dmiProperties[0].value == 'value1'
56 and: 'the public property in the result has the correct name and value'
57 assert objectUnderTest.publicProperties[0].name == 'myPublicProperty'
58 assert objectUnderTest.publicProperties[0].value == 'value2'
59 and: 'the composite state matches the composite state of the ncmpServiceCmHandle'
60 objectUnderTest.getCompositeState().cmHandleState == CmHandleState.LOCKED
61 objectUnderTest.getCompositeState() == ncmpServiceCmHandle.getCompositeState()
64 def 'Resolve DMI service name: #scenario and #requiredService service require.'() {
65 given: 'a yang model cm handle'
66 def objectUnderTest = YangModelCmHandle.toYangModelCmHandle(dmiServiceName, dmiDataServiceName,
67 dmiModelServiceName, new NcmpServiceCmHandle(cmHandleId: 'cm-handle-id-1'),'')
69 assert objectUnderTest.resolveDmiServiceName(requiredService) == expectedService
71 scenario | dmiServiceName | dmiDataServiceName | dmiModelServiceName | requiredService || expectedService
72 'common service registered' | 'common service' | 'does not matter' | 'does not matter' | DATA || 'common service'
73 'common service registered' | 'common service' | 'does not matter' | 'does not matter' | MODEL || 'common service'
74 'common service empty' | '' | 'data service' | 'does not matter' | DATA || 'data service'
75 'common service empty' | '' | 'does not matter' | 'model service' | MODEL || 'model service'
76 'common service blank' | ' ' | 'data service' | 'does not matter' | DATA || 'data service'
77 'common service blank' | ' ' | 'does not matter' | 'model service' | MODEL || 'model service'
78 'common service null ' | null | 'data service' | 'does not matter' | DATA || 'data service'
79 'common service null' | null | 'does not matter' | 'model service' | MODEL || 'model service'
80 'only model service registered' | null | null | 'does not matter' | DATA || null
81 'only data service registered' | null | 'does not matter' | null | MODEL || null
84 def 'Yang Model Cm Handle Deep Copy'() {
85 given: 'a yang model cm handle'
86 def currentYangModelCmHandle = new YangModelCmHandle(id: 'cmhandle',
87 publicProperties: [new YangModelCmHandle.Property('publicProperty1', 'value1')],
88 dmiProperties: [new YangModelCmHandle.Property('dmiProperty1', 'value1')],
89 compositeState: new CompositeState(cmHandleState: CmHandleState.ADVISED, dataSyncEnabled: false))
90 when: 'a deep copy is created'
91 def yangModelCmhandleDeepCopy = YangModelCmHandle.deepCopyOf(currentYangModelCmHandle)
92 and: 'we try to mutate current yang model cm handle'
93 currentYangModelCmHandle.id = 'cmhandle-changed'
94 currentYangModelCmHandle.dmiProperties = [new YangModelCmHandle.Property('updatedPublicProperty1', 'value1')]
95 currentYangModelCmHandle.publicProperties = [new YangModelCmHandle.Property('updatedDmiProperty1', 'value1')]
96 currentYangModelCmHandle.compositeState.cmHandleState = CmHandleState.READY
97 currentYangModelCmHandle.compositeState.dataSyncEnabled = true
98 then: 'there is no change in the deep copied object'
99 assert yangModelCmhandleDeepCopy.id == 'cmhandle'
100 assert yangModelCmhandleDeepCopy.dmiProperties == [new YangModelCmHandle.Property('dmiProperty1', 'value1')]
101 assert yangModelCmhandleDeepCopy.publicProperties == [new YangModelCmHandle.Property('publicProperty1', 'value1')]
102 assert yangModelCmhandleDeepCopy.compositeState.cmHandleState == CmHandleState.ADVISED
103 assert yangModelCmhandleDeepCopy.compositeState.dataSyncEnabled == false
104 and: 'equality on reference and hashcode behave as expected'
105 assert currentYangModelCmHandle.hashCode() != yangModelCmhandleDeepCopy.hashCode()
106 assert currentYangModelCmHandle != yangModelCmhandleDeepCopy