From e182a6b6cb4a87b4f461adf83fe60a65948fc230 Mon Sep 17 00:00:00 2001 From: "puthuparambil.aditya" Date: Thu, 10 Dec 2020 16:49:53 +0000 Subject: [PATCH 1/1] Retrieve All anchors for a given Dataspace Issue-ID: CPS-8 Signed-off-by: puthuparambil.aditya Change-Id: Idb2e4f83d390f078345e556d89781e0bf4a9a41f --- cps-rest/docs/api/swagger/openapi.yml | 7 ++++++- .../cps/rest/controller/CpsRestController.java | 5 ++++- .../rest/exceptions/CpsRestExceptionHandler.java | 3 ++- cps-ri/pom.xml | 4 ++++ .../spi/impl/CpsAdminPersistenceServiceImpl.java | 13 +++++++++++++ .../cps/spi/repository/FragmentRepository.java | 11 +++++++++++ .../java/org/onap/cps/api/CpsAdminService.java | 9 +++++++++ .../org/onap/cps/api/impl/CpsAdminServiceImpl.java | 6 ++++++ .../onap/cps/spi/CpsAdminPersistenceService.java | 10 ++++++++++ .../cps/api/impl/CpsAdminServiceImplSpec.groovy | 22 +++++++++++++++++++++- 10 files changed, 86 insertions(+), 4 deletions(-) diff --git a/cps-rest/docs/api/swagger/openapi.yml b/cps-rest/docs/api/swagger/openapi.yml index 56a012ffe..441d5e52c 100755 --- a/cps-rest/docs/api/swagger/openapi.yml +++ b/cps-rest/docs/api/swagger/openapi.yml @@ -61,12 +61,17 @@ paths: 401: description: Unauthorized content: {} + 400: + description: Bad Request + content: {} 403: description: Forbidden - content: {} 404: description: Not Found content: {} + 204: + description: No Content + content: {} post: tags: - cps-rest diff --git a/cps-rest/src/main/java/org/onap/cps/rest/controller/CpsRestController.java b/cps-rest/src/main/java/org/onap/cps/rest/controller/CpsRestController.java index 30d3e24bb..32ea35c5e 100755 --- a/cps-rest/src/main/java/org/onap/cps/rest/controller/CpsRestController.java +++ b/cps-rest/src/main/java/org/onap/cps/rest/controller/CpsRestController.java @@ -26,6 +26,7 @@ import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; +import java.util.Collection; import javax.validation.Valid; import org.modelmapper.ModelMapper; import org.onap.cps.api.CpService; @@ -107,8 +108,10 @@ public class CpsRestController implements CpsRestApi { } @Override + public ResponseEntity getAnchors(final String dataspaceName) { - return null; + final Collection anchorDetails = cpsAdminService.getAnchors(dataspaceName); + return new ResponseEntity<>(anchorDetails, HttpStatus.OK); } @Override diff --git a/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java b/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java index fc0164f5e..00e72a189 100644 --- a/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java +++ b/cps-rest/src/main/java/org/onap/cps/rest/exceptions/CpsRestExceptionHandler.java @@ -23,6 +23,7 @@ import org.apache.commons.lang3.exception.ExceptionUtils; import org.onap.cps.rest.controller.CpsRestController; import org.onap.cps.rest.model.ErrorMessage; import org.onap.cps.spi.exceptions.AnchorAlreadyDefinedException; +import org.onap.cps.spi.exceptions.CpsAdminException; import org.onap.cps.spi.exceptions.CpsException; import org.onap.cps.spi.exceptions.DataValidationException; import org.onap.cps.spi.exceptions.ModelValidationException; @@ -48,7 +49,7 @@ public class CpsRestExceptionHandler { } @ExceptionHandler({ModelValidationException.class, DataValidationException.class, - SchemaSetAlreadyDefinedException.class, AnchorAlreadyDefinedException.class}) + SchemaSetAlreadyDefinedException.class, AnchorAlreadyDefinedException.class, CpsAdminException.class}) public static ResponseEntity handleBadRequestExceptions(final CpsException exception) { return buildErrorResponse(HttpStatus.BAD_REQUEST, exception.getMessage(), extractDetails(exception)); } diff --git a/cps-ri/pom.xml b/cps-ri/pom.xml index b5fe93381..89b19d5ff 100644 --- a/cps-ri/pom.xml +++ b/cps-ri/pom.xml @@ -36,6 +36,10 @@ org.projectlombok lombok + + org.modelmapper + modelmapper + org.springframework.boot diff --git a/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsAdminPersistenceServiceImpl.java b/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsAdminPersistenceServiceImpl.java index f11950721..48e730359 100644 --- a/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsAdminPersistenceServiceImpl.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/impl/CpsAdminPersistenceServiceImpl.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * Modifications Copyright (C) 2020 Bell Canada. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +21,10 @@ package org.onap.cps.spi.impl; +import java.lang.reflect.Type; +import java.util.Collection; +import org.modelmapper.ModelMapper; +import org.modelmapper.TypeToken; import org.onap.cps.spi.CpsAdminPersistenceService; import org.onap.cps.spi.entities.Dataspace; import org.onap.cps.spi.entities.Fragment; @@ -61,4 +66,12 @@ public class CpsAdminPersistenceServiceImpl implements CpsAdminPersistenceServic throw new AnchorAlreadyDefinedException(anchor.getDataspaceName(), anchorName, ex); } } + + @Override + public Collection getAnchors(final String dataspaceName) { + final Dataspace dataspace = dataspaceRepository.getByName(dataspaceName); + final Collection fragments = fragmentRepository.findFragmentsThatAreAnchorsByDataspace(dataspace); + final Type anchorListType = new TypeToken>() {}.getType(); + return new ModelMapper().map(fragments, anchorListType); + } } diff --git a/cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentRepository.java b/cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentRepository.java index ba83f1588..7ae7c13b7 100755 --- a/cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentRepository.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentRepository.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * Modifications Copyright (C) 2020 Bell Canada. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,10 +21,20 @@ package org.onap.cps.spi.repository; +import java.util.Collection; +import org.onap.cps.spi.entities.Dataspace; import org.onap.cps.spi.entities.Fragment; import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; import org.springframework.stereotype.Repository; @Repository public interface FragmentRepository extends JpaRepository { + + default Collection findFragmentsThatAreAnchorsByDataspace(Dataspace dataspace) { + return findFragmentsByDataspaceAndParentFragmentIsNull(dataspace); + } + + Collection findFragmentsByDataspaceAndParentFragmentIsNull(Dataspace dataspace); } \ No newline at end of file diff --git a/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java b/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java index 98ea8ebd8..a2c05bfe5 100644 --- a/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java +++ b/cps-service/src/main/java/org/onap/cps/api/CpsAdminService.java @@ -20,6 +20,7 @@ package org.onap.cps.api; +import java.util.Collection; import org.onap.cps.spi.exceptions.CpsException; import org.onap.cps.spi.model.Anchor; @@ -36,4 +37,12 @@ public interface CpsAdminService { * @throws CpsException if input data is invalid. */ String createAnchor(Anchor anchor); + + /** + * Read all anchors in the given a dataspace. + * + * @param dataspaceName dataspace name + * @return a collection of anchors + */ + Collection getAnchors(String dataspaceName); } diff --git a/cps-service/src/main/java/org/onap/cps/api/impl/CpsAdminServiceImpl.java b/cps-service/src/main/java/org/onap/cps/api/impl/CpsAdminServiceImpl.java index b4deef678..5d9bc015f 100644 --- a/cps-service/src/main/java/org/onap/cps/api/impl/CpsAdminServiceImpl.java +++ b/cps-service/src/main/java/org/onap/cps/api/impl/CpsAdminServiceImpl.java @@ -20,6 +20,7 @@ package org.onap.cps.api.impl; +import java.util.Collection; import org.onap.cps.api.CpsAdminService; import org.onap.cps.spi.CpsAdminPersistenceService; import org.onap.cps.spi.model.Anchor; @@ -36,4 +37,9 @@ public class CpsAdminServiceImpl implements CpsAdminService { public String createAnchor(final Anchor anchor) { return cpsAdminPersistenceService.createAnchor(anchor); } + + @Override + public Collection getAnchors(final String dataspaceName) { + return cpsAdminPersistenceService.getAnchors(dataspaceName); + } } diff --git a/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java b/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java index 6709c1fb0..4e88d49a6 100644 --- a/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java +++ b/cps-service/src/main/java/org/onap/cps/spi/CpsAdminPersistenceService.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * Modifications Copyright (C) 2020 Bell Canada. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,6 +21,7 @@ package org.onap.cps.spi; +import java.util.Collection; import org.onap.cps.spi.model.Anchor; /* @@ -34,4 +36,12 @@ public interface CpsAdminPersistenceService { * @return the anchor name. */ String createAnchor(Anchor anchor); + + /** + * Read all anchors in the given a dataspace. + * + * @param dataspaceName dataspace name + * @return a collection of anchors + */ + Collection getAnchors(String dataspaceName); } diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy index 65a8e71bc..d31a2f72d 100644 --- a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy +++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpsAdminServiceImplSpec.groovy @@ -20,8 +20,8 @@ package org.onap.cps.api.impl - import org.onap.cps.spi.CpsAdminPersistenceService +import org.onap.cps.spi.exceptions.DataspaceNotFoundException import org.onap.cps.spi.model.Anchor import spock.lang.Specification @@ -52,4 +52,24 @@ class CpsAdminServiceImplSpec extends Specification { def exceptionThrownInServiceLayer = thrown(Exception) exceptionThrownInServiceLayer == exceptionThrownInPersistenceLayer } + + def 'Retrieve all anchors for an existing dataspace'() { + given: 'that the dataspace exist and an anchor is associated with the dataspace' + Collection anchorCollection = Arrays.asList(anchor) + mockCpsAdminPersistenceService.getAnchors('dummyDataspace') >> { anchorCollection } + expect: 'we try to retrieve an anchor, a collection of anchor is returned by the service' + objectUnderTest.getAnchors('dummyDataspace') == anchorCollection + } + + def 'Retrieve all anchors for a non existing dataspace'() { + given: 'that the dataspace does not exist, service throws an exception' + def exceptionThrownInPersistenceLayer = new DataspaceNotFoundException(_ as String) + mockCpsAdminPersistenceService.getAnchors('dummyDataspace') >> + { throw exceptionThrownInPersistenceLayer } + when: 'we try to retrieve a anchor with a non-existant dataspace' + objectUnderTest.getAnchors('dummyDataspace') + then: 'the same exception is thrown by CPS' + def exceptionThrownInServiceLayer = thrown(Exception) + exceptionThrownInServiceLayer == exceptionThrownInPersistenceLayer + } } -- 2.16.6