Merge "Subscription model with status and predicates"
[cps.git] / cps-rest / src / test / groovy / org / onap / cps / rest / controller / AdminRestControllerSpec.groovy
index 41ad9ca..f81efd6 100755 (executable)
@@ -3,6 +3,7 @@
  *  Copyright (C) 2020-2021 Pantheon.tech
  *  Modifications Copyright (C) 2020-2021 Bell Canada.
  *  Modifications Copyright (C) 2021-2022 Nordix Foundation
+ *  Modifications Copyright (C) 2022 TechMahindra Ltd.
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -34,6 +35,7 @@ import org.onap.cps.api.CpsModuleService
 import org.onap.cps.spi.exceptions.AlreadyDefinedException
 import org.onap.cps.spi.exceptions.SchemaSetInUseException
 import org.onap.cps.spi.model.Anchor
+import org.onap.cps.spi.model.Dataspace
 import org.onap.cps.spi.model.SchemaSet
 import org.spockframework.spring.SpringBean
 import org.springframework.beans.factory.annotation.Autowired
@@ -69,22 +71,25 @@ class AdminRestControllerSpec extends Specification {
     def anchorName = 'my_anchor'
     def schemaSetName = 'my_schema_set'
     def anchor = new Anchor(name: anchorName, dataspaceName: dataspaceName, schemaSetName: schemaSetName)
+    def dataspace = new Dataspace(name: dataspaceName)
 
-    def 'Create new dataspace.'() {
-        given: 'an endpoint'
-            def createDataspaceEndpoint = "$basePath/v1/dataspaces"
+    def 'Create new dataspace with #scenario.'() {
         when: 'post is invoked'
             def response =
                     mvc.perform(
-                            post(createDataspaceEndpoint)
+                            post("/cps/api/${apiVersion}/dataspaces")
                                     .param('dataspace-name', dataspaceName))
                             .andReturn().response
         then: 'service method is invoked with expected parameters'
             1 * mockCpsAdminService.createDataspace(dataspaceName)
         and: 'dataspace is create successfully'
             response.status == HttpStatus.CREATED.value()
-    }
-
+            assert response.getContentAsString() == expectedResponseBody
+        where: 'following cases are tested'
+            scenario | apiVersion  || expectedResponseBody
+            'V1 API' | 'v1'        || 'my_dataspace'
+            'V2 API' | 'v2'        || ''
+    } 
     def 'Create dataspace over existing with same name.'() {
         given: 'an endpoint'
             def createDataspaceEndpoint = "$basePath/v1/dataspaces"
@@ -101,16 +106,39 @@ class AdminRestControllerSpec extends Specification {
             response.status == HttpStatus.CONFLICT.value()
     }
 
-    def 'Create schema set from yang file.'() {
+    def 'Get a dataspace.'() {
+        given: 'service method returns a dataspace'
+            mockCpsAdminService.getDataspace(dataspaceName) >> dataspace
+        and: 'an endpoint'
+            def getDataspaceEndpoint = "$basePath/v1/admin/dataspaces/$dataspaceName"
+        when: 'get dataspace API is invoked'
+            def response = mvc.perform(get(getDataspaceEndpoint)).andReturn().response
+        then: 'the correct dataspace is returned'
+            response.status == HttpStatus.OK.value()
+            response.getContentAsString().contains(dataspaceName)
+    }
+
+    def 'Get all dataspaces.'() {
+        given: 'service method returns all dataspace'
+            mockCpsAdminService.getAllDataspaces() >> [dataspace, new Dataspace(name: "dataspace-test2")]
+        and: 'an endpoint'
+            def getAllDataspaceEndpoint = "$basePath/v1/admin/dataspaces"
+        when: 'get all dataspace API is invoked'
+            def response = mvc.perform(get(getAllDataspaceEndpoint)).andReturn().response
+        then: 'the correct dataspace is returned'
+            response.status == HttpStatus.OK.value()
+            response.getContentAsString().contains(dataspaceName)
+            response.getContentAsString().contains("dataspace-test2")
+    }
+
+    def 'Create schema set from yang file with #scenario.'() {
         def yangResourceMapCapture
         given: 'single yang file'
             def multipartFile = createMultipartFile("filename.yang", "content")
-        and: 'an endpoint'
-            def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets"
         when: 'file uploaded with schema set create request'
             def response =
                     mvc.perform(
-                            multipart(schemaSetEndpoint)
+                            multipart("/cps/api/${apiVersion}/dataspaces/my_dataspace/schema-sets")
                                     .file(multipartFile)
                                     .param('schema-set-name', schemaSetName))
                             .andReturn().response
@@ -119,19 +147,22 @@ class AdminRestControllerSpec extends Specification {
                     { args -> yangResourceMapCapture = args[2] }
             yangResourceMapCapture['filename.yang'] == 'content'
         and: 'response code indicates success'
-            response.status == HttpStatus.CREATED.value()
+            assert response.status == HttpStatus.CREATED.value()
+            assert response.getContentAsString() == expectedResponseBody
+        where: 'following cases are tested'
+            scenario | apiVersion || expectedResponseBody
+            'V1 API' | 'v1'       || 'my_schema_set'
+            'V2 API' | 'v2'       || ''
     }
 
-    def 'Create schema set from zip archive.'() {
+    def 'Create schema set from zip archive with #scenario.'() {
         def yangResourceMapCapture
         given: 'zip archive with multiple .yang files inside'
             def multipartFile = createZipMultipartFileFromResource("/yang-files-set.zip")
-        and: 'an endpoint'
-            def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets"
         when: 'file uploaded with schema set create request'
             def response =
                     mvc.perform(
-                            multipart(schemaSetEndpoint)
+                            multipart("/cps/api/${apiVersion}/dataspaces/my_dataspace/schema-sets")
                                     .file(multipartFile)
                                     .param('schema-set-name', schemaSetName))
                             .andReturn().response
@@ -141,25 +172,33 @@ class AdminRestControllerSpec extends Specification {
             yangResourceMapCapture['assembly.yang'] == "fake assembly content 1\n"
             yangResourceMapCapture['component.yang'] == "fake component content 1\n"
         and: 'response code indicates success'
-            response.status == HttpStatus.CREATED.value()
+            assert response.status == HttpStatus.CREATED.value()
+            assert response.getContentAsString() == expectedResponseBody
+        where: 'following cases are tested'
+            scenario | apiVersion || expectedResponseBody
+            'V1 API' | 'v1'       || 'my_schema_set'
+            'V2 API' | 'v2'       || ''
     }
 
-    def 'Create a schema set from a yang file that is greater than 1MB.'() {
+    def 'Create a schema set from a yang file that is greater than 1MB #scenario.'() {
         given: 'a yang file greater than 1MB'
             def multipartFile = createMultipartFileFromResource("/model-over-1mb.yang")
-        and: 'an endpoint'
-            def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets"
         when: 'a file is uploaded to the create schema set endpoint'
             def response =
                     mvc.perform(
-                            multipart(schemaSetEndpoint)
+                            multipart("/cps/api/${apiVersion}/dataspaces/my_dataspace/schema-sets")
                                     .file(multipartFile)
                                     .param('schema-set-name', schemaSetName))
                             .andReturn().response
         then: 'the associated service method is invoked'
             1 * mockCpsModuleService.createSchemaSet(dataspaceName, schemaSetName, _)
         and: 'the response code indicates success'
-            response.status == HttpStatus.CREATED.value()
+            assert response.status == HttpStatus.CREATED.value()
+            assert response.getContentAsString() == expectedResponseBody
+        where: 'following cases are tested'
+            scenario | apiVersion || expectedResponseBody
+            'V1 API' | 'v1'       || 'my_schema_set'
+            'V2 API' | 'v2'       || ''
     }
 
     def 'Create schema set from zip archive having #caseDescriptor.'() {
@@ -250,23 +289,41 @@ class AdminRestControllerSpec extends Specification {
             response.getContentAsString().contains(schemaSetName)
     }
 
-    def 'Create Anchor.'() {
+    def 'Get all schema sets for a given dataspace name.'() {
+        given: 'service method returns all schema sets for a dataspace'
+            mockCpsModuleService.getSchemaSets(dataspaceName) >>
+                [new SchemaSet(name: schemaSetName, dataspaceName: dataspaceName),
+                new SchemaSet(name: "test-schemaset", dataspaceName: dataspaceName)]
+        and: 'an endpoint'
+            def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets"
+        when: 'get schema sets API is invoked'
+            def response = mvc.perform(get(schemaSetEndpoint)).andReturn().response
+        then: 'the correct schema sets is returned'
+            assert response.status == HttpStatus.OK.value()
+            assert response.getContentAsString() == '[{"dataspaceName":"my_dataspace","moduleReferences":[],"name":' +
+                   '"my_schema_set"},{"dataspaceName":"my_dataspace","moduleReferences":[],"name":"test-schemaset"}]'
+    }
+
+    def 'Create Anchor with #scenario.'() {
         given: 'request parameters'
             def requestParams = new LinkedMultiValueMap<>()
             requestParams.add('schema-set-name', schemaSetName)
             requestParams.add('anchor-name', anchorName)
-        and: 'an endpoint'
-            def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors"
         when: 'post is invoked'
             def response =
                     mvc.perform(
-                            post(anchorEndpoint).contentType(MediaType.APPLICATION_JSON)
+                            post("/cps/api/${apiVersion}/dataspaces/my_dataspace/anchors")
+                                    .contentType(MediaType.APPLICATION_JSON)
                                     .params(requestParams as MultiValueMap))
-                            .andReturn().response
+                                    .andReturn().response
         then: 'anchor is created successfully'
             1 * mockCpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName)
-            response.status == HttpStatus.CREATED.value()
-            response.getContentAsString().contains(anchorName)
+            assert response.status == HttpStatus.CREATED.value()
+            assert response.getContentAsString() == expectedResponseBody
+        where: 'following cases are tested'
+            scenario | apiVersion || expectedResponseBody
+            'V1 API' | 'v1'       || 'my_anchor'
+            'V2 API' | 'v2'       || ''
     }
 
     def 'Get existing anchor.'() {