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.junit4.SpringRunner;
  54
  55 @RunWith(SpringRunner.class)
  56 @SpringBootTest
  57 public class CpsModulePersistenceServiceTest {
  58
  59     private static final String CLEAR_DATA = "/data/clear-all.sql";
  60     private static final String SET_DATA = "/data/schemaset.sql";
  61
  62     private static final String ANCHOR_NAME = "ANCHOR-001";
  63     private static final String DATASPACE_NAME = "DATASPACE-001";
  64     private static final String DATASPACE_NAME_INVALID = "DATASPACE-X";
  65     private static final String SCHEMA_SET_NAME = "SCHEMA-SET-001";
  66     private static final String SCHEMA_SET_NAME_NEW = "SCHEMA-SET-NEW";
  67     private static final String SCHEMA_SET_NAME_NO_ANCHORS = "SCHEMA-SET-100";
  68     private static final String SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA = "SCHEMA-SET-101";
  69
  70     private static final String EXISTING_RESOURCE_NAME = "module1@2020-02-02.yang";
  71     private static final String EXISTING_RESOURCE_CONTENT = "CONTENT-001";
  72     private static final String EXISTING_RESOURCE_CHECKSUM = "877e65a9f36d54e7702c3f073f6bc42b";
  73     private static final Long EXISTING_RESOURCE_ID = 3001L;
  74
  75     private static final String NEW_RESOURCE_NAME = "new-module@2020-02-02.yang";
  76     private static final String NEW_RESOURCE_CONTENT = "CONTENT-NEW";
  77     private static final String NEW_RESOURCE_CHECKSUM = "c94d40a1350eb1c0b1c1949eac84fc59";
  78     private static final Long NEW_RESOURCE_ABSTRACT_ID = 0L;
  79
  80     private static final Long SHARED_RESOURCE_ID1 = 3003L;
  81     private static final Long SHARED_RESOURCE_ID2 = 3004L;
  82     private static final Long ORPHAN_RESOURCE_ID = 3100L;
  83     private static final Integer REMOVED_ANCHOR_ID1 = 6001;
  84     private static final Integer REMOVED_ANCHOR_ID2 = 6002;
  85     private static final Long REMOVED_FRAGMENT_ID = 7001L;
  86
  87     @ClassRule
  88     public static DatabaseTestContainer testContainer = DatabaseTestContainer.getInstance();
  89
  90     @Autowired
  91     private CpsModulePersistenceService cpsModulePersistenceService;
  92
  93     @Autowired
  94     private CpsAdminPersistenceService cpsAdminPersistenceService;
  95
  96     @Autowired
  97     DataspaceRepository dataspaceRepository;
  98
  99     @Autowired
 100     private SchemaSetRepository schemaSetRepository;
 101
 102     @Autowired
 103     private YangResourceRepository yangResourceRepository;
 104
 105     @Autowired
 106     private AnchorRepository anchorRepository;
 107
 108     @Autowired
 109     private FragmentRepository fragmentRepository;
 110
 111     @Test(expected = DataspaceNotFoundException.class)
 112     @Sql(CLEAR_DATA)
 113     public void testStoreSchemaSetToInvalidDataspace() {
 114         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME_INVALID, SCHEMA_SET_NAME_NEW,
 115             toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT));
 116     }
 117
 118     @Test(expected = SchemaSetAlreadyDefinedException.class)
 119     @Sql({CLEAR_DATA, SET_DATA})
 120     public void testStoreDuplicateSchemaSet() {
 121         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME,
 122             toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT));
 123     }
 124
 125     @Test
 126     @Sql({CLEAR_DATA, SET_DATA})
 127     public void testStoreSchemaSetWithNewYangResource() {
 128         final Map<String, String> yangResourcesNameToContentMap = toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT);
 129         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 130             yangResourcesNameToContentMap);
 131         assertSchemaSetPersisted(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 132             NEW_RESOURCE_ABSTRACT_ID, NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT, NEW_RESOURCE_CHECKSUM);
 133         assertEquals(yangResourcesNameToContentMap,
 134             cpsModulePersistenceService.getYangSchemaResources(DATASPACE_NAME, SCHEMA_SET_NAME_NEW));
 135     }
 136
 137     @Test
 138     @Sql({CLEAR_DATA, SET_DATA})
 139     public void testGetYangResourcesWithAnchorName() {
 140         final Map<String, String> yangResourcesNameToContentMap =
 141             toMap(NEW_RESOURCE_NAME, NEW_RESOURCE_CONTENT);
 142         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 143             yangResourcesNameToContentMap);
 144
 145         cpsAdminPersistenceService.createAnchor(DATASPACE_NAME, SCHEMA_SET_NAME_NEW, ANCHOR_NAME);
 146         assertEquals(yangResourcesNameToContentMap,
 147             cpsModulePersistenceService.getYangSchemaSetResources(DATASPACE_NAME, ANCHOR_NAME));
 148     }
 149
 150     @Test
 151     @Sql({CLEAR_DATA, SET_DATA})
 152     public void testStoreSchemaSetWithExistingYangResourceReuse() {
 153         cpsModulePersistenceService.storeSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 154             toMap(NEW_RESOURCE_NAME, EXISTING_RESOURCE_CONTENT));
 155         assertSchemaSetPersisted(DATASPACE_NAME, SCHEMA_SET_NAME_NEW,
 156             EXISTING_RESOURCE_ID, EXISTING_RESOURCE_NAME, EXISTING_RESOURCE_CONTENT, EXISTING_RESOURCE_CHECKSUM);
 157     }
 158
 159     private void assertSchemaSetPersisted(final String expectedDataspaceName, final String expectedSchemaSetName,
 160         final Long expectedYangResourceId, final String expectedYangResourceName,
 161         final String expectedYangResourceContent,
 162         final String expectedYangResourceChecksum) {
 163
 164         // assert the schema set is persisted
 165         final SchemaSetEntity schemaSetEntity = getSchemaSetFromDatabase(expectedDataspaceName, expectedSchemaSetName);
 166         assertEquals(expectedDataspaceName, schemaSetEntity.getDataspace().getName());
 167         assertEquals(expectedSchemaSetName, schemaSetEntity.getName());
 168
 169         // assert the attached yang resource is persisted
 170         final Set<YangResourceEntity> yangResourceEntities = schemaSetEntity.getYangResources();
 171         assertNotNull(yangResourceEntities);
 172         assertEquals(1, yangResourceEntities.size());
 173
 174         // assert the attached yang resource content
 175         final YangResourceEntity yangResourceEntity = yangResourceEntities.iterator().next();
 176         assertNotNull(yangResourceEntity.getId());
 177         if (expectedYangResourceId != NEW_RESOURCE_ABSTRACT_ID) {
 178             // existing resource with known id
 179             assertEquals(expectedYangResourceId, yangResourceEntity.getId());
 180         }
 181         assertEquals(expectedYangResourceName, yangResourceEntity.getName());
 182         assertEquals(expectedYangResourceContent, yangResourceEntity.getContent());
 183         assertEquals(expectedYangResourceChecksum, yangResourceEntity.getChecksum());
 184     }
 185
 186     @Test
 187     @Sql({CLEAR_DATA, SET_DATA})
 188     public void testStrictDeleteSchemaSetNoAnchors() {
 189         cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NO_ANCHORS,
 190             CASCADE_DELETE_PROHIBITED);
 191
 192         // validate schema set removed
 193         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(DATASPACE_NAME);
 194         assertFalse(schemaSetRepository
 195             .findByDataspaceAndName(dataspaceEntity, SCHEMA_SET_NAME_NO_ANCHORS).isPresent());
 196
 197         // validate shared resource remain, but orphan one is removed
 198         assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID1).isPresent());
 199         assertFalse(yangResourceRepository.findById(ORPHAN_RESOURCE_ID).isPresent());
 200     }
 201
 202
 203     @Test
 204     @Sql({CLEAR_DATA, SET_DATA})
 205     public void testFullDeleteSchemaSetWithAnchorsAndData() {
 206         cpsModulePersistenceService
 207             .deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA, CASCADE_DELETE_ALLOWED);
 208
 209         // validate schema set removed
 210         final DataspaceEntity dataspaceEntity = dataspaceRepository.getByName(DATASPACE_NAME);
 211         assertFalse(schemaSetRepository
 212             .findByDataspaceAndName(dataspaceEntity, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA).isPresent());
 213
 214         // validate shared resources remain
 215         assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID1).isPresent());
 216         assertTrue(yangResourceRepository.findById(SHARED_RESOURCE_ID2).isPresent());
 217
 218         // validate associated anchors and data are removed
 219         assertFalse(anchorRepository.findById(REMOVED_ANCHOR_ID1).isPresent());
 220         assertFalse(anchorRepository.findById(REMOVED_ANCHOR_ID2).isPresent());
 221         assertFalse(fragmentRepository.findById(REMOVED_FRAGMENT_ID).isPresent());
 222     }
 223
 224     @Test(expected = DataspaceNotFoundException.class)
 225     @Sql(CLEAR_DATA)
 226     public void testDeleteSchemaSetWithinInvalidDataspace() {
 227         cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME_INVALID, SCHEMA_SET_NAME, CASCADE_DELETE_ALLOWED);
 228     }
 229
 230     @Test(expected = SchemaSetNotFoundException.class)
 231     @Sql({CLEAR_DATA, SET_DATA})
 232     public void testDeleteNonExistingSchemaSet() {
 233         cpsModulePersistenceService.deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_NEW, CASCADE_DELETE_ALLOWED);
 234     }
 235
 236     @Test(expected = SchemaSetInUseException.class)
 237     @Sql({CLEAR_DATA, SET_DATA})
 238     public void testStrictDeleteSchemaSetInUse() {
 239         cpsModulePersistenceService
 240             .deleteSchemaSet(DATASPACE_NAME, SCHEMA_SET_NAME_WITH_ANCHORS_AND_DATA, CASCADE_DELETE_PROHIBITED);
 241     }
 242
 243     private static Map<String, String> toMap(final String key, final String value) {
 244         return ImmutableMap.<String, String>builder().put(key, value).build();
 245     }
 246
 247     private SchemaSetEntity getSchemaSetFromDatabase(final String dataspaceName, final String schemaSetName) {
 248         final DataspaceEntity dataspaceEntity = dataspaceRepository.findByName(dataspaceName).orElseThrow();
 249         return schemaSetRepository.findByDataspaceAndName(dataspaceEntity, schemaSetName).orElseThrow();
 250     }
 251 }