X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-rest%2Fsrc%2Ftest%2Fgroovy%2Forg%2Fonap%2Fcps%2Frest%2Fcontroller%2FDataRestControllerSpec.groovy;h=b9b680d35fdec9627a7a498c3d14bb6220ce67c2;hb=f2ce686eeb0781afb6766034581d9508d3501d55;hp=bed3ba2c90340e8ff5603af10578d924707194fa;hpb=e7f94478a241f8ee7618da08f6bc8495e9f5a504;p=cps.git diff --git a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy old mode 100644 new mode 100755 index bed3ba2c9..b9b680d35 --- a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy +++ b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy @@ -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. @@ -19,10 +20,23 @@ 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.patch +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put + import org.modelmapper.ModelMapper +import org.onap.cps.api.CpsQueryService 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 +44,9 @@ 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 static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post +import spock.lang.Unroll @WebMvcTest class DataRestControllerSpec extends Specification { @@ -46,27 +60,148 @@ class DataRestControllerSpec extends Specification { @SpringBean CpsAdminService mockCpsAdminService = Mock() + @SpringBean + CpsQueryService mockCpsQueryService = Mock() + @SpringBean ModelMapper modelMapper = Mock() @Autowired MockMvc mvc - @Value('${rest.api.base-path}') + @Value('${rest.api.cps-base-path}') def basePath + def dataNodeBaseEndpoint def dataspaceName = 'my_dataspace' def anchorName = 'my_anchor' + @Shared + static DataNode dataNodeWithLeavesNoChildren = new DataNodeBuilder().withXpath('/xpath') + .withLeaves([leaf: 'value', leafList: ['leaveListElement1', 'leaveListElement2']]).build() + + @Shared + static DataNode dataNodeWithChild = new DataNodeBuilder().withXpath('/parent') + .withChildDataNodes([new DataNodeBuilder().withXpath("/parent/child").build()]).build() + + def setup() { + dataNodeBaseEndpoint = "$basePath/v1/dataspaces/$dataspaceName" + } + def 'Create a node.'() { - given:'an endpoint' - def nodeEndpoint ="$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes" + given: 'some json to create a data node' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/nodes" 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 - then: 'the java API is called with the correct parameters' - 1 * mockCpsDataService.saveData(dataspaceName, anchorName, json) + when: 'post is invoked with datanode endpoint and json' + def response = mvc.perform( + post(endpoint).contentType(MediaType.APPLICATION_JSON).content(json) + ).andReturn().response + then: 'a created response is returned' response.status == HttpStatus.CREATED.value() + then: 'the java API was called with the correct parameters' + 1 * mockCpsDataService.saveData(dataspaceName, anchorName, json) + } + + @Unroll + def 'Get data node with leaves'() { + given: 'the service returns data node leaves' + def xpath = 'some xPath' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/node" + mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, OMIT_DESCENDANTS) >> dataNodeWithLeavesNoChildren + when: 'get request is performed through REST API' + def response = mvc.perform( + get(endpoint).param('xpath', xpath) + ).andReturn().response + then: 'a success response is returned' + response.status == HttpStatus.OK.value() + and: 'response contains expected leaf and value' + response.contentAsString.contains('"leaf":"value"') + and: 'response contains expected leaf-list and values' + response.contentAsString.contains('"leafList":["leaveListElement1","leaveListElement2"]') + } + + @Unroll + def 'Get data node with #scenario.'() { + given: 'the service returns data node with #scenario' + def xpath = 'some xPath' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/node" + mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, expectedCpsDataServiceOption) >> dataNode + when: 'get request is performed through REST API' + def response = mvc.perform(get(endpoint) + .param('xpath', xpath) + .param('include-descendants', includeDescendantsOption)) + .andReturn().response + then: 'a success response is returned' + response.status == HttpStatus.OK.value() + and: 'the response contains child is #expectChildInResponse' + response.contentAsString.contains('"child"') == expectChildInResponse + where: + scenario | dataNode | includeDescendantsOption || expectedCpsDataServiceOption | expectChildInResponse + 'no descendants by default' | dataNodeWithLeavesNoChildren | '' || OMIT_DESCENDANTS | false + 'no descendant explicitly' | dataNodeWithLeavesNoChildren | 'false' || OMIT_DESCENDANTS | false + 'with descendants' | dataNodeWithChild | 'true' || INCLUDE_ALL_DESCENDANTS | true + } + + @Unroll + def 'Get data node error scenario: #scenario.'() { + given: 'the service throws an exception' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/node" + mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, _) >> { throw exception } + when: 'get request is performed through REST API' + def response = mvc.perform( + get(endpoint).param("xpath", xpath) + ).andReturn().response + then: 'a success response is 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 + } + + @Unroll + def 'Update data node leaves: #scenario.'() { + given: 'json data' + def jsonData = 'json data' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/nodes" + when: 'patch request is performed' + def response = mvc.perform( + patch(endpoint) + .contentType(MediaType.APPLICATION_JSON) + .content(jsonData) + .param('xpath', xpath) + ).andReturn().response + then: 'the service method is invoked with expected parameters' + 1 * mockCpsDataService.updateNodeLeaves(dataspaceName, anchorName, xpathServiceParameter, jsonData) + and: 'response status indicates success' + response.status == HttpStatus.OK.value() + where: + scenario | xpath | xpathServiceParameter + 'root node by default' | '' | '/' + 'node by parent xpath' | '/xpath' | '/xpath' + } + + @Unroll + def 'Replace data node tree: #scenario.'() { + given: 'json data' + def jsonData = 'json data' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/nodes" + when: 'put request is performed' + def response = mvc.perform( + put(endpoint) + .contentType(MediaType.APPLICATION_JSON) + .content(jsonData) + .param('xpath', xpath) + ).andReturn().response + then: 'the service method is invoked with expected parameters' + 1 * mockCpsDataService.replaceNodeTree(dataspaceName, anchorName, xpathServiceParameter, jsonData) + and: 'response status indicates success' + response.status == HttpStatus.OK.value() + where: + scenario | xpath | xpathServiceParameter + 'root node by default' | '' | '/' + 'node by parent xpath' | '/xpath' | '/xpath' } -} \ No newline at end of file +}