2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2019-2021 Nordix Foundation.
4 * Modifications Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
5 * Modifications Copyright (C) 2024 Nordix Foundation
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.tosca.authorative.concepts;
25 import static org.assertj.core.api.Assertions.assertThat;
26 import static org.assertj.core.api.Assertions.assertThatThrownBy;
27 import static org.junit.jupiter.api.Assertions.assertEquals;
28 import static org.junit.jupiter.api.Assertions.assertNotNull;
29 import static org.junit.jupiter.api.Assertions.assertTrue;
31 import com.google.gson.GsonBuilder;
32 import java.util.ArrayList;
33 import java.util.List;
35 import java.util.Map.Entry;
36 import org.junit.jupiter.api.BeforeAll;
37 import org.junit.jupiter.api.Test;
38 import org.onap.policy.common.utils.coder.CoderException;
39 import org.onap.policy.common.utils.coder.StandardCoder;
40 import org.onap.policy.common.utils.resources.ResourceUtils;
41 import org.onap.policy.models.base.PfKey;
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44 import org.yaml.snakeyaml.Yaml;
47 * Test of the {@link ToscaTypedEntityFilter} class.
49 * @author Liam Fallon (liam.fallon@est.tech)
51 class ToscaTypedEntityFilterTest {
52 private static final String VERSION_100 = "1.0.0";
54 private static final String VERSION_000 = "0.0.0";
56 // Logger for this class
57 private static final Logger LOGGER = LoggerFactory.getLogger(ToscaTypedEntityFilterTest.class);
60 private static final String[] policyResourceNames = {
61 "policies/vCPE.policies.optimization.input.tosca.yaml",
62 "policies/vCPE.policy.monitoring.input.tosca.yaml",
63 "policies/vCPE.policy.operational.input.tosca.yaml",
64 "policies/vDNS.policy.monitoring.input.tosca.yaml",
65 "policies/vDNS.policy.operational.input.tosca.yaml",
66 "policies/vDNS.policy.guard.frequencylimiter.input.tosca.yaml",
67 "policies/vDNS.policy.guard.minmaxvnfs.input.tosca.yaml",
68 "policies/vFirewall.policy.monitoring.input.tosca.yaml",
69 "policies/vFirewall.policy.operational.input.tosca.yaml"
73 private static List<ToscaPolicy> policyList = new ArrayList<>();
76 * Set up a Tosca Policy type list for filtering.
78 * @throws CoderException on JSON decoding errors
81 public static void setupTypeList() throws CoderException {
82 for (String policyResourceName : policyResourceNames) {
83 String policyString = ResourceUtils.getResourceAsString(policyResourceName);
84 if (policyResourceName.endsWith("yaml")) {
85 LOGGER.info("loading {}", policyResourceName);
86 Object yamlObject = new Yaml().load(policyString);
87 policyString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
90 ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
91 assertNotNull(serviceTemplate);
93 for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
94 addPolicies(foundPolicyMap);
98 for (ToscaPolicy policy : policyList) {
99 LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
100 + ":" + policy.getTypeVersion());
104 private static void addPolicies(Map<String, ToscaPolicy> foundPolicyMap) {
105 for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
106 ToscaPolicy policy = policyEntry.getValue();
107 if (policy.getName() == null) {
108 policy.setName(policyEntry.getKey());
111 if (policy.getVersion() == null) {
112 policy.setVersion(PfKey.NULL_KEY_VERSION);
114 if (policy.getTypeVersion() == null) {
115 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
117 if (!policyList.contains(policy)) {
118 policyList.add(policy);
124 void testNullList() {
125 ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().build();
127 assertThatThrownBy(() -> {
129 }).hasMessageMatching("originalList is marked .*on.*ull but is null");
133 void testFilterNothing() {
134 ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().build();
136 List<ToscaPolicy> filteredList = filter.filter(policyList);
137 assertTrue(filteredList.containsAll(policyList));
141 void testFilterLatestVersion() {
142 ToscaTypedEntityFilter<ToscaPolicy> filter =
143 ToscaTypedEntityFilter.<ToscaPolicy>builder().version(ToscaTypedEntityFilter.LATEST_VERSION).build();
145 List<ToscaPolicy> filteredList = filter.filter(policyList);
146 assertEquals(22, filteredList.size());
147 assertEquals(VERSION_100, filteredList.get(7).getVersion());
148 assertEquals(VERSION_100, filteredList.get(12).getVersion());
150 assertEquals(22, policyList.size());
151 assertEquals(22, filteredList.size());
154 // Change versions to a couple of policies
156 policyList.forEach(policy -> {
157 if ("onap.vfirewall.tca".equals(policy.getName())) {
158 policy.setVersion("2.0.0");
159 } else if ("operational.modifyconfig".equals(policy.getName())) {
160 policy.setVersion("3.4.5");
164 // We'll still get back the same number of policies
166 filteredList = filter.filter(policyList);
167 assertEquals(22, filteredList.size());
169 // Assert that the correct versions are returned
171 policyList.forEach(policy -> {
172 if ("onap.vfirewall.tca".equals(policy.getName())) {
173 assertThat(policy.getVersion()).isEqualTo("2.0.0");
174 } else if ("operational.modifyconfig".equals(policy.getName())) {
175 assertThat(policy.getVersion()).isEqualTo("3.4.5");
177 assertThat(policy.getVersion()).isEqualTo(VERSION_100);
182 // Change versions back
184 policyList.forEach(policy -> {
185 if ("onap.vfirewall.tca".equals(policy.getName())) {
186 policy.setVersion(VERSION_100);
187 } else if ("operational.modifyconfig".equals(policy.getName())) {
188 policy.setVersion(VERSION_100);
192 // We'll still get back the same number of policies
194 filteredList = filter.filter(policyList);
195 assertEquals(22, filteredList.size());
197 // Assert that the correct versions are returned
199 policyList.forEach(policy -> assertThat(policy.getVersion()).isEqualTo(VERSION_100));
203 void testFilterNameVersion() {
204 ToscaTypedEntityFilter<ToscaPolicy> filter =
205 ToscaTypedEntityFilter.<ToscaPolicy>builder().name("operational.modifyconfig").build();
206 List<ToscaPolicy> filteredList = filter.filter(policyList);
207 assertEquals(1, filteredList.size());
209 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("guard.frequency.scaleout").build();
210 filteredList = filter.filter(policyList);
211 assertEquals(1, filteredList.size());
213 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("guard.frequency.scalein").build();
214 filteredList = filter.filter(policyList);
215 assertEquals(0, filteredList.size());
217 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().version(VERSION_100).build();
218 filteredList = filter.filter(policyList);
219 assertEquals(22, filteredList.size());
221 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1")
222 .version(VERSION_100).build();
223 filteredList = filter.filter(policyList);
224 assertEquals(1, filteredList.size());
226 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("operational.modifyconfig").version(VERSION_100)
228 filteredList = filter.filter(policyList);
229 assertEquals(1, filteredList.size());
233 void testFilterVersionPrefix() {
235 ToscaTypedEntityFilter<ToscaPolicy> filter =
236 ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix(null).build();
237 List<ToscaPolicy> filteredList = filter.filter(policyList);
238 assertEquals(22, filteredList.size());
240 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix("1.").build();
241 filteredList = filter.filter(policyList);
242 assertEquals(22, filteredList.size());
244 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix("100.").build();
245 filteredList = filter.filter(policyList);
246 assertEquals(0, filteredList.size());
250 void testFilterTypeVersion() {
251 ToscaTypedEntityFilter<ToscaPolicy> filter =
252 ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.Operational").build();
253 List<ToscaPolicy> filteredList = filter.filter(policyList);
254 assertEquals(0, filteredList.size());
256 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.operational.common.Apex")
258 filteredList = filter.filter(policyList);
259 assertEquals(0, filteredList.size());
261 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
262 .type("onap.policies.controlloop.operational.common.Drools").build();
263 filteredList = filter.filter(policyList);
264 assertEquals(3, filteredList.size());
266 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.monitoring.tcagen2").build();
267 filteredList = filter.filter(policyList);
268 assertEquals(3, filteredList.size());
270 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.NonOperational").build();
271 filteredList = filter.filter(policyList);
272 assertEquals(0, filteredList.size());
274 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().typeVersion(VERSION_000).build();
275 filteredList = filter.filter(policyList);
276 assertEquals(0, filteredList.size());
278 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.optimization.resource.HpaPolicy")
279 .typeVersion(VERSION_100).build();
280 filteredList = filter.filter(policyList);
281 assertEquals(2, filteredList.size());
283 filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.Operational")
284 .typeVersion(VERSION_000).build();
285 filteredList = filter.filter(policyList);
286 assertEquals(0, filteredList.size());