schema:
type: boolean
default: false
+ cpsPathInQuery:
+ name: cps-path
+ in: query
+ description: cps-path
+ required: false
+ schema:
+ type: string
+ default: /
+
responses:
NotFound:
/v1/cm-handles/{cm-handle}/node:
$ref: 'xnfProxy.yml#/nodeByCmHandleAndXpath'
+ /v1/cm-handles/{cm-handle}/nodes/query:
+ $ref: 'xnfProxy.yml#/nodesByCmHandleAndCpsPath'
+
+ /v1/cm-handles/{cm-handle}/nodes:
+ $ref: 'xnfProxy.yml#/nodesByCmHandleAndXpath'
\ No newline at end of file
$ref: 'components.yaml#/components/responses/NotFound'
501:
$ref: 'components.yaml#/components/responses/NotImplemented'
+
+nodesByCmHandleAndCpsPath:
+ get:
+ description: Query nodes for the given cps path and cm Handle
+ tags:
+ - nf-proxy
+ summary: Query data nodes
+ operationId: queryNodesByCmHandleAndCpsPath
+ parameters:
+ - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+ - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
+ responses:
+ 200:
+ $ref: 'components.yaml#/components/responses/Ok'
+ 400:
+ $ref: 'components.yaml#/components/responses/BadRequest'
+ 401:
+ $ref: 'components.yaml#/components/responses/Unauthorized'
+ 403:
+ $ref: 'components.yaml#/components/responses/Forbidden'
+ 404:
+ $ref: 'components.yaml#/components/responses/NotFound'
+
+nodesByCmHandleAndXpath:
+ patch:
+ description: Update node leaves for the given cps path and cm Handle
+ tags:
+ - nf-proxy
+ summary: Update node leaves
+ operationId: updateNodeLeaves
+ parameters:
+ - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+ - $ref: 'components.yaml#/components/parameters/xpathInQuery'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: string
+ responses:
+ 200:
+ $ref: 'components.yaml#/components/responses/Ok'
+ 400:
+ $ref: 'components.yaml#/components/responses/BadRequest'
+ 401:
+ $ref: 'components.yaml#/components/responses/Unauthorized'
+ 403:
+ $ref: 'components.yaml#/components/responses/Forbidden'
+ 404:
+ $ref: 'components.yaml#/components/responses/NotFound'
+
+ put:
+ description: Replace a node with descendants for the given cps path and cm Handle
+ tags:
+ - nf-proxy
+ summary: Replace a node with descendants
+ operationId: replaceNode
+ parameters:
+ - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
+ - $ref: 'components.yaml#/components/parameters/xpathInQuery'
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ type: string
+ responses:
+ 200:
+ $ref: 'components.yaml#/components/responses/Ok'
+ 400:
+ $ref: 'components.yaml#/components/responses/BadRequest'
+ 401:
+ $ref: 'components.yaml#/components/responses/Unauthorized'
+ 403:
+ $ref: 'components.yaml#/components/responses/Forbidden'
+ 404:
+ $ref: 'components.yaml#/components/responses/NotFound'
\ No newline at end of file
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Pantheon.tech
- * ================================================================================
+ * Modifications (C) 2021 Nordix Foundation
* Modification Copyright (C) 2021 highstreet technologies GmbH
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
package org.onap.cps.nfproxy.rest.controller;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import java.util.Collection;
import javax.validation.Valid;
import org.onap.cps.nfproxy.api.NfProxyDataService;
import org.onap.cps.nfproxy.rest.api.NfProxyApi;
@RequestMapping("${rest.api.xnf-base-path}")
public class NfProxyController implements NfProxyApi {
+ private static final Gson GSON = new GsonBuilder().create();
private static final String XPATH_ROOT = "/";
@Autowired
@Override
public ResponseEntity<Object> getNodeByCmHandleAndXpath(final String cmHandle, @Valid final String xpath,
- @Valid final Boolean includeDescendants) {
+ @Valid final Boolean includeDescendants) {
if (XPATH_ROOT.equals(xpath)) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
}
final DataNode dataNode = nfProxyDataService.getDataNode(cmHandle, xpath, fetchDescendantsOption);
return new ResponseEntity<>(DataMapUtils.toDataMap(dataNode), HttpStatus.OK);
}
+
+ @Override
+ public ResponseEntity<Object> queryNodesByCmHandleAndCpsPath(final String cmHandle, @Valid final String cpsPath) {
+ final Collection<DataNode> dataNodes = nfProxyDataService.queryDataNodes(cmHandle, cpsPath);
+ return new ResponseEntity<>(GSON.toJson(dataNodes), HttpStatus.OK);
+ }
+
+ @Override
+ public ResponseEntity<Object> replaceNode(@Valid final String jsonData, final String cmHandle,
+ @Valid final String parentNodeXpath) {
+ nfProxyDataService.replaceNodeTree(cmHandle, parentNodeXpath, jsonData);
+ return new ResponseEntity<>(HttpStatus.OK);
+ }
+
+ @Override
+ public ResponseEntity<Object> updateNodeLeaves(@Valid final String jsonData, final String cmHandle,
+ @Valid final String parentNodeXpath) {
+ nfProxyDataService.updateNodeLeaves(cmHandle, parentNodeXpath, jsonData);
+ return new ResponseEntity<>(HttpStatus.OK);
+ }
}
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 Pantheon.tech
- * ================================================================================
* Modification Copyright (C) 2021 highstreet technologies GmbH
+ * Modification Copyright (C) 2021 Nordix Foundation
* ================================================================================
* 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.nfproxy.rest.controller
+import com.google.common.collect.ImmutableMap
+import com.google.gson.Gson
import org.onap.cps.nfproxy.api.NfProxyDataService
+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
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.Specification
-import spock.lang.Unroll
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.*
@WebMvcTest
class NfProxyControllerSpec extends Specification {
dataNodeBaseEndpoint = "$basePath/v1"
}
- @Unroll
+ def cmHandle = 'some handle'
+ def xpath = 'some xpath'
+
+ def 'Query data node by cps path for the given cm handle.'() {
+ given: 'service method returns a list containing a data node'
+ def cpsPath = '/xpath/leaves[@leaf=\'value\']'
+ def dataNode = new DataNodeBuilder().withXpath("/xpath")
+ .withLeaves(ImmutableMap.of("leaf", "value")).build()
+ ArrayList<DataNode> dataNodeList = new ArrayList();
+ dataNodeList.add(dataNode)
+ mockNfProxyDataService.queryDataNodes(cmHandle, cpsPath) >> dataNodeList
+ and: 'the query endpoint'
+ def dataNodeEndpoint = "$dataNodeBaseEndpoint/cm-handles/$cmHandle/nodes/query"
+ when: 'query data nodes API is invoked'
+ def response = mvc.perform(get(dataNodeEndpoint).param('cps-path', cpsPath)).andReturn().response
+ then: 'the response contains the the datanode in json format'
+ response.status == HttpStatus.OK.value()
+ def expectedJsonContent = new Gson().toJson(dataNode)
+ response.getContentAsString().contains(expectedJsonContent)
+ }
+
+ def 'Update data node leaves.'() {
+ given: 'json data'
+ def jsonData = 'json data'
+ and: 'the query endpoint'
+ def endpoint = "$dataNodeBaseEndpoint/cm-handles/$cmHandle/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 once with expected parameters'
+ 1 * mockNfProxyDataService.updateNodeLeaves(cmHandle, xpath, jsonData)
+ and: 'response status indicates success'
+ response.status == HttpStatus.OK.value()
+ }
+
+ def 'Replace data node tree.'() {
+ given: 'json data'
+ def jsonData = 'json data'
+ and: 'the query endpoint'
+ def endpoint = "$dataNodeBaseEndpoint/cm-handles/$cmHandle/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 once with expected parameters'
+ 1 * mockNfProxyDataService.replaceNodeTree(cmHandle, xpath, jsonData)
+ and: 'response status indicates success'
+ response.status == HttpStatus.OK.value()
+ }
+
def 'Get data node.'() {
given: 'the service returns a data node'
def xpath = 'some xpath'
- def cmHandle = 'some handle'
def dataNode = new DataNodeBuilder().withXpath(xpath).withLeaves(["leaf": "value"]).build()
- def endpoint = "$dataNodeBaseEndpoint/cm-handles/$cmHandle/node"
mockNfProxyDataService.getDataNode(cmHandle, xpath, OMIT_DESCENDANTS) >> dataNode
+ and: 'the query endpoint'
+ def endpoint = "$dataNodeBaseEndpoint/cm-handles/$cmHandle/node"
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.contentAsString.contains('"leaf":"value"')
}
}
+
<groupId>${project.groupId}</groupId>
<artifactId>cps-service</artifactId>
</dependency>
+ <dependency>
+ <groupId>org.spockframework</groupId>
+ <artifactId>spock-core</artifactId>
+ <scope>test</scope>
+ </dependency>
</dependencies>
</project>
\ No newline at end of file
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 highstreet technologies GmbH
+ * Copyright (C) 2021 Nordix Foundation
* ================================================================================
* 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.nfproxy.api;
+import java.util.Collection;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.onap.cps.spi.FetchDescendantsOption;
import org.onap.cps.spi.model.DataNode;
/**
* Retrieves datanode by XPath for a given cm handle.
*
- * @param cmHandle The identifier for a network function, network element, subnetwork or any other
- * cm object by managed NF-Proxy
+ * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm
+ * object by managed NF-Proxy
* @param xpath xpath
* @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
* (recursively) as well
* @return data node object
*/
DataNode getDataNode(@NonNull String cmHandle, @NonNull String xpath,
- @NonNull FetchDescendantsOption fetchDescendantsOption);
+ @NonNull FetchDescendantsOption fetchDescendantsOption);
+
+ /**
+ * Get datanodes for the given cm handle by cps path.
+ *
+ * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object by
+ * managed NF-Proxy
+ * @param cpsPath cps path
+ * @return a collection of datanodes
+ */
+ Collection<DataNode> queryDataNodes(@NonNull String cmHandle, @NonNull String cpsPath);
+
+ /**
+ * Updates data node for given cm handle using xpath to parent node.
+ *
+ * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object
+ * by managed NF-Proxy
+ * @param parentNodeXpath xpath to parent node
+ * @param jsonData json data
+ */
+ void updateNodeLeaves(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData);
+
+ /**
+ * Replaces existing data node content including descendants.
+ *
+ * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object
+ * by managed NF-Proxy
+ * @param parentNodeXpath xpath to parent node
+ * @param jsonData json data
+ */
+ void replaceNodeTree(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData);
}
/*
* ============LICENSE_START=======================================================
* Copyright (C) 2021 highstreet technologies GmbH
+ * Copyright (C) 2021 Nordix Foundation
* ================================================================================
* 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.nfproxy.api.impl;
-import org.checkerframework.checker.nullness.qual.NonNull;
+import java.util.Collection;
import org.onap.cps.api.CpsDataService;
+import org.onap.cps.api.CpsQueryService;
import org.onap.cps.nfproxy.api.NfProxyDataService;
import org.onap.cps.spi.FetchDescendantsOption;
import org.onap.cps.spi.model.DataNode;
@Autowired
private CpsDataService cpsDataService;
+ @Autowired
+ private CpsQueryService cpsQueryService;
+
@Override
- public DataNode getDataNode(@NonNull final String cmHandle, @NonNull final String xpath,
- @NonNull final FetchDescendantsOption fetchDescendantsOption) {
+ public DataNode getDataNode(final String cmHandle, final String xpath,
+ final FetchDescendantsOption fetchDescendantsOption) {
return cpsDataService.getDataNode(NF_PROXY_DATASPACE_NAME, cmHandle, xpath, fetchDescendantsOption);
}
+
+ @Override
+ public Collection<DataNode> queryDataNodes(final String cmHandle, final String cpsPath) {
+ return cpsQueryService.queryDataNodes(NF_PROXY_DATASPACE_NAME, cmHandle, cpsPath);
+ }
+
+ @Override
+ public void updateNodeLeaves(final String cmHandle, final String parentNodeXpath, final String jsonData) {
+ cpsDataService.updateNodeLeaves(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData);
+ }
+
+ @Override
+ public void replaceNodeTree(final String cmHandle, final String parentNodeXpath, final String jsonData) {
+ cpsDataService.replaceNodeTree(NF_PROXY_DATASPACE_NAME, cmHandle, parentNodeXpath, jsonData);
+ }
}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Nordix Foundation
+ * ================================================================================
+ * 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.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.api.impl
+
+import org.onap.cps.api.CpsDataService
+import org.onap.cps.api.CpsQueryService
+import org.onap.cps.nfproxy.api.impl.NfProxyDataServiceImpl
+import spock.lang.Specification
+
+class NfProxyDataServiceImplSpec extends Specification {
+ def objectUnderTest = new NfProxyDataServiceImpl()
+ def mockcpsDataService = Mock(CpsDataService)
+ def mockcpsQueryService = Mock(CpsQueryService)
+
+ def setup() {
+ objectUnderTest.cpsDataService = mockcpsDataService
+ objectUnderTest.cpsQueryService = mockcpsQueryService
+ }
+
+ def cmHandle = 'some handle'
+ def expectedDataspaceName = 'NFP-Operational'
+
+ def 'Query data nodes by cps path.'() {
+ given: 'a cm Handle and a cps path'
+ def cpsPath = '/cps-path'
+ when: 'queryDataNodes is invoked'
+ objectUnderTest.queryDataNodes(cmHandle, cpsPath)
+ then: 'the persistence service is called once with the correct parameters'
+ 1 * mockcpsQueryService.queryDataNodes(expectedDataspaceName, cmHandle, cpsPath)
+ }
+
+ def 'Update data node leaves.'() {
+ given: 'a cm Handle and a cps path'
+ def xpath = '/xpath'
+ def jsonData = 'some json'
+ when: 'updateNodeLeaves is invoked'
+ objectUnderTest.updateNodeLeaves(cmHandle, xpath, jsonData)
+ then: 'the persistence service is called once with the correct parameters'
+ 1 * mockcpsDataService.updateNodeLeaves(expectedDataspaceName, cmHandle, xpath, jsonData)
+ }
+
+ def 'Replace data node tree.'() {
+ given: 'a cm Handle and a cps path'
+ def xpath = '/xpath'
+ def jsonData = 'some json'
+ when: 'replaceNodeTree is invoked'
+ objectUnderTest.replaceNodeTree(cmHandle, xpath, jsonData)
+ then: 'the persistence service is called once with the correct parameters'
+ 1 * mockcpsDataService.replaceNodeTree(expectedDataspaceName, cmHandle, xpath, jsonData)
+ }
+}
Code Review / cps.git / commitdiff