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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2020 Nordix Foundation.
   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  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.models.provider.impl;
  22
  23 import static org.junit.Assert.assertEquals;
  24 import static org.junit.Assert.assertNotNull;
  25
  26 import java.net.URISyntaxException;
  27 import java.util.Base64;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Set;
  31
  32 import lombok.NonNull;
  33
  34 import org.junit.After;
  35 import org.junit.Before;
  36 import org.junit.Test;
  37 import org.onap.policy.common.utils.coder.CoderException;
  38 import org.onap.policy.common.utils.coder.StandardCoder;
  39 import org.onap.policy.common.utils.coder.YamlJsonTranslator;
  40 import org.onap.policy.common.utils.resources.ResourceUtils;
  41 import org.onap.policy.models.base.PfModelException;
  42 import org.onap.policy.models.provider.PolicyModelsProvider;
  43 import org.onap.policy.models.provider.PolicyModelsProviderFactory;
  44 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyFilter;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * Test persistence of monitoring policies to and from the database.
  53  *
  54  * @author Liam Fallon (liam.fallon@est.tech)
  55  */
  56 public class PolicyToscaPersistenceTest {
  57     private static final Logger LOGGER = LoggerFactory.getLogger(PolicyToscaPersistenceTest.class);
  58
  59     private YamlJsonTranslator yamlJsonTranslator = new YamlJsonTranslator();
  60     private StandardCoder standardCoder = new StandardCoder();
  61
  62     private PolicyModelsProvider databaseProvider;
  63
  64     /**
  65      * Initialize provider.
  66      *
  67      * @throws PfModelException on exceptions in the tests
  68      * @throws CoderException on JSON encoding and decoding errors
  69      */
  70     @Before
  71     public void setupParameters() throws Exception {
  72         // H2, use "org.mariadb.jdbc.Driver" and "jdbc:mariadb://localhost:3306/policy" for locally installed MariaDB
  73
  74         PolicyModelsProviderParameters parameters = new PolicyModelsProviderParameters();
  75         parameters.setDatabaseDriver("org.h2.Driver");
  76         parameters.setDatabaseUrl("jdbc:h2:mem:testdb");
  77         parameters.setDatabaseUser("policy");
  78         parameters.setDatabasePassword(Base64.getEncoder().encodeToString("P01icY".getBytes()));
  79         parameters.setPersistenceUnit("ToscaConceptTest");
  80
  81         databaseProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(parameters);
  82
  83         createPolicyTypes();
  84     }
  85
  86     @After
  87     public void teardown() throws Exception {
  88         databaseProvider.close();
  89     }
  90
  91     @Test
  92     public void testToscaPolicyPersistence() throws Exception {
  93         Set<String> policyResources = ResourceUtils.getDirectoryContents("policies");
  94
  95         for (String policyResource : policyResources) {
  96             if (!policyResource.contains("\\.tosca\\.")) {
  97                 continue;
  98             }
  99
 100             String policyString = ResourceUtils.getResourceAsString(policyResource);
 101
 102             if (policyResource.endsWith("yaml")) {
 103                 testPolicyPersistence(yamlJsonTranslator.fromYaml(policyString, ToscaServiceTemplate.class));
 104             } else {
 105                 testPolicyPersistence(standardCoder.decode(policyString, ToscaServiceTemplate.class));
 106             }
 107         }
 108     }
 109
 110     @Test
 111     public void testNamingPolicyGet() throws PfModelException {
 112         String policyYamlString = ResourceUtils.getResourceAsString("policies/sdnc.policy.naming.input.tosca.yaml");
 113         ToscaServiceTemplate serviceTemplate =
 114                 yamlJsonTranslator.fromYaml(policyYamlString, ToscaServiceTemplate.class);
 115
 116         long createStartTime = System.currentTimeMillis();
 117         databaseProvider.createPolicies(serviceTemplate);
 118         LOGGER.trace("Naming policy create time (ms): {}", System.currentTimeMillis() - createStartTime);
 119
 120         long getStartTime = System.currentTimeMillis();
 121         ToscaServiceTemplate namingServiceTemplate =
 122                 databaseProvider.getPolicies("SDNC_Policy.ONAP_VNF_NAMING_TIMESTAMP", "1.0.0");
 123         LOGGER.trace("Naming policy get time (ms): {}", System.currentTimeMillis() - getStartTime);
 124
 125         assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
 126         assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
 127         assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
 128
 129         long deleteStartTime = System.currentTimeMillis();
 130         databaseProvider.deletePolicy("SDNC_Policy.ONAP_VNF_NAMING_TIMESTAMP", "1.0.0");
 131         LOGGER.trace("Naming policy delete time (ms): {}", System.currentTimeMillis() - deleteStartTime);
 132     }
 133
 134     /**
 135      * Check persistence of a policy.
 136      *
 137      * @param serviceTemplate the service template containing the policy
 138      * @throws Exception any exception thrown
 139      */
 140     public void testPolicyPersistence(@NonNull final ToscaServiceTemplate serviceTemplate) throws Exception {
 141         assertNotNull(serviceTemplate);
 142
 143         databaseProvider.createPolicies(serviceTemplate);
 144         databaseProvider.updatePolicies(serviceTemplate);
 145
 146         for (Map<String, ToscaPolicy> policyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
 147             for (ToscaPolicy policy : policyMap.values()) {
 148                 ToscaServiceTemplate gotToscaServiceTemplate =
 149                         databaseProvider.getPolicies(policy.getName(), policy.getVersion());
 150
 151                 assertEquals(policy.getType(), gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0)
 152                         .get(policy.getName()).getType());
 153
 154                 gotToscaServiceTemplate = databaseProvider.getFilteredPolicies(ToscaPolicyFilter.builder().build());
 155
 156                 assertEquals(policy.getType(),
 157                         getToscaPolicyFromMapList(gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies(),
 158                                 policy.getName()).getType());
 159
 160                 gotToscaServiceTemplate = databaseProvider.getFilteredPolicies(
 161                         ToscaPolicyFilter.builder().name(policy.getName()).version(policy.getVersion()).build());
 162
 163                 assertEquals(policy.getType(), gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0)
 164                         .get(policy.getName()).getType());
 165             }
 166         }
 167     }
 168
 169     private ToscaPolicy getToscaPolicyFromMapList(List<Map<String, ToscaPolicy>> toscaPolicyMapList,
 170             String policyName) {
 171         ToscaPolicy toscaPolicy = new ToscaPolicy();
 172         for (Map<String, ToscaPolicy> policyMap : toscaPolicyMapList) {
 173             toscaPolicy = policyMap.get(policyName);
 174             if (toscaPolicy != null) {
 175                 break;
 176             }
 177         }
 178         return toscaPolicy;
 179     }
 180
 181     private void createPolicyTypes() throws CoderException, PfModelException, URISyntaxException {
 182         Set<String> policyTypeResources = ResourceUtils.getDirectoryContents("policytypes");
 183
 184         for (String policyTypeResource : policyTypeResources) {
 185             String policyTypeYamlString = ResourceUtils.getResourceAsString(policyTypeResource);
 186             ToscaServiceTemplate toscaServiceTemplatePolicyType =
 187                     yamlJsonTranslator.fromYaml(policyTypeYamlString, ToscaServiceTemplate.class);
 188
 189             assertNotNull(toscaServiceTemplatePolicyType);
 190             databaseProvider.createPolicyTypes(toscaServiceTemplatePolicyType);
 191         }
 192     }
 193 }