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

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