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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2023 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.init
import ch.qos.logback.classic.Level
import ch.qos.logback.classic.Logger
import ch.qos.logback.core.read.ListAppender
import org.onap.cps.api.CpsAdminService
import org.onap.cps.api.CpsDataService
import org.onap.cps.api.CpsModuleService
import org.onap.cps.ncmp.api.impl.exception.NcmpStartUpException
import org.onap.cps.spi.exceptions.AlreadyDefinedException
import org.onap.cps.spi.exceptions.DataValidationException
import org.onap.cps.spi.exceptions.SchemaSetNotFoundException
import org.onap.cps.spi.model.Dataspace
import org.springframework.boot.SpringApplication
import org.slf4j.LoggerFactory
import org.springframework.boot.context.event.ApplicationReadyEvent
import org.springframework.context.annotation.AnnotationConfigApplicationContext
import spock.lang.Specification
class SubscriptionModelLoaderSpec extends Specification {
def mockCpsAdminService = Mock(CpsAdminService)
def mockCpsModuleService = Mock(CpsModuleService)
def mockCpsDataService = Mock(CpsDataService)
def objectUnderTest = new SubscriptionModelLoader(mockCpsAdminService, mockCpsModuleService, mockCpsDataService)
def sampleYangContentMap = ['subscription.yang':'module subscription { *sample content* }']
def applicationContext = new AnnotationConfigApplicationContext()
def applicationReadyEvent = new ApplicationReadyEvent(new SpringApplication(), null, applicationContext, null)
def yangResourceToContentMap
def logger = (Logger) LoggerFactory.getLogger(objectUnderTest.getClass())
def loggingListAppender
void setup() {
yangResourceToContentMap = objectUnderTest.createYangResourceToContentMap()
logger.setLevel(Level.DEBUG)
loggingListAppender = new ListAppender()
logger.addAppender(loggingListAppender)
loggingListAppender.start()
applicationContext.refresh()
}
void cleanup() {
((Logger) LoggerFactory.getLogger(SubscriptionModelLoader.class)).detachAndStopAllAppenders()
applicationContext.close()
}
def 'Onboard subscription model successfully via application ready event'() {
given: 'dataspace is ready for use'
mockCpsAdminService.getDataspace('NCMP-Admin') >> new Dataspace('NCMP-Admin')
and:'model loader is enabled'
objectUnderTest.subscriptionModelLoaderEnabled = true
and: 'maximum attempt count is set'
objectUnderTest.maximumAttemptCount = 20
and: 'retry time is set'
objectUnderTest.retryTimeMs = 100
when: 'the application is ready'
objectUnderTest.onApplicationEvent(applicationReadyEvent)
then: 'the module service to create schema set is called once'
1 * mockCpsModuleService.createSchemaSet('NCMP-Admin', 'subscriptions',sampleYangContentMap)
and: 'the admin service to create an anchor set is called once'
1 * mockCpsAdminService.createAnchor('NCMP-Admin', 'subscriptions', 'AVC-Subscriptions')
and: 'the data service to create a top level datanode is called once'
1 * mockCpsDataService.saveData('NCMP-Admin', 'AVC-Subscriptions', '{"subscription-registry":{}}', _)
}
def 'No subscription model onboarding when subscription model loader is disabled' () {
when: 'model loader is disabled'
objectUnderTest.subscriptionModelLoaderEnabled = false
and: 'application is ready'
objectUnderTest.onApplicationEvent(applicationReadyEvent)
and: 'dataspace is ready for use'
mockCpsAdminService.getDataspace('NCMP-Admin') >> new Dataspace('NCMP-Admin')
then: 'the module service to create schema set was not called'
0 * mockCpsModuleService.createSchemaSet(*_)
and: 'the admin service to create an anchor set was not called'
0 * mockCpsAdminService.createAnchor(*_)
and: 'the data service to create a top level datanode was not called'
0 * mockCpsDataService.saveData(*_)
}
def 'Onboard subscription model fails as NCMP dataspace does not exist' () {
given: 'model loader is enabled'
objectUnderTest.subscriptionModelLoaderEnabled = true
and: 'maximum attempt count is set'
objectUnderTest.maximumAttemptCount = 20
and: 'retry time is set'
objectUnderTest.retryTimeMs = 100
when: 'the application is ready'
objectUnderTest.onApplicationEvent(applicationReadyEvent)
then: 'the module service to create schema set was not called'
0 * mockCpsModuleService.createSchemaSet(*_)
and: 'the admin service to create an anchor set was not called'
0 * mockCpsAdminService.createAnchor(*_)
and: 'the data service to create a top level datanode was not called'
0 * mockCpsDataService.saveData(*_)
and: 'the log message contains the correct exception message'
def logs = loggingListAppender.list.toString()
assert logs.contains("Retrieval of NCMP dataspace fails")
}
def 'Exception occurred while schema set creation' () {
given: 'creating a schema set throws an exception'
mockCpsModuleService.createSchemaSet(*_) >> { throw new DataValidationException(*_) }
and: 'model loader is enabled'
objectUnderTest.subscriptionModelLoaderEnabled = true
and: 'dataspace is ready for use'
mockCpsAdminService.getDataspace('NCMP-Admin') >> new Dataspace('NCMP-Admin')
when: 'application is ready'
objectUnderTest.onApplicationEvent(applicationReadyEvent)
then: 'the admin service to create an anchor set was not called'
0 * mockCpsAdminService.createAnchor(*_)
and: 'the data service to create a top level datanode was not called'
0 * mockCpsDataService.saveData(*_)
}
def 'Create schema set from model file'() {
when: 'the method to create schema set is called with the following parameters'
objectUnderTest.createSchemaSet("myDataspace", "mySchemaSet", yangResourceToContentMap)
then: 'yang resource to content map is as expected'
assert sampleYangContentMap == yangResourceToContentMap
and: 'the module service to create schema set is called once with the correct map'
1 * mockCpsModuleService.createSchemaSet(_, _, yangResourceToContentMap)
}
def 'Create schema set fails due to AlreadyDefined exception'() {
given: 'creating a schema set throws an exception as it already exists'
mockCpsModuleService.createSchemaSet('NCMP-Admin', 'subscriptions', yangResourceToContentMap) >>
{ throw AlreadyDefinedException.forSchemaSet('subscriptions', "sampleContextName", null) }
when: 'the method to onboard model is called'
objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the admin service to create an anchor set is then called once'
1 * mockCpsAdminService.createAnchor('NCMP-Admin', 'subscriptions', 'AVC-Subscriptions')
}
def 'Create schema set fails due to any other exception'() {
given: 'creating a schema set throws an exception'
mockCpsModuleService.createSchemaSet(*_) >> { throw new NcmpStartUpException("Creating schema set failed", "") }
when: 'the method to onboard model is called'
objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the log message contains the correct exception message'
def debugMessage = loggingListAppender.list[0].toString()
assert debugMessage.contains("Creating schema set failed")
and: 'exception is thrown'
thrown(NcmpStartUpException)
}
def 'Create anchor fails due to AlreadyDefined exception'() {
given: 'creating anchor throws an exception as it already exists'
mockCpsAdminService.createAnchor(*_) >>
{ throw AlreadyDefinedException.forSchemaSet('subscriptions', "sampleContextName", null) }
when: 'the method to onboard model is called'
objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'no exception thrown'
noExceptionThrown()
and: 'the log message contains the correct exception message'
def infoMessage = loggingListAppender.list[0].toString()
assert infoMessage.contains("already exists")
}
def 'Create anchor fails due to any other exception'() {
given: 'creating an anchor failed'
mockCpsAdminService.createAnchor(*_) >>
{ throw new SchemaSetNotFoundException('NCMP-Admin', 'subscriptions') }
when: 'the method to onboard model is called'
objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the log message contains the correct exception message'
def debugMessage = loggingListAppender.list[0].toString()
assert debugMessage.contains("Schema Set not found")
and: 'exception is thrown'
thrown(NcmpStartUpException)
}
def 'Create top level node fails due to an AlreadyDefined exception'() {
given: 'the saving of the node data will throw an Already Defined exception'
mockCpsDataService.saveData(*_) >>
{ throw AlreadyDefinedException.forDataNodes(['/xpath'], "sampleContextName") }
when: 'the method to onboard model is called'
objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'no exception thrown'
noExceptionThrown()
and: 'the log message contains the correct exception message'
def infoMessage = loggingListAppender.list[0].toString()
assert infoMessage.contains("already exists")
}
def 'Create top level node fails due to any other exception'() {
given: 'the saving of the node data will throw an exception'
mockCpsDataService.saveData(*_) >>
{ throw new DataValidationException("Invalid JSON", "JSON Data is invalid") }
when: 'the method to onboard model is called'
objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the log message contains the correct exception message'
def debugMessage = loggingListAppender.list[0].toString()
assert debugMessage.contains("Creating data node for subscription model failed: Invalid JSON")
and: 'exception is thrown'
thrown(NcmpStartUpException)
}
def 'Get file content as string'() {
when: 'the method to get yang content is called'
objectUnderTest.getFileContentAsString('NonExistingFile')
then: 'exception is thrown'
thrown(NcmpStartUpException)
}
}
|
