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=c5fd1620304858185dfcb83be995172a7204d985;hpb=24c72db6b3674bde16eb5a7313d71f507a880de9;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 c5fd16203..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 @@ -2,12 +2,14 @@ * ============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. @@ -31,9 +33,7 @@ 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.api.CpsQueryService import org.onap.cps.spi.model.DataNode import org.onap.cps.spi.model.DataNodeBuilder import org.spockframework.spring.SpringBean @@ -45,30 +45,20 @@ import org.springframework.http.MediaType import org.springframework.test.web.servlet.MockMvc import spock.lang.Shared import spock.lang.Specification -import spock.lang.Unroll -@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 dataNodeEndpoint + def dataNodeBaseEndpoint def dataspaceName = 'my_dataspace' def anchorName = 'my_anchor' @@ -81,31 +71,77 @@ class DataRestControllerSpec extends Specification { .withChildDataNodes([new DataNodeBuilder().withXpath("/parent/child").build()]).build() def setup() { - dataNodeEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes" + 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 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 node.'() { + 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(dataNodeEndpoint).contentType(MediaType.APPLICATION_JSON).content(json) + 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.saveData(dataspaceName, anchorName, json) + 1 * mockCpsDataService.saveListNodeData(dataspaceName, anchorName, parentNodeXpath, jsonData) } - @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(dataNodeEndpoint).param('xpath', xpath) - ).andReturn().response + 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' @@ -114,16 +150,18 @@ class DataRestControllerSpec extends Specification { 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(dataNodeEndpoint) - .param('xpath', xpath) - .param('include-descendants', includeDescendantsOption)) - .andReturn().response + 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' @@ -135,63 +173,66 @@ class DataRestControllerSpec extends Specification { 'with descendants' | dataNodeWithChild | 'true' || INCLUDE_ALL_DESCENDANTS | true } - @Unroll - def 'Get data node error scenario: #scenario.'() { - given: 'the service 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("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(dataNodeEndpoint) - .contentType(MediaType.APPLICATION_JSON) - .content(jsonData) - .param('xpath', xpath) - ).andReturn().response + 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 | xpath | xpathServiceParameter - 'root node by default' | '' | '/' - 'node by parent xpath' | '/xpath' | '/xpath' + scenario | inputXpath || xpathServiceParameter + 'root node by default' | '' || '/' + 'root node by choice' | '/' || '/' + 'some xpath by parent' | '/some/xpath' || '/some/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(dataNodeEndpoint) - .contentType(MediaType.APPLICATION_JSON) - .content(jsonData) - .param('xpath', xpath) - ).andReturn().response + 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 | xpath | xpathServiceParameter - 'root node by default' | '' | '/' - 'node by parent xpath' | '/xpath' | '/xpath' + 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) } }