dataType:
type: string
data:
- type: object
+ type: string
cmHandleProperties:
type: object
additionalProperties:
dataType:
type: string
data:
- type: object
+ type: string
cmHandleProperties:
type: object
additionalProperties:
@Component
public static class DmiPluginProperties {
- @Value("${dmi.service.name}")
- private String dmiServiceName;
+ @Value("${dmi.service.url}")
+ private String dmiServiceUrl;
}
}
* @return response from sdnc
*/
String writeResourceDataPassthroughForCmHandle(String cmHandle, String resourceIdentifier, String dataType,
- Object data);
+ String data);
}
\ No newline at end of file
* @param objectMapper objectMapper
*/
public DmiServiceImpl(final DmiPluginProperties dmiPluginProperties,
- final NcmpRestClient ncmpRestClient,
- final SdncOperations sdncOperations, final ObjectMapper objectMapper) {
+ final NcmpRestClient ncmpRestClient,
+ final SdncOperations sdncOperations, final ObjectMapper objectMapper) {
this.dmiPluginProperties = dmiPluginProperties;
this.ncmpRestClient = ncmpRestClient;
this.objectMapper = objectMapper;
return createModuleSchema(responseBody);
} else {
throw new DmiException("SDNC is not able to process request.",
- RESPONSE_CODE + responseEntity.getStatusCode() + MESSAGE + responseEntity.getBody());
+ RESPONSE_CODE + responseEntity.getStatusCode() + MESSAGE + responseEntity.getBody());
}
}
} else if (responseEntity.getStatusCode() == HttpStatus.NOT_FOUND) {
log.error("SDNC did not return a module resource for the given cmHandle {}", cmHandle);
throw new ModuleResourceNotFoundException(cmHandle,
- "SDNC did not return a module resource for the given cmHandle.");
+ "SDNC did not return a module resource for the given cmHandle.");
} else {
log.error("Error occurred when getting module resources from SDNC for the given cmHandle {}", cmHandle);
throw new DmiException(cmHandle,
- RESPONSE_CODE + responseEntity.getStatusCode() + MESSAGE + responseEntity.getBody());
+ RESPONSE_CODE + responseEntity.getStatusCode() + MESSAGE + responseEntity.getBody());
}
}
return getModuleResponses.toJSONString();
@Override
public void registerCmHandles(final List<String> cmHandles) {
final CmHandleOperation cmHandleOperation = new CmHandleOperation();
- cmHandleOperation.setDmiPlugin(dmiPluginProperties.getDmiServiceName());
+ cmHandleOperation.setDmiPlugin(dmiPluginProperties.getDmiServiceUrl());
final List<CreatedCmHandle> createdCmHandleList = new ArrayList<>();
for (final String cmHandle : cmHandles) {
final CreatedCmHandle createdCmHandle = new CreatedCmHandle();
} catch (final JsonProcessingException e) {
log.error("Parsing error occurred while converting cm-handles to JSON {}", cmHandles);
throw new DmiException("Internal Server Error.",
- "Parsing error occurred while converting given cm-handles object list to JSON ");
+ "Parsing error occurred while converting given cm-handles object list to JSON ");
}
final ResponseEntity<String> responseEntity = ncmpRestClient.registerCmHandlesWithNcmp(cmHandlesJson);
if ((responseEntity.getStatusCode() != HttpStatus.CREATED)) {
return objectMapper.readValue(modulesListAsJson, ModuleSchemas.class);
} catch (final JsonProcessingException e) {
log.error("JSON exception occurred when converting the following modules to node schema "
- + "{}", modulesListAsJson);
+ + "{}", modulesListAsJson);
throw new DmiException("Unable to process JSON.",
- "JSON exception occurred when mapping modules.", e);
+ "JSON exception occurred when mapping modules.", e);
}
}
@Override
public Object getResourceDataOperationalForCmHandle(final @NotNull String cmHandle,
- final @NotNull String resourceIdentifier,
- final String acceptParam,
- final String fieldsQuery,
- final Integer depthQuery,
- final Map<String, String> cmHandlePropertyMap) {
+ final @NotNull String resourceIdentifier,
+ final String acceptParam,
+ final String fieldsQuery,
+ final Integer depthQuery,
+ final Map<String, String> cmHandlePropertyMap) {
// not using cmHandlePropertyMap of onap dmi impl , other dmi impl might use this.
final ResponseEntity<String> responseEntity = sdncOperations.getResouceDataForOperationalAndRunning(cmHandle,
- resourceIdentifier,
- fieldsQuery,
- depthQuery,
- acceptParam,
+ resourceIdentifier,
+ fieldsQuery,
+ depthQuery,
+ acceptParam,
CONTENT_QUERY_PASSTHROUGH_OPERATIONAL);
return prepareAndSendResponse(responseEntity, cmHandle);
}
@Override
public Object getResourceDataPassThroughRunningForCmHandle(final @NotNull String cmHandle,
- final @NotNull String resourceIdentifier,
- final String acceptParam,
- final String fieldsQuery,
- final Integer depthQuery,
- final Map<String, String> cmHandlePropertyMap) {
+ final @NotNull String resourceIdentifier,
+ final String acceptParam,
+ final String fieldsQuery,
+ final Integer depthQuery,
+ final Map<String, String> cmHandlePropertyMap) {
// not using cmHandlePropertyMap of onap dmi impl , other dmi impl might use this.
final ResponseEntity<String> responseEntity = sdncOperations.getResouceDataForOperationalAndRunning(cmHandle,
- resourceIdentifier,
- fieldsQuery,
- depthQuery,
- acceptParam,
- CONTENT_QUERY_PASSTHROUGH_RUNNING);
+ resourceIdentifier,
+ fieldsQuery,
+ depthQuery,
+ acceptParam,
+ CONTENT_QUERY_PASSTHROUGH_RUNNING);
return prepareAndSendResponse(responseEntity, cmHandle);
}
@Override
public String writeResourceDataPassthroughForCmHandle(final String cmHandle, final String resourceIdentifier,
- final String dataType, final Object data) {
- final String jsonData;
- try {
- jsonData = objectMapper.writeValueAsString(data);
- } catch (final JsonProcessingException e) {
- log.error("JSON exception occurred when processing pass through request data for the given cmHandle {}",
- cmHandle);
- throw new DmiException("Unable to process incoming JSON from the request body.",
- "JSON exception occurred when writing data for the given cmHandle " + cmHandle, e);
- }
+ final String dataType, final String data) {
final ResponseEntity<String> responseEntity =
- sdncOperations.writeResourceDataPassthroughRunning(cmHandle, resourceIdentifier, dataType, jsonData);
+ sdncOperations.writeResourceDataPassthroughRunning(cmHandle, resourceIdentifier, dataType, data);
if (responseEntity.getStatusCode().is2xxSuccessful()) {
return responseEntity.getBody();
} else {
return responseEntity.getBody();
} else {
throw new ResourceDataNotFound(cmHandle,
- RESPONSE_CODE + responseEntity.getStatusCode() + MESSAGE + responseEntity.getBody());
+ RESPONSE_CODE + responseEntity.getStatusCode() + MESSAGE + responseEntity.getBody());
}
}
moduleRequest = writer.writeValueAsString(ietfNetconfModuleReferences);
} catch (final JsonProcessingException e) {
log.error("JSON exception occurred when creating the module request for the given module reference {}",
- moduleReference.getName());
+ moduleReference.getName());
throw new DmiException("Unable to process JSON.",
- "JSON exception occurred when creating the module request.", e);
+ "JSON exception occurred when creating the module request.", e);
}
return moduleRequest;
}
private JSONObject toJsonObject(final ModuleReference moduleReference,
- final ResponseEntity<String> response) {
+ final ResponseEntity<String> response) {
final var jsonObject = new JSONObject();
jsonObject.put("moduleName", moduleReference.getName());
jsonObject.put("revision", moduleReference.getRevision());
private String extractYangSourceFromBody(final ResponseEntity<String> responseEntity) {
final var responseBodyAsJsonObject = new Gson().fromJson(responseEntity.getBody(), JsonObject.class);
if (responseBodyAsJsonObject.getAsJsonObject(IETF_NETCONF_MONITORING_OUTPUT) == null
- || responseBodyAsJsonObject.getAsJsonObject(IETF_NETCONF_MONITORING_OUTPUT)
+ || responseBodyAsJsonObject.getAsJsonObject(IETF_NETCONF_MONITORING_OUTPUT)
.getAsJsonPrimitive("data") == null) {
log.error("Error occurred when trying to parse the response body from sdnc {}", responseEntity.getBody());
throw new ModuleResourceNotFoundException(responseEntity.getBody(),
- "Error occurred when trying to parse the response body from sdnc.");
+ "Error occurred when trying to parse the response body from sdnc.");
}
return responseBodyAsJsonObject.getAsJsonObject(IETF_NETCONF_MONITORING_OUTPUT).getAsJsonPrimitive("data")
- .toString();
+ .toString();
}
}
\ No newline at end of file
dmi:
service:
- name: onap-dmi-plugin
+ url: ${DMI_SERVICE_URL}
rest:
api:
security:
permit-uri: /manage/**,/swagger-ui/**,/swagger-resources/**,/v3/api-docs
auth:
- username: ${CPS_USERNAME}
- password: ${CPS_PASSWORD}
+ username: ${DMI_USERNAME}
+ password: ${DMI_PASSWORD}
# Actuator
management:
import org.onap.cps.ncmp.dmi.exception.DmiException
import org.onap.cps.ncmp.dmi.exception.ModuleResourceNotFoundException
import org.onap.cps.ncmp.dmi.exception.ModulesNotFoundException
-import org.onap.cps.ncmp.dmi.model.DataAccessReadRequest
-import org.onap.cps.ncmp.dmi.model.DataAccessWriteRequest
import org.onap.cps.ncmp.dmi.model.ModuleReference
import org.onap.cps.ncmp.dmi.model.ModuleSchemaList
-import org.onap.cps.ncmp.dmi.model.ModuleSchemaProperties
-import org.onap.cps.ncmp.dmi.model.ModuleSchemas
import org.onap.cps.ncmp.dmi.model.ModuleSet
import org.onap.cps.ncmp.dmi.model.ModuleSetSchemas
import org.onap.cps.ncmp.dmi.service.DmiService
['prop1': 'value1', 'prop2': 'value2'])
}
- def 'Write data using passthrough running for a cm handle.'() {
+ def 'Write data using passthrough running for a cm handle using #scenario.'() {
given: 'write data for cmHandle url and jsonData'
def writeDataforCmHandlePassthroughRunning = "${basePathV1}/ch/some-cmHandle/data/ds/ncmp-datastore:passthrough-running/some-resourceIdentifier"
- def jsonData = TestUtils.getResourceFileContent('WriteDataForCmHandle.json')
+ def jsonData = TestUtils.getResourceFileContent(requestBodyFile)
and: 'dmi service is called'
- mockDmiService.writeResourceDataPassthroughForCmHandle('some-cmHandle', 'some-resourceIdentifier', 'application/json', ['some-data': 'some-value']) >> '{some-json}'
+ mockDmiService.writeResourceDataPassthroughForCmHandle('some-cmHandle',
+ 'some-resourceIdentifier', 'application/json',
+ expectedRequestData) >> '{some-json}'
when: 'write cmHandle passthrough running post api is invoked with json data'
def response = mvc.perform(
post(writeDataforCmHandlePassthroughRunning).contentType(MediaType.APPLICATION_JSON)
response.status == HttpStatus.CREATED.value()
and: 'the data in the request body is as expected'
response.getContentAsString() == '{some-json}'
+ where: 'given request body and data'
+ scenario | requestBodyFile || expectedRequestData
+ 'data with normal chars' | 'dataWithNormalChar.json' || 'normal request body'
+ 'data with special chars' | 'dataWithSpecialChar.json'|| 'data with quote \" and new line \n'
}
def 'Get resource data for pass-through running from cm handle.'() {
def givenCmHandlesList = ['node1', 'node2']
def expectedJson = '{"dmiPlugin":"test-dmi-service","createdCmHandles":[{"cmHandle":"node1"},{"cmHandle":"node2"}]}'
and: 'mockDmiPluginProperties returns test-dmi-service'
- mockDmiPluginProperties.getDmiServiceName() >> 'test-dmi-service'
+ mockDmiPluginProperties.getDmiServiceUrl() >> 'test-dmi-service'
when: 'register cm handles service method with the given cm handles'
objectUnderTest.registerCmHandles(givenCmHandlesList)
then: 'register cm handle with ncmp called once and return "created" status'
given: 'cm-handle list'
def cmHandlesList = ['node1', 'node2']
and: 'dmi plugin service name is "test-dmi-service"'
- mockDmiPluginProperties.getDmiServiceName() >> 'test-dmi-service'
+ mockDmiPluginProperties.getDmiServiceUrl() >> 'test-dmi-service'
and: 'ncmp rest client returns #responseEntity'
mockNcmpRestClient.registerCmHandlesWithNcmp(_ as String) >> responseEntity
when: 'register cm handles service method called'
def moduleReference = new ModuleReference(name: 'NAME',revision: 'REVISION')
def moduleList = [moduleReference]
when: 'get module resources is invoked with the given cm handle and a module list'
- objectUnderTest.getModuleResources(cmHandle, moduleList)
+ objectUnderTest.getModuleResources(cmHandle, moduleList)
then: 'get modules resources is called once with a response body that contains no data'
1 * mockSdncOperations.getModuleResource(cmHandle, _) >> new ResponseEntity<String>(responseBody, HttpStatus.OK)
and: 'a module resource not found exception is thrown'
}
def 'Write resource data for passthrough running for the given cm handle with a #scenario from sdnc.'() {
- given: 'sdnc returns a response'
+ given: 'sdnc returns a response with #scenario'
mockSdncOperations.writeResourceDataPassthroughRunning(_, _, _, _) >> new ResponseEntity<String>('response json', httpResponse)
when: 'write resource data for cm handle method invoked'
def response = objectUnderTest.writeResourceDataPassthroughForCmHandle('some-cmHandle',
'201 CREATED response' | HttpStatus.CREATED
}
+ def 'Write resource data using for passthrough running for the given cm handle with #scenario.'() {
+ given: 'sdnc returns a created response'
+ mockSdncOperations.writeResourceDataPassthroughRunning('some-cmHandle',
+ 'some-resourceIdentifier', 'some-dataType', requestBody) >> new ResponseEntity<String>('response json', HttpStatus.CREATED)
+ when: 'write resource data from cm handles service method invoked'
+ def response = objectUnderTest.writeResourceDataPassthroughForCmHandle('some-cmHandle',
+ 'some-resourceIdentifier', 'some-dataType', requestBody)
+ then: 'response have expected json'
+ response == 'response json'
+ where: 'given request body'
+ scenario | requestBody
+ 'data contains normal char' | 'normal char string'
+ 'data contains quote and new line' | 'data with quote " and \n new line'
+ }
+
def 'Write resource data for passthrough running with a 500 response from sdnc.'() {
given: 'sdnc returns a 500 response for the write operation'
mockSdncOperations.writeResourceDataPassthroughRunning(_, _, _, _) >> new ResponseEntity<String>('response json', HttpStatus.INTERNAL_SERVER_ERROR)
when: 'write resource data for pass through method is invoked'
objectUnderTest.writeResourceDataPassthroughForCmHandle('some-cmHandle',
- 'some-resourceIdentifier', 'some-dataType', new Object())
- then: 'a dmi exception is thrown'
- thrown(DmiException.class)
- }
-
- def 'Write resource data for passthrough running with a json processing exception.'() {
- given: 'sdnc returns a 200 response for the write operation'
- mockSdncOperations.writeResourceDataPassthroughRunning(_, _, _, _) >> new ResponseEntity<String>('response json', HttpStatus.OK)
- and: 'a json processing exception is thrown'
- objectUnderTest.objectMapper = mockObjectMapper
- mockObjectMapper.writeValueAsString(_) >> { throw new JsonProcessingException('some-exception') }
- when: 'write resource data for pass through method is invoked'
- objectUnderTest.writeResourceDataPassthroughForCmHandle('some-cmHandle',
- 'some-resourceIdentifier', 'some-dataType', new Object())
+ 'some-resourceIdentifier', 'some-dataType', _ as String)
then: 'a dmi exception is thrown'
thrown(DmiException.class)
}
}
def 'Get resource data from node to SDNC.'() {
- given: 'excpected url, topology-id, sdncOperation object'
+ given: 'expected url, topology-id, sdncOperation object'
def expectedUrl = '/rests/data/network-topology:network-topology/topology=test-topology/node=node1/yang-ext:mount/testResourceId?fields=testFields&depth=10&content=testContent'
when: 'called get modules from node'
objectUnderTest.getResouceDataForOperationalAndRunning('node1', 'testResourceId',
}
def 'Write resource data to SDNC.'() {
- given: 'excpected url, topology-id, sdncOperation object'
+ given: 'expected url, topology-id, sdncOperation object'
def expectedUrl = '/rests/data/network-topology:network-topology/topology=test-topology/node=node1/yang-ext:mount/testResourceId'
when: 'write resource data for pass through running is called'
- objectUnderTest.writeResourceDataPassthroughRunning('node1', 'testResourceId', 'application/json','testData')
- then: 'the post operation is executed with the correct URL'
- 1 * mockSdncRestClient.postOperationWithJsonData(expectedUrl, _ as String, _ as HttpHeaders)
+ objectUnderTest.writeResourceDataPassthroughRunning('node1','testResourceId','application/json','requestData')
+ then: 'the post operation is executed with the correct URL and data'
+ 1 * mockSdncRestClient.postOperationWithJsonData(expectedUrl, 'requestData', _ as HttpHeaders)
}
}
\ No newline at end of file
{
"operation": "create",
"dataType": "application/json",
- "data": {
- "some-data": "some-value"
- },
+ "data": "normal request body",
"cmHandleProperties": {
"some-property": "some-property-value"
}
--- /dev/null
+{
+ "operation": "create",
+ "dataType": "application/json",
+ "data": "data with quote \" and new line \n",
+ "cmHandleProperties": {
+ "some-property": "some-property-value"
+ }
+}
\ No newline at end of file
Code Review / cps / ncmp-dmi-plugin.git / commitdiff