2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2021 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.assertThat;
25 import static org.assertj.core.api.Assertions.assertThatThrownBy;
26 import static org.junit.Assert.assertEquals;
27 import static org.junit.Assert.assertNotNull;
28 import static org.junit.Assert.assertTrue;
30 import com.google.gson.GsonBuilder;
31 import java.util.ArrayList;
32 import java.util.List;
34 import java.util.Map.Entry;
35 import org.junit.BeforeClass;
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.resources.ResourceUtils;
40 import org.onap.policy.models.base.PfKey;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.yaml.snakeyaml.Yaml;
46 * Test of the {@link ToscaTypedEntityFilter} class.
48 * @author Liam Fallon (liam.fallon@est.tech)
50 public class ToscaTypedEntityFilterTest {
51 private static final String VERSION_100 = "1.0.0";
53 private static final String VERSION_000 = "0.0.0";
55 // Logger for this class
56 private static final Logger LOGGER = LoggerFactory.getLogger(ToscaTypedEntityFilterTest.class);
59 private static final String[] policyResourceNames = {
60 "policies/vCPE.policies.optimization.input.tosca.yaml",
61 "policies/vCPE.policy.monitoring.input.tosca.yaml",
62 "policies/vCPE.policy.operational.input.tosca.yaml",
63 "policies/vDNS.policy.monitoring.input.tosca.yaml",
64 "policies/vDNS.policy.operational.input.tosca.yaml",
65 "policies/vDNS.policy.guard.frequencylimiter.input.tosca.yaml",
66 "policies/vDNS.policy.guard.minmaxvnfs.input.tosca.yaml",
67 "policies/vFirewall.policy.monitoring.input.tosca.yaml",
68 "policies/vFirewall.policy.operational.input.tosca.yaml"
72 private static List<ToscaPolicy> policyList = new ArrayList<>();
75 * Set up a Tosca Policy type list for filtering.
77 * @throws CoderException on JSON decoding errors
80 public static void setupTypeList() throws CoderException {
81 for (String policyResourceName : policyResourceNames) {
82 String policyString = ResourceUtils.getResourceAsString(policyResourceName);
83 if (policyResourceName.endsWith("yaml")) {
84 LOGGER.info("loading {}", policyResourceName);
85 Object yamlObject = new Yaml().load(policyString);
86 policyString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
89 ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
90 assertNotNull(serviceTemplate);
92 for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
93 addPolicies(foundPolicyMap);
97 for (ToscaPolicy policy : policyList) {
98 LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
99 + ":" + policy.getTypeVersion());
103 private static void addPolicies(Map<String, ToscaPolicy> foundPolicyMap) {
104 for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
105 ToscaPolicy policy = policyEntry.getValue();
106 if (policy.getName() == null) {
107 policy.setName(policyEntry.getKey());
110 if (policy.getVersion() == null) {
111 policy.setVersion(PfKey.NULL_KEY_VERSION);
113 if (policy.getTypeVersion() == null) {
114 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
116 if (!policyList.contains(policy)) {
117 policyList.add(policy);
123 public void testNullList() {
124 ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().build();
126 assertThatThrownBy(() -> {
128 }).hasMessageMatching("originalList is marked .*on.*ull but is null");
132 public void testFilterNothing() {
133 ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().build();
135 List<ToscaPolicy> filteredList = filter.filter(policyList);
136 assertTrue(filteredList.containsAll(policyList));
140 public void testFilterLatestVersion() {
141 ToscaTypedEntityFilter<ToscaPolicy> filter =
142 ToscaTypedEntityFilter.<ToscaPolicy>builder().version(ToscaTypedEntityFilter.LATEST_VERSION).build();
144 List<ToscaPolicy> filteredList = filter.filter(policyList);
145 assertEquals(22, filteredList.size());
146 assertEquals(VERSION_100, filteredList.get(7).getVersion());
147 assertEquals(VERSION_100, filteredList.get(12).getVersion());
149 assertEquals(22, policyList.size());
150 assertEquals(22, filteredList.size());
153 // Change versions to a couple of policies
155 policyList.forEach(policy -> {
156 if ("onap.vfirewall.tca".equals(policy.getName())) {
157 policy.setVersion("2.0.0");
158 } else if ("operational.modifyconfig".equals(policy.getName())) {
159 policy.setVersion("3.4.5");
163 // We'll still get back the same number of policies
165 filteredList = filter.filter(policyList);
166 assertEquals(22, filteredList.size());
168 // Assert that the correct versions are returned
170 policyList.forEach(policy -> {
171 if ("onap.vfirewall.tca".equals(policy.getName())) {
172 assertThat(policy.getVersion()).isEqualTo("2.0.0");
173 } else if ("operational.modifyconfig".equals(policy.getName())) {
174 assertThat(policy.getVersion()).isEqualTo("3.4.5");
176 assertThat(policy.getVersion()).isEqualTo(VERSION_100);
181 // Change versions back
183 policyList.forEach(policy -> {
184 if ("onap.vfirewall.tca".equals(policy.getName())) {
185 policy.setVersion(VERSION_100);
186 } else if ("operational.modifyconfig".equals(policy.getName())) {
187 policy.setVersion(VERSION_100);
191 // We'll still get back the same number of policies
193 filteredList = filter.filter(policyList);
194 assertEquals(22, filteredList.size());
196 // Assert that the correct versions are returned
198 policyList.forEach(policy -> assertThat(policy.getVersion()).isEqualTo(VERSION_100));
202 public void testFilterNameVersion() {
203 ToscaTypedEntityFilter<ToscaPolicy> filter =
204 ToscaTypedEntityFilter.<ToscaPolicy>builder().name("operational.modifyconfig").build();
205 List<ToscaPolicy> filteredList = filter.filter(policyList);
206 assertEquals(1, filteredList.size());
208 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("guard.frequency.scaleout").build();
209 filteredList = filter.filter(policyList);
210 assertEquals(1, filteredList.size());
212 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("guard.frequency.scalein").build();
213 filteredList = filter.filter(policyList);
214 assertEquals(0, filteredList.size());
216 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().version(VERSION_100).build();
217 filteredList = filter.filter(policyList);
218 assertEquals(22, filteredList.size());
220 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1")
221 .version(VERSION_100).build();
222 filteredList = filter.filter(policyList);
223 assertEquals(1, filteredList.size());
225 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("operational.modifyconfig").version(VERSION_100)
227 filteredList = filter.filter(policyList);
228 assertEquals(1, filteredList.size());
232 public void testFilterVersionPrefix() {
234 ToscaTypedEntityFilter<ToscaPolicy> filter =
235 ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix(null).build();
236 List<ToscaPolicy> filteredList = filter.filter(policyList);
237 assertEquals(22, filteredList.size());
239 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix("1.").build();
240 filteredList = filter.filter(policyList);
241 assertEquals(22, filteredList.size());
243 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix("100.").build();
244 filteredList = filter.filter(policyList);
245 assertEquals(0, filteredList.size());
249 public void testFilterTypeVersion() {
250 ToscaTypedEntityFilter<ToscaPolicy> filter =
251 ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.Operational").build();
252 List<ToscaPolicy> filteredList = filter.filter(policyList);
253 assertEquals(0, filteredList.size());
255 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.operational.common.Apex")
257 filteredList = filter.filter(policyList);
258 assertEquals(0, filteredList.size());
260 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
261 .type("onap.policies.controlloop.operational.common.Drools").build();
262 filteredList = filter.filter(policyList);
263 assertEquals(3, filteredList.size());
265 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.monitoring.tcagen2").build();
266 filteredList = filter.filter(policyList);
267 assertEquals(3, filteredList.size());
269 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.NonOperational").build();
270 filteredList = filter.filter(policyList);
271 assertEquals(0, filteredList.size());
273 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().typeVersion(VERSION_000).build();
274 filteredList = filter.filter(policyList);
275 assertEquals(0, filteredList.size());
277 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.optimization.resource.HpaPolicy")
278 .typeVersion(VERSION_100).build();
279 filteredList = filter.filter(policyList);
280 assertEquals(2, filteredList.size());
282 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.Operational")
283 .typeVersion(VERSION_000).build();
284 filteredList = filter.filter(policyList);
285 assertEquals(0, filteredList.size());