models-tosca/src/test/java/org/onap/policy/models/tosca/authorative/concepts/ToscaTypedEntityFilterTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021, 2025 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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.models.tosca.authorative.concepts;
  24
  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;
  30
  31 import com.google.gson.GsonBuilder;
  32 import java.util.ArrayList;
  33 import java.util.List;
  34 import java.util.Map;
  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;
  45
  46 /**
  47  * Test of the {@link ToscaTypedEntityFilter} class.
  48  *
  49  * @author Liam Fallon (liam.fallon@est.tech)
  50  */
  51 class ToscaTypedEntityFilterTest {
  52     private static final String VERSION_100 = "1.0.0";
  53
  54     private static final String VERSION_000 = "0.0.0";
  55
  56     // Logger for this class
  57     private static final Logger LOGGER = LoggerFactory.getLogger(ToscaTypedEntityFilterTest.class);
  58
  59     // @formatter:off
  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"
  70     };
  71     // @formatter:on
  72
  73     private static final List<ToscaPolicy> policyList = new ArrayList<>();
  74
  75     /**
  76      * Set up a Tosca Policy type list for filtering.
  77      *
  78      * @throws CoderException on JSON decoding errors
  79      */
  80     @BeforeAll
  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);
  88             }
  89
  90             ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
  91             assertNotNull(serviceTemplate);
  92
  93             for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
  94                 addPolicies(foundPolicyMap);
  95             }
  96         }
  97
  98         for (ToscaPolicy policy : policyList) {
  99             LOGGER.info("using policy-{}:{}, type-{}:{}", policy.getName(), policy.getVersion(),
 100                 policy.getType(), policy.getTypeVersion());
 101         }
 102     }
 103
 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());
 109             }
 110
 111             if (policy.getVersion() == null) {
 112                 policy.setVersion(PfKey.NULL_KEY_VERSION);
 113             }
 114             if (policy.getTypeVersion() == null) {
 115                 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
 116             }
 117             if (!policyList.contains(policy)) {
 118                 policyList.add(policy);
 119             }
 120         }
 121     }
 122
 123     @Test
 124     void testNullList() {
 125         ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().build();
 126
 127         assertThatThrownBy(() -> {
 128             filter.filter(null);
 129         }).hasMessageMatching("originalList is marked .*on.*ull but is null");
 130     }
 131
 132     @Test
 133     void testFilterNothing() {
 134         ToscaTypedEntityFilter<ToscaPolicy> filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().build();
 135
 136         List<ToscaPolicy> filteredList = filter.filter(policyList);
 137         assertTrue(filteredList.containsAll(policyList));
 138     }
 139
 140     @Test
 141     void testFilterLatestVersion() {
 142         ToscaTypedEntityFilter<ToscaPolicy> filter =
 143             ToscaTypedEntityFilter.<ToscaPolicy>builder().version(ToscaTypedEntityFilter.LATEST_VERSION).build();
 144
 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());
 149
 150         assertEquals(22, policyList.size());
 151         assertEquals(22, filteredList.size());
 152
 153         //
 154         // Change versions to a couple of policies
 155         //
 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");
 161             }
 162         });
 163         //
 164         // We'll still get back the same number of policies
 165         //
 166         filteredList = filter.filter(policyList);
 167         assertEquals(22, filteredList.size());
 168         //
 169         // Assert that the correct versions are returned
 170         //
 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");
 176             } else {
 177                 assertThat(policy.getVersion()).isEqualTo(VERSION_100);
 178             }
 179         });
 180
 181         //
 182         // Change versions back
 183         //
 184         policyList.forEach(policy -> {
 185             if ("onap.vfirewall.tca".equals(policy.getName()) || "operational.modifyconfig".equals(policy.getName())) {
 186                 policy.setVersion(VERSION_100);
 187             }
 188         });
 189         //
 190         // We'll still get back the same number of policies
 191         //
 192         filteredList = filter.filter(policyList);
 193         assertEquals(22, filteredList.size());
 194         //
 195         // Assert that the correct versions are returned
 196         //
 197         policyList.forEach(policy -> assertThat(policy.getVersion()).isEqualTo(VERSION_100));
 198     }
 199
 200     @Test
 201     void testFilterNameVersion() {
 202         ToscaTypedEntityFilter<ToscaPolicy> filter =
 203             ToscaTypedEntityFilter.<ToscaPolicy>builder().name("operational.modifyconfig").build();
 204         List<ToscaPolicy> filteredList = filter.filter(policyList);
 205         assertEquals(1, filteredList.size());
 206
 207         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("guard.frequency.scaleout").build();
 208         filteredList = filter.filter(policyList);
 209         assertEquals(1, filteredList.size());
 210
 211         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("guard.frequency.scalein").build();
 212         filteredList = filter.filter(policyList);
 213         assertEquals(0, filteredList.size());
 214
 215         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().version(VERSION_100).build();
 216         filteredList = filter.filter(policyList);
 217         assertEquals(22, filteredList.size());
 218
 219         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1")
 220             .version(VERSION_100).build();
 221         filteredList = filter.filter(policyList);
 222         assertEquals(1, filteredList.size());
 223
 224         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().name("operational.modifyconfig").version(VERSION_100)
 225             .build();
 226         filteredList = filter.filter(policyList);
 227         assertEquals(1, filteredList.size());
 228     }
 229
 230     @Test
 231     void testFilterVersionPrefix() {
 232         // null pattern
 233         ToscaTypedEntityFilter<ToscaPolicy> filter =
 234             ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix(null).build();
 235         List<ToscaPolicy> filteredList = filter.filter(policyList);
 236         assertEquals(22, filteredList.size());
 237
 238         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix("1.").build();
 239         filteredList = filter.filter(policyList);
 240         assertEquals(22, filteredList.size());
 241
 242         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().versionPrefix("100.").build();
 243         filteredList = filter.filter(policyList);
 244         assertEquals(0, filteredList.size());
 245     }
 246
 247     @Test
 248     void testFilterTypeVersion() {
 249         ToscaTypedEntityFilter<ToscaPolicy> filter =
 250             ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.Operational").build();
 251         List<ToscaPolicy> filteredList = filter.filter(policyList);
 252         assertEquals(0, filteredList.size());
 253
 254         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.operational.common.Apex")
 255             .build();
 256         filteredList = filter.filter(policyList);
 257         assertEquals(0, filteredList.size());
 258
 259         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder()
 260             .type("onap.policies.controlloop.operational.common.Drools").build();
 261         filteredList = filter.filter(policyList);
 262         assertEquals(3, filteredList.size());
 263
 264         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.monitoring.tcagen2").build();
 265         filteredList = filter.filter(policyList);
 266         assertEquals(3, filteredList.size());
 267
 268         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.NonOperational").build();
 269         filteredList = filter.filter(policyList);
 270         assertEquals(0, filteredList.size());
 271
 272         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().typeVersion(VERSION_000).build();
 273         filteredList = filter.filter(policyList);
 274         assertEquals(0, filteredList.size());
 275
 276         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.optimization.resource.HpaPolicy")
 277             .typeVersion(VERSION_100).build();
 278         filteredList = filter.filter(policyList);
 279         assertEquals(2, filteredList.size());
 280
 281         filter = ToscaTypedEntityFilter.<ToscaPolicy>builder().type("onap.policies.controlloop.Operational")
 282             .typeVersion(VERSION_000).build();
 283         filteredList = filter.filter(policyList);
 284         assertEquals(0, filteredList.size());
 285     }
 286 }