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=8675f42a51dd20dc1a7f9b497b881b47123498b9;hb=be21595d53636e2c9b912bfbe8dfdefb81edc70f;hp=f6df3ce9eaf80a97fd6fb5f13cf70d04c8bcde77;hpb=5e1a5a7bde3a1650b86e2d22edde26520439757f;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 f6df3ce9e..8675f42a5 --- 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,12 +1,15 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2021 Nordix Foundation + * Modifications Copyright (C) 2021 Pantheon.tech + * Modifications Copyright (C) 2021 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. @@ -19,10 +22,20 @@ 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.CpsAdminService import org.onap.cps.api.CpsDataService import org.onap.cps.api.CpsModuleService +import org.onap.cps.api.CpsQueryService +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,43 +43,196 @@ 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 - -@WebMvcTest +@WebMvcTest(DataRestController) class DataRestControllerSpec extends Specification { @SpringBean CpsDataService mockCpsDataService = Mock() - @SpringBean - CpsModuleService mockCpsModuleService = Mock() - - @SpringBean - CpsAdminService mockCpsAdminService = Mock() - - @SpringBean - ModelMapper modelMapper = Mock() - @Autowired MockMvc mvc @Value('${rest.api.cps-base-path}') def basePath + def dataNodeBaseEndpoint def dataspaceName = 'my_dataspace' def anchorName = 'my_anchor' - def 'Create a node.'() { - given:'an endpoint' - def nodeEndpoint ="$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes" + @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: #scenario.'() { + 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' + when: 'post is invoked with datanode endpoint and json' + def response = + mvc.perform( + post(endpoint) + .contentType(MediaType.APPLICATION_JSON) + .param('xpath', parentNodeXpath) + .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) + where: 'following xpath parameters are are used' + scenario | parentNodeXpath + 'no xpath parameter' | '' + 'xpath parameter point root' | '/' + } + + def 'Create a child node'() { + given: 'some json to create a data node' + def endpoint = "$dataNodeBaseEndpoint/anchors/$anchorName/nodes" + def json = 'some json (this is not validated)' + and: 'parent node xpath' + def parentNodeXpath = 'some xpath' + when: 'post is invoked with datanode endpoint and json' + def response = + mvc.perform( + post(endpoint) + .contentType(MediaType.APPLICATION_JSON) + .param('xpath', parentNodeXpath) + .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, parentNodeXpath, json) + } + + def 'Create list node child elements.'() { + given: 'parent node xpath and json data inputs' + def parentNodeXpath = 'parent node xpath' + def jsonData = 'json data' + when: 'post is invoked list-node endpoint' + def response = mvc.perform( + post("$dataNodeBaseEndpoint/anchors/$anchorName/list-node") + .contentType(MediaType.APPLICATION_JSON) + .param('xpath', parentNodeXpath) + .content(jsonData) + ).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.saveListNodeData(dataspaceName, anchorName, parentNodeXpath, jsonData) + } + + 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"]') + } + + 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 + } + + 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', inputXpath) + ).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 | inputXpath || xpathServiceParameter + 'root node by default' | '' || '/' + 'root node by choice' | '/' || '/' + 'some xpath by parent' | '/some/xpath' || '/some/xpath' + } + + 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', inputXpath)) + .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 | inputXpath || xpathServiceParameter + 'root node by default' | '' || '/' + 'root node by choice' | '/' || '/' + 'some xpath by parent' | '/some/xpath' || '/some/xpath' + } + + def 'Replace list node child elements.'() { + given: 'parent node xpath and json data inputs' + def parentNodeXpath = 'parent node xpath' + def jsonData = 'json data' + when: 'patch is invoked list-node endpoint' + def response = mvc.perform( + patch("$dataNodeBaseEndpoint/anchors/$anchorName/list-node") + .contentType(MediaType.APPLICATION_JSON) + .param('xpath', parentNodeXpath) + .content(jsonData) + ).andReturn().response + then: 'a success response is returned' + response.status == HttpStatus.OK.value() + then: 'the java API was called with the correct parameters' + 1 * mockCpsDataService.replaceListNodeData(dataspaceName, anchorName, parentNodeXpath, jsonData) } -} \ No newline at end of file +}