import ch.qos.logback.classic.Level
import ch.qos.logback.classic.Logger
import ch.qos.logback.core.read.ListAppender
-import org.junit.jupiter.api.AfterEach
-import org.junit.jupiter.api.BeforeEach
import org.onap.cps.api.CpsAdminService
import org.onap.cps.api.CpsDataService
import org.onap.cps.api.CpsModuleService
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 mockCpsDataService = Mock(CpsDataService)
def objectUnderTest = new SubscriptionModelLoader(mockCpsAdminService, mockCpsModuleService, mockCpsDataService)
- def SUBSCRIPTION_DATASPACE_NAME = objectUnderTest.SUBSCRIPTION_DATASPACE_NAME;
- def SUBSCRIPTION_ANCHOR_NAME = objectUnderTest.SUBSCRIPTION_ANCHOR_NAME;
- def SUBSCRIPTION_SCHEMASET_NAME = objectUnderTest.SUBSCRIPTION_SCHEMASET_NAME;
- def SUBSCRIPTION_REGISTRY_DATANODE_NAME = objectUnderTest.SUBSCRIPTION_REGISTRY_DATANODE_NAME;
-
def sampleYangContentMap = ['subscription.yang':'module subscription { *sample content* }']
- def applicationReadyEvent = new ApplicationReadyEvent(new SpringApplication(), null, null, null)
+ def applicationContext = new AnnotationConfigApplicationContext()
+
+ def applicationReadyEvent = new ApplicationReadyEvent(new SpringApplication(), null, applicationContext, null)
- def logger
- def appender
+ def yangResourceToContentMap
+ def logger = (Logger) LoggerFactory.getLogger(objectUnderTest.getClass())
+ def loggingListAppender
- @BeforeEach
void setup() {
- logger = (Logger) LoggerFactory.getLogger(objectUnderTest.getClass())
- appender = new ListAppender()
+ yangResourceToContentMap = objectUnderTest.createYangResourceToContentMap()
logger.setLevel(Level.DEBUG)
- appender.start()
- logger.addAppender(appender)
+ loggingListAppender = new ListAppender()
+ logger.addAppender(loggingListAppender)
+ loggingListAppender.start()
+ applicationContext.refresh()
}
- @AfterEach
- void teardown() {
- ((Logger) LoggerFactory.getLogger(SubscriptionModelLoader.class)).detachAndStopAllAppenders();
+ void cleanup() {
+ ((Logger) LoggerFactory.getLogger(SubscriptionModelLoader.class)).detachAndStopAllAppenders()
+ applicationContext.close()
}
def 'Onboard subscription model successfully via application ready event'() {
- when:'model loader is enabled'
+ given: 'dataspace is ready for use'
+ mockCpsAdminService.getDataspace('NCMP-Admin') >> new Dataspace('NCMP-Admin')
+ and:'model loader is enabled'
objectUnderTest.subscriptionModelLoaderEnabled = true
- and: 'the application is ready'
+ 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(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME,sampleYangContentMap)
+ 1 * mockCpsModuleService.createSchemaSet('NCMP-Admin', 'subscriptions',sampleYangContentMap)
and: 'the admin service to create an anchor set is called once'
- 1 * mockCpsAdminService.createAnchor(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME)
+ 1 * mockCpsAdminService.createAnchor('NCMP-Admin', 'subscriptions', 'AVC-Subscriptions')
and: 'the data service to create a top level datanode is called once'
- 1 * mockCpsDataService.saveData(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_ANCHOR_NAME, '{"' + SUBSCRIPTION_REGISTRY_DATANODE_NAME + '":{}}', _)
+ 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'() {
- given: 'the method to create yang resource to content map returns the correct map'
- def yangResourceToContentMap = objectUnderTest.createYangResourceToContentMap()
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'
}
def 'Create schema set fails due to AlreadyDefined exception'() {
- given: 'the method to create yang resource to content map returns the correct map'
- def yangResourceToContentMap = objectUnderTest.createYangResourceToContentMap()
- and: 'creating a schema set throws an exception as it already exists'
- mockCpsModuleService.createSchemaSet(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, yangResourceToContentMap) >>
- { throw AlreadyDefinedException.forSchemaSet(SUBSCRIPTION_SCHEMASET_NAME, "sampleContextName", null) }
+ 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()
+ objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the admin service to create an anchor set is then called once'
- 1 * mockCpsAdminService.createAnchor(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME)
+ 1 * mockCpsAdminService.createAnchor('NCMP-Admin', 'subscriptions', 'AVC-Subscriptions')
}
def 'Create schema set fails due to any other exception'() {
- given: 'the method to create yang resource to content map returns the correct map'
- def yangResourceToContentMap = objectUnderTest.createYangResourceToContentMap()
- and: 'creating a schema set throws an exception'
- mockCpsModuleService.createSchemaSet(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, yangResourceToContentMap) >>
- { throw new NcmpStartUpException("Creating schema set failed", ""); }
+ 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()
+ objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the log message contains the correct exception message'
- def debugMessage = appender.list[0].toString()
+ 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(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME) >>
- { throw AlreadyDefinedException.forSchemaSet(SUBSCRIPTION_SCHEMASET_NAME, "sampleContextName", null) }
+ mockCpsAdminService.createAnchor(*_) >>
+ { throw AlreadyDefinedException.forSchemaSet('subscriptions', "sampleContextName", null) }
when: 'the method to onboard model is called'
- objectUnderTest.onboardSubscriptionModel()
+ 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(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME) >>
- { throw new SchemaSetNotFoundException(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME) }
+ mockCpsAdminService.createAnchor(*_) >>
+ { throw new SchemaSetNotFoundException('NCMP-Admin', 'subscriptions') }
when: 'the method to onboard model is called'
- objectUnderTest.onboardSubscriptionModel()
+ objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the log message contains the correct exception message'
- def debugMessage = appender.list[0].toString()
+ 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(*_) >>
- { AlreadyDefinedException.forDataNode('/xpath', "sampleContextName", null) }
+ { throw AlreadyDefinedException.forDataNode('/xpath', "sampleContextName", null) }
when: 'the method to onboard model is called'
- objectUnderTest.onboardSubscriptionModel()
+ 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'() {
mockCpsDataService.saveData(*_) >>
{ throw new DataValidationException("Invalid JSON", "JSON Data is invalid") }
when: 'the method to onboard model is called'
- objectUnderTest.onboardSubscriptionModel()
+ objectUnderTest.onboardSubscriptionModel(yangResourceToContentMap)
then: 'the log message contains the correct exception message'
- def debugMessage = appender.list[0].toString()
+ 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'
- def response = objectUnderTest.getFileContentAsString()
- then: 'the response is as expected'
- assert response == 'module subscription { *sample content* }'
+ objectUnderTest.getFileContentAsString('NonExistingFile')
+ then: 'exception is thrown'
+ thrown(NcmpStartUpException)
}
-}
\ No newline at end of file
+}
Code Review / cps.git / blobdiff