import java.util.Set;
import java.util.stream.Collectors;
import javax.transaction.Transactional;
+import org.onap.cps.spi.CascadeDeleteAllowed;
import org.onap.cps.spi.CpsAdminPersistenceService;
import org.onap.cps.spi.CpsModulePersistenceService;
+import org.onap.cps.spi.entities.AnchorEntity;
import org.onap.cps.spi.entities.DataspaceEntity;
import org.onap.cps.spi.entities.SchemaSetEntity;
import org.onap.cps.spi.entities.YangResourceEntity;
import org.onap.cps.spi.exceptions.SchemaSetAlreadyDefinedException;
+import org.onap.cps.spi.exceptions.SchemaSetInUseException;
import org.onap.cps.spi.model.Anchor;
+import org.onap.cps.spi.repository.AnchorRepository;
import org.onap.cps.spi.repository.DataspaceRepository;
+import org.onap.cps.spi.repository.FragmentRepository;
import org.onap.cps.spi.repository.SchemaSetRepository;
import org.onap.cps.spi.repository.YangResourceRepository;
import org.springframework.beans.factory.annotation.Autowired;
@Autowired
private DataspaceRepository dataspaceRepository;
+ @Autowired
+ private AnchorRepository anchorRepository;
+
+ @Autowired
+ private FragmentRepository fragmentRepository;
+
@Autowired
private CpsAdminPersistenceService cpsAdminPersistenceService;
final Anchor anchor = cpsAdminPersistenceService.getAnchor(dataspaceName, anchorName);
return getYangSchemaResources(dataspaceName, anchor.getSchemaSetName());
}
+
+ @Override
+ @Transactional
+ public void deleteSchemaSet(final String dataspaceName, final String schemaSetName,
+ final CascadeDeleteAllowed cascadeDeleteAllowed) {
+ final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(dataspaceName);
+ final SchemaSetEntity schemaSetEntity =
+ schemaSetRepository.getByDataspaceAndName(dataspaceEntity, schemaSetName);
+
+ final Collection<AnchorEntity> anchorEntities = anchorRepository.findAllBySchemaSet(schemaSetEntity);
+ if (!anchorEntities.isEmpty()) {
+ if (cascadeDeleteAllowed != CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED) {
+ throw new SchemaSetInUseException(dataspaceName, schemaSetName);
+ }
+ fragmentRepository.deleteByAnchorIn(anchorEntities);
+ anchorRepository.deleteAll(anchorEntities);
+ }
+ schemaSetRepository.delete(schemaSetEntity);
+ yangResourceRepository.deleteOrphans();
+ }
}
import javax.validation.constraints.NotNull;
import org.onap.cps.spi.entities.AnchorEntity;
import org.onap.cps.spi.entities.DataspaceEntity;
+import org.onap.cps.spi.entities.SchemaSetEntity;
import org.onap.cps.spi.exceptions.AnchorNotFoundException;
import org.springframework.data.jpa.repository.JpaRepository;
}
Collection<AnchorEntity> findAllByDataspace(@NotNull DataspaceEntity dataspaceEntity);
+
+ Collection<AnchorEntity> findAllBySchemaSet(@NotNull SchemaSetEntity schemaSetEntity);
}
\ No newline at end of file
\r
package org.onap.cps.spi.repository;\r
\r
+import java.util.Collection;\r
+import javax.validation.constraints.NotNull;\r
+import org.onap.cps.spi.entities.AnchorEntity;\r
import org.onap.cps.spi.entities.FragmentEntity;\r
import org.springframework.data.jpa.repository.JpaRepository;\r
+import org.springframework.data.jpa.repository.Modifying;\r
+import org.springframework.data.jpa.repository.Query;\r
+import org.springframework.data.repository.query.Param;\r
import org.springframework.stereotype.Repository;\r
\r
@Repository\r
public interface FragmentRepository extends JpaRepository<FragmentEntity, Long> {\r
\r
+ @Modifying\r
+ @Query("DELETE FROM FragmentEntity fe WHERE fe.anchor IN (:anchors)")\r
+ void deleteByAnchorIn(@NotNull @Param("anchors") Collection<AnchorEntity> anchorEntities);\r
+\r
}
\ No newline at end of file
import javax.validation.constraints.NotNull;
import org.onap.cps.spi.entities.YangResourceEntity;
import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Modifying;
+import org.springframework.data.jpa.repository.Query;
import org.springframework.stereotype.Repository;
@Repository
List<YangResourceEntity> findAllByChecksumIn(@NotNull Set<String> checksum);
+ @Modifying
+ @Query(value = "DELETE FROM yang_resource yr WHERE NOT EXISTS "
+ + "(SELECT 1 FROM schema_set_yang_resources ssyr WHERE ssyr.yang_resource_id = yr.id)", nativeQuery = true)
+ void deleteOrphans();
}
package org.onap.cps.spi.impl;
import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
+import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import org.onap.cps.spi.entities.YangResourceEntity;
import org.onap.cps.spi.exceptions.DataspaceNotFoundException;
import org.onap.cps.spi.exceptions.SchemaSetAlreadyDefinedException;
+import org.onap.cps.spi.exceptions.SchemaSetInUseException;
+import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
+import org.onap.cps.spi.repository.AnchorRepository;
import org.onap.cps.spi.repository.DataspaceRepository;
+import org.onap.cps.spi.repository.FragmentRepository;
import org.onap.cps.spi.repository.SchemaSetRepository;
+import org.onap.cps.spi.repository.YangResourceRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.jdbc.Sql;
private static final String DATASPACE_NAME_INVALID = "DATASPACE-X";
private static final String SCHEMA_SET_NAME = "SCHEMA-SET-001";
private static final String SCHEMA_SET_NAME_NEW = "SCHEMA-SET-NEW";
+ private static final String SCHEMA_SET_NAME_NO_ANCHORS = "SCHEMA-SET-100";
+ private static final String SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA = "SCHEMA-SET-101";
private static final String EXISTING_RESOURCE_NAME = "module1@2020-02-02.yang";
private static final String EXISTING_RESOURCE_CONTENT = "CONTENT-001";
private static final String NEW_RESOURCE_CHECKSUM = "c94d40a1350eb1c0b1c1949eac84fc59";
private static final Long NEW_RESOURCE_ABSTRACT_ID = 0L;
+ private static final Long SHARED_RESOURCE_ID1 = 3003L;
+ private static final Long SHARED_RESOURCE_ID2 = 3004L;
+ private static final Long ORPHAN_RESOURCE_ID = 3100L;
+ private static final Integer REMOVED_ANCHOR_ID1 = 6001;
+ private static final Integer REMOVED_ANCHOR_ID2 = 6002;
+ private static final Long REMOVED_FRAGMENT_ID = 7001L;
+
@ClassRule
public static DatabaseTestContainer testContainer = DatabaseTestContainer.getInstance();
private CpsAdminPersistenceService cpsAdminPersistenceService;
@Autowired
- private DataspaceRepository dataspaceRepository;
+ DataspaceRepository dataspaceRepository;
@Autowired
private SchemaSetRepository schemaSetRepository;
+ @Autowired
+ private YangResourceRepository yangResourceRepository;
+
+ @Autowired
+ private AnchorRepository anchorRepository;
+
+ @Autowired
+ private FragmentRepository fragmentRepository;
@Test(expected = DataspaceNotFoundException.class)
@Sql(CLEAR_DATA)
}
@Test(expected = SchemaSetAlreadyDefinedException.class)
- @SqlGroup({@Sql(CLEAR_DATA), @Sql(SET_DATA)})
+ @Sql({CLEAR_DATA, SET_DATA})
public void testStoreDuplicateSchemaSet() {
cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME,
toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT));
}
@Test
- @SqlGroup({@Sql(CLEAR_DATA), @Sql(SET_DATA)})
+ @Sql({CLEAR_DATA, SET_DATA})
public void testStoreSchemaSetWithNewYangResource() {
final Map<String, String> yangResourcesNameToContentMap = toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT);
cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
assertSchemaSetPersisted(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
NEW_RESOURCE_ABSTRACT_ID, NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT, NEW_RESOURCE_CHECKSUM);
assertEquals(yangResourcesNameToContentMap,
- cpsModulePersistenceService.getYangSchemaResources(DATASPACE_NAME, SCHEMA_SET_NAME_NEW));
+ cpsModulePersistenceService.getYangSchemaResources(DATASPACE_NAME, SCHEMA_SET_NAME_NEW));
}
@Test
- @SqlGroup({@Sql(CLEAR_DATA), @Sql(SET_DATA)})
+ @Sql({CLEAR_DATA, SET_DATA})
public void testGetYangResourcesWithAnchorName() {
final Map<String, String> yangResourcesNameToContentMap =
toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT);
}
@Test
- @SqlGroup({@Sql(CLEAR_DATA), @Sql(SET_DATA)})
+ @Sql({CLEAR_DATA, SET_DATA})
public void testStoreSchemaSetWithExistingYangResourceReuse() {
cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
toMap(NEW_RESOURCE_NAME, EXISTING_RESOURCE_CONTENT));
}
private void assertSchemaSetPersisted(final String expectedDataspaceName, final String expectedSchemaSetName,
- final Long expectedYangResourceId, final String expectedYangResourceName,
- final String expectedYangResourceContent,
- final String expectedYangResourceChecksum) {
+ final Long expectedYangResourceId, final String expectedYangResourceName,
+ final String expectedYangResourceContent,
+ final String expectedYangResourceChecksum) {
// assert the schema set is persisted
final SchemaSetEntity schemaSetEntity = getSchemaSetFromDatabase(expectedDataspaceName, expectedSchemaSetName);
assertEquals(expectedYangResourceChecksum, yangResourceEntity.getChecksum());
}
+ @Test
+ @Sql({CLEAR_DATA, SET_DATA})
+ public void testStrictDeleteSchemaSetNoAnchors() {
+ cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NO_ANCHORS,
+ CASCADE_DELETE_PROHIBITED);
+
+ // validate schema set removed
+ final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(DATASPACE_NAME);
+ assertFalse(schemaSetRepository
+ .findByDataspaceAndName(dataspaceEntity, SCHEMA_SET_NAME_NO_ANCHORS).isPresent());
+
+ // validate shared resource remain, but orphan one is removed
+ assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID1).isPresent());
+ assertFalse(yangResourceRepository.findById(ORPHAN_RESOURCE_ID).isPresent());
+ }
+
+
+ @Test
+ @Sql({CLEAR_DATA, SET_DATA})
+ public void testFullDeleteSchemaSetWithAnchorsAndData() {
+ cpsModulePersistenceService
+ .deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA, CASCADE_DELETE_ALLOWED);
+
+ // validate schema set removed
+ final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(DATASPACE_NAME);
+ assertFalse(schemaSetRepository
+ .findByDataspaceAndName(dataspaceEntity, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA).isPresent());
+
+ // validate shared resources remain
+ assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID1).isPresent());
+ assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID2).isPresent());
+
+ // validate associated anchors and data are removed
+ assertFalse(anchorRepository.findById(REMOVED_ANCHOR_ID1).isPresent());
+ assertFalse(anchorRepository.findById(REMOVED_ANCHOR_ID2).isPresent());
+ assertFalse(fragmentRepository.findById(REMOVED_FRAGMENT_ID).isPresent());
+ }
+
+ @Test(expected = DataspaceNotFoundException.class)
+ @Sql(CLEAR_DATA)
+ public void testDeleteSchemaSetWithinInvalidDataspace() {
+ cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME_INVALID, SCHEMA_SET_NAME, CASCADE_DELETE_ALLOWED);
+ }
+
+ @Test(expected = SchemaSetNotFoundException.class)
+ @Sql({CLEAR_DATA, SET_DATA})
+ public void testDeleteNonExistingSchemaSet() {
+ cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW, CASCADE_DELETE_ALLOWED);
+ }
+
+ @Test(expected = SchemaSetInUseException.class)
+ @Sql({CLEAR_DATA, SET_DATA})
+ public void testStrictDeleteSchemaSetInUse() {
+ cpsModulePersistenceService
+ .deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA, CASCADE_DELETE_PROHIBITED);
+ }
+
private static Map<String, String> toMap(final String key, final String value) {
return ImmutableMap.<String, String>builder().put(key, value).build();
}
(1001, 'DATASPACE-001'), (1002, 'DATASPACE-002');
INSERT INTO SCHEMA_SET (ID, NAME, DATASPACE_ID) VALUES
- (2001, 'SCHEMA-SET-001', 1001), (2002, 'SCHEMA-SET-002', 1001);
+ (2001, 'SCHEMA-SET-001', 1001), (2002, 'SCHEMA-SET-002', 1001),
+ (2100, 'SCHEMA-SET-100', 1001), -- for removal, not referenced by anchors
+ (2101, 'SCHEMA-SET-101', 1001); -- for removal, having anchor and data associated
INSERT INTO YANG_RESOURCE (ID, NAME, CONTENT, CHECKSUM) VALUES
(3001, 'module1@2020-02-02.yang', 'CONTENT-001', '877e65a9f36d54e7702c3f073f6bc42b'),
(3002, 'module2@2020-02-02.yang', 'CONTENT-002', '88892586b1f23fe8c1595759784a18f8'),
(3003, 'module3@2020-02-02.yang', 'CONTENT-003', 'fc5740499a09a48e0c95d6fc45d4bde8'),
- (3004, 'module4@2020-02-02.yang', 'CONTENT-004', '3801280fe532f5cbf535695cf6122026');
+ (3004, 'module4@2020-02-02.yang', 'CONTENT-004', '3801280fe532f5cbf535695cf6122026'),
+ (3100, 'orphan@2020-02-02.yang', 'ORPHAN', 'checksum'); -- for auto-removal as orphan
INSERT INTO SCHEMA_SET_YANG_RESOURCES (SCHEMA_SET_ID, YANG_RESOURCE_ID) VALUES
- (2001, 3001), (2001, 3002), (2002, 3003), (2002, 3004);
+ (2001, 3001), (2001, 3002),
+ (2002, 3003), (2002, 3004),
+ (2100, 3003), (2100, 3100), -- orphan removal case
+ (2101, 3003), (2101, 3004);
+
+INSERT INTO ANCHOR (ID, NAME, DATASPACE_ID, SCHEMA_SET_ID) VALUES -- anchors for removal
+ (6001, 'ANCHOR1', 1001, 2101),
+ (6002, 'ANCHOR2', 1001, 2101);
+
+INSERT INTO FRAGMENT (ID, XPATH, ANCHOR_ID, DATASPACE_ID) VALUES
+ (7001, '/XPATH', 6001, 1001);
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Pantheon.tech
+ * ================================================================================
+ * 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;
+
+/**
+ * Cascade delete option.
+ */
+public enum CascadeDeleteAllowed {
+ CASCADE_DELETE_ALLOWED,
+ CASCADE_DELETE_PROHIBITED
+}
import java.util.Map;
import org.checkerframework.checker.nullness.qual.NonNull;
+import org.onap.cps.spi.exceptions.DataInUseException;
/**
* Service to manage modules.
void storeSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
@NonNull Map<String, String> yangResourcesNameToContentMap);
+ /**
+ * Deletes Schema Set.
+ *
+ * @param dataspaceName dataspace name
+ * @param schemaSetName schema set name
+ * @param cascadeDeleteAllowed indicates the allowance to remove associated anchors and data if exist
+ * @throws DataInUseException if cascadeDeleteAllowed is set to CASCADE_DELETE_PROHIBITED and there
+ * is associated anchor record exists in database
+ */
+ void deleteSchemaSet(@NonNull String dataspaceName, @NonNull String schemaSetName,
+ @NonNull CascadeDeleteAllowed cascadeDeleteAllowed);
+
/**
* Returns YANG resources per specific dataspace / schemaSetName.
*
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Pantheon.tech
+ * ================================================================================
+ * 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.exceptions;
+
+/**
+ * Runtime exception. Thrown when data record rejected to be deleted because it's being referenced by other data.
+ */
+public class DataInUseException extends CpsException {
+
+ private static final long serialVersionUID = 5011830482789788314L;
+
+ /**
+ * Constructor.
+ *
+ * @param message error message
+ * @param details error details
+ */
+ public DataInUseException(final String message, final String details) {
+ super(message, details);
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2021 Pantheon.tech
+ * ================================================================================
+ * 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.exceptions;
+
+/**
+ * Runtime exception. Thrown when schema set record rejected to be deleted because it has anchor records associated.
+ */
+@SuppressWarnings("squid:S110") // Team agreed to accept 6 levels of inheritance for CPS Exceptions
+public class SchemaSetInUseException extends DataInUseException {
+
+ private static final long serialVersionUID = -3729328573253023683L;
+
+ /**
+ * Constructor.
+ *
+ * @param dataspaceName dataspace name
+ * @param schemaSetName schema set name
+ */
+ public SchemaSetInUseException(final String dataspaceName, final String schemaSetName) {
+ super("Schema Set is being used.",
+ String.format("Schema Set with name %s in dataspace %s is having Anchor records associated.",
+ schemaSetName, dataspaceName)
+ );
+ }
+}
== "Dataspace with name ${dataspaceName} does not exist."
}
- def'Creating a data validation exception.'() {
+ def 'Creating a data validation exception.'() {
given: 'a data validation exception is created'
def exception = new DataValidationException(providedMessage, providedDetails, rootCause)
expect: 'the exception has the provided message'
exception.cause == rootCause
}
- def'Creating a model validation exception.'() {
+ def 'Creating a model validation exception.'() {
given: 'a data validation exception is created'
def exception = new ModelValidationException(providedMessage, providedDetails)
expect: 'the exception has the provided message'
def 'Creating a exception for an object not found in a dataspace.'() {
def descriptionOfObject = 'some object'
expect: 'the exception details contains the correct message with dataspace name and description of the object'
- (new NotFoundInDataspaceException(dataspaceName,descriptionOfObject)).details
+ (new NotFoundInDataspaceException(dataspaceName, descriptionOfObject)).details
== "${descriptionOfObject} does not exist in dataspace ${dataspaceName}."
}
def 'Creating a exception that a schema set cannot be found.'() {
expect: 'the exception details contains the correct message with dataspace and schema set names'
- (new SchemaSetNotFoundException(dataspaceName,schemaSetName)).details
+ (new SchemaSetNotFoundException(dataspaceName, schemaSetName)).details
== "Schema Set with name ${schemaSetName} was not found for dataspace ${dataspaceName}."
}
-
+
def 'Creating a exception that an anchor cannot be found.'() {
expect: 'the exception details contains the correct message with dataspace and anchor name'
(new AnchorNotFoundException(anchorName, dataspaceName)).details
== "Anchor with name ${anchorName} does not exist in dataspace ${dataspaceName}."
}
+
+ def 'Creating an exception that the schema set being used and cannot be deleted.'() {
+ expect: 'the exception details contains the correct message with dataspace and schema set names'
+ (new SchemaSetInUseException(dataspaceName, schemaSetName)).details
+ == ("Schema Set with name ${schemaSetName} in dataspace ${dataspaceName} is having "
+ + "Anchor records associated.")
+ }
}
\ No newline at end of file
Code Review / cps.git / commitdiff