From: niamhcore Date: Mon, 1 Feb 2021 19:16:54 +0000 (+0000) Subject: Refactoring tests and adding tests for creating a node. X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=27add4d028f040a740bed68707c648ee8441eeb2;p=cps.git Refactoring tests and adding tests for creating a node. Issue-ID: CPS-26 Signed-off-by: niamhcore Change-Id: I36e3f2bbb2928cc6b8d0d4a079516f801c33df13 --- diff --git a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy index 5f8147cd5..e0db106d5 100755 --- a/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy +++ b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/AdminRestControllerSpec.groovy @@ -68,30 +68,33 @@ class AdminRestControllerSpec extends Specification { @Value('${rest.api.base-path}') def basePath - def anchorsEndpoint = '/v1/dataspaces/my_dataspace/anchors' - def anchorEndpoint = '/v1/dataspaces/my_dataspace/anchors/my_anchorname' - def schemaSetsEndpoint = '/v1/dataspaces/test-dataspace/schema-sets' - def schemaSetEndpoint = schemaSetsEndpoint + '/my_schema_set' - + def dataspaceName = 'my_dataspace' def anchor = new Anchor(name: 'my_anchor') def anchorList = [anchor] + def anchorName = 'my_anchor' + def schemaSetName = 'my_schema_set' - def 'Create new dataspace'() { - when: - def response = performCreateDataspaceRequest("new-dataspace") - then: 'Service method is invoked with expected parameters' - 1 * mockCpsAdminService.createDataspace("new-dataspace") - and: 'Dataspace is create successfully' + def 'Create new dataspace.'() { + given: 'an endpoint' + def createDataspaceEndpoint = "$basePath/v1/dataspaces"; + when: 'post is invoked' + def response = mvc.perform( + post(createDataspaceEndpoint).param('dataspace-name', dataspaceName)).andReturn().response + then: 'service method is invoked with expected parameters' + 1 * mockCpsAdminService.createDataspace(dataspaceName) + and: 'dataspace is create successfully' response.status == HttpStatus.CREATED.value() } - def 'Create dataspace over existing with same name'() { - given: + def 'Create dataspace over existing with same name.'() { + given: 'an endpoint' + def createDataspaceEndpoint = "$basePath/v1/dataspaces"; + and: 'the service method throws an exception indicating the dataspace is already defined' def thrownException = new DataspaceAlreadyDefinedException("", new RuntimeException()) - mockCpsAdminService.createDataspace("existing-dataspace") >> { throw thrownException } - when: - def response = performCreateDataspaceRequest("existing-dataspace") - then: 'Dataspace creation fails' + mockCpsAdminService.createDataspace(dataspaceName) >> { throw thrownException } + when: 'post is invoked' + def response = mvc.perform(post(createDataspaceEndpoint).param('dataspace-name', dataspaceName)).andReturn().response + then: 'dataspace creation fails' response.status == HttpStatus.BAD_REQUEST.value() } @@ -99,10 +102,13 @@ class AdminRestControllerSpec extends Specification { def yangResourceMapCapture given: 'single yang file' def multipartFile = createMultipartFile("filename.yang", "content") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = mvc.perform(multipart(schemaSetEndpoint) + .file(multipartFile).param('schema-set-name', schemaSetName)).andReturn().response then: 'associated service method is invoked with expected parameters' - 1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >> + 1 * mockCpsModuleService.createSchemaSet(dataspaceName, schemaSetName, _) >> { args -> yangResourceMapCapture = args[2] } yangResourceMapCapture['filename.yang'] == 'content' and: 'response code indicates success' @@ -113,10 +119,13 @@ class AdminRestControllerSpec extends Specification { def yangResourceMapCapture given: 'zip archive with multiple .yang files inside' def multipartFile = createZipMultipartFileFromResource("/yang-files-set.zip") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = mvc.perform(multipart(schemaSetEndpoint) + .file(multipartFile).param('schema-set-name', schemaSetName)).andReturn().response then: 'associated service method is invoked with expected parameters' - 1 * mockCpsModuleService.createSchemaSet('test-dataspace', 'test-schema-set', _) >> + 1 * mockCpsModuleService.createSchemaSet(dataspaceName, schemaSetName, _) >> { args -> yangResourceMapCapture = args[2] } yangResourceMapCapture['assembly.yang'] == "fake assembly content 1\n" yangResourceMapCapture['component.yang'] == "fake component content 1\n" @@ -126,8 +135,11 @@ class AdminRestControllerSpec extends Specification { @Unroll def 'Create schema set from zip archive having #caseDescriptor.'() { + given: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'zip archive having #caseDescriptor is uploaded with create schema set request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = mvc.perform(multipart(schemaSetEndpoint) + .file(multipartFile).param('schema-set-name', schemaSetName)).andReturn().response then: 'create schema set rejected' response.status == HttpStatus.BAD_REQUEST.value() where: 'following cases are tested' @@ -139,16 +151,23 @@ class AdminRestControllerSpec extends Specification { def 'Create schema set from file with unsupported filename extension.'() { given: 'file with unsupported filename extension (.doc)' def multipartFile = createMultipartFile("filename.doc", "content") + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(multipartFile) + def response = mvc.perform(multipart(schemaSetEndpoint) + .file(multipartFile).param('schema-set-name', schemaSetName)).andReturn().response then: 'create schema set rejected' response.status == HttpStatus.BAD_REQUEST.value() } @Unroll def 'Create schema set from #fileType file with IOException occurrence on processing.'() { + given: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets" when: 'file uploaded with schema set create request' - def response = performCreateSchemaSetRequest(createMultipartFileForIOException(fileType)) + def multipartFile = createMultipartFileForIOException(fileType) + def response = mvc.perform(multipart(schemaSetEndpoint) + .file(multipartFile).param('schema-set-name', schemaSetName)).andReturn().response then: 'the error response returned indicating internal server error occurrence' response.status == HttpStatus.INTERNAL_SERVER_ERROR.value() where: 'following file types are used' @@ -156,105 +175,100 @@ class AdminRestControllerSpec extends Specification { } def 'Delete schema set.'() { + given: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets/$schemaSetName" when: 'delete schema set endpoint is invoked' - def response = performDeleteRequest(schemaSetEndpoint) + def response = mvc.perform(delete(schemaSetEndpoint)).andReturn().response then: 'associated service method is invoked with expected parameters' - 1 * mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', CASCADE_DELETE_PROHIBITED) + 1 * mockCpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED) and: 'response code indicates success' response.status == HttpStatus.NO_CONTENT.value() } def 'Delete schema set which is in use.'() { - given: 'the service method throws an exception indicating the schema set is in use' - def thrownException = new SchemaSetInUseException('test-dataspace', 'my_schema_set') - mockCpsModuleService.deleteSchemaSet('test-dataspace', 'my_schema_set', CASCADE_DELETE_PROHIBITED) >> + given: 'service method throws an exception indicating the schema set is in use' + def thrownException = new SchemaSetInUseException(dataspaceName, schemaSetName) + mockCpsModuleService.deleteSchemaSet(dataspaceName, schemaSetName, CASCADE_DELETE_PROHIBITED) >> { throw thrownException } + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets/$schemaSetName" when: 'delete schema set endpoint is invoked' - def response = performDeleteRequest(schemaSetEndpoint) + def response = mvc.perform(delete(schemaSetEndpoint)).andReturn().response then: 'schema set deletion fails with conflict response code' response.status == HttpStatus.CONFLICT.value() } - def performCreateDataspaceRequest(String dataspaceName) { - return mvc.perform( - post("$basePath/v1/dataspaces").param('dataspace-name', dataspaceName) - ).andReturn().response - } - - def createMultipartFile(filename, content) { - return new MockMultipartFile("file", filename, "text/plain", content.getBytes()) - } - - def createZipMultipartFileFromResource(resourcePath) { - return new MockMultipartFile("file", "test.zip", "application/zip", - getClass().getResource(resourcePath).getBytes()) - } - - def createMultipartFileForIOException(extension) { - def multipartFile = Mock(MockMultipartFile) - multipartFile.getOriginalFilename() >> "TEST." + extension - multipartFile.getBytes() >> { throw new IOException() } - multipartFile.getInputStream() >> { throw new IOException() } - return multipartFile - } - - def performCreateSchemaSetRequest(multipartFile) { - return mvc.perform( - multipart("$basePath$schemaSetsEndpoint") - .file(multipartFile) - .param('schema-set-name', 'test-schema-set') - ).andReturn().response - } - - def performDeleteRequest(String deleteEndpoint) { - return mvc.perform(delete("$basePath$deleteEndpoint")).andReturn().response - } - - def 'Get existing schema set'() { - given: - mockCpsModuleService.getSchemaSet('test-dataspace', 'my_schema_set') >> - new SchemaSet(name: 'my_schema_set', dataspaceName: 'test-dataspace') + def 'Get existing schema set.'() { + given: 'service method returns a new schema set' + mockCpsModuleService.getSchemaSet(dataspaceName, schemaSetName) >> + new SchemaSet(name: schemaSetName, dataspaceName: dataspaceName) + and: 'an endpoint' + def schemaSetEndpoint = "$basePath/v1/dataspaces/$dataspaceName/schema-sets/$schemaSetName" when: 'get schema set API is invoked' - def response = mvc.perform(get("$basePath$schemaSetEndpoint")).andReturn().response + def response = mvc.perform(get(schemaSetEndpoint)).andReturn().response then: 'the correct schema set is returned' response.status == HttpStatus.OK.value() - response.getContentAsString().contains('my_schema_set') + response.getContentAsString().contains(schemaSetName) } - def 'Create Anchor'() { - given: + def 'Create Anchor.'() { + given: 'request parameters' def requestParams = new LinkedMultiValueMap<>() - requestParams.add('schema-set-name', 'my_schema-set') - requestParams.add('anchor-name', 'my_anchor') + requestParams.add('schema-set-name', schemaSetName) + requestParams.add('anchor-name', anchorName) + and: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors" when: 'post is invoked' - def response = mvc.perform(post("$basePath$anchorsEndpoint").contentType(MediaType.APPLICATION_JSON) + def response = mvc.perform(post(anchorEndpoint).contentType(MediaType.APPLICATION_JSON) .params(requestParams as MultiValueMap)).andReturn().response - then: 'Anchor is created successfully' - 1 * mockCpsAdminService.createAnchor('my_dataspace', 'my_schema-set', 'my_anchor') + then: 'anchor is created successfully' + 1 * mockCpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName) response.status == HttpStatus.CREATED.value() - response.getContentAsString().contains('my_anchor') + response.getContentAsString().contains(anchorName) } - def 'Get existing anchor'() { - given: - mockCpsAdminService.getAnchors('my_dataspace') >> anchorList + def 'Get existing anchor.'() { + given: 'service method returns a list of anchors' + mockCpsAdminService.getAnchors(dataspaceName) >> anchorList + and: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors" when: 'get all anchors API is invoked' - def response = mvc.perform(get("$basePath$anchorsEndpoint")).andReturn().response + def response = mvc.perform(get(anchorEndpoint)).andReturn().response then: 'the correct anchor is returned' response.status == HttpStatus.OK.value() - response.getContentAsString().contains('my_anchor') + response.getContentAsString().contains(anchorName) } def 'Get existing anchor by dataspace and anchor name.'() { - given: - mockCpsAdminService.getAnchor('my_dataspace','my_anchorname') >> new Anchor(name: 'my_anchorname', dataspaceName: 'my_dataspace', schemaSetName: 'my_schemaSetName') + given: 'service method returns an anchor' + mockCpsAdminService.getAnchor(dataspaceName,anchorName) >> new Anchor(name: anchorName, dataspaceName: dataspaceName, schemaSetName:schemaSetName) + and: 'an endpoint' + def anchorEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName" when: 'get anchor API is invoked' - def response = mvc.perform(get("$basePath$anchorEndpoint")).andReturn().response + def response = mvc.perform(get(anchorEndpoint)) + .andReturn().response def responseContent = response.getContentAsString() then: 'the correct anchor is returned' response.status == HttpStatus.OK.value() - responseContent.contains('my_anchorname') - responseContent.contains('my_dataspace') - responseContent.contains('my_schemaSetName') + responseContent.contains(anchorName) + responseContent.contains(dataspaceName) + responseContent.contains(schemaSetName) + } + + def createMultipartFile(filename, content) { + return new MockMultipartFile("file", filename, "text/plain", content.getBytes()) + } + + def createZipMultipartFileFromResource(resourcePath) { + return new MockMultipartFile("file", "test.zip", "application/zip", + getClass().getResource(resourcePath).getBytes()) + } + + def createMultipartFileForIOException(extension) { + def multipartFile = Mock(MockMultipartFile) + multipartFile.getOriginalFilename() >> "TEST." + extension + multipartFile.getBytes() >> { throw new IOException() } + multipartFile.getInputStream() >> { throw new IOException() } + return multipartFile } } 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 new file mode 100644 index 000000000..bed3ba2c9 --- /dev/null +++ b/cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy @@ -0,0 +1,72 @@ +/* + * ============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.rest.controller + +import org.modelmapper.ModelMapper +import org.onap.cps.api.CpsAdminService +import org.onap.cps.api.CpsDataService +import org.onap.cps.api.CpsModuleService +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 static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post + +@WebMvcTest +class DataRestControllerSpec extends Specification { + + @SpringBean + CpsDataService mockCpsDataService = Mock() + + @SpringBean + CpsModuleService mockCpsModuleService = Mock() + + @SpringBean + CpsAdminService mockCpsAdminService = Mock() + + @SpringBean + ModelMapper modelMapper = Mock() + + @Autowired + MockMvc mvc + + @Value('${rest.api.base-path}') + def basePath + + def dataspaceName = 'my_dataspace' + def anchorName = 'my_anchor' + + def 'Create a node.'() { + given:'an endpoint' + def nodeEndpoint ="$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes" + def json = 'some json (this is not validated)' + when: 'post is invoked' + def response = mvc.perform(post(nodeEndpoint).contentType(MediaType.APPLICATION_JSON).content(json)) + .andReturn().response + then: 'the java API is called with the correct parameters' + 1 * mockCpsDataService.saveData(dataspaceName, anchorName, json) + response.status == HttpStatus.CREATED.value() + } +} \ No newline at end of file diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy new file mode 100644 index 000000000..5874e27ec --- /dev/null +++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsDataServiceImplSpec.groovy @@ -0,0 +1,70 @@ +/* + * ============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.TestUtils +import org.onap.cps.api.CpsAdminService +import org.onap.cps.api.CpsModuleService +import org.onap.cps.spi.CpsDataPersistenceService +import org.onap.cps.spi.model.Anchor +import org.onap.cps.yang.YangTextSchemaSourceSet +import org.onap.cps.yang.YangTextSchemaSourceSetBuilder +import spock.lang.Specification + +class CpsDataServiceImplSpec extends Specification { + def mockCpsDataPersistenceService = Mock(CpsDataPersistenceService) + def mockCpsAdminService = Mock(CpsAdminService) + def mockCpsModuleService = Mock(CpsModuleService) + def mockYangTextSchemaSourceSetCache = Mock(YangTextSchemaSourceSetCache) + + def objectUnderTest = new CpsDataServiceImpl() + + def setup() { + objectUnderTest.cpsDataPersistenceService = mockCpsDataPersistenceService; + objectUnderTest.cpsAdminService = mockCpsAdminService; + objectUnderTest.cpsModuleService = mockCpsModuleService; + objectUnderTest.yangTextSchemaSourceSetCache = mockYangTextSchemaSourceSetCache; + } + + def dataspaceName = 'some dataspace' + def anchorName = 'some anchor' + def schemaSetName = 'some schema set' + + def 'Saving json data.'() { + given: 'that the admin service will return an anchor' + def anchor = new Anchor() + anchor.name = anchorName + anchor.schemaSetName = schemaSetName + mockCpsAdminService.getAnchor(dataspaceName, anchorName) >> anchor + and: 'the schema source set cache returns a schema source set' + def mockYangTextSchemaSourceSet = Mock(YangTextSchemaSourceSet) + mockYangTextSchemaSourceSetCache.get(dataspaceName,schemaSetName) >> mockYangTextSchemaSourceSet + and: 'the schema source sets returns the test-tree schema context' + def yangResourceNameToContent = TestUtils.getYangResourcesAsMap('test-tree.yang') + def schemaContext = YangTextSchemaSourceSetBuilder.of(yangResourceNameToContent).getSchemaContext() + mockYangTextSchemaSourceSet.getSchemaContext() >> schemaContext + when: 'save data method is invoked with test-tree json data' + def jsonData = org.onap.cps.TestUtils.getResourceFileContent('test-tree.json') + objectUnderTest.saveData(dataspaceName, anchorName, jsonData) + then: 'the persistence service method is invoked with correct parameters' + 1 * mockCpsDataPersistenceService.storeDataNode(dataspaceName, anchorName, + { dataNode -> dataNode.xpath == '/test-tree' }) + } +} \ No newline at end of file