2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. 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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * SPDX-License-Identifier: Apache-2.0
19 * ============LICENSE_END=========================================================
22 package org.onap.policy.models.tosca.authorative.concepts;
24 import static org.assertj.core.api.Assertions.assertThatThrownBy;
25 import static org.junit.Assert.assertEquals;
26 import static org.junit.Assert.assertNotNull;
27 import static org.junit.Assert.assertTrue;
29 import com.google.gson.GsonBuilder;
30 import java.util.ArrayList;
31 import java.util.List;
33 import java.util.Map.Entry;
34 import org.junit.BeforeClass;
35 import org.junit.Test;
36 import org.onap.policy.common.utils.coder.CoderException;
37 import org.onap.policy.common.utils.coder.StandardCoder;
38 import org.onap.policy.common.utils.resources.ResourceUtils;
39 import org.onap.policy.models.base.PfKey;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
42 import org.yaml.snakeyaml.Yaml;
45 * Test of the {@link ToscaPolicyFilter} class.
47 * @author Liam Fallon (liam.fallon@est.tech)
49 public class ToscaPolicyFilterTest {
50 private static final String VERSION_100 = "1.0.0";
52 private static final String VERSION_000 = "0.0.0";
54 // Logger for this class
55 private static final Logger LOGGER = LoggerFactory.getLogger(ToscaPolicyFilterTest.class);
58 private static final String[] policyResourceNames = {
59 "policies/vCPE.policies.optimization.input.tosca.yaml",
60 "policies/vCPE.policy.monitoring.input.tosca.json",
61 "policies/vCPE.policy.monitoring.input.tosca.yaml",
62 "policies/vCPE.policy.operational.input.tosca.yaml",
63 "policies/vDNS.policy.guard.frequency.input.tosca.json",
64 "policies/vDNS.policy.guard.frequency.input.tosca.yaml",
65 "policies/vDNS.policy.guard.minmax.input.tosca.yaml",
66 "policies/vDNS.policy.monitoring.input.tosca.json",
67 "policies/vDNS.policy.monitoring.input.tosca.yaml",
68 "policies/vDNS.policy.operational.input.tosca.yaml",
69 "policies/vFirewall.policy.monitoring.input.tosca.json",
70 "policies/vFirewall.policy.monitoring.input.tosca.yaml",
71 "policies/vFirewall.policy.operational.input.tosca.json",
72 "policies/vFirewall.policy.operational.input.tosca.yaml"
76 private static List<ToscaPolicy> policyList = new ArrayList<>();
79 * Set up a Tosca Policy type list for filtering.
81 * @throws CoderException on JSON decoding errors
84 public static void setupTypeList() throws CoderException {
85 for (String policyResourceName : policyResourceNames) {
86 String policyString = ResourceUtils.getResourceAsString(policyResourceName);
87 if (policyResourceName.endsWith("yaml")) {
88 Object yamlObject = new Yaml().load(policyString);
89 policyString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
92 ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
93 assertNotNull(serviceTemplate);
95 for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
96 addPolicies(foundPolicyMap);
100 for (ToscaPolicy policy : policyList) {
101 LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
102 + ":" + policy.getTypeVersion());
106 private static void addPolicies(Map<String, ToscaPolicy> foundPolicyMap) {
107 for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
108 ToscaPolicy policy = policyEntry.getValue();
109 if (policy.getName() == null) {
110 policy.setName(policyEntry.getKey());
113 if (policy.getVersion() == null) {
114 policy.setVersion(PfKey.NULL_KEY_VERSION);
116 if (policy.getTypeVersion() == null) {
117 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
119 if (!policyList.contains(policy)) {
120 policyList.add(policy);
126 public void testNullList() {
127 ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
129 assertThatThrownBy(() -> {
131 }).hasMessage("originalList is marked @NonNull but is null");
135 public void testFilterNothing() {
136 ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
138 List<ToscaPolicy> filteredList = filter.filter(policyList);
139 assertTrue(filteredList.containsAll(policyList));
143 public void testFilterLatestVersion() {
144 ToscaPolicyFilter filter = ToscaPolicyFilter.builder().version(ToscaPolicyFilter.LATEST_VERSION).build();
146 List<ToscaPolicy> filteredList = filter.filter(policyList);
147 assertEquals(22, filteredList.size());
148 assertEquals(VERSION_100, filteredList.get(7).getVersion());
149 assertEquals(VERSION_100, filteredList.get(12).getVersion());
151 assertEquals(24, policyList.size());
152 assertEquals(22, filteredList.size());
154 policyList.get(10).setVersion("2.0.0");
155 policyList.get(16).setVersion("3.4.5");
156 filteredList = filter.filter(policyList);
157 assertEquals(22, filteredList.size());
158 assertEquals("2.0.0", filteredList.get(12).getVersion());
159 assertEquals("3.4.5", filteredList.get(14).getVersion());
161 policyList.get(10).setVersion(VERSION_100);
162 policyList.get(16).setVersion(VERSION_100);
163 filteredList = filter.filter(policyList);
164 assertEquals(22, filteredList.size());
165 assertEquals(VERSION_100, filteredList.get(12).getVersion());
166 assertEquals(VERSION_100, filteredList.get(14).getVersion());
170 public void testFilterNameVersion() {
171 ToscaPolicyFilter filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").build();
172 List<ToscaPolicy> filteredList = filter.filter(policyList);
173 assertEquals(2, filteredList.size());
175 filter = ToscaPolicyFilter.builder().name("guard.frequency.scaleout").build();
176 filteredList = filter.filter(policyList);
177 assertEquals(2, filteredList.size());
179 filter = ToscaPolicyFilter.builder().name("guard.frequency.scalein").build();
180 filteredList = filter.filter(policyList);
181 assertEquals(0, filteredList.size());
183 filter = ToscaPolicyFilter.builder().version(VERSION_100).build();
184 filteredList = filter.filter(policyList);
185 assertEquals(22, filteredList.size());
187 filter = ToscaPolicyFilter.builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1").version(VERSION_100).build();
188 filteredList = filter.filter(policyList);
189 assertEquals(1, filteredList.size());
191 filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").version(VERSION_100).build();
192 filteredList = filter.filter(policyList);
193 assertEquals(1, filteredList.size());
197 public void testFilterVersionPrefix() {
199 ToscaPolicyFilter filter = ToscaPolicyFilter.builder().versionPrefix(null).build();
200 List<ToscaPolicy> filteredList = filter.filter(policyList);
201 assertEquals(24, filteredList.size());
203 filter = ToscaPolicyFilter.builder().versionPrefix("1.").build();
204 filteredList = filter.filter(policyList);
205 assertEquals(22, filteredList.size());
207 filter = ToscaPolicyFilter.builder().versionPrefix("100.").build();
208 filteredList = filter.filter(policyList);
209 assertEquals(0, filteredList.size());
213 public void testFilterTypeVersion() {
214 ToscaPolicyFilter filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").build();
215 List<ToscaPolicy> filteredList = filter.filter(policyList);
216 assertEquals(1, filteredList.size());
218 filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.operational.common.Drools").build();
219 filteredList = filter.filter(policyList);
220 assertEquals(3, filteredList.size());
222 filter = ToscaPolicyFilter.builder().type("onap.policies.monitoring.cdap.tca.hi.lo.app").build();
223 filteredList = filter.filter(policyList);
224 assertEquals(3, filteredList.size());
226 filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.NonOperational").build();
227 filteredList = filter.filter(policyList);
228 assertEquals(0, filteredList.size());
230 filter = ToscaPolicyFilter.builder().typeVersion(VERSION_000).build();
231 filteredList = filter.filter(policyList);
232 assertEquals(7, filteredList.size());
234 filter = ToscaPolicyFilter.builder().type("onap.policies.optimization.resource.HpaPolicy")
235 .typeVersion(VERSION_100).build();
236 filteredList = filter.filter(policyList);
237 assertEquals(2, filteredList.size());
239 filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").typeVersion(VERSION_000)
241 filteredList = filter.filter(policyList);
242 assertEquals(1, filteredList.size());