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

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