models-provider/src/test/java/org/onap/policy/models/provider/impl/PolicyToscaPersistenceTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 Nordix Foundation.
   4  *  Modifications Copyright (C) 2020 Bell Canada. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.models.provider.impl;
  23
  24 import static org.assertj.core.api.Assertions.assertThatCode;
  25 import static org.junit.Assert.assertEquals;
  26 import static org.junit.Assert.assertNotNull;
  27
  28 import java.net.URISyntaxException;
  29 import java.util.LinkedHashMap;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Set;
  33 import java.util.concurrent.CountDownLatch;
  34 import java.util.concurrent.TimeUnit;
  35 import lombok.NonNull;
  36 import org.junit.After;
  37 import org.junit.Before;
  38 import org.junit.Test;
  39 import org.onap.policy.common.utils.coder.CoderException;
  40 import org.onap.policy.common.utils.coder.StandardCoder;
  41 import org.onap.policy.common.utils.coder.YamlJsonTranslator;
  42 import org.onap.policy.common.utils.resources.ResourceUtils;
  43 import org.onap.policy.models.base.PfModelException;
  44 import org.onap.policy.models.provider.PolicyModelsProvider;
  45 import org.onap.policy.models.provider.PolicyModelsProviderFactory;
  46 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntityFilter;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 /**
  56  * Test persistence of monitoring policies to and from the database.
  57  *
  58  * @author Liam Fallon (liam.fallon@est.tech)
  59  */
  60 public class PolicyToscaPersistenceTest {
  61     private static final Logger LOGGER = LoggerFactory.getLogger(PolicyToscaPersistenceTest.class);
  62
  63     private YamlJsonTranslator yamlJsonTranslator = new YamlJsonTranslator();
  64     private StandardCoder standardCoder = new StandardCoder();
  65
  66     private PolicyModelsProvider databaseProvider;
  67
  68     /**
  69      * Initialize provider.
  70      *
  71      * @throws PfModelException on exceptions in the tests
  72      * @throws CoderException on JSON encoding and decoding errors
  73      */
  74     @Before
  75     public void setupParameters() throws Exception {
  76         // H2, use "org.mariadb.jdbc.Driver" and "jdbc:mariadb://localhost:3306/policy" for locally installed MariaDB
  77
  78         PolicyModelsProviderParameters parameters = new PolicyModelsProviderParameters();
  79         parameters.setDatabaseDriver("org.h2.Driver");
  80         parameters.setDatabaseUrl("jdbc:h2:mem:testdb");
  81         parameters.setDatabaseUser("policy");
  82         parameters.setDatabasePassword("P01icY");
  83         parameters.setPersistenceUnit("ToscaConceptTest");
  84
  85         databaseProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(parameters);
  86
  87         createPolicyTypes();
  88     }
  89
  90     @After
  91     public void teardown() throws Exception {
  92         databaseProvider.close();
  93     }
  94
  95     @Test
  96     public void testToscaPolicyPersistence() throws Exception {
  97         Set<String> policyResources = ResourceUtils.getDirectoryContents("policies");
  98
  99         for (String policyResource : policyResources) {
 100             if (!policyResource.contains("\\.tosca\\.")) {
 101                 continue;
 102             }
 103
 104             String policyString = ResourceUtils.getResourceAsString(policyResource);
 105
 106             if (policyResource.endsWith("yaml")) {
 107                 testPolicyPersistence(yamlJsonTranslator.fromYaml(policyString, ToscaServiceTemplate.class));
 108             } else {
 109                 testPolicyPersistence(standardCoder.decode(policyString, ToscaServiceTemplate.class));
 110             }
 111         }
 112     }
 113
 114     @Test
 115     public void testHpaPolicyTypeGet() throws PfModelException {
 116         long getStartTime = System.currentTimeMillis();
 117         ToscaServiceTemplate hpaServiceTemplate =
 118                 databaseProvider.getPolicyTypes("onap.policies.optimization.resource.HpaPolicy", "1.0.0");
 119         LOGGER.trace("HPA policy normal get time (ms): {}", System.currentTimeMillis() - getStartTime);
 120
 121         assertEquals(3, hpaServiceTemplate.getPolicyTypesAsMap().size());
 122         assertEquals(5, hpaServiceTemplate.getDataTypesAsMap().size());
 123
 124         getStartTime = System.currentTimeMillis();
 125         ToscaEntityFilter<ToscaPolicyType> hpaFilter = ToscaEntityFilter.<ToscaPolicyType>builder()
 126                 .name("onap.policies.optimization.resource.HpaPolicy").version("1.0.0").build();
 127         hpaServiceTemplate = databaseProvider.getFilteredPolicyTypes(hpaFilter);
 128         LOGGER.trace("HPA policy filter name version get time (ms): {}", System.currentTimeMillis() - getStartTime);
 129
 130         assertEquals(3, hpaServiceTemplate.getPolicyTypesAsMap().size());
 131         assertEquals(5, hpaServiceTemplate.getDataTypesAsMap().size());
 132
 133         getStartTime = System.currentTimeMillis();
 134         hpaFilter = ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.optimization.resource.HpaPolicy")
 135                 .build();
 136         hpaServiceTemplate = databaseProvider.getFilteredPolicyTypes(hpaFilter);
 137         LOGGER.trace("HPA policy filter name only get time (ms): {}", System.currentTimeMillis() - getStartTime);
 138
 139         assertEquals(3, hpaServiceTemplate.getPolicyTypesAsMap().size());
 140         assertEquals(5, hpaServiceTemplate.getDataTypesAsMap().size());
 141     }
 142
 143     @Test
 144     public void testNamingPolicyGet() throws PfModelException {
 145         String policyYamlString = ResourceUtils.getResourceAsString("policies/sdnc.policy.naming.input.tosca.yaml");
 146         ToscaServiceTemplate serviceTemplate =
 147                 yamlJsonTranslator.fromYaml(policyYamlString, ToscaServiceTemplate.class);
 148
 149         long createStartTime = System.currentTimeMillis();
 150         databaseProvider.createPolicies(serviceTemplate);
 151         LOGGER.trace("Naming policy create time (ms): {}", System.currentTimeMillis() - createStartTime);
 152
 153         long getStartTime = System.currentTimeMillis();
 154         ToscaServiceTemplate namingServiceTemplate =
 155                 databaseProvider.getPolicies("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", "1.0.0");
 156         LOGGER.trace("Naming policy normal get time (ms): {}", System.currentTimeMillis() - getStartTime);
 157
 158         assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
 159         assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
 160         assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
 161
 162         getStartTime = System.currentTimeMillis();
 163         ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
 164                 .name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").version("1.0.0").build();
 165         namingServiceTemplate = databaseProvider.getFilteredPolicies(filter);
 166         LOGGER.trace("Naming policy filtered get time (ms): {}", System.currentTimeMillis() - getStartTime);
 167
 168         assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
 169         assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
 170         assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
 171
 172         getStartTime = System.currentTimeMillis();
 173         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").build();
 174         namingServiceTemplate = databaseProvider.getFilteredPolicies(filter);
 175         LOGGER.trace("Naming policy filtered name only get time (ms): {}", System.currentTimeMillis() - getStartTime);
 176
 177         assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
 178         assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
 179         assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
 180
 181         long deleteStartTime = System.currentTimeMillis();
 182         ToscaServiceTemplate deletedServiceTemplate =
 183                 databaseProvider.deletePolicy("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", "1.0.0");
 184         LOGGER.trace("Naming policy delete time (ms): {}", System.currentTimeMillis() - deleteStartTime);
 185
 186         assertEquals(1, deletedServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
 187     }
 188
 189     @Test
 190     public void testNamingPolicyVersions() throws PfModelException {
 191         String policyYamlString = ResourceUtils.getResourceAsString("policies/sdnc.policy.naming.input.tosca.yaml");
 192         ToscaServiceTemplate serviceTemplate =
 193                 yamlJsonTranslator.fromYaml(policyYamlString, ToscaServiceTemplate.class);
 194
 195         // Create policy types and data types
 196         List<Map<String, ToscaPolicy>> policyMapList = serviceTemplate.getToscaTopologyTemplate().getPolicies();
 197         databaseProvider.createPolicies(serviceTemplate);
 198
 199         // Clear the policy map list so we start from afresh with versions
 200         ToscaPolicy namingPolicy = policyMapList.get(0).values().iterator().next();
 201         policyMapList.clear();
 202
 203         // Create 21 more versions of the policy
 204         for (int i = 2; i < 22; i++) {
 205             ToscaPolicy clonedNamingPolicy = new ToscaPolicy(namingPolicy);
 206             clonedNamingPolicy.setVersion(i + ".0.0");
 207             Map<String, ToscaPolicy> policyMap = new LinkedHashMap<>(1);
 208             policyMap.put(clonedNamingPolicy.getName(), clonedNamingPolicy);
 209             policyMapList.add(policyMap);
 210         }
 211
 212         databaseProvider.createPolicies(serviceTemplate);
 213
 214         for (int i = 1; i < 22; i++) {
 215             ToscaServiceTemplate namingServiceTemplate =
 216                     databaseProvider.getPolicies("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", i + ".0.0");
 217             assertEquals(i + ".0.0", namingServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).values()
 218                     .iterator().next().getVersion());
 219
 220             ToscaTypedEntityFilter<ToscaPolicy> policyFilter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
 221                     .name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").version(i + ".0.0").build();
 222             namingServiceTemplate = databaseProvider.getFilteredPolicies(policyFilter);
 223             assertEquals(i + ".0.0", namingServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).values()
 224                     .iterator().next().getVersion());
 225         }
 226
 227         ToscaTypedEntityFilter<ToscaPolicy> policyFilter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
 228                 .name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").version(ToscaTypedEntityFilter.LATEST_VERSION).build();
 229         ToscaServiceTemplate namingServiceTemplate = databaseProvider.getFilteredPolicies(policyFilter);
 230         assertEquals("21.0.0", namingServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).values().iterator()
 231                 .next().getVersion());
 232
 233         for (int i = 1; i < 22; i++) {
 234             ToscaServiceTemplate deletedServiceTemplate =
 235                     databaseProvider.deletePolicy("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", i + ".0.0");
 236             assertEquals(1, deletedServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
 237         }
 238     }
 239
 240     /**
 241      * Check persistence of a policy.
 242      *
 243      * @param serviceTemplate the service template containing the policy
 244      * @throws Exception any exception thrown
 245      */
 246     public void testPolicyPersistence(@NonNull final ToscaServiceTemplate serviceTemplate) throws Exception {
 247         assertNotNull(serviceTemplate);
 248
 249         CountDownLatch threadCountDownLatch = new CountDownLatch(10);
 250
 251         for (int i = 0; i < 10; i++) {
 252             new Thread() {
 253                 @Override
 254                 public void run() {
 255                     assertThatCode(() -> databaseProvider.createPolicies(serviceTemplate)).doesNotThrowAnyException();
 256                     assertThatCode(() -> databaseProvider.updatePolicies(serviceTemplate)).doesNotThrowAnyException();
 257                     threadCountDownLatch.countDown();
 258                 }
 259             }.start();
 260         }
 261
 262         threadCountDownLatch.await(10, TimeUnit.SECONDS);
 263
 264         for (Map<String, ToscaPolicy> policyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
 265             for (ToscaPolicy policy : policyMap.values()) {
 266                 ToscaServiceTemplate gotToscaServiceTemplate =
 267                         databaseProvider.getPolicies(policy.getName(), policy.getVersion());
 268
 269                 assertEquals(policy.getType(), gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0)
 270                         .get(policy.getName()).getType());
 271
 272                 gotToscaServiceTemplate =
 273                         databaseProvider.getFilteredPolicies(ToscaTypedEntityFilter.<ToscaPolicy>builder().build());
 274
 275                 assertEquals(policy.getType(),
 276                         getToscaPolicyFromMapList(gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies(),
 277                                 policy.getName()).getType());
 278
 279                 gotToscaServiceTemplate = databaseProvider.getFilteredPolicies(ToscaTypedEntityFilter
 280                         .<ToscaPolicy>builder().name(policy.getName()).version(policy.getVersion()).build());
 281
 282                 assertEquals(policy.getType(), gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0)
 283                         .get(policy.getName()).getType());
 284             }
 285         }
 286     }
 287
 288     private ToscaPolicy getToscaPolicyFromMapList(List<Map<String, ToscaPolicy>> toscaPolicyMapList,
 289             String policyName) {
 290         ToscaPolicy toscaPolicy = new ToscaPolicy();
 291         for (Map<String, ToscaPolicy> policyMap : toscaPolicyMapList) {
 292             toscaPolicy = policyMap.get(policyName);
 293             if (toscaPolicy != null) {
 294                 break;
 295             }
 296         }
 297         return toscaPolicy;
 298     }
 299
 300     private void createPolicyTypes() throws CoderException, PfModelException, URISyntaxException {
 301         Set<String> policyTypeResources = ResourceUtils.getDirectoryContents("policytypes");
 302
 303         for (String policyTypeResource : policyTypeResources) {
 304             String policyTypeYamlString = ResourceUtils.getResourceAsString(policyTypeResource);
 305             ToscaServiceTemplate toscaServiceTemplatePolicyType =
 306                     yamlJsonTranslator.fromYaml(policyTypeYamlString, ToscaServiceTemplate.class);
 307
 308             assertNotNull(toscaServiceTemplatePolicyType);
 309             databaseProvider.createPolicyTypes(toscaServiceTemplatePolicyType);
 310         }
 311     }
 312 }