summaryrefslogtreecommitdiffstats
path: root/cps-service/src/test/groovy/org/onap/cps/api/impl/CpServiceImplSpec.groovy
blob: 2a3d5cbc5f21464a69105a4f192aac1cea9719e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2020 Nordix Foundation
 *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
 *  ================================================================================
 *  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.api.impl

import org.onap.cps.TestUtils
import org.onap.cps.api.model.AnchorDetails
import org.onap.cps.exceptions.CpsValidationException
import org.onap.cps.spi.DataPersistenceService
import org.onap.cps.spi.FragmentPersistenceService
import org.opendaylight.yangtools.yang.common.Revision
import org.opendaylight.yangtools.yang.model.api.SchemaContext
import spock.lang.Specification

class CpServiceImplSpec extends Specification {

    def mockDataPersistenceService = Mock(DataPersistenceService)
    def mockFragmentPersistenceService = Mock(FragmentPersistenceService)
    def objectUnderTest = new CpServiceImpl()

    def setup() {
        objectUnderTest.dataPersistenceService = mockDataPersistenceService
        objectUnderTest.fragmentPersistenceService = mockFragmentPersistenceService
    }

    def 'Cps Service provides to its client the id assigned by the system when storing a data structure'() {
        given: 'that data persistence service is giving id 123 to a data structure it is asked to store'
            mockDataPersistenceService.storeJsonStructure(_) >> 123
        expect: 'Cps service returns the same id when storing data structure'
            objectUnderTest.storeJsonStructure('') == 123
    }

    def 'Parse and Validate a Yang Model with a Valid Yang Model'() {
        given: 'a yang model (file)'
            def yangModel = TestUtils.getResourceFileContent('bookstore.yang')
        when: 'a valid model is parsed and validated'
            def result = objectUnderTest.parseAndValidateModel(yangModel)
        then: 'Verify a schema context for that model is created with the correct identity'
            assertModule(result)
    }

    def 'Parse and Validate a Yang Model Using a File'() {
        given: 'a yang file that contains a yang model'
            File file = new File(ClassLoader.getSystemClassLoader().getResource('bookstore.yang').getFile())
        when: 'a model is parsed and validated'
            def result = objectUnderTest.parseAndValidateModel(file)
        then: 'Verify a schema context for that model is created with the correct identity'
            assertModule(result)

    }

    def assertModule(SchemaContext schemaContext){
        def optionalModule = schemaContext.findModule('stores', Revision.of('2020-09-15'))
        return schemaContext.modules.size() == 1 && optionalModule.isPresent()
    }

    def 'Parse and Validate an Invalid Model'() {
        given: 'a yang file that contains a invalid yang model'
            File file = new File(ClassLoader.getSystemClassLoader().getResource('invalid.yang').getFile())
        when: 'the model is parsed and validated'
            objectUnderTest.parseAndValidateModel(file)
        then: 'a CpsValidationException is thrown'
            thrown(CpsValidationException)
    }

    def 'Store a SchemaContext'() {
        expect: 'No exception to be thrown when a valid model (schema) is stored'
            objectUnderTest.storeSchemaContext(Stub(SchemaContext.class), "sampleDataspace")
    }

    def 'Read a JSON object with a valid identifier'(){
        given: 'that the data persistence service returns a JSON structure for identifier 1'
            mockDataPersistenceService.getJsonById(1) >> '{name : hello}'
        expect: 'that the same JSON structure is returned by CPS'
            objectUnderTest.getJsonById(1) == '{name : hello}'
    }

    def 'Read a JSON object with an identifier that does not exist'(){
        given: 'that the data persistence service throws an exception'
            def exceptionThrownByPersistenceService = new IllegalStateException()
            mockDataPersistenceService.getJsonById(_) >> {throw exceptionThrownByPersistenceService}
        when: 'we try to get the JSON structure'
            objectUnderTest.getJsonById(1);
        then: 'the same exception is thrown by CPS'
            thrown(IllegalStateException)
    }

    def 'Delete a JSON object with a valid identifier'(){
        given: 'that the data persistence service can delete a JSON structure for identifier 1'
            mockDataPersistenceService.deleteJsonById(1)
        expect: 'No exception is thrown when we delete a JSON structure with identifier 1'
            objectUnderTest.deleteJsonById(1)
    }

    def 'Delete a JSON object with an identifier that does not exist'(){
        given: 'that the data persistence service throws an exception'
            mockDataPersistenceService.deleteJsonById(_) >> {throw new IllegalStateException()}
        when: 'we try to delete a JSON structure'
            objectUnderTest.deleteJsonById(100);
        then: 'the same exception is thrown by CPS'
            thrown(IllegalStateException)
    }

    def 'Create an anchor with a non-existant dataspace'(){
        given: 'that the dataspace does not exist service throws an exception'
            AnchorDetails anchorDetails = new AnchorDetails()
            anchorDetails.setDataspace('dummyDataspace')
            mockFragmentPersistenceService.createAnchor(anchorDetails) >> {throw new CpsValidationException(_ as String, _ as String)}
        when: 'we try to create a anchor with a non-existant dataspace'
            objectUnderTest.createAnchor(anchorDetails)
        then: 'the same exception is thrown by CPS'
            thrown(CpsValidationException)
    }

    def 'Create an anchor with invalid dataspace, namespace and revision'(){
        given: 'that the dataspace, namespace and revison combination does not exist service throws an exception'
            AnchorDetails anchorDetails = new AnchorDetails()
            anchorDetails.setDataspace('dummyDataspace')
            anchorDetails.setNamespace('dummyNamespace')
            anchorDetails.setRevision('dummyRevision')
            mockFragmentPersistenceService.createAnchor(anchorDetails) >> {throw new CpsValidationException(_ as String, _ as String)}
        when: 'we try to create a anchor with a non-existant dataspace, namespace and revison combination'
            objectUnderTest.createAnchor(anchorDetails)
        then: 'the same exception is thrown by CPS'
            thrown(CpsValidationException)
    }

    def 'Create a duplicate anchor'(){
        given: 'that the anchor already exist service throws an exception'
            AnchorDetails anchorDetails = new AnchorDetails()
            anchorDetails.setDataspace('dummyDataspace')
            anchorDetails.setNamespace('dummyNamespace')
            anchorDetails.setRevision('dummyRevision')
            anchorDetails.setRevision('dummyAnchorName')
            mockFragmentPersistenceService.createAnchor(anchorDetails) >> {throw new CpsValidationException(_ as String, _ as String)}
        when: 'we try to create a duplicate anchor'
            objectUnderTest.createAnchor(anchorDetails)
        then: 'the same exception is thrown by CPS'
            thrown(CpsValidationException)
    }

    def 'Create an anchor with supplied anchor name, dataspace, namespace and revision'(){
        given: 'that the anchor does not pre-exist service creates an anchor'
            AnchorDetails anchorDetails = new AnchorDetails()
            anchorDetails.setDataspace('dummyDataspace')
            anchorDetails.setNamespace('dummyNamespace')
            anchorDetails.setRevision('dummyRevision')
            anchorDetails.setRevision('dummyAnchorName')
            mockFragmentPersistenceService.createAnchor(anchorDetails) >> 'dummyAnchorName'
        expect: 'anchor name is returned by service'
            objectUnderTest.createAnchor(anchorDetails) == 'dummyAnchorName'
    }
}