From 48830f146f6776afa180fefa101788b169bc841a Mon Sep 17 00:00:00 2001 From: "Rishi.Chail" Date: Mon, 9 Nov 2020 03:28:44 +0000 Subject: [PATCH] =?utf8?q?VSE:=20Create=20an=20anchor=20in=20the=20given?= =?utf8?q?=C2=A0dataspace?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Issue-ID: CPS-42 https://jira.onap.org/browse/CPS-42 Signed-off-by: Rishi Chail Change-Id: If67be6f13889808da4d9fe830595766af67e4fdf --- cps-dependencies/pom.xml | 10 +- cps-rest/docs/api/swagger/openapi.yml | 38 +++--- cps-rest/pom.xml | 4 + .../main/java/org/onap/cps/config/CpsConfig.java | 50 ++++++++ .../cps/rest/controller/CpsRestController.java | 27 ++++- .../onap/cps/swagger/config/SpringFoxConfig.java | 46 -------- .../java/org/onap/cps/spi/entities/Dataspace.java | 5 +- .../java/org/onap/cps/spi/entities/Fragment.java | 15 ++- .../spi/impl/FragmentPersistenceServiceImpl.java | 72 ++++++++++++ .../cps/spi/impl/ModelPersistencyServiceImpl.java | 14 +-- .../cps/spi/repository/DataspaceRepository.java | 10 +- .../cps/spi/repository/FragmentRepository.java | 29 +++++ .../onap/cps/spi/repository/ModuleRepository.java | 26 +++++ cps-ri/src/main/resources/schema.sql | 127 +++++++++++---------- .../src/main/java/org/onap/cps/api/CpService.java | 25 ++-- .../java/org/onap/cps/api/impl/CpServiceImpl.java | 22 +++- .../java/org/onap/cps/api/model/AnchorDetails.java | 42 +++++++ .../java/org/onap/cps/exceptions/CpsException.java | 3 +- .../onap/cps/exceptions/CpsNotFoundException.java | 3 +- .../onap/cps/spi/FragmentPersistenceService.java | 34 ++++++ .../org/onap/cps/api/impl/CpServiceImplSpec.groovy | 55 +++++++++ 21 files changed, 496 insertions(+), 161 deletions(-) mode change 100644 => 100755 cps-dependencies/pom.xml mode change 100644 => 100755 cps-rest/docs/api/swagger/openapi.yml mode change 100644 => 100755 cps-rest/pom.xml create mode 100755 cps-rest/src/main/java/org/onap/cps/config/CpsConfig.java mode change 100644 => 100755 cps-rest/src/main/java/org/onap/cps/rest/controller/CpsRestController.java delete mode 100644 cps-rest/src/main/java/org/onap/cps/swagger/config/SpringFoxConfig.java create mode 100755 cps-ri/src/main/java/org/onap/cps/spi/impl/FragmentPersistenceServiceImpl.java mode change 100644 => 100755 cps-ri/src/main/java/org/onap/cps/spi/impl/ModelPersistencyServiceImpl.java mode change 100644 => 100755 cps-ri/src/main/java/org/onap/cps/spi/repository/DataspaceRepository.java create mode 100755 cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentRepository.java mode change 100644 => 100755 cps-ri/src/main/java/org/onap/cps/spi/repository/ModuleRepository.java mode change 100644 => 100755 cps-ri/src/main/resources/schema.sql mode change 100644 => 100755 cps-service/src/main/java/org/onap/cps/api/CpService.java mode change 100644 => 100755 cps-service/src/main/java/org/onap/cps/api/impl/CpServiceImpl.java create mode 100755 cps-service/src/main/java/org/onap/cps/api/model/AnchorDetails.java create mode 100755 cps-service/src/main/java/org/onap/cps/spi/FragmentPersistenceService.java mode change 100644 => 100755 cps-service/src/test/groovy/org/onap/cps/api/impl/CpServiceImplSpec.groovy diff --git a/cps-dependencies/pom.xml b/cps-dependencies/pom.xml old mode 100644 new mode 100755 index 6286391a5..9e0269b3a --- a/cps-dependencies/pom.xml +++ b/cps-dependencies/pom.xml @@ -1,7 +1,7 @@ + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 org.onap.cps @@ -21,6 +21,7 @@ https://nexus.onap.org /content/repositories/releases/ /content/repositories/snapshots/ + 2.3.8 2.0-M2-groovy-3.0 2.3.3.RELEASE 3.0.0 @@ -93,6 +94,11 @@ commons-lang3 ${commons-lang3.version} + + org.modelmapper + modelmapper + ${modelmapper.version} + \ No newline at end of file diff --git a/cps-rest/docs/api/swagger/openapi.yml b/cps-rest/docs/api/swagger/openapi.yml old mode 100644 new mode 100755 index 82f47c088..0c7c83c56 --- a/cps-rest/docs/api/swagger/openapi.yml +++ b/cps-rest/docs/api/swagger/openapi.yml @@ -81,26 +81,19 @@ paths: type: string requestBody: content: - multipart/form-data: + application/json: schema: - required: - - file - properties: - multipartFile: - type: string - description: multipartFile - format: binary + title: Anchor + description: anchor + $ref: '#/components/schemas/Anchor' required: true responses: - 200: - description: OK + 201: + description: Created content: application/json: schema: - type: object - 201: - description: Created - content: {} + type: string 401: description: Unauthorized content: {} @@ -370,4 +363,19 @@ paths: 404: description: Not Found content: {} -components: {} \ No newline at end of file +components: + schemas: + Anchor: + type: object + title: Anchor + required: + - anchorName + - namespace + - revision + properties: + anchorName: + type: string + namespace: + type: string + revision: + type: string \ No newline at end of file diff --git a/cps-rest/pom.xml b/cps-rest/pom.xml old mode 100644 new mode 100755 index fc3e6325e..3a82ca377 --- a/cps-rest/pom.xml +++ b/cps-rest/pom.xml @@ -50,6 +50,10 @@ org.apache.commons commons-lang3 + + org.modelmapper + modelmapper + org.springframework.boot spring-boot-starter-test diff --git a/cps-rest/src/main/java/org/onap/cps/config/CpsConfig.java b/cps-rest/src/main/java/org/onap/cps/config/CpsConfig.java new file mode 100755 index 000000000..cca5fe7d8 --- /dev/null +++ b/cps-rest/src/main/java/org/onap/cps/config/CpsConfig.java @@ -0,0 +1,50 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. 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. + * 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.config; + +import org.modelmapper.ModelMapper; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; + +@Configuration +public class CpsConfig { + + /** + * Swagger configuration. + */ + @Bean + public Docket api() { + return new Docket(DocumentationType.OAS_30).select().apis(RequestHandlerSelectors.any()) + .paths(PathSelectors.any()).build(); + } + + /** + * ModelMapper configuration. + */ + @Bean + public ModelMapper modelMapper() { + return new ModelMapper(); + } +} \ No newline at end of file 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 old mode 100644 new mode 100755 index f0c5fcbc4..9e57408fb --- 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 @@ -27,10 +27,13 @@ import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStream; import javax.validation.Valid; +import org.modelmapper.ModelMapper; import org.onap.cps.api.CpService; +import org.onap.cps.api.model.AnchorDetails; import org.onap.cps.exceptions.CpsException; import org.onap.cps.exceptions.CpsValidationException; import org.onap.cps.rest.api.CpsRestApi; +import org.onap.cps.rest.model.Anchor; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; @@ -49,9 +52,22 @@ public class CpsRestController implements CpsRestApi { @Autowired private CpService cpService; + @Autowired + private ModelMapper modelMapper; + + /** + * Create a new anchor. + * + * @param anchor the anchor details object. + * @param dataspaceName the dataspace name. + * @return a ResponseEntity with the anchor name. + */ @Override - public ResponseEntity createAnchor(@Valid MultipartFile multipartFile, String dataspaceName) { - return null; + public final ResponseEntity createAnchor(@Valid Anchor anchor, String dataspaceName) { + final AnchorDetails anchorDetails = modelMapper.map(anchor, AnchorDetails.class); + anchorDetails.setDataspace(dataspaceName); + final String anchorName = cpService.createAnchor(anchorDetails); + return new ResponseEntity(anchorName, HttpStatus.CREATED); } @Override @@ -151,7 +167,7 @@ public class CpsRestController implements CpsRestApi { try { final Gson gson = new Gson(); gson.fromJson(getJsonString(multipartFile), Object.class); - } catch (JsonSyntaxException e) { + } catch (final JsonSyntaxException e) { throw new CpsValidationException("Not a valid JSON file.", e); } } @@ -160,13 +176,12 @@ public class CpsRestController implements CpsRestApi { try { final File file = File.createTempFile("tempFile", ".yang"); file.deleteOnExit(); - try (OutputStream outputStream = new FileOutputStream(file)) { outputStream.write(multipartFile.getBytes()); } return file; - } catch (IOException e) { + } catch (final IOException e) { throw new CpsException(e); } } @@ -174,7 +189,7 @@ public class CpsRestController implements CpsRestApi { private static String getJsonString(final MultipartFile multipartFile) { try { return new String(multipartFile.getBytes()); - } catch (IOException e) { + } catch (final IOException e) { throw new CpsException(e); } } diff --git a/cps-rest/src/main/java/org/onap/cps/swagger/config/SpringFoxConfig.java b/cps-rest/src/main/java/org/onap/cps/swagger/config/SpringFoxConfig.java deleted file mode 100644 index 73e179511..000000000 --- a/cps-rest/src/main/java/org/onap/cps/swagger/config/SpringFoxConfig.java +++ /dev/null @@ -1,46 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * 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. - * 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.swagger.config; - -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -import springfox.documentation.builders.PathSelectors; -import springfox.documentation.builders.RequestHandlerSelectors; -import springfox.documentation.spi.DocumentationType; -import springfox.documentation.spring.web.plugins.Docket; - -/** - * Swagger configuration. - */ -@Configuration -public class SpringFoxConfig { - - /** - * Define api configuration. - */ - @Bean - public Docket api() { - return new Docket(DocumentationType.OAS_30) - .select() - .apis(RequestHandlerSelectors.any()) - .paths(PathSelectors.any()) - .build(); - } -} diff --git a/cps-ri/src/main/java/org/onap/cps/spi/entities/Dataspace.java b/cps-ri/src/main/java/org/onap/cps/spi/entities/Dataspace.java index 627a14467..aeab4f844 100644 --- a/cps-ri/src/main/java/org/onap/cps/spi/entities/Dataspace.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/entities/Dataspace.java @@ -19,6 +19,7 @@ package org.onap.cps.spi.entities; +import java.io.Serializable; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.GeneratedValue; @@ -41,7 +42,9 @@ import lombok.Setter; @AllArgsConstructor @NoArgsConstructor @Table(name = "dataspace") -public class Dataspace { +public class Dataspace implements Serializable { + + private static final long serialVersionUID = 8395254649813051882L; @Id @GeneratedValue(strategy = GenerationType.IDENTITY) diff --git a/cps-ri/src/main/java/org/onap/cps/spi/entities/Fragment.java b/cps-ri/src/main/java/org/onap/cps/spi/entities/Fragment.java index 12422dc5f..4d8a90b73 100644 --- a/cps-ri/src/main/java/org/onap/cps/spi/entities/Fragment.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/entities/Fragment.java @@ -21,6 +21,7 @@ package org.onap.cps.spi.entities; import com.vladmihalcea.hibernate.type.json.JsonBinaryType; +import java.io.Serializable; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; @@ -32,6 +33,7 @@ import javax.persistence.ManyToOne; import javax.persistence.OneToOne; import javax.validation.constraints.NotNull; import lombok.AllArgsConstructor; +import lombok.Builder; import lombok.Getter; import lombok.NoArgsConstructor; import lombok.Setter; @@ -47,8 +49,11 @@ import org.hibernate.annotations.TypeDefs; @Entity @AllArgsConstructor @NoArgsConstructor +@Builder @TypeDefs({@TypeDef(name = "jsonb", typeClass = JsonBinaryType.class)}) -public class Fragment { +public class Fragment implements Serializable { + + private static final long serialVersionUID = 7737669789097119667L; @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @@ -62,6 +67,10 @@ public class Fragment { @Column(columnDefinition = "jsonb") private String attributes; + @Column(columnDefinition = "text") + private String anchorName; + + @NotNull @ManyToOne(fetch = FetchType.LAZY) @JoinColumn(name = "dataspace_id") private Dataspace dataspace; @@ -73,4 +82,8 @@ public class Fragment { @OneToOne(fetch = FetchType.LAZY) @JoinColumn(name = "parent_id") private Fragment parentFragment; + + @OneToOne(fetch = FetchType.LAZY) + @JoinColumn(name = "module_id") + private ModuleEntity module; } diff --git a/cps-ri/src/main/java/org/onap/cps/spi/impl/FragmentPersistenceServiceImpl.java b/cps-ri/src/main/java/org/onap/cps/spi/impl/FragmentPersistenceServiceImpl.java new file mode 100755 index 000000000..47d98c92b --- /dev/null +++ b/cps-ri/src/main/java/org/onap/cps/spi/impl/FragmentPersistenceServiceImpl.java @@ -0,0 +1,72 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. 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. + * 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.spi.impl; + +import org.onap.cps.api.model.AnchorDetails; +import org.onap.cps.exceptions.CpsNotFoundException; +import org.onap.cps.exceptions.CpsValidationException; +import org.onap.cps.spi.FragmentPersistenceService; +import org.onap.cps.spi.entities.Dataspace; +import org.onap.cps.spi.entities.Fragment; +import org.onap.cps.spi.entities.ModuleEntity; +import org.onap.cps.spi.repository.DataspaceRepository; +import org.onap.cps.spi.repository.FragmentRepository; +import org.onap.cps.spi.repository.ModuleRepository; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.dao.DataIntegrityViolationException; +import org.springframework.stereotype.Component; + +@Component +public class FragmentPersistenceServiceImpl implements FragmentPersistenceService { + + @Autowired + private DataspaceRepository dataspaceRepository; + + @Autowired + private FragmentRepository fragmentRepository; + + @Autowired + private ModuleRepository moduleRepository; + + @Override + public String createAnchor(final AnchorDetails anchorDetails) { + try { + final Dataspace dataspace = dataspaceRepository.getByName(anchorDetails.getDataspace()); + final ModuleEntity moduleEntity = + moduleRepository.getByDataspaceAndNamespaceAndRevision(dataspace, + anchorDetails.getNamespace(), anchorDetails.getRevision()); + + final Fragment fragment = Fragment.builder().xpath(anchorDetails.getAnchorName()) + .anchorName(anchorDetails.getAnchorName()) + .dataspace(dataspace).module(moduleEntity).build(); + + fragmentRepository.save(fragment); + return anchorDetails.getAnchorName(); + } catch (final CpsNotFoundException ex) { + throw new CpsValidationException("Validation Error", + String.format("Dataspace and/or Module do not exist.")); + } catch (final DataIntegrityViolationException ex) { + throw new CpsValidationException("Duplication Error", + String.format("Anchor with name %s already exist in dataspace %s.", + anchorDetails.getAnchorName(), anchorDetails.getDataspace())); + } + } +} \ No newline at end of file diff --git a/cps-ri/src/main/java/org/onap/cps/spi/impl/ModelPersistencyServiceImpl.java b/cps-ri/src/main/java/org/onap/cps/spi/impl/ModelPersistencyServiceImpl.java old mode 100644 new mode 100755 index 01c7a7b53..56bba04b7 --- a/cps-ri/src/main/java/org/onap/cps/spi/impl/ModelPersistencyServiceImpl.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/impl/ModelPersistencyServiceImpl.java @@ -31,17 +31,11 @@ import org.springframework.stereotype.Component; @Component public class ModelPersistencyServiceImpl implements ModelPersistencyService { - - private final ModuleRepository moduleRepository; - - private final DataspaceRepository dataspaceRepository; + @Autowired + private ModuleRepository moduleRepository; @Autowired - public ModelPersistencyServiceImpl(final ModuleRepository moduleRepository, - final DataspaceRepository dataspaceRepository) { - this.moduleRepository = moduleRepository; - this.dataspaceRepository = dataspaceRepository; - } + private DataspaceRepository dataspaceRepository; @Override public void storeModule(final String namespace, final String moduleContent, final String revision, @@ -50,7 +44,7 @@ public class ModelPersistencyServiceImpl implements ModelPersistencyService { if (Boolean.FALSE.equals(dataspaceRepository.existsByName(dataspaceName))) { dataspaceRepository.save(dataspace); } - dataspace.setId(dataspaceRepository.findByName(dataspaceName).getId()); + dataspace.setId(dataspaceRepository.getByName(dataspaceName).getId()); final ModuleEntity moduleEntity = new ModuleEntity(namespace, moduleContent, revision, dataspace); moduleRepository.save(moduleEntity); } diff --git a/cps-ri/src/main/java/org/onap/cps/spi/repository/DataspaceRepository.java b/cps-ri/src/main/java/org/onap/cps/spi/repository/DataspaceRepository.java old mode 100644 new mode 100755 index 46a526610..ad8004c07 --- a/cps-ri/src/main/java/org/onap/cps/spi/repository/DataspaceRepository.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/repository/DataspaceRepository.java @@ -20,6 +20,9 @@ package org.onap.cps.spi.repository; +import java.util.Optional; +import javax.validation.constraints.NotNull; +import org.onap.cps.exceptions.CpsNotFoundException; import org.onap.cps.spi.entities.Dataspace; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; @@ -28,5 +31,10 @@ import org.springframework.stereotype.Repository; public interface DataspaceRepository extends JpaRepository { Boolean existsByName(String name); //Checks if there are any records by name() - Dataspace findByName(String name); + Optional findByName(@NotNull String name); + + default Dataspace getByName(@NotNull String name) { + return findByName(name).orElseThrow( + () -> new CpsNotFoundException("Not Found", "Dataspace " + name + " does not exist.")); + } } \ No newline at end of file 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 new file mode 100755 index 000000000..ba83f1588 --- /dev/null +++ b/cps-ri/src/main/java/org/onap/cps/spi/repository/FragmentRepository.java @@ -0,0 +1,29 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. 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. + * 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.spi.repository; + +import org.onap.cps.spi.entities.Fragment; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.stereotype.Repository; + +@Repository +public interface FragmentRepository extends JpaRepository { +} \ No newline at end of file diff --git a/cps-ri/src/main/java/org/onap/cps/spi/repository/ModuleRepository.java b/cps-ri/src/main/java/org/onap/cps/spi/repository/ModuleRepository.java old mode 100644 new mode 100755 index f9078d7c1..fe27c8ec3 --- a/cps-ri/src/main/java/org/onap/cps/spi/repository/ModuleRepository.java +++ b/cps-ri/src/main/java/org/onap/cps/spi/repository/ModuleRepository.java @@ -20,10 +20,36 @@ package org.onap.cps.spi.repository; +import java.util.Optional; +import javax.validation.constraints.NotNull; +import org.onap.cps.exceptions.CpsNotFoundException; +import org.onap.cps.spi.entities.Dataspace; import org.onap.cps.spi.entities.ModuleEntity; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; @Repository public interface ModuleRepository extends JpaRepository { + + Optional findByDataspaceAndNamespaceAndRevision(@NotNull Dataspace dataspace, + @NotNull String namespace, + @NotNull String revision); + + /** + * This method gets a ModuleEntity by dataspace, namespace and revision. + * + * @param dataspace the dataspace + * @param namespace the namespace + * @param revision the revision + * @return the ModuleEntity + * @throws CpsNotFoundException if ModuleEntity not found + */ + default ModuleEntity getByDataspaceAndNamespaceAndRevision(@NotNull Dataspace dataspace, @NotNull String namespace, + @NotNull String revision) { + return findByDataspaceAndNamespaceAndRevision(dataspace, namespace, + revision) + .orElseThrow(() -> new CpsNotFoundException("Validation Error", String.format( + "Module with dataspace %s, revision %s does not exist in namespace %s.", + dataspace.getName(), revision, namespace))); + } } \ No newline at end of file diff --git a/cps-ri/src/main/resources/schema.sql b/cps-ri/src/main/resources/schema.sql old mode 100644 new mode 100755 index ba05048e8..3fabc6c9f --- a/cps-ri/src/main/resources/schema.sql +++ b/cps-ri/src/main/resources/schema.sql @@ -1,64 +1,65 @@ -CREATE TABLE IF NOT EXISTS RELATION_TYPE -( - RELATION_TYPE TEXT NOT NULL, - ID SERIAL PRIMARY KEY -); - -CREATE TABLE IF NOT EXISTS DATASPACE -( - ID SERIAL PRIMARY KEY, - NAME TEXT NOT NULL, - CONSTRAINT "UQ_NAME" UNIQUE (NAME) -); - -CREATE TABLE IF NOT EXISTS SCHEMA_NODE -( - SCHEMA_NODE_IDENTIFIER TEXT NOT NULL, - ID SERIAL PRIMARY KEY -); - -CREATE TABLE IF NOT EXISTS MODULE -( - NAMESPACE TEXT NOT NULL, - REVISION TEXT NOT NULL, - MODULE_CONTENT TEXT NOT NULL, - DATASPACE_ID BIGINT NOT NULL, - ID SERIAL PRIMARY KEY, - UNIQUE (DATASPACE_ID, NAMESPACE, REVISION), - CONSTRAINT module_dataspace FOREIGN KEY (DATASPACE_ID) REFERENCES DATASPACE (id) ON UPDATE CASCADE ON DELETE CASCADE -); - -CREATE TABLE IF NOT EXISTS FRAGMENT -( - ID BIGSERIAL PRIMARY KEY, - XPATH TEXT NOT NULL, - DATASPACE_ID INTEGER NOT NULL REFERENCES DATASPACE(ID), - ATTRIBUTES JSONB, - ANCHOR_ID BIGINT REFERENCES FRAGMENT(ID), - PARENT_ID BIGINT REFERENCES FRAGMENT(ID), - MODULE_ID INTEGER REFERENCES MODULE(ID), - SCHEMA_NODE_ID INTEGER REFERENCES SCHEMA_NODE(ID) -); - -CREATE TABLE IF NOT EXISTS RELATION -( - FROM_FRAGMENT_ID BIGINT NOT NULL REFERENCES FRAGMENT(ID), - TO_FRAGMENT_ID BIGINT NOT NULL REFERENCES FRAGMENT(ID), - RELATION_TYPE_ID INTEGER NOT NULL REFERENCES RELATION_TYPE(ID), - FROM_REL_XPATH TEXT NOT NULL, - TO_REL_XPATH TEXT NOT NULL, - CONSTRAINT RELATION_PKEY PRIMARY KEY (TO_FRAGMENT_ID, FROM_FRAGMENT_ID, RELATION_TYPE_ID) -); - - -CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_DATASPACE_ID_FK" ON FRAGMENT USING BTREE(DATASPACE_ID) ; -CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_MODULE_ID_FK" ON FRAGMENT USING BTREE(MODULE_ID) ; -CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_PARENT_ID_FK" ON FRAGMENT USING BTREE(PARENT_ID) ; -CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_ANCHOR_ID_FK" ON FRAGMENT USING BTREE(ANCHOR_ID) ; -CREATE INDEX IF NOT EXISTS "PERF_SCHEMA_NODE_SCHEMA_NODE_ID" ON SCHEMA_NODE USING BTREE(SCHEMA_NODE_IDENTIFIER) ; -CREATE INDEX IF NOT EXISTS "FKI_SCHEMA_NODE_ID_TO_ID" ON FRAGMENT USING BTREE(SCHEMA_NODE_ID) ; -CREATE INDEX IF NOT EXISTS "FKI_RELATION_TYPE_ID_FK" ON RELATION USING BTREE(RELATION_TYPE_ID); -CREATE INDEX IF NOT EXISTS "FKI_RELATIONS_FROM_ID_FK" ON RELATION USING BTREE(FROM_FRAGMENT_ID); -CREATE INDEX IF NOT EXISTS "FKI_RELATIONS_TO_ID_FK" ON RELATION USING BTREE(TO_FRAGMENT_ID); -CREATE INDEX IF NOT EXISTS "PERF_MODULE_MODULE_CONTENT" ON MODULE USING BTREE(MODULE_CONTENT); +CREATE TABLE IF NOT EXISTS RELATION_TYPE +( + RELATION_TYPE TEXT NOT NULL, + ID SERIAL PRIMARY KEY +); + +CREATE TABLE IF NOT EXISTS DATASPACE +( + ID SERIAL PRIMARY KEY, + NAME TEXT NOT NULL, + CONSTRAINT "UQ_NAME" UNIQUE (NAME) +); + +CREATE TABLE IF NOT EXISTS SCHEMA_NODE +( + SCHEMA_NODE_IDENTIFIER TEXT NOT NULL, + ID SERIAL PRIMARY KEY +); + +CREATE TABLE IF NOT EXISTS MODULE +( + ID SERIAL PRIMARY KEY, + NAMESPACE TEXT NOT NULL, + REVISION TEXT NOT NULL, + MODULE_CONTENT TEXT NOT NULL, + DATASPACE_ID BIGINT NOT NULL, + UNIQUE (DATASPACE_ID, NAMESPACE, REVISION), + CONSTRAINT MODULE_DATASPACE FOREIGN KEY (DATASPACE_ID) REFERENCES DATASPACE (id) ON UPDATE CASCADE ON DELETE CASCADE +); + +CREATE TABLE IF NOT EXISTS FRAGMENT +( + ID BIGSERIAL PRIMARY KEY, + XPATH TEXT NOT NULL, + ATTRIBUTES JSONB, + ANCHOR_NAME TEXT, + ANCHOR_ID BIGINT REFERENCES FRAGMENT(ID), + PARENT_ID BIGINT REFERENCES FRAGMENT(ID), + MODULE_ID INTEGER REFERENCES MODULE(ID), + DATASPACE_ID INTEGER NOT NULL REFERENCES DATASPACE(ID), + SCHEMA_NODE_ID INTEGER REFERENCES SCHEMA_NODE(ID), + UNIQUE (DATASPACE_ID, ANCHOR_NAME, XPATH) +); + +CREATE TABLE IF NOT EXISTS RELATION +( + FROM_FRAGMENT_ID BIGINT NOT NULL REFERENCES FRAGMENT(ID), + TO_FRAGMENT_ID BIGINT NOT NULL REFERENCES FRAGMENT(ID), + RELATION_TYPE_ID INTEGER NOT NULL REFERENCES RELATION_TYPE(ID), + FROM_REL_XPATH TEXT NOT NULL, + TO_REL_XPATH TEXT NOT NULL, + CONSTRAINT RELATION_PKEY PRIMARY KEY (TO_FRAGMENT_ID, FROM_FRAGMENT_ID, RELATION_TYPE_ID) +); + +CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_DATASPACE_ID_FK" ON FRAGMENT USING BTREE(DATASPACE_ID) ; +CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_MODULE_ID_FK" ON FRAGMENT USING BTREE(MODULE_ID) ; +CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_PARENT_ID_FK" ON FRAGMENT USING BTREE(PARENT_ID) ; +CREATE INDEX IF NOT EXISTS "FKI_FRAGMENT_ANCHOR_ID_FK" ON FRAGMENT USING BTREE(ANCHOR_ID) ; +CREATE INDEX IF NOT EXISTS "PERF_SCHEMA_NODE_SCHEMA_NODE_ID" ON SCHEMA_NODE USING BTREE(SCHEMA_NODE_IDENTIFIER) ; +CREATE INDEX IF NOT EXISTS "FKI_SCHEMA_NODE_ID_TO_ID" ON FRAGMENT USING BTREE(SCHEMA_NODE_ID) ; +CREATE INDEX IF NOT EXISTS "FKI_RELATION_TYPE_ID_FK" ON RELATION USING BTREE(RELATION_TYPE_ID); +CREATE INDEX IF NOT EXISTS "FKI_RELATIONS_FROM_ID_FK" ON RELATION USING BTREE(FROM_FRAGMENT_ID); +CREATE INDEX IF NOT EXISTS "FKI_RELATIONS_TO_ID_FK" ON RELATION USING BTREE(TO_FRAGMENT_ID); +CREATE INDEX IF NOT EXISTS "PERF_MODULE_MODULE_CONTENT" ON MODULE USING BTREE(MODULE_CONTENT); CREATE UNIQUE INDEX IF NOT EXISTS "UQ_FRAGMENT_XPATH"ON FRAGMENT USING btree(xpath COLLATE pg_catalog."default" text_pattern_ops, dataspace_id); \ No newline at end of file diff --git a/cps-service/src/main/java/org/onap/cps/api/CpService.java b/cps-service/src/main/java/org/onap/cps/api/CpService.java old mode 100644 new mode 100755 index 4d94a4654..6b59949ca --- a/cps-service/src/main/java/org/onap/cps/api/CpService.java +++ b/cps-service/src/main/java/org/onap/cps/api/CpService.java @@ -21,9 +21,9 @@ package org.onap.cps.api; import java.io.File; -import java.io.IOException; +import org.onap.cps.api.model.AnchorDetails; +import org.onap.cps.exceptions.CpsValidationException; import org.opendaylight.yangtools.yang.model.api.SchemaContext; -import org.opendaylight.yangtools.yang.model.parser.api.YangParserException; /** * Configuration and persistency service interface which holds methods for parsing and storing yang models and data. @@ -36,7 +36,7 @@ public interface CpService { * @param yangModelContent the input stream * @return the schema context */ - SchemaContext parseAndValidateModel(final String yangModelContent); + SchemaContext parseAndValidateModel(String yangModelContent); /** * Parse and validate a file representing a yang model to generate a schema context. @@ -44,7 +44,7 @@ public interface CpService { * @param yangModelFile the yang file * @return the schema context */ - SchemaContext parseAndValidateModel(final File yangModelFile); + SchemaContext parseAndValidateModel(File yangModelFile); /** * Store schema context for a yang model. @@ -52,7 +52,7 @@ public interface CpService { * @param schemaContext the schema context * @param dataspaceName the dataspace name */ - void storeSchemaContext(final SchemaContext schemaContext, final String dataspaceName); + void storeSchemaContext(SchemaContext schemaContext, String dataspaceName); /** * Store the JSON structure in the database. @@ -60,7 +60,7 @@ public interface CpService { * @param jsonStructure the JSON structure. * @return entity ID. */ - Integer storeJsonStructure(final String jsonStructure); + Integer storeJsonStructure(String jsonStructure); /** * Read a JSON Object using the object identifier. @@ -68,12 +68,21 @@ public interface CpService { * @param jsonObjectId the JSON object identifier. * @return the JSON structure. */ - String getJsonById(final int jsonObjectId); + String getJsonById(int jsonObjectId); /** * Delete a JSON Object using the object identifier. * * @param jsonObjectId the JSON object identifier. */ - void deleteJsonById(final int jsonObjectId); + void deleteJsonById(int jsonObjectId); + + /** + * Create an anchor using provided anchorDetails object. + * + * @param anchorDetails the anchor details object. + * @return the anchor name. + * @throws CpsValidationException if input data is invalid. + */ + String createAnchor(AnchorDetails anchorDetails); } diff --git a/cps-service/src/main/java/org/onap/cps/api/impl/CpServiceImpl.java b/cps-service/src/main/java/org/onap/cps/api/impl/CpServiceImpl.java old mode 100644 new mode 100755 index c33746e86..8cdadbeb5 --- a/cps-service/src/main/java/org/onap/cps/api/impl/CpServiceImpl.java +++ b/cps-service/src/main/java/org/onap/cps/api/impl/CpServiceImpl.java @@ -26,9 +26,11 @@ import java.io.FileWriter; import java.io.IOException; import java.util.Optional; import org.onap.cps.api.CpService; +import org.onap.cps.api.model.AnchorDetails; import org.onap.cps.exceptions.CpsException; import org.onap.cps.exceptions.CpsValidationException; import org.onap.cps.spi.DataPersistencyService; +import org.onap.cps.spi.FragmentPersistenceService; import org.onap.cps.spi.ModelPersistencyService; import org.onap.cps.utils.YangUtils; import org.opendaylight.yangtools.yang.common.Revision; @@ -48,6 +50,9 @@ public class CpServiceImpl implements CpService { @Autowired private DataPersistencyService dataPersistencyService; + @Autowired + private FragmentPersistenceService fragmentPersistenceService; + @Override public final SchemaContext parseAndValidateModel(final String yangModelContent) { @@ -57,7 +62,7 @@ public class CpServiceImpl implements CpService { writer.write(yangModelContent); } return parseAndValidateModel(tempFile); - } catch (IOException e) { + } catch (final IOException e) { throw new CpsException(e); } } @@ -66,9 +71,9 @@ public class CpServiceImpl implements CpService { public final SchemaContext parseAndValidateModel(final File yangModelFile) { try { return YangUtils.parseYangModelFile(yangModelFile); - } catch (YangParserException e) { + } catch (final YangParserException e) { throw new CpsValidationException("Yang file validation failed", e.getMessage()); - } catch (IOException e) { + } catch (final IOException e) { throw new CpsException(e); } } @@ -91,10 +96,15 @@ public class CpServiceImpl implements CpService { @Override public final void storeSchemaContext(final SchemaContext schemaContext, final String dataspaceName) { for (final Module module : schemaContext.getModules()) { - Optional optionalRevision = module.getRevision(); - String revisionValue = optionalRevision.isPresent() ? optionalRevision.get().toString() : null; + final Optional optionalRevision = module.getRevision(); + final String revisionValue = optionalRevision.map(Object::toString).orElse(null); modelPersistencyService.storeModule(module.getNamespace().toString(), module.toString(), revisionValue, dataspaceName); } } -} + + @Override + public String createAnchor(AnchorDetails anchorDetails) { + return fragmentPersistenceService.createAnchor(anchorDetails); + } +} \ No newline at end of file diff --git a/cps-service/src/main/java/org/onap/cps/api/model/AnchorDetails.java b/cps-service/src/main/java/org/onap/cps/api/model/AnchorDetails.java new file mode 100755 index 000000000..576168ae7 --- /dev/null +++ b/cps-service/src/main/java/org/onap/cps/api/model/AnchorDetails.java @@ -0,0 +1,42 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. 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. + * 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.model; + +import java.io.Serializable; +import lombok.Getter; +import lombok.NoArgsConstructor; +import lombok.Setter; + +@Getter +@Setter +@NoArgsConstructor +public class AnchorDetails implements Serializable { + + private static final long serialVersionUID = 1464791260718603291L; + + private String anchorName; + + private String dataspace; + + private String namespace; + + private String revision; +} \ No newline at end of file diff --git a/cps-service/src/main/java/org/onap/cps/exceptions/CpsException.java b/cps-service/src/main/java/org/onap/cps/exceptions/CpsException.java index b54453cd9..4dd19dd82 100644 --- a/cps-service/src/main/java/org/onap/cps/exceptions/CpsException.java +++ b/cps-service/src/main/java/org/onap/cps/exceptions/CpsException.java @@ -20,13 +20,14 @@ package org.onap.cps.exceptions; import lombok.Getter; -import org.springframework.core.NestedExceptionUtils; /** * CP Service exception. */ public class CpsException extends RuntimeException { + private static final long serialVersionUID = 5573438585188332404L; + @Getter String details; diff --git a/cps-service/src/main/java/org/onap/cps/exceptions/CpsNotFoundException.java b/cps-service/src/main/java/org/onap/cps/exceptions/CpsNotFoundException.java index f44fe806c..4613da8f2 100644 --- a/cps-service/src/main/java/org/onap/cps/exceptions/CpsNotFoundException.java +++ b/cps-service/src/main/java/org/onap/cps/exceptions/CpsNotFoundException.java @@ -19,13 +19,14 @@ package org.onap.cps.exceptions; -import lombok.Getter; /** * CP Service exception. Indicates the requested data being absent. */ public class CpsNotFoundException extends CpsException { + private static final long serialVersionUID = -1852996415384288431L; + /** * Constructor. * diff --git a/cps-service/src/main/java/org/onap/cps/spi/FragmentPersistenceService.java b/cps-service/src/main/java/org/onap/cps/spi/FragmentPersistenceService.java new file mode 100755 index 000000000..48dbb0cc2 --- /dev/null +++ b/cps-service/src/main/java/org/onap/cps/spi/FragmentPersistenceService.java @@ -0,0 +1,34 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation. 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. + * 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.spi; + +import org.onap.cps.api.model.AnchorDetails; + +public interface FragmentPersistenceService { + + /** + * Create an Anchor. + * + * @param anchorDetails the anchorDetails object. + * @return the anchor name. + */ + String createAnchor(AnchorDetails anchorDetails); +} diff --git a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpServiceImplSpec.groovy b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpServiceImplSpec.groovy old mode 100644 new mode 100755 index 5f42810bd..3c51cca59 --- a/cps-service/src/test/groovy/org/onap/cps/api/impl/CpServiceImplSpec.groovy +++ b/cps-service/src/test/groovy/org/onap/cps/api/impl/CpServiceImplSpec.groovy @@ -21,8 +21,11 @@ package org.onap.cps.api.impl import org.onap.cps.TestUtils +import org.onap.cps.api.model.AnchorDetails +import org.onap.cps.exceptions.CpsNotFoundException import org.onap.cps.exceptions.CpsValidationException import org.onap.cps.spi.DataPersistencyService +import org.onap.cps.spi.FragmentPersistenceService import org.opendaylight.yangtools.yang.common.Revision import org.opendaylight.yangtools.yang.model.api.SchemaContext import spock.lang.Specification @@ -30,10 +33,12 @@ import spock.lang.Specification class CpServiceImplSpec extends Specification { def mockDataPersistencyService = Mock(DataPersistencyService) + def mockFragmentPersistenceService = Mock(FragmentPersistenceService) def objectUnderTest = new CpServiceImpl() def setup() { objectUnderTest.dataPersistencyService = mockDataPersistencyService + objectUnderTest.fragmentPersistenceService = mockFragmentPersistenceService } def 'Cps Service provides to its client the id assigned by the system when storing a data structure'() { @@ -113,4 +118,54 @@ class CpServiceImplSpec extends Specification { then: 'the same exception is thrown by CPS' thrown(IllegalStateException) } + + def 'Create an anchor with a non-existant dataspace'(){ + given: 'that the dataspace does not exist service throws an exception' + AnchorDetails anchorDetails = new AnchorDetails() + anchorDetails.setDataspace('dummyDataspace') + mockFragmentPersistenceService.createAnchor(anchorDetails) >> {throw new CpsValidationException(_ as String, _ as String)} + when: 'we try to create a anchor with a non-existant dataspace' + objectUnderTest.createAnchor(anchorDetails) + then: 'the same exception is thrown by CPS' + thrown(CpsValidationException) + } + + def 'Create an anchor with invalid dataspace, namespace and revision'(){ + given: 'that the dataspace, namespace and revison combination does not exist service throws an exception' + AnchorDetails anchorDetails = new AnchorDetails() + anchorDetails.setDataspace('dummyDataspace') + anchorDetails.setNamespace('dummyNamespace') + anchorDetails.setRevision('dummyRevision') + mockFragmentPersistenceService.createAnchor(anchorDetails) >> {throw new CpsValidationException(_ as String, _ as String)} + when: 'we try to create a anchor with a non-existant dataspace, namespace and revison combination' + objectUnderTest.createAnchor(anchorDetails) + then: 'the same exception is thrown by CPS' + thrown(CpsValidationException) + } + + def 'Create a duplicate anchor'(){ + given: 'that the anchor already exist service throws an exception' + AnchorDetails anchorDetails = new AnchorDetails() + anchorDetails.setDataspace('dummyDataspace') + anchorDetails.setNamespace('dummyNamespace') + anchorDetails.setRevision('dummyRevision') + anchorDetails.setRevision('dummyAnchorName') + mockFragmentPersistenceService.createAnchor(anchorDetails) >> {throw new CpsValidationException(_ as String, _ as String)} + when: 'we try to create a duplicate anchor' + objectUnderTest.createAnchor(anchorDetails) + then: 'the same exception is thrown by CPS' + thrown(CpsValidationException) + } + + def 'Create an anchor with supplied anchor name, dataspace, namespace and revision'(){ + given: 'that the anchor does not pre-exist service creates an anchor' + AnchorDetails anchorDetails = new AnchorDetails() + anchorDetails.setDataspace('dummyDataspace') + anchorDetails.setNamespace('dummyNamespace') + anchorDetails.setRevision('dummyRevision') + anchorDetails.setRevision('dummyAnchorName') + mockFragmentPersistenceService.createAnchor(anchorDetails) >> 'dummyAnchorName' + expect: 'anchor name is returned by service' + objectUnderTest.createAnchor(anchorDetails) == 'dummyAnchorName' + } } \ No newline at end of file -- 2.16.6