diff options
Diffstat (limited to 'cps-rest')
4 files changed, 126 insertions, 16 deletions
diff --git a/cps-rest/docs/api/swagger/components.yml b/cps-rest/docs/api/swagger/components.yml index 9e306cda5d..3694f36cd3 100755 --- a/cps-rest/docs/api/swagger/components.yml +++ b/cps-rest/docs/api/swagger/components.yml @@ -68,9 +68,9 @@ components: schema: type: string xpathInQuery: - name: cps-path + name: xpath in: query - description: cps-path + description: xpath required: false schema: type: string diff --git a/cps-rest/docs/api/swagger/cpsData.yml b/cps-rest/docs/api/swagger/cpsData.yml index 9abace2047..eabed28365 100755 --- a/cps-rest/docs/api/swagger/cpsData.yml +++ b/cps-rest/docs/api/swagger/cpsData.yml @@ -48,6 +48,59 @@ nodesByDataspaceAndAnchor: '403': $ref: 'components.yml#/components/responses/Forbidden' + patch: + description: Update a data node leaves for a given dataspace and anchor and a parent node xpath + tags: + - cps-data + summary: Update node leaves + operationId: updateNodeLeaves + parameters: + - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yml#/components/parameters/anchorNameInPath' + - $ref: 'components.yml#/components/parameters/xpathInQuery' + requestBody: + required: true + content: + application/json: + schema: + type: string + responses: + '200': + $ref: 'components.yml#/components/responses/Ok' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden' + + put: + description: Replace a node with descendants for a given dataspace, anchor and a parent node xpath + tags: + - cps-data + summary: Replace a node with descendants + operationId: replaceNode + parameters: + - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' + - $ref: 'components.yml#/components/parameters/anchorNameInPath' + - $ref: 'components.yml#/components/parameters/xpathInQuery' + requestBody: + required: true + content: + application/json: + schema: + type: string + responses: + '200': + $ref: 'components.yml#/components/responses/Ok' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden' + + nodesByDataspace: get: description: Get all nodes for a given dataspace using an xpath or schema node identifier - DRAFT diff --git a/cps-rest/src/main/java/org/onap/cps/rest/controller/DataRestController.java b/cps-rest/src/main/java/org/onap/cps/rest/controller/DataRestController.java index c39a9696e3..8366f06b38 100755 --- a/cps-rest/src/main/java/org/onap/cps/rest/controller/DataRestController.java +++ b/cps-rest/src/main/java/org/onap/cps/rest/controller/DataRestController.java @@ -54,15 +54,29 @@ public class DataRestController implements CpsDataApi { @Override public ResponseEntity<Object> getNodeByDataspaceAndAnchor(final String dataspaceName, final String anchorName, - final String cpsPath, final Boolean includeDescendants) { - if ("/".equals(cpsPath)) { + final String xpath, final Boolean includeDescendants) { + if ("/".equals(xpath)) { // TODO: extracting data by anchor only (root data node and below) return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); } final FetchDescendantsOption fetchDescendantsOption = Boolean.TRUE.equals(includeDescendants) ? FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS : FetchDescendantsOption.OMIT_DESCENDANTS; final DataNode dataNode = - cpsDataService.getDataNode(dataspaceName, anchorName, cpsPath, fetchDescendantsOption); + cpsDataService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption); return new ResponseEntity<>(DataMapUtils.toDataMap(dataNode), HttpStatus.OK); } + + @Override + public ResponseEntity<Object> updateNodeLeaves(final String jsonData, final String dataspaceName, + final String anchorName, final String parentNodeXpath) { + cpsDataService.updateNodeLeaves(dataspaceName, anchorName, parentNodeXpath, jsonData); + return new ResponseEntity<>(HttpStatus.OK); + } + + @Override + public ResponseEntity<Object> replaceNode(final String jsonData, final String dataspaceName, + final String anchorName, final String parentNodeXpath) { + cpsDataService.replaceNodeTree(dataspaceName, anchorName, parentNodeXpath, jsonData); + return new ResponseEntity<>(HttpStatus.OK); + } } 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 index a79b5f440d..c5fd162030 100644 --- 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 @@ -23,7 +23,9 @@ 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 @@ -72,7 +74,7 @@ class DataRestControllerSpec extends Specification { @Shared static DataNode dataNodeWithLeavesNoChildren = new DataNodeBuilder().withXpath('/xpath') - .withLeaves([leaf:'value', leafList:['leaveListElement1','leaveListElement2']]).build() + .withLeaves([leaf: 'value', leafList: ['leaveListElement1', 'leaveListElement2']]).build() @Shared static DataNode dataNodeWithChild = new DataNodeBuilder().withXpath('/parent') @@ -102,8 +104,7 @@ class DataRestControllerSpec extends Specification { mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, OMIT_DESCENDANTS) >> dataNodeWithLeavesNoChildren when: 'get request is performed through REST API' def response = mvc.perform( - get(dataNodeEndpoint) - .param('cps-path', xpath) + get(dataNodeEndpoint).param('xpath', xpath) ).andReturn().response then: 'a success response is returned' response.status == HttpStatus.OK.value() @@ -120,18 +121,18 @@ class DataRestControllerSpec extends Specification { mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, expectedCpsDataServiceOption) >> dataNode when: 'get request is performed through REST API' def response = mvc.perform(get(dataNodeEndpoint) - .param('cps-path', xpath) - .param('include-descendants', urlOption)) - .andReturn().response + .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 | urlOption || 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 + 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 @@ -140,7 +141,7 @@ class DataRestControllerSpec extends Specification { 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) + get(dataNodeEndpoint).param("xpath", xpath) ).andReturn().response then: 'a success response is returned' response.status == httpStatus.value() @@ -151,4 +152,46 @@ class DataRestControllerSpec extends Specification { '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' + when: 'patch request is performed' + def response = mvc.perform( + patch(dataNodeEndpoint) + .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' + when: 'put request is performed' + def response = mvc.perform( + put(dataNodeEndpoint) + .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' + } } |