Fetching data node by xpath - rest and service layers
[cps.git] / cps-rest / src / test / groovy / org / onap / cps / rest / controller / DataRestControllerSpec.groovy
index f6df3ce..727a16e 100644 (file)
@@ -1,6 +1,7 @@
 /*
  *  ============LICENSE_START=======================================================
  *  Copyright (C) 2021 Nordix Foundation
+ *  Modifications Copyright (C) 2021 Pantheon.tech
  *  ================================================================================
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
 
 package org.onap.cps.rest.controller
 
+import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS
+import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
+
+import com.google.common.collect.ImmutableMap
 import org.modelmapper.ModelMapper
 import org.onap.cps.api.CpsAdminService
 import org.onap.cps.api.CpsDataService
 import org.onap.cps.api.CpsModuleService
+import org.onap.cps.spi.exceptions.AnchorNotFoundException
+import org.onap.cps.spi.exceptions.DataNodeNotFoundException
+import org.onap.cps.spi.exceptions.DataspaceNotFoundException
+import org.onap.cps.spi.model.DataNode
+import org.onap.cps.spi.model.DataNodeBuilder
 import org.spockframework.spring.SpringBean
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Value
@@ -30,9 +42,11 @@ import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
 import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.test.web.servlet.MockMvc
+import spock.lang.Shared
 import spock.lang.Specification
+import spock.lang.Unroll
 
-import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post
+import javax.annotation.PostConstruct
 
 @WebMvcTest
 class DataRestControllerSpec extends Specification {
@@ -55,18 +69,73 @@ class DataRestControllerSpec extends Specification {
     @Value('${rest.api.cps-base-path}')
     def basePath
 
+    String dataNodeEndpoint
     def dataspaceName = 'my_dataspace'
     def anchorName = 'my_anchor'
 
+    @Shared
+    static DataNode dataNodeNoChildren = new DataNodeBuilder().withXpath("/xpath")
+            .withLeaves(ImmutableMap.of("leaf", "value")).build()
+
+    @Shared
+    static DataNode dataNodeWithChild = new DataNodeBuilder().withXpath("/parent")
+            .withChildDataNodes(Arrays.asList(
+                    new DataNodeBuilder().withXpath("/parent/child").build()
+            )).build()
+
+    @PostConstruct
+    def initEndpoints() {
+        dataNodeEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes"
+    }
+
     def 'Create a node.'() {
-        given:'an endpoint'
-            def nodeEndpoint ="$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes"
+        given: 'an endpoint'
             def json = 'some json (this is not validated)'
         when: 'post is invoked'
-            def response = mvc.perform(post(nodeEndpoint).contentType(MediaType.APPLICATION_JSON).content(json))
-                    .andReturn().response
+            def response = mvc.perform(
+                    post(dataNodeEndpoint).contentType(MediaType.APPLICATION_JSON).content(json)
+            ).andReturn().response
         then: 'the java API is called with the correct parameters'
             1 * mockCpsDataService.saveData(dataspaceName, anchorName, json)
             response.status == HttpStatus.CREATED.value()
     }
+
+    @Unroll
+    def 'Get data node with #scenario.'() {
+        given: 'the service returns data node #scenario'
+            mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption) >> dataNode
+        when: 'get request is performed through REST API'
+            def response = mvc.perform(
+                    get(dataNodeEndpoint)
+                            .param('cps-path', xpath)
+                            .param('include-descendants', includeDescendants)
+            ).andReturn().response
+        then: 'assert the success response returned'
+            response.status == HttpStatus.OK.value()
+        and: 'response contains expected value'
+            response.contentAsString.contains(checkString)
+        where:
+            scenario                    | dataNode           | xpath     | includeDescendants | fetchDescendantsOption  || checkString
+            'no descendants by default' | dataNodeNoChildren | '/xpath'  | ''                 | OMIT_DESCENDANTS        || '"leaf"'
+            'no descendant explicitly'  | dataNodeNoChildren | '/xpath'  | 'false'            | OMIT_DESCENDANTS        || '"leaf"'
+            'with descendants'          | dataNodeWithChild  | '/parent' | 'true'             | INCLUDE_ALL_DESCENDANTS || '"child"'
+    }
+
+    @Unroll
+    def 'Get data node error scenario: #scenario.'() {
+        given: 'the service returns throws an exception'
+            mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, _) >> { throw exception }
+        when: 'get request is performed through REST API'
+            def response = mvc.perform(
+                    get(dataNodeEndpoint).param("cps-path", xpath)
+            ).andReturn().response
+        then: 'assert the success response returned'
+            response.status == httpStatus.value()
+        where:
+            scenario       | xpath     | exception                                 || httpStatus
+            'no dataspace' | '/x-path' | new DataspaceNotFoundException('')        || HttpStatus.BAD_REQUEST
+            'no anchor'    | '/x-path' | new AnchorNotFoundException('', '')       || HttpStatus.BAD_REQUEST
+            'no data'      | '/x-path' | new DataNodeNotFoundException('', '', '') || HttpStatus.NOT_FOUND
+            'empty path'   | ''        | new IllegalStateException()               || HttpStatus.NOT_IMPLEMENTED
+    }
 }
\ No newline at end of file