cps-ri/src/test/java/org/onap/cps/spi/impl/CpsModulePersistenceServiceTest.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Pantheon.tech
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.onap.cps.spi.impl;
  21
  22 import static org.junit.Assert.assertEquals;
  23 import static org.junit.Assert.assertFalse;
  24 import static org.junit.Assert.assertNotNull;
  25 import static org.junit.Assert.assertTrue;
  26 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_ALLOWED;
  27 import static org.onap.cps.spi.CascadeDeleteAllowed.CASCADE_DELETE_PROHIBITED;
  28
  29 import com.google.common.collect.ImmutableMap;
  30 import java.util.Map;
  31 import java.util.Set;
  32 import org.junit.ClassRule;
  33 import org.junit.Test;
  34 import org.junit.runner.RunWith;
  35 import org.onap.cps.DatabaseTestContainer;
  36 import org.onap.cps.spi.CpsAdminPersistenceService;
  37 import org.onap.cps.spi.CpsModulePersistenceService;
  38 import org.onap.cps.spi.entities.DataspaceEntity;
  39 import org.onap.cps.spi.entities.SchemaSetEntity;
  40 import org.onap.cps.spi.entities.YangResourceEntity;
  41 import org.onap.cps.spi.exceptions.DataspaceNotFoundException;
  42 import org.onap.cps.spi.exceptions.SchemaSetAlreadyDefinedException;
  43 import org.onap.cps.spi.exceptions.SchemaSetInUseException;
  44 import org.onap.cps.spi.exceptions.SchemaSetNotFoundException;
  45 import org.onap.cps.spi.repository.AnchorRepository;
  46 import org.onap.cps.spi.repository.DataspaceRepository;
  47 import org.onap.cps.spi.repository.FragmentRepository;
  48 import org.onap.cps.spi.repository.SchemaSetRepository;
  49 import org.onap.cps.spi.repository.YangResourceRepository;
  50 import org.springframework.beans.factory.annotation.Autowired;
  51 import org.springframework.boot.test.context.SpringBootTest;
  52 import org.springframework.test.context.jdbc.Sql;
  53 import org.springframework.test.context.jdbc.SqlGroup;
  54 import org.springframework.test.context.junit4.SpringRunner;
  55
  56
  57 @RunWith(SpringRunner.class)
  58 @SpringBootTest
  59 public class CpsModulePersistenceServiceTest {
  60
  61     private static final String CLEAR_DATA = "/data/clear-all.sql";
  62     private static final String SET_DATA = "/data/schemaset.sql";
  63
  64     private static final String ANCHOR_NAME = "ANCHOR-001";
  65     private static final String DATASPACE_NAME = "DATASPACE-001";
  66     private static final String DATASPACE_NAME_INVALID = "DATASPACE-X";
  67     private static final String SCHEMA_SET_NAME = "SCHEMA-SET-001";
  68     private static final String SCHEMA_SET_NAME_NEW = "SCHEMA-SET-NEW";
  69     private static final String SCHEMA_SET_NAME_NO_ANCHORS = "SCHEMA-SET-100";
  70     private static final String SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA = "SCHEMA-SET-101";
  71
  72     private static final String EXISTING_RESOURCE_NAME = "module1@2020-02-02.yang";
  73     private static final String EXISTING_RESOURCE_CONTENT = "CONTENT-001";
  74     private static final String EXISTING_RESOURCE_CHECKSUM = "877e65a9f36d54e7702c3f073f6bc42b";
  75     private static final Long EXISTING_RESOURCE_ID = 3001L;
  76
  77     private static final String NEW_RESOURCE_NAME = "new-module@2020-02-02.yang";
  78     private static final String NEW_RESOURCE_CONTENT = "CONTENT-NEW";
  79     private static final String NEW_RESOURCE_CHECKSUM = "c94d40a1350eb1c0b1c1949eac84fc59";
  80     private static final Long NEW_RESOURCE_ABSTRACT_ID = 0L;
  81
  82     private static final Long SHARED_RESOURCE_ID1 = 3003L;
  83     private static final Long SHARED_RESOURCE_ID2 = 3004L;
  84     private static final Long ORPHAN_RESOURCE_ID = 3100L;
  85     private static final Integer REMOVED_ANCHOR_ID1 = 6001;
  86     private static final Integer REMOVED_ANCHOR_ID2 = 6002;
  87     private static final Long REMOVED_FRAGMENT_ID = 7001L;
  88
  89     @ClassRule
  90     public static DatabaseTestContainer testContainer = DatabaseTestContainer.getInstance();
  91
  92     @Autowired
  93     private CpsModulePersistenceService cpsModulePersistenceService;
  94
  95     @Autowired
  96     private CpsAdminPersistenceService cpsAdminPersistenceService;
  97
  98     @Autowired
  99     DataspaceRepository dataspaceRepository;
 100
 101     @Autowired
 102     private SchemaSetRepository schemaSetRepository;
 103
 104     @Autowired
 105     private YangResourceRepository yangResourceRepository;
 106
 107     @Autowired
 108     private AnchorRepository anchorRepository;
 109
 110     @Autowired
 111     private FragmentRepository fragmentRepository;
 112
 113     @Test(expected = DataspaceNotFoundException.class)
 114     @Sql(CLEAR_DATA)
 115     public void testStoreSchemaSetToInvalidDataspace() {
 116         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME_INVALID, SCHEMA_SET_NAME_NEW,
 117             toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT));
 118     }
 119
 120     @Test(expected = SchemaSetAlreadyDefinedException.class)
 121     @Sql({CLEAR_DATA, SET_DATA})
 122     public void testStoreDuplicateSchemaSet() {
 123         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME,
 124             toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT));
 125     }
 126
 127     @Test
 128     @Sql({CLEAR_DATA, SET_DATA})
 129     public void testStoreSchemaSetWithNewYangResource() {
 130         final Map<String, String> yangResourcesNameToContentMap = toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT);
 131         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 132             yangResourcesNameToContentMap);
 133         assertSchemaSetPersisted(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 134             NEW_RESOURCE_ABSTRACT_ID, NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT, NEW_RESOURCE_CHECKSUM);
 135         assertEquals(yangResourcesNameToContentMap,
 136             cpsModulePersistenceService.getYangSchemaResources(DATASPACE_NAME, SCHEMA_SET_NAME_NEW));
 137     }
 138
 139     @Test
 140     @Sql({CLEAR_DATA, SET_DATA})
 141     public void testGetYangResourcesWithAnchorName() {
 142         final Map<String, String> yangResourcesNameToContentMap =
 143             toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT);
 144         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 145             yangResourcesNameToContentMap);
 146
 147         cpsAdminPersistenceService.createAnchor(DATASPACE_NAME, SCHEMA_SET_NAME_NEW, ANCHOR_NAME);
 148         assertEquals(yangResourcesNameToContentMap,
 149             cpsModulePersistenceService.getYangSchemaSetResources(DATASPACE_NAME, ANCHOR_NAME));
 150     }
 151
 152     @Test
 153     @Sql({CLEAR_DATA, SET_DATA})
 154     public void testStoreSchemaSetWithExistingYangResourceReuse() {
 155         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 156             toMap(NEW_RESOURCE_NAME, EXISTING_RESOURCE_CONTENT));
 157         assertSchemaSetPersisted(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 158             EXISTING_RESOURCE_ID, EXISTING_RESOURCE_NAME, EXISTING_RESOURCE_CONTENT, EXISTING_RESOURCE_CHECKSUM);
 159     }
 160
 161     private void assertSchemaSetPersisted(final String expectedDataspaceName, final String expectedSchemaSetName,
 162         final Long expectedYangResourceId, final String expectedYangResourceName,
 163         final String expectedYangResourceContent,
 164         final String expectedYangResourceChecksum) {
 165
 166         // assert the schema set is persisted
 167         final SchemaSetEntity schemaSetEntity = getSchemaSetFromDatabase(expectedDataspaceName, expectedSchemaSetName);
 168         assertEquals(expectedDataspaceName, schemaSetEntity.getDataspace().getName());
 169         assertEquals(expectedSchemaSetName, schemaSetEntity.getName());
 170
 171         // assert the attached yang resource is persisted
 172         final Set<YangResourceEntity> yangResourceEntities = schemaSetEntity.getYangResources();
 173         assertNotNull(yangResourceEntities);
 174         assertEquals(1, yangResourceEntities.size());
 175
 176         // assert the attached yang resource content
 177         final YangResourceEntity yangResourceEntity = yangResourceEntities.iterator().next();
 178         assertNotNull(yangResourceEntity.getId());
 179         if (expectedYangResourceId != NEW_RESOURCE_ABSTRACT_ID) {
 180             // existing resource with known id
 181             assertEquals(expectedYangResourceId, yangResourceEntity.getId());
 182         }
 183         assertEquals(expectedYangResourceName, yangResourceEntity.getName());
 184         assertEquals(expectedYangResourceContent, yangResourceEntity.getContent());
 185         assertEquals(expectedYangResourceChecksum, yangResourceEntity.getChecksum());
 186     }
 187
 188     @Test
 189     @Sql({CLEAR_DATA, SET_DATA})
 190     public void testStrictDeleteSchemaSetNoAnchors() {
 191         cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NO_ANCHORS,
 192             CASCADE_DELETE_PROHIBITED);
 193
 194         // validate schema set removed
 195         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(DATASPACE_NAME);
 196         assertFalse(schemaSetRepository
 197             .findByDataspaceAndName(dataspaceEntity, SCHEMA_SET_NAME_NO_ANCHORS).isPresent());
 198
 199         // validate shared resource remain, but orphan one is removed
 200         assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID1).isPresent());
 201         assertFalse(yangResourceRepository.findById(ORPHAN_RESOURCE_ID).isPresent());
 202     }
 203
 204
 205     @Test
 206     @Sql({CLEAR_DATA, SET_DATA})
 207     public void testFullDeleteSchemaSetWithAnchorsAndData() {
 208         cpsModulePersistenceService
 209             .deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA, CASCADE_DELETE_ALLOWED);
 210
 211         // validate schema set removed
 212         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(DATASPACE_NAME);
 213         assertFalse(schemaSetRepository
 214             .findByDataspaceAndName(dataspaceEntity, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA).isPresent());
 215
 216         // validate shared resources remain
 217         assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID1).isPresent());
 218         assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID2).isPresent());
 219
 220         // validate associated anchors and data are removed
 221         assertFalse(anchorRepository.findById(REMOVED_ANCHOR_ID1).isPresent());
 222         assertFalse(anchorRepository.findById(REMOVED_ANCHOR_ID2).isPresent());
 223         assertFalse(fragmentRepository.findById(REMOVED_FRAGMENT_ID).isPresent());
 224     }
 225
 226     @Test(expected = DataspaceNotFoundException.class)
 227     @Sql(CLEAR_DATA)
 228     public void testDeleteSchemaSetWithinInvalidDataspace() {
 229         cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME_INVALID, SCHEMA_SET_NAME, CASCADE_DELETE_ALLOWED);
 230     }
 231
 232     @Test(expected = SchemaSetNotFoundException.class)
 233     @Sql({CLEAR_DATA, SET_DATA})
 234     public void testDeleteNonExistingSchemaSet() {
 235         cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW, CASCADE_DELETE_ALLOWED);
 236     }
 237
 238     @Test(expected = SchemaSetInUseException.class)
 239     @Sql({CLEAR_DATA, SET_DATA})
 240     public void testStrictDeleteSchemaSetInUse() {
 241         cpsModulePersistenceService
 242             .deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA, CASCADE_DELETE_PROHIBITED);
 243     }
 244
 245     private static Map<String, String> toMap(final String key, final String value) {
 246         return ImmutableMap.<String, String>builder().put(key, value).build();
 247     }
 248
 249     private SchemaSetEntity getSchemaSetFromDatabase(final String dataspaceName, final String schemaSetName) {
 250         final DataspaceEntity dataspaceEntity = dataspaceRepository.findByName(dataspaceName).orElseThrow();
 251         return schemaSetRepository.findByDataspaceAndName(dataspaceEntity, schemaSetName).orElseThrow();
 252     }
 253 }