<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
-<modelVersion>4.0.0</modelVersion>
-<parent>
- <groupId>org.onap.cps</groupId>
- <artifactId>cps-parent</artifactId>
- <version>2.0.1-SNAPSHOT</version>
- <relativePath>../cps-parent/pom.xml</relativePath>
-</parent>
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>org.onap.cps</groupId>
+
<artifactId>cps-parent</artifactId>
+ <version>2.0.1-SNAPSHOT</version>
+ <relativePath>../cps-parent/pom.xml</relativePath>
+ </parent>
-<artifactId>cps-ncmp-rest</artifactId>
-
- <properties>
- <minimum-coverage>0.95</minimum-coverage>
- </properties>
+ <artifactId>cps-ncmp-rest</artifactId>
<dependencies>
<dependency>
import groovy.json.JsonSlurper
import org.onap.cps.ncmp.api.NetworkCmProxyDataService
+import org.onap.cps.ncmp.api.impl.exception.NcmpException
import org.onap.cps.spi.FetchDescendantsOption
import org.onap.cps.spi.exceptions.CpsException
import org.spockframework.spring.SpringBean
dataNodeBaseEndpoint = "$basePath/v1"
}
- def 'Get request with runtime exception returns HTTP Status Internal Server Error.'() {
- when: 'runtime exception is thrown by the service'
- setupTestException(new IllegalStateException(errorMessage))
- def response = performTestRequest()
- then: 'an HTTP Internal Server Error response is returned with correct message and details'
- assertTestResponse(response, INTERNAL_SERVER_ERROR, errorMessage, null)
- }
-
- def 'Get request with generic CPS exception returns HTTP Status Internal Server Error.'() {
+ def 'Get request with generic #scenario exception returns HTTP Status Internal Server Error.'() {
when: 'generic CPS exception is thrown by the service'
- setupTestException(new CpsException(errorMessage, errorDetails))
+ setupTestException(exception)
def response = performTestRequest()
then: 'an HTTP Internal Server Error response is returned with correct message and details'
- assertTestResponse(response, INTERNAL_SERVER_ERROR, errorMessage, errorDetails)
+ assertTestResponse(response, INTERNAL_SERVER_ERROR, errorMessage, expectedErrorDetails)
+ where:
+ scenario | exception || expectedErrorDetails
+ 'CPS' | new CpsException(errorMessage, errorDetails) || errorDetails
+ 'NCMP' | new NcmpException(errorMessage, errorDetails) || null
+ 'other' | new IllegalStateException(errorMessage) || null
}
def setupTestException(exception) {
<artifactId>cps-ncmp-service</artifactId>
<properties>
- <minimum-coverage>0.87</minimum-coverage>
+ <minimum-coverage>0.90</minimum-coverage>
</properties>
<dependencies>
@Override
public void updateDmiRegistrationAndSyncModule(final DmiPluginRegistration dmiPluginRegistration) {
- if (dmiPluginRegistration.getCreatedCmHandles() != null) {
- parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(dmiPluginRegistration);
- }
- if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
- parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
- }
- if (dmiPluginRegistration.getRemovedCmHandles() != null) {
- parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
+ try {
+ if (dmiPluginRegistration.getCreatedCmHandles() != null) {
+ parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(dmiPluginRegistration);
+ }
+ if (dmiPluginRegistration.getUpdatedCmHandles() != null) {
+ parseAndUpdateCmHandlesInDmiRegistration(dmiPluginRegistration);
+ }
+ if (dmiPluginRegistration.getRemovedCmHandles() != null) {
+ parseAndRemoveCmHandlesInDmiRegistration(dmiPluginRegistration);
+ }
+ } catch (final JsonProcessingException e) {
+ handleJsonProcessingException(dmiPluginRegistration, e);
}
}
return prepareOperationBody(requestBodyObject);
}
- private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration) {
- try {
- final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
-
- for (final CmHandle cmHandle : dmiPluginRegistration.getUpdatedCmHandles()) {
- final PersistenceCmHandle persistenceCmHandle =
- toPersistenceCmHandle(dmiPluginRegistration.getDmiPlugin(), cmHandle);
- persistenceCmHandlesList.add(persistenceCmHandle);
- }
- final String cmHandlesJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
- cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
- "/dmi-registry", cmHandlesJsonData, NO_TIMESTAMP);
- } catch (final JsonProcessingException e) {
- handleJsonProcessingException(dmiPluginRegistration, e);
- }
+ private void parseAndUpdateCmHandlesInDmiRegistration(final DmiPluginRegistration dmiPluginRegistration)
+ throws JsonProcessingException {
+ final PersistenceCmHandlesList updatedPersistenceCmHandlesList = toPersistenceCmHandlesList(
+ dmiPluginRegistration.getDmiPlugin(),
+ dmiPluginRegistration.getUpdatedCmHandles());
+ final String cmHandlesAsJson = objectMapper.writeValueAsString(updatedPersistenceCmHandlesList);
+ cpsDataService.updateNodeLeavesAndExistingDescendantLeaves(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR,
+ "/dmi-registry", cmHandlesAsJson, NO_TIMESTAMP);
}
private void parseAndCreateCmHandlesInDmiRegistrationAndSyncModule(
- final DmiPluginRegistration dmiPluginRegistration) {
- try {
- final var persistenceCmHandlesList = new PersistenceCmHandlesList();
- for (final CmHandle cmHandle : dmiPluginRegistration.getCreatedCmHandles()) {
- final PersistenceCmHandle persistenceCmHandle =
- toPersistenceCmHandle(dmiPluginRegistration.getDmiPlugin(), cmHandle);
- persistenceCmHandlesList.add(persistenceCmHandle);
- }
- final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
+ final DmiPluginRegistration dmiPluginRegistration) throws JsonProcessingException {
+ final PersistenceCmHandlesList createdPersistenceCmHandlesList = toPersistenceCmHandlesList(
+ dmiPluginRegistration.getDmiPlugin(),
+ dmiPluginRegistration.getCreatedCmHandles());
+ registerAndSyncNewCmHandles(createdPersistenceCmHandlesList);
+ }
- registerAndSyncNode(persistenceCmHandlesList, cmHandleJsonData);
- } catch (final JsonProcessingException e) {
- handleJsonProcessingException(dmiPluginRegistration, e);
+ private static PersistenceCmHandlesList toPersistenceCmHandlesList(final String dmiPlugin,
+ final Collection<CmHandle> cmHandles) {
+ final PersistenceCmHandlesList persistenceCmHandlesList = new PersistenceCmHandlesList();
+ for (final CmHandle cmHandle : cmHandles) {
+ final PersistenceCmHandle persistenceCmHandle = toPersistenceCmHandle(dmiPlugin, cmHandle);
+ persistenceCmHandlesList.add(persistenceCmHandle);
}
+ return persistenceCmHandlesList;
}
private static void handleJsonProcessingException(final DmiPluginRegistration dmiPluginRegistration,
throw new DataValidationException(message, e.getMessage(), e);
}
- private void registerAndSyncNode(final PersistenceCmHandlesList persistenceCmHandlesList,
- final String cmHandleJsonData) {
+ private void registerAndSyncNewCmHandles(final PersistenceCmHandlesList persistenceCmHandlesList)
+ throws JsonProcessingException {
+ final String cmHandleJsonData = objectMapper.writeValueAsString(persistenceCmHandlesList);
cpsDataService.saveListNodeData(NCMP_DATASPACE_NAME, NCMP_DMI_REGISTRY_ANCHOR, "/dmi-registry",
cmHandleJsonData, NO_TIMESTAMP);
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.setRevision(yangResourceAsJson.get(REVISION).getAsString());
final String yangSourceJson = yangResourceAsJson.get("yangSource").getAsString();
String yangSource = JsonUtils.removeWrappingTokens(yangSourceJson);
def noTimestamp = null
def cmHandleXPath = "/dmi-registry/cm-handles[@id='testCmHandle']"
def cmHandleForModelSync = new PersistenceCmHandle(id:'some cm handle', dmiServiceName: 'some service name')
-
def expectedDataspaceName = 'NFP-Operational'
+
+
+ def 'Get data node.'() {
+ when: 'queryDataNodes is invoked'
+ objectUnderTest.getDataNode(cmHandle, 'some xpath', fetchDescendantsOption)
+ then: 'the persistence data service is called once with the correct parameters'
+ 1 * mockCpsDataService.getDataNode(expectedDataspaceName, cmHandle, 'some xpath', fetchDescendantsOption)
+ where: 'all fetch descendants options are supported'
+ fetchDescendantsOption << FetchDescendantsOption.values()
+ }
+
def 'Query data nodes by cps path with #fetchDescendantsOption.'() {
given: 'a cm Handle and a cps path'
def cpsPath = '/cps-path'
when: 'queryDataNodes is invoked'
objectUnderTest.queryDataNodes(cmHandle, cpsPath, fetchDescendantsOption)
- then: 'the persistence service is called once with the correct parameters'
+ then: 'the persistence query service is called once with the correct parameters'
1 * mockCpsQueryService.queryDataNodes(expectedDataspaceName, cmHandle, cpsPath, fetchDescendantsOption)
where: 'all fetch descendants options are supported'
fetchDescendantsOption << FetchDescendantsOption.values()
def 'Get resource data for pass-through operational from dmi.'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'data node is got from data service'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
def 'Get resource data for pass-through operational from dmi threw parsing exception.'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'cps data service returns valid cmHandle data node'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
def 'Get resource data for pass-through operational from dmi return NOK response.'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'cps data service returns valid cmHandle data node'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
def 'Get resource data for pass-through running from dmi.'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
def 'Get resource data for pass-through running from dmi threw parsing exception.'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
def 'Get resource data for pass-through running from dmi return NOK response.'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
exceptionThrown.details.contains('NOK-json')
}
- def 'Write resource data for pass-through running from dmi using POST.'() {
- given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def 'Write resource data for pass-through running from dmi using POST #scenario cm handle properties.'() {
+ given: 'data node representing cmHandle #scenario cm handle properties'
+ def cmHandleDataNode = getCmHandleDataNodeForTest(includeCmHandleProperties)
and: 'cpsDataService returns valid cm-handle datanode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
1 * mockDmiOperations.createResourceDataPassThroughRunningFromDmi('testDmiService',
'testCmHandle',
'testResourceId',
- '{"operation":"create","dataType":"application/json","data":"{some-json}","cmHandleProperties":{"testName":"testValue"}}')
+ '{"operation":"create","dataType":"application/json","data":"{some-json}","cmHandleProperties":'
+ + expectedJsonForCmhandleProperties+ '}')
>> { new ResponseEntity<>(HttpStatus.OK) }
+ where:
+ scenario | includeCmHandleProperties || expectedJsonForCmhandleProperties
+ 'with' | true || '{"testName":"testValue"}'
+ 'without' | false || '{}'
}
def 'Write resource data for pass-through running from dmi using POST "not found" response (from DMI).'() {
given: 'data node representing cmHandle and its properties'
- def cmHandleDataNode = getCmHandleDataNodeForTest()
+ def cmHandleDataNode = getCmHandleDataNodeForTest(true)
and: 'cpsDataService returns valid dataNode'
mockCpsDataService.getDataNode('NCMP-Admin', 'ncmp-dmi-registry',
cmHandleXPath, FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS) >> cmHandleDataNode
}
def 'Sync model for a (new) cm handle with #scenario'() {
- given: 'DMI PLug-in returns a list of module references'
+ given: 'DMI Plug-in returns a list of module references'
getModulesForCmHandle()
def knownModule1 = new ModuleReference('module1', '1')
def knownOtherModule = new ModuleReference('some other module', 'some revision')
1 * mockCpsModuleService.createSchemaSetFromModules(expectedDataspaceName, cmHandleForModelSync.getId(), expectedYangResourceToContentMap, [knownModule1])
and: 'admin service create anchor method has been called with correct parameters'
1 * mockCpsAdminService.createAnchor(expectedDataspaceName, cmHandleForModelSync.getId(), cmHandleForModelSync.getId())
- where: 'the following responses are recieved from SDNC'
+ where: 'the following responses are received from SDNC'
scenario | sdncReponseBody || expectedYangResourceToContentMap
'one unknown module' | '[{"moduleName" : "someModule", "revision" : "1","yangSource": "[some yang source]"}]' || [someModule: 'some yang source']
'no unknown module' | '[]' || [:]
}
+
def 'Getting Yang Resources.'() {
when: 'yang resources is called'
objectUnderTest.getYangResourcesModuleReferences('some cm handle')
def jsonData = TestUtils.getResourceFileContent('cmHandleModules.json')
mockDmiProperties.getAuthUsername() >> 'someUser'
mockDmiProperties.getAuthPassword() >> 'somePassword'
- mockDmiProperties.getDmiPluginBasePath() >> 'someUrl'
def moduleReferencesFromCmHandleAsJson = new ResponseEntity<String>(jsonData, HttpStatus.OK)
mockDmiOperations.getResourceFromDmi(_, cmHandleForModelSync.getId(), 'modules') >> moduleReferencesFromCmHandleAsJson
}
return objectUnderTest
}
- def getCmHandleDataNodeForTest() {
+ def getCmHandleDataNodeForTest(boolean includeCmHandleProperties) {
def cmHandleDataNode = new DataNode()
cmHandleDataNode.leaves = ['dmi-service-name': 'testDmiService']
- def cmHandlePropertyDataNode = new DataNode()
- cmHandlePropertyDataNode.leaves = ['name': 'testName', 'value': 'testValue']
- cmHandleDataNode.childDataNodes = [cmHandlePropertyDataNode]
+ if (includeCmHandleProperties) {
+ def cmHandlePropertyDataNode = new DataNode()
+ cmHandlePropertyDataNode.leaves = ['name': 'testName', 'value': 'testValue']
+ cmHandleDataNode.childDataNodes = [cmHandlePropertyDataNode]
+ }
return cmHandleDataNode
}
@Autowired
DmiRestClient objectUnderTest
+ def resourceUrl = 'some url'
def 'DMI PUT operation.'() {
- given: 'a PUT url'
- def getResourceDataUrl = 'http://some-uri/getResourceDataUrl'
- and: 'the rest template returns a valid response entity'
+ given: 'the rest template returns a valid response entity'
def mockResponseEntity = Mock(ResponseEntity)
- mockRestTemplate.exchange(getResourceDataUrl, HttpMethod.PUT, _ as HttpEntity, Object.class) >> mockResponseEntity
+ mockRestTemplate.exchange(resourceUrl, HttpMethod.PUT, _ as HttpEntity, Object.class) >> mockResponseEntity
when: 'PUT operation is invoked'
- def result = objectUnderTest.putOperationWithJsonData(getResourceDataUrl, 'json-data', new HttpHeaders())
+ def result = objectUnderTest.putOperationWithJsonData(resourceUrl, 'json-data', new HttpHeaders())
then: 'the output of the method is equal to the output from the test template'
result == mockResponseEntity
}
- def 'DMI POST operation.'() {
- given: 'a POST url'
- def getResourceDataUrl = 'http://some-uri/createResourceDataUrl'
- and: 'the rest template returns a valid response entity'
+ def 'DMI POST operation'() {
+ given: 'the rest template returns a valid response entity'
def mockResponseEntity = Mock(ResponseEntity)
- mockRestTemplate.postForEntity(getResourceDataUrl, _ as HttpEntity, String.class) >> mockResponseEntity
+ mockRestTemplate.exchange(resourceUrl, HttpMethod.POST, _ as HttpEntity, String.class) >> mockResponseEntity
when: 'POST operation is invoked'
- def result = objectUnderTest.postOperationWithJsonData(getResourceDataUrl, 'json-data', new HttpHeaders())
+ def result = objectUnderTest.postOperation(resourceUrl, new HttpHeaders())
+ then: 'the output of the method is equal to the output from the rest template'
+ result == mockResponseEntity
+ }
+
+ def 'DMI POST operation with JSON.'() {
+ given: 'the rest template returns a valid response entity'
+ def mockResponseEntity = Mock(ResponseEntity)
+ mockRestTemplate.postForEntity(resourceUrl, _ as HttpEntity, String.class) >> mockResponseEntity
+ when: 'POST operation is invoked'
+ def result = objectUnderTest.postOperationWithJsonData(resourceUrl, 'json-data', new HttpHeaders())
then: 'the output of the method is equal to the output from the test template'
result == mockResponseEntity
}
@Autowired
NcmpConfiguration.DmiProperties dmiProperties
+ def 'NcmpConfiguration Construction.'() {
+ expect: 'the system can create an instance'
+ new NcmpConfiguration() != null
+ }
+
def 'DMI Properties.'() {
expect: 'properties are set to values in test configuration yaml file'
dmiProperties.authUsername == 'some-user'
--- /dev/null
+package org.onap.cps.ncmp.api.models
+
+import spock.lang.Specification
+
+class YangResourceSpec extends Specification {
+
+ YangResource objectUnderTest = new YangResource(moduleName: 'module name',
+ revision:'revision',
+ yangSource:'source')
+
+ def 'Yang resource attributes'() {
+ expect: 'correct module name'
+ objectUnderTest.moduleName == 'module name'
+ and: 'correct revision (this property is not used in production code, hence the need for this test)'
+ objectUnderTest.revision == 'revision'
+ and: 'correct yang source'
+ objectUnderTest.yangSource == 'source'
+ }
+
+}
Code Review / cps.git / commitdiff