Removed ExtendedModuleReference Object
[cps.git] / cps-service / src / test / groovy / org / onap / cps / api / impl / CpsModuleServiceImplSpec.groovy
index 5f2168a..bae06bb 100644 (file)
@@ -1,13 +1,15 @@
 /*
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2020 Nordix Foundation
- *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
+ *  Copyright (C) 2020-2022 Nordix Foundation
+ *  Modifications Copyright (C) 2020-2021 Pantheon.tech
+ *  Modifications Copyright (C) 2020-2022 Bell Canada.
  *  ================================================================================
  *  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.
@@ -24,40 +26,39 @@ import org.onap.cps.TestUtils
 import org.onap.cps.api.CpsAdminService
 import org.onap.cps.spi.CpsModulePersistenceService
 import org.onap.cps.spi.exceptions.ModelValidationException
+import org.onap.cps.spi.exceptions.SchemaSetInUseException
+import org.onap.cps.spi.model.Anchor
 import org.onap.cps.spi.model.ModuleReference
-import org.spockframework.spring.SpringBean
-import org.springframework.beans.factory.annotation.Autowired
-import org.springframework.boot.test.context.SpringBootTest
-import org.springframework.cache.CacheManager
-import org.springframework.cache.caffeine.CaffeineCacheManager
-import org.springframework.context.annotation.ComponentScan
-import org.springframework.test.context.ContextConfiguration
+import org.onap.cps.yang.YangTextSchemaSourceSetBuilder
 import spock.lang.Specification
-import spock.lang.Unroll
-
 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED
 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED
 
-@SpringBootTest
-@ComponentScan("org.onap.cps")
-@ContextConfiguration(classes = CpsModuleServiceImplSpec.class)
 class CpsModuleServiceImplSpec extends Specification {
-    @SpringBean
-    CpsModulePersistenceService mockModuleStoreService = Mock()
-    @SpringBean
-    CpsAdminService mockCpsAdminService = Mock()
-    @Autowired
-    CpsModuleServiceImpl objectUnderTest = new CpsModuleServiceImpl()
-    @SpringBean
-    CacheManager cacheManager = new CaffeineCacheManager("yangSchema");
-
-    def 'Create schema set'() {
+
+    def mockCpsModulePersistenceService = Mock(CpsModulePersistenceService)
+    def mockCpsAdminService = Mock(CpsAdminService)
+    def mockYangTextSchemaSourceSetCache = Mock(YangTextSchemaSourceSetCache)
+
+    def objectUnderTest = new CpsModuleServiceImpl(mockCpsModulePersistenceService, mockYangTextSchemaSourceSetCache, mockCpsAdminService)
+
+    def 'Create schema set.'() {
         given: 'Valid yang resource as name-to-content map'
             def yangResourcesNameToContentMap = TestUtils.getYangResourcesAsMap('bookstore.yang')
         when: 'Create schema set method is invoked'
             objectUnderTest.createSchemaSet('someDataspace', 'someSchemaSet', yangResourcesNameToContentMap)
         then: 'Parameters are validated and processing is delegated to persistence service'
-            1 * mockModuleStoreService.storeSchemaSet('someDataspace', 'someSchemaSet', yangResourcesNameToContentMap)
+            1 * mockCpsModulePersistenceService.storeSchemaSet('someDataspace', 'someSchemaSet', yangResourcesNameToContentMap)
+    }
+
+    def 'Create schema set from new modules and existing modules.'() {
+        given: 'a list of existing modules module reference'
+            def moduleReferenceForExistingModule = new ModuleReference("test",  "2021-10-12","test.org")
+            def listOfExistingModulesModuleReference = [moduleReferenceForExistingModule]
+        when: 'create schema set from modules method is invoked'
+            objectUnderTest.createSchemaSetFromModules("someDataspaceName", "someSchemaSetName", [newModule: "newContent"], listOfExistingModulesModuleReference)
+        then: 'processing is delegated to persistence service'
+            1 * mockCpsModulePersistenceService.storeSchemaSetFromModules("someDataspaceName", "someSchemaSetName", [newModule: "newContent"], listOfExistingModulesModuleReference)
     }
 
     def 'Create schema set from invalid resources'() {
@@ -72,35 +73,87 @@ class CpsModuleServiceImplSpec extends Specification {
     def 'Get schema set by name and dataspace.'() {
         given: 'an already present schema set'
             def yangResourcesNameToContentMap = TestUtils.getYangResourcesAsMap('bookstore.yang')
-            mockModuleStoreService.getYangSchemaResources('someDataspace', 'someSchemaSet') >> yangResourcesNameToContentMap
+        and: 'yang resource cache returns the expected schema set'
+            mockYangTextSchemaSourceSetCache.get('someDataspace', 'someSchemaSet') >> YangTextSchemaSourceSetBuilder.of(yangResourcesNameToContentMap)
         when: 'get schema set method is invoked'
             def result = objectUnderTest.getSchemaSet('someDataspace', 'someSchemaSet')
         then: 'the correct schema set is returned'
             result.getName().contains('someSchemaSet')
             result.getDataspaceName().contains('someDataspace')
-            result.getModuleReferences().contains(new ModuleReference('stores', 'org:onap:ccsdk:sample', '2020-09-15'))
+            result.getModuleReferences().contains(new ModuleReference('stores', '2020-09-15', 'org:onap:ccsdk:sample'))
     }
 
-    def 'Schema set caching.'() {
-        given: 'an  schema set'
-            def yangResourcesNameToContentMap = TestUtils.getYangResourcesAsMap('bookstore.yang')
-        when: 'get schema set method is invoked twice'
-            2.times {
-                objectUnderTest.getSchemaSet('someDataspace', 'someSchemaSet')
-            }
-        then: 'the persistency service called only once'
-            1 * mockModuleStoreService.getYangSchemaResources('someDataspace', 'someSchemaSet') >> yangResourcesNameToContentMap
+    def 'Delete schema-set when cascade is allowed.'() {
+        given: '#numberOfAnchors anchors are associated with schemaset'
+            def associatedAnchors = createAnchors(numberOfAnchors)
+            mockCpsAdminService.getAnchors('my-dataspace', 'my-schemaset') >> associatedAnchors
+        when: 'schema set deletion is requested with cascade allowed'
+            objectUnderTest.deleteSchemaSet('my-dataspace', 'my-schemaset', CASCADE_DELETE_ALLOWED)
+        then: 'anchor deletion is called #numberOfAnchors times'
+            numberOfAnchors * mockCpsAdminService.deleteAnchor('my-dataspace', _)
+        and: 'persistence service method is invoked with same parameters'
+            1 * mockCpsModulePersistenceService.deleteSchemaSet('my-dataspace', 'my-schemaset')
+        and: 'schema set will be removed from the cache'
+            1 * mockYangTextSchemaSourceSetCache.removeFromCache('my-dataspace', 'my-schemaset')
+        and: 'orphan yang resources are deleted'
+            1 * mockCpsModulePersistenceService.deleteUnusedYangResourceModules()
+        where: 'following parameters are used'
+            numberOfAnchors << [0, 3]
     }
 
-    @Unroll
-    def 'Delete set by name and dataspace with #cascadeDeleteOption.'(){
-        when: 'schema set deletion is requested'
-            objectUnderTest.deleteSchemaSet(dataspaceName, schemaSetname, cascadeDeleteOption)
-        then: 'persistence service method is invoked with same parameters'
-            mockModuleStoreService.deleteSchemaSet(dataspaceName, schemaSetname, cascadeDeleteOption)
-        where: 'following parameters are used'
-            dataspaceName | schemaSetname | cascadeDeleteOption
-            'dataspace-1'  | 'schemas-set-1' | CASCADE_DELETE_ALLOWED
-            'dataspace-2'  | 'schemas-set-2' | CASCADE_DELETE_PROHIBITED
+    def 'Delete schema-set when cascade is prohibited.'() {
+        given: 'no anchors are associated with schemaset'
+            mockCpsAdminService.getAnchors('my-dataspace', 'my-schemaset') >> Collections.emptyList()
+        when: 'schema set deletion is requested with cascade allowed'
+            objectUnderTest.deleteSchemaSet('my-dataspace', 'my-schemaset', CASCADE_DELETE_PROHIBITED)
+        then: 'no anchors are deleted'
+            0 * mockCpsAdminService.deleteAnchor(_, _)
+        and: 'persistence service method is invoked with same parameters'
+            1 * mockCpsModulePersistenceService.deleteSchemaSet('my-dataspace', 'my-schemaset')
+        and: 'schema set will be removed from the cache'
+            1 * mockYangTextSchemaSourceSetCache.removeFromCache('my-dataspace', 'my-schemaset')
+        and: 'orphan yang resources are deleted'
+            1 * mockCpsModulePersistenceService.deleteUnusedYangResourceModules()
+    }
+
+    def 'Delete schema-set when cascade is prohibited and schema-set has anchors.'() {
+        given: '2 anchors are associated with schemaset'
+            mockCpsAdminService.getAnchors('my-dataspace', 'my-schemaset') >> createAnchors(2)
+        when: 'schema set deletion is requested with cascade allowed'
+            objectUnderTest.deleteSchemaSet('my-dataspace', 'my-schemaset', CASCADE_DELETE_PROHIBITED)
+        then: 'Schema-Set in Use exception is thrown'
+            thrown(SchemaSetInUseException)
+    }
+
+    def createAnchors(int anchorCount) {
+        def anchors = []
+        (0..<anchorCount).each { anchors.add(new Anchor("my-anchor-$it", 'my-dataspace', 'my-schemaset')) }
+        return anchors
+    }
+
+    def 'Get all yang resources module references.'() {
+        given: 'an already present module reference'
+            def moduleReferences = [new ModuleReference('some module name','some revision name')]
+            mockCpsModulePersistenceService.getYangResourceModuleReferences('someDataspaceName') >> moduleReferences
+        expect: 'the list provided by persistence service is returned as result'
+            objectUnderTest.getYangResourceModuleReferences('someDataspaceName') == moduleReferences
+    }
+
+
+    def 'Get all yang resources module references for the given dataspace name and anchor name.'() {
+        given: 'the module store service service returns a list module references'
+            def moduleReferences = [new ModuleReference()]
+            mockCpsModulePersistenceService.getYangResourceModuleReferences('someDataspaceName', 'someAnchorName') >> moduleReferences
+        expect: 'the list provided by persistence service is returned as result'
+            objectUnderTest.getYangResourcesModuleReferences('someDataspaceName', 'someAnchorName') == moduleReferences
+    }
+
+    def 'Identifying new module references'(){
+        given: 'module references from cm handle'
+            def moduleReferencesToCheck = [new ModuleReference('some-module', 'some-revision')]
+        when: 'identifyNewModuleReferences is called'
+            objectUnderTest.identifyNewModuleReferences(moduleReferencesToCheck)
+        then: 'cps module persistence service is called with module references to check'
+            1 * mockCpsModulePersistenceService.identifyNewModuleReferences(moduleReferencesToCheck);
     }
 }