2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2021, 2023-2024 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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * SPDX-License-Identifier: Apache-2.0
20 * ============LICENSE_END=========================================================
23 package org.onap.policy.models.provider.impl;
25 import static org.assertj.core.api.Assertions.assertThatCode;
26 import static org.junit.Assert.assertEquals;
27 import static org.junit.Assert.assertNotNull;
29 import java.net.URISyntaxException;
30 import java.util.LinkedHashMap;
31 import java.util.List;
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;
57 * Test persistence of monitoring policies to and from the database.
59 * @author Liam Fallon (liam.fallon@est.tech)
61 public class PolicyToscaPersistenceTest {
62 private static final Logger LOGGER = LoggerFactory.getLogger(PolicyToscaPersistenceTest.class);
64 private YamlJsonTranslator yamlJsonTranslator = new YamlJsonTranslator();
65 private StandardCoder standardCoder = new StandardCoder();
67 private PolicyModelsProvider databaseProvider;
70 * Initialize provider.
72 * @throws PfModelException on exceptions in the tests
73 * @throws CoderException on JSON encoding and decoding errors
76 public void setupParameters() throws Exception {
77 // H2, use "org.mariadb.jdbc.Driver" and "jdbc:mariadb://localhost:3306/policy" for locally installed MariaDB
79 PolicyModelsProviderParameters parameters = new PolicyModelsProviderParameters();
81 if (System.getProperty("USE-MARIADB") != null) {
82 parameters.setDatabaseDriver("org.mariadb.jdbc.Driver");
83 parameters.setDatabaseUrl("jdbc:mariadb://localhost:3306/policy");
85 parameters.setDatabaseDriver("org.h2.Driver");
86 parameters.setDatabaseUrl("jdbc:h2:mem:PolicyToscaPersistenceTest");
89 parameters.setDatabaseUser("policy");
90 parameters.setDatabasePassword("P01icY");
91 parameters.setPersistenceUnit("ToscaConceptTest");
94 databaseProvider = new PolicyModelsProviderFactory().createPolicyModelsProvider(parameters);
100 public void teardown() throws Exception {
101 databaseProvider.close();
105 public void testToscaPolicyPersistence() throws Exception {
106 Set<String> policyResources = ResourceUtils.getDirectoryContents("policies");
108 for (String policyResource : policyResources) {
109 if (!policyResource.contains("\\.tosca\\.")) {
113 String policyString = ResourceUtils.getResourceAsString(policyResource);
115 if (policyResource.endsWith("yaml")) {
116 testPolicyPersistence(yamlJsonTranslator.fromYaml(policyString, ToscaServiceTemplate.class));
118 testPolicyPersistence(standardCoder.decode(policyString, ToscaServiceTemplate.class));
124 public void testHpaPolicyTypeGet() throws PfModelException {
125 long getStartTime = System.currentTimeMillis();
126 ToscaServiceTemplate hpaServiceTemplate =
127 databaseProvider.getPolicyTypes("onap.policies.optimization.resource.HpaPolicy", "1.0.0");
128 LOGGER.trace("HPA policy normal get time (ms): {}", System.currentTimeMillis() - getStartTime);
130 assertEquals(3, hpaServiceTemplate.getPolicyTypesAsMap().size());
131 assertEquals(5, hpaServiceTemplate.getDataTypesAsMap().size());
133 getStartTime = System.currentTimeMillis();
134 ToscaEntityFilter<ToscaPolicyType> hpaFilter = ToscaEntityFilter.<ToscaPolicyType>builder()
135 .name("onap.policies.optimization.resource.HpaPolicy").version("1.0.0").build();
136 hpaServiceTemplate = databaseProvider.getFilteredPolicyTypes(hpaFilter);
137 LOGGER.trace("HPA policy filter name version get time (ms): {}", System.currentTimeMillis() - getStartTime);
139 assertEquals(3, hpaServiceTemplate.getPolicyTypesAsMap().size());
140 assertEquals(5, hpaServiceTemplate.getDataTypesAsMap().size());
142 getStartTime = System.currentTimeMillis();
143 hpaFilter = ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.optimization.resource.HpaPolicy")
145 hpaServiceTemplate = databaseProvider.getFilteredPolicyTypes(hpaFilter);
146 LOGGER.trace("HPA policy filter name only get time (ms): {}", System.currentTimeMillis() - getStartTime);
148 assertEquals(3, hpaServiceTemplate.getPolicyTypesAsMap().size());
149 assertEquals(5, hpaServiceTemplate.getDataTypesAsMap().size());
153 public void testNamingPolicyGet() throws PfModelException {
154 String policyYamlString = ResourceUtils.getResourceAsString("policies/sdnc.policy.naming.input.tosca.yaml");
155 ToscaServiceTemplate serviceTemplate =
156 yamlJsonTranslator.fromYaml(policyYamlString, ToscaServiceTemplate.class);
158 long createStartTime = System.currentTimeMillis();
159 databaseProvider.createPolicies(serviceTemplate);
160 LOGGER.trace("Naming policy create time (ms): {}", System.currentTimeMillis() - createStartTime);
162 long getStartTime = System.currentTimeMillis();
163 ToscaServiceTemplate namingServiceTemplate =
164 databaseProvider.getPolicies("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", "1.0.0");
165 LOGGER.trace("Naming policy normal get time (ms): {}", System.currentTimeMillis() - getStartTime);
167 assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
168 assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
169 assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
171 getStartTime = System.currentTimeMillis();
172 ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
173 .name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").version("1.0.0").build();
174 namingServiceTemplate = databaseProvider.getFilteredPolicies(filter);
175 LOGGER.trace("Naming policy filtered get time (ms): {}", System.currentTimeMillis() - getStartTime);
177 assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
178 assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
179 assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
181 getStartTime = System.currentTimeMillis();
182 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").build();
183 namingServiceTemplate = databaseProvider.getFilteredPolicies(filter);
184 LOGGER.trace("Naming policy filtered name only get time (ms): {}", System.currentTimeMillis() - getStartTime);
186 assertEquals(1, namingServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
187 assertEquals(1, namingServiceTemplate.getPolicyTypesAsMap().size());
188 assertEquals(3, namingServiceTemplate.getDataTypesAsMap().size());
190 long deleteStartTime = System.currentTimeMillis();
191 ToscaServiceTemplate deletedServiceTemplate =
192 databaseProvider.deletePolicy("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", "1.0.0");
193 LOGGER.trace("Naming policy delete time (ms): {}", System.currentTimeMillis() - deleteStartTime);
195 assertEquals(1, deletedServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
199 public void testNamingPolicyVersions() throws PfModelException {
200 String policyYamlString = ResourceUtils.getResourceAsString("policies/sdnc.policy.naming.input.tosca.yaml");
201 ToscaServiceTemplate serviceTemplate =
202 yamlJsonTranslator.fromYaml(policyYamlString, ToscaServiceTemplate.class);
204 // Create policy types and data types
205 List<Map<String, ToscaPolicy>> policyMapList = serviceTemplate.getToscaTopologyTemplate().getPolicies();
206 databaseProvider.createPolicies(serviceTemplate);
208 // Clear the policy map list so we start from afresh with versions
209 ToscaPolicy namingPolicy = policyMapList.get(0).values().iterator().next();
210 policyMapList.clear();
212 // Create 21 more versions of the policy
213 for (int i = 2; i < 22; i++) {
214 ToscaPolicy clonedNamingPolicy = new ToscaPolicy(namingPolicy);
215 clonedNamingPolicy.setVersion(i + ".0.0");
216 Map<String, ToscaPolicy> policyMap = new LinkedHashMap<>(1);
217 policyMap.put(clonedNamingPolicy.getName(), clonedNamingPolicy);
218 policyMapList.add(policyMap);
221 databaseProvider.createPolicies(serviceTemplate);
223 for (int i = 1; i < 22; i++) {
224 ToscaServiceTemplate namingServiceTemplate =
225 databaseProvider.getPolicies("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", i + ".0.0");
226 assertEquals(i + ".0.0", namingServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).values()
227 .iterator().next().getVersion());
229 ToscaTypedEntityFilter<ToscaPolicy> policyFilter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
230 .name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").version(i + ".0.0").build();
231 namingServiceTemplate = databaseProvider.getFilteredPolicies(policyFilter);
232 assertEquals(i + ".0.0", namingServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).values()
233 .iterator().next().getVersion());
236 ToscaTypedEntityFilter<ToscaPolicy> policyFilter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
237 .name("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP").version(ToscaTypedEntityFilter.LATEST_VERSION).build();
238 ToscaServiceTemplate namingServiceTemplate = databaseProvider.getFilteredPolicies(policyFilter);
239 assertEquals("21.0.0", namingServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0).values().iterator()
240 .next().getVersion());
242 for (int i = 1; i < 22; i++) {
243 ToscaServiceTemplate deletedServiceTemplate =
244 databaseProvider.deletePolicy("SDNC_Policy.ONAP_NF_NAMING_TIMESTAMP", i + ".0.0");
245 assertEquals(1, deletedServiceTemplate.getToscaTopologyTemplate().getPoliciesAsMap().size());
250 * Check persistence of a policy.
252 * @param serviceTemplate the service template containing the policy
253 * @throws Exception any exception thrown
255 public void testPolicyPersistence(@NonNull final ToscaServiceTemplate serviceTemplate) throws Exception {
256 assertNotNull(serviceTemplate);
258 CountDownLatch threadCountDownLatch = new CountDownLatch(10);
260 for (int i = 0; i < 10; i++) {
264 assertThatCode(() -> databaseProvider.createPolicies(serviceTemplate)).doesNotThrowAnyException();
265 assertThatCode(() -> databaseProvider.updatePolicies(serviceTemplate)).doesNotThrowAnyException();
266 threadCountDownLatch.countDown();
271 threadCountDownLatch.await(10, TimeUnit.SECONDS);
273 for (Map<String, ToscaPolicy> policyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
274 for (ToscaPolicy policy : policyMap.values()) {
275 ToscaServiceTemplate gotToscaServiceTemplate =
276 databaseProvider.getPolicies(policy.getName(), policy.getVersion());
278 assertEquals(policy.getType(), gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0)
279 .get(policy.getName()).getType());
281 gotToscaServiceTemplate =
282 databaseProvider.getFilteredPolicies(ToscaTypedEntityFilter.<ToscaPolicy>builder().build());
284 assertEquals(policy.getType(),
285 getToscaPolicyFromMapList(gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies(),
286 policy.getName()).getType());
288 gotToscaServiceTemplate = databaseProvider.getFilteredPolicies(ToscaTypedEntityFilter
289 .<ToscaPolicy>builder().name(policy.getName()).version(policy.getVersion()).build());
291 assertEquals(policy.getType(), gotToscaServiceTemplate.getToscaTopologyTemplate().getPolicies().get(0)
292 .get(policy.getName()).getType());
297 private ToscaPolicy getToscaPolicyFromMapList(List<Map<String, ToscaPolicy>> toscaPolicyMapList,
299 ToscaPolicy toscaPolicy = new ToscaPolicy();
300 for (Map<String, ToscaPolicy> policyMap : toscaPolicyMapList) {
301 toscaPolicy = policyMap.get(policyName);
302 if (toscaPolicy != null) {
309 private void createPolicyTypes() throws CoderException, PfModelException, URISyntaxException {
310 Set<String> policyTypeResources = ResourceUtils.getDirectoryContents("policytypes");
312 for (String policyTypeResource : policyTypeResources) {
313 String policyTypeYamlString = ResourceUtils.getResourceAsString(policyTypeResource);
314 ToscaServiceTemplate toscaServiceTemplatePolicyType =
315 yamlJsonTranslator.fromYaml(policyTypeYamlString, ToscaServiceTemplate.class);
317 assertNotNull(toscaServiceTemplatePolicyType);
318 databaseProvider.createPolicyTypes(toscaServiceTemplatePolicyType);