--- /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.ncmp.api.impl;
+
+public class JsonUtils {
+
+ private static final String BACK_SLASH = "\\";
+ private static final String NEW_LINE = "\n";
+ private static final String QUOTE = "\"";
+
+
+ /**
+ * Remove redundant beginning and end characters.
+ * @param input string to format
+ * @return formatted string
+ */
+ public static String removeWrappingTokens(final String input) {
+ return input.substring(1, input.length() - 1);
+ }
+
+ /**
+ * Remove redundant escape characters.
+ * @param input string to format
+ * @return formatted string
+ */
+ public static String removeRedundantEscapeCharacters(final String input) {
+ return input.replace(BACK_SLASH + "n", NEW_LINE)
+ .replace(BACK_SLASH + QUOTE, QUOTE)
+ .replace(BACK_SLASH + BACK_SLASH + QUOTE, BACK_SLASH + QUOTE);
+ }
+}
.cmHandleProperties(cmHandlePropertiesMap)
.build();
final var dmiRequestBody = prepareOperationBody(dmiRequestBodyObject);
- final ResponseEntity<Void> responseEntity = dmiOperations
+ final ResponseEntity<String> responseEntity = dmiOperations
.createResourceDataPassThroughRunningFromDmi(dmiServiceName,
cmHandle,
resourceIdentifier,
}
}
- private Map<String, String> getCmHandlePropertiesAsMap(final Collection<DataNode> cmHandlePropertiesList) {
+ private static Map<String, String> getCmHandlePropertiesAsMap(final Collection<DataNode> cmHandlePropertiesList) {
if (cmHandlePropertiesList == null || cmHandlePropertiesList.isEmpty()) {
return null;
}
return cmHandlePropertiesMap;
}
- private Object handleResponse(final @NotNull ResponseEntity<Object> responseEntity) {
+ private static Object handleResponse(final @NotNull ResponseEntity<Object> responseEntity) {
if (responseEntity.getStatusCode() == HttpStatus.OK) {
return responseEntity.getBody();
} else {
}
}
- private void handleResponseForPost(final @NotNull ResponseEntity<Void> responseEntity) {
- if (responseEntity.getStatusCode() != HttpStatus.CREATED) {
+ private static void handleResponseForPost(final @NotNull ResponseEntity<String> responseEntity) {
+ if (responseEntity.getStatusCode() != HttpStatus.OK) {
throw new NcmpException("Not able to create resource data.",
"DMI status code: " + responseEntity.getStatusCodeValue()
+ ", DMI response body: " + responseEntity.getBody());
final PersistenceCmHandle persistenceCmHandle =
toPersistenceCmHandle(dmiPluginRegistration.getDmiPlugin(), cmHandle);
persistenceCmHandlesList.add(persistenceCmHandle);
- createAnchorAndSyncModel(persistenceCmHandle);
}
final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
- cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
- cmHandleJsonData, NO_TIMESTAMP);
+
+ registerAndSyncNode(dmiPluginRegistration, persistenceCmHandlesList, cmHandleJsonData);
} catch (final JsonProcessingException e) {
log.error("Parsing error occurred while converting Object to JSON for DMI Registry.");
throw new DataValidationException(
}
}
- private PersistenceCmHandle toPersistenceCmHandle(final String dmiPluginService,
- final CmHandle cmHandle) {
+ private void registerAndSyncNode(final DmiPluginRegistration dmiPluginRegistration,
+ final PersistenceCmHandlesList persistenceCmHandlesList,
+ final String cmHandleJsonData) {
+ cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
+ cmHandleJsonData, NO_TIMESTAMP);
+
+ for (final PersistenceCmHandle persistenceCmHandle : persistenceCmHandlesList.getPersistenceCmHandles()) {
+ createAnchorAndSyncModel(persistenceCmHandle);
+ }
+ }
+
+ private static PersistenceCmHandle toPersistenceCmHandle(final String dmiPluginService,
+ final CmHandle cmHandle) {
final PersistenceCmHandle persistenceCmHandle = new PersistenceCmHandle();
persistenceCmHandle.setDmiServiceName(dmiPluginService);
persistenceCmHandle.setId(cmHandle.getCmHandleID());
final var knownModuleReferencesInCps =
cpsModuleService.getYangResourceModuleReferences(NF_PROXY_DATASPACE_NAME);
final List<ModuleReference> existingModuleReferences = new ArrayList<>();
- for (final ModuleReference moduleReferenceFromDmiForCmHandle :
- moduleReferencesFromDmiForCmHandle) {
+
+ final List<ModuleReference> unknownModuleReferences = new ArrayList<>();
+ for (final ModuleReference moduleReferenceFromDmiForCmHandle : moduleReferencesFromDmiForCmHandle) {
if (knownModuleReferencesInCps.contains(moduleReferenceFromDmiForCmHandle)) {
existingModuleReferences.add(moduleReferenceFromDmiForCmHandle);
+ } else {
+ unknownModuleReferences.add(moduleReferenceFromDmiForCmHandle);
}
}
+ final JsonObject requestBodyAsJson = getRequestBodyAsJson(unknownModuleReferences);
+
final Map<String, String> newYangResourcesModuleNameToContentMap =
- getNewYangResources(cmHandle);
+ getNewYangResources(cmHandle, requestBodyAsJson.toString());
cpsModuleService.createSchemaSetFromModules(NCMP_DATASPACE_NAME, cmHandle.getId(),
newYangResourcesModuleNameToContentMap, existingModuleReferences);
cpsAdminService.createAnchor(NCMP_DATASPACE_NAME, cmHandle.getId(), cmHandle.getId());
}
- private Map<String, String> getNewYangResources(final PersistenceCmHandle cmHandle) {
- final var moduleResourcesAsJsonString = dmiOperations.getResourceFromDmi(
- cmHandle.getDmiServiceName(), cmHandle.getId(), "moduleResources");
- final JsonArray moduleResources = new Gson().fromJson(moduleResourcesAsJsonString.getBody(), JsonArray.class);
+ private JsonObject getRequestBodyAsJson(final List<ModuleReference> unknownModuleReferences) {
+
+ final JsonObject requestBodyAsJson = new JsonObject();
+ requestBodyAsJson.addProperty("operation", "read");
+
+ final JsonArray moduleReferencesAsJson = getModuleReferencesAsJson(unknownModuleReferences);
+
+ final JsonObject data = new JsonObject();
+ data.add("modules", moduleReferencesAsJson);
+ requestBodyAsJson.add("data", data);
+
+ return requestBodyAsJson;
+ }
+
+ private JsonArray getModuleReferencesAsJson(final List<ModuleReference> unknownModuleReferences) {
+ final JsonArray moduleReferences = new JsonArray();
+
+ for (final ModuleReference moduleReference : unknownModuleReferences) {
+ final JsonObject moduleReferenceAsJson = new JsonObject();
+ moduleReferenceAsJson.addProperty("name", moduleReference.getModuleName());
+ moduleReferenceAsJson.addProperty("revision", moduleReference.getRevision());
+ moduleReferences.add(moduleReferenceAsJson);
+ }
+ return moduleReferences;
+ }
+
+ private Map<String, String> getNewYangResources(final PersistenceCmHandle cmHandle, final String jsonData) {
+ final var moduleResourcesAsJsonString = dmiOperations.getResourceFromDmiWithJsonData(
+ cmHandle.getDmiServiceName(), jsonData, cmHandle.getId(), "moduleResources");
+
+ final JsonArray moduleResources = new Gson().fromJson(moduleResourcesAsJsonString.getBody(),
+ JsonArray.class);
final Map<String, String> newYangResourcesModuleNameToContentMap = new HashMap<>();
for (final JsonElement moduleResource : moduleResources) {
return newYangResourcesModuleNameToContentMap;
}
- private YangResource toYangResource(final JsonObject yangResourceAsJson) {
+ private static YangResource toYangResource(final JsonObject yangResourceAsJson) {
final YangResource yangResource = new YangResource();
yangResource.setModuleName(yangResourceAsJson.get("moduleName").getAsString());
yangResource.setRevision(yangResourceAsJson.get("revision").getAsString());
- yangResource.setYangSource(yangResourceAsJson.get("yangSource").getAsString());
+ final String yangSourceJson = yangResourceAsJson.get("yangSource").getAsString();
+
+ String yangSource = JsonUtils.removeWrappingTokens(yangSourceJson);
+ yangSource = JsonUtils.removeRedundantEscapeCharacters(yangSource);
+ yangResource.setYangSource(yangSource);
+
return yangResource;
}
return restTemplate.exchange(dmiResourceUrl, HttpMethod.PUT, httpEntity, Object.class);
}
- public ResponseEntity<Void> postOperationWithJsonData(final String dmiResourceUrl,
- final String jsonData, final HttpHeaders headers) {
- final var httpEntity = new HttpEntity<>(jsonData, configureHttpHeaders(headers));
- return restTemplate.postForEntity(dmiResourceUrl, httpEntity, Void.class);
+ /**
+ * Sends POST operation to DMI with json body containing module references.
+ * @param dmiResourceUrl dmi resource url
+ * @param jsonData json data body
+ * @param httpHeaders http headers
+ * @return response entity of type String
+ */
+ public ResponseEntity<String> postOperationWithJsonData(final String dmiResourceUrl,
+ final String jsonData,
+ final HttpHeaders httpHeaders) {
+ final var httpEntity = new HttpEntity<>(jsonData, configureHttpHeaders(httpHeaders));
+ return restTemplate.postForEntity(dmiResourceUrl, httpEntity, String.class);
}
private HttpHeaders configureHttpHeaders(final HttpHeaders httpHeaders) {
return httpHeaders;
}
+ /**
+ * Sends POST operation to DMI.
+ * @param dmiResourceUrl dmi resource url
+ * @param httpHeaders http headers
+ * @return response entity of type String
+ */
public ResponseEntity<String> postOperation(final String dmiResourceUrl, final HttpHeaders httpHeaders) {
final var httpEntity = new HttpEntity<>(configureHttpHeaders(httpHeaders));
return restTemplate.exchange(dmiResourceUrl, HttpMethod.POST, httpEntity, String.class);
final var dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
final var httpHeaders = new HttpHeaders();
return dmiRestClient.postOperation(dmiResourceDataUrl, httpHeaders);
+ }
+ /**
+ * Get resources from DMI for modules.
+ *
+ * @param dmiServiceName dmi service name
+ * @param jsonData module names and revisions as JSON
+ * @param cmHandle cmHandle
+ * @param resourceName name of the resource(s)
+ * @return {@code ResponseEntity} response entity
+ */
+ public ResponseEntity<String> getResourceFromDmiWithJsonData(final String dmiServiceName,
+ final String jsonData,
+ final String cmHandle,
+ final String resourceName) {
+ final String dmiResourceDataUrl = getDmiResourceUrl(dmiServiceName, cmHandle, resourceName);
+ return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonData, new HttpHeaders());
}
/**
* @param jsonBody json body for put operation
* @return {@code ResponseEntity} response entity
*/
- public ResponseEntity<Void> createResourceDataPassThroughRunningFromDmi(final String dmiServiceName,
+ public ResponseEntity<String> createResourceDataPassThroughRunningFromDmi(final String dmiServiceName,
final String cmHandle,
final String resourceId,
final String jsonBody) {
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.ArrayList;
import java.util.List;
+import lombok.Getter;
+@Getter
public class PersistenceCmHandlesList {
@JsonProperty("cm-handles")
- private List<PersistenceCmHandle> persistenceCmHandles;
+ private List<PersistenceCmHandle> persistenceCmHandles = new ArrayList<>();
/**
* Add a persistenceCmHandle.
* @param persistenceCmHandle the persistenceCmHandle to add
*/
public void add(final PersistenceCmHandle persistenceCmHandle) {
- if (persistenceCmHandles == null) {
- persistenceCmHandles = new ArrayList<>();
- }
persistenceCmHandles.add(persistenceCmHandle);
}
-
}
--- /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.ncmp.api.impl
+
+import spock.lang.Specification
+
+class JsonUtilsSpec extends Specification {
+ def 'Remove redundant escape characters.'() {
+ expect: 'removing redundant escape characters returns the correct output for #scenario'
+ JsonUtils.removeRedundantEscapeCharacters(input) == expectedOutput
+ where: 'the following input is used'
+ scenario | input || expectedOutput
+ 'two lines' | 'line1\\nline2' || 'line1\nline2'
+ 'a string inside quotes' | 'a \\"word in quotes\\"' || 'a "word in quotes"'
+ 'quotes inside quotes (double escape)' | '\\"quotes \\\\\\"inside\\\\\\" quotes\\"' || '"quotes \\"inside\\" quotes"' // human readable: "quotes \"inside\" quotes"
+ }
+ def 'Remove wrapping tokens.'() {
+ expect: 'removing wrapping tokens returns the correct output for #scenario'
+ JsonUtils.removeWrappingTokens(input) == expectedOutput
+ where: 'the following input is used'
+ scenario | input || expectedOutput
+ 'a string in quotes' | '"abc"' || 'abc'
+ 'a string in apostrophes' | "'abc'" || 'abc'
+ 'a string inside any other tokens' | 'abcde' || 'bcd'
+ }
+}
+
import org.onap.cps.ncmp.api.models.CmHandle
import org.onap.cps.ncmp.api.models.DmiPluginRegistration
import org.onap.cps.ncmp.api.models.PersistenceCmHandle
+import org.onap.cps.ncmp.api.models.PersistenceCmHandlesList
import org.onap.cps.ncmp.utils.TestUtils
import org.onap.cps.spi.FetchDescendantsOption
import org.onap.cps.spi.model.DataNode
def cmHandleXPath = "/dmi-registry/cm-handles[@id='testCmHandle']"
def cmHandleForModelSync = new PersistenceCmHandle(id:'some cm handle', dmiServiceName: 'some service name')
def expectedDataspaceNameForModleSync = 'NCMP-Admin'
- def NO_NAMESPACE = null
def expectedDataspaceName = 'NFP-Operational'
def 'Query data nodes by cps path with #fetchDescendantsOption.'() {
'testCmHandle',
'testResourceId',
'{"operation":"create","dataType":"application/json","data":"{some-json}","cmHandleProperties":{"testName":"testValue"}}')
- >> { new ResponseEntity<>(HttpStatus.CREATED) }
+ >> { new ResponseEntity<>(HttpStatus.OK) }
}
def 'Write resource data for pass-through running from dmi using POST "not found" response (from DMI).'() {
mockCpsModuleService.getYangResourceModuleReferences(_) >> [knownModule1, knownOtherModule]
and: 'DMI-Plugin returns resource(s) for "new" module(s)'
def moduleResources = new ResponseEntity<String>(sdncReponseBody, HttpStatus.OK)
- mockDmiOperations.getResourceFromDmi(_, cmHandleForModelSync.getId(), 'moduleResources') >> moduleResources
+ mockDmiOperations.getResourceFromDmiWithJsonData(_, _, _, 'moduleResources') >> moduleResources
when: 'module Sync is triggered'
objectUnderTest.createAnchorAndSyncModel(cmHandleForModelSync)
then: 'the CPS module service is called once with the correct parameters'
and: 'admin service create anchor method has been called with correct parameters'
1 * mockCpsAdminService.createAnchor(expectedDataspaceNameForModleSync, cmHandleForModelSync.getId(), cmHandleForModelSync.getId())
where: 'the following responses are recieved from SDNC'
- scenario | sdncReponseBody || expectedYangResourceToContentMap
- 'one unknown module' | '[{"moduleName" : "someModule", "revision" : "1","yangSource": "someResource"}]' || [someModule: 'someResource']
- 'no unknown module' | '[]' || [:]
+ scenario | sdncReponseBody || expectedYangResourceToContentMap
+ 'one unknown module' | '[{"moduleName" : "someModule", "revision" : "1","yangSource": "[some yang source]"}]' || [someModule: 'some yang source']
+ 'no unknown module' | '[]' || [:]
}
def getModulesForCmHandle() {
setupTestConfigurationData()
and: 'the rest template returns a valid response entity'
def mockResponseEntity = Mock(ResponseEntity)
- mockRestTemplate.postForEntity(getResourceDataUrl, _ as HttpEntity, Void.class) >> mockResponseEntity
+ mockRestTemplate.postForEntity(getResourceDataUrl, _ as HttpEntity, String.class) >> mockResponseEntity
when: 'POST operation is invoked'
def result = objectUnderTest.postOperationWithJsonData(getResourceDataUrl, 'json-data', new HttpHeaders())
then: 'the output of the method is equal to the output from the test template'
then: 'the post operation is executed with the correct URL'
1 * mockDmiRestClient.postOperation(expectedUrl, _ as HttpHeaders)
}
+
+ def 'Call get resource from dmi with json data.'() {
+ given: 'expected url & json data'
+ def requestBody = 'some json'
+ def expectedUrl = 'testDmiBasePath/dmi/v1/ch/testCmHandle/modules'
+ def expectedHttpHeaders = new HttpHeaders()
+ when: 'get resource data is called to dmi'
+ objectUnderTest.getResourceFromDmiWithJsonData('testDmiBasePath',
+ requestBody,
+ 'testCmHandle',
+ 'modules')
+ then: 'the post operation is executed with the correct URL and json data'
+ 1 * mockDmiRestClient.postOperationWithJsonData(expectedUrl, requestBody, expectedHttpHeaders)
+ }
}
\ No newline at end of file
Code Review / cps.git / commitdiff