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
  32 import java.util.ArrayList;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.Map.Entry;
  36
  37 import org.junit.BeforeClass;
  38 import org.junit.Test;
  39 import org.onap.policy.common.utils.coder.CoderException;
  40 import org.onap.policy.common.utils.coder.StandardCoder;
  41 import org.onap.policy.common.utils.resources.ResourceUtils;
  42 import org.onap.policy.models.base.PfKey;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45 import org.yaml.snakeyaml.Yaml;
  46
  47 /**
  48  * Test of the {@link ToscaPolicyFilter} class.
  49  *
  50  * @author Liam Fallon (liam.fallon@est.tech)
  51  */
  52 public class ToscaPolicyFilterTest {
  53     private static final String VERSION_100 = "1.0.0";
  54
  55     private static final String VERSION_000 = "0.0.0";
  56
  57     // Logger for this class
  58     private static final Logger LOGGER = LoggerFactory.getLogger(ToscaPolicyFilterTest.class);
  59
  60     // @formatter:off
  61     private static final String[] policyResourceNames = {
  62         "policies/vCPE.policies.optimization.input.tosca.yaml",
  63         "policies/vCPE.policy.monitoring.input.tosca.yaml",
  64         "policies/vCPE.policy.operational.input.tosca.yaml",
  65         "policies/vDNS.policy.monitoring.input.tosca.yaml",
  66         "policies/vDNS.policy.operational.input.tosca.yaml",
  67         "policies/vDNS.policy.guard.frequencylimiter.input.tosca.yaml",
  68         "policies/vDNS.policy.guard.minmaxvnfs.input.tosca.yaml",
  69         "policies/vFirewall.policy.monitoring.input.tosca.yaml",
  70         "policies/vFirewall.policy.operational.input.tosca.yaml"
  71     };
  72     // @formatter:on
  73
  74     private static List<ToscaPolicy> policyList = new ArrayList<>();
  75
  76     /**
  77      * Set up a Tosca Policy type list for filtering.
  78      *
  79      * @throws CoderException on JSON decoding errors
  80      */
  81     @BeforeClass
  82     public static void setupTypeList() throws CoderException {
  83         for (String policyResourceName : policyResourceNames) {
  84             String policyString = ResourceUtils.getResourceAsString(policyResourceName);
  85             if (policyResourceName.endsWith("yaml")) {
  86                 LOGGER.info("loading {}", policyResourceName);
  87                 Object yamlObject = new Yaml().load(policyString);
  88                 policyString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
  89             }
  90
  91             ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
  92             assertNotNull(serviceTemplate);
  93
  94             for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
  95                 addPolicies(foundPolicyMap);
  96             }
  97         }
  98
  99         for (ToscaPolicy policy : policyList) {
 100             LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
 101                     + ":" + policy.getTypeVersion());
 102         }
 103     }
 104
 105     private static void addPolicies(Map<String, ToscaPolicy> foundPolicyMap) {
 106         for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
 107             ToscaPolicy policy = policyEntry.getValue();
 108             if (policy.getName() == null) {
 109                 policy.setName(policyEntry.getKey());
 110             }
 111
 112             if (policy.getVersion() == null) {
 113                 policy.setVersion(PfKey.NULL_KEY_VERSION);
 114             }
 115             if (policy.getTypeVersion() == null) {
 116                 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
 117             }
 118             if (!policyList.contains(policy)) {
 119                 policyList.add(policy);
 120             }
 121         }
 122     }
 123
 124     @Test
 125     public void testNullList() {
 126         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 127
 128         assertThatThrownBy(() -> {
 129             filter.filter(null);
 130         }).hasMessageMatching("originalList is marked .*on.*ull but is null");
 131     }
 132
 133     @Test
 134     public void testFilterNothing() {
 135         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 136
 137         List<ToscaPolicy> filteredList = filter.filter(policyList);
 138         assertTrue(filteredList.containsAll(policyList));
 139     }
 140
 141     @Test
 142     public void testFilterLatestVersion() {
 143         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().version(ToscaPolicyFilter.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())) {
 186                 policy.setVersion(VERSION_100);
 187             } else if ("operational.modifyconfig".equals(policy.getName())) {
 188                 policy.setVersion(VERSION_100);
 189             }
 190         });
 191         //
 192         // We'll still get back the same number of policies
 193         //
 194         filteredList = filter.filter(policyList);
 195         assertEquals(22, filteredList.size());
 196         //
 197         // Assert that the correct versions are returned
 198         //
 199         policyList.forEach(policy -> assertThat(policy.getVersion()).isEqualTo(VERSION_100));
 200     }
 201
 202     @Test
 203     public void testFilterNameVersion() {
 204         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").build();
 205         List<ToscaPolicy> filteredList = filter.filter(policyList);
 206         assertEquals(1, filteredList.size());
 207
 208         filter = ToscaPolicyFilter.builder().name("guard.frequency.scaleout").build();
 209         filteredList = filter.filter(policyList);
 210         assertEquals(1, filteredList.size());
 211
 212         filter = ToscaPolicyFilter.builder().name("guard.frequency.scalein").build();
 213         filteredList = filter.filter(policyList);
 214         assertEquals(0, filteredList.size());
 215
 216         filter = ToscaPolicyFilter.builder().version(VERSION_100).build();
 217         filteredList = filter.filter(policyList);
 218         assertEquals(22, filteredList.size());
 219
 220         filter = ToscaPolicyFilter.builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1").version(VERSION_100).build();
 221         filteredList = filter.filter(policyList);
 222         assertEquals(1, filteredList.size());
 223
 224         filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").version(VERSION_100).build();
 225         filteredList = filter.filter(policyList);
 226         assertEquals(1, filteredList.size());
 227     }
 228
 229     @Test
 230     public void testFilterVersionPrefix() {
 231         // null pattern
 232         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().versionPrefix(null).build();
 233         List<ToscaPolicy> filteredList = filter.filter(policyList);
 234         assertEquals(22, filteredList.size());
 235
 236         filter = ToscaPolicyFilter.builder().versionPrefix("1.").build();
 237         filteredList = filter.filter(policyList);
 238         assertEquals(22, filteredList.size());
 239
 240         filter = ToscaPolicyFilter.builder().versionPrefix("100.").build();
 241         filteredList = filter.filter(policyList);
 242         assertEquals(0, filteredList.size());
 243     }
 244
 245     @Test
 246     public void testFilterTypeVersion() {
 247         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").build();
 248         List<ToscaPolicy> filteredList = filter.filter(policyList);
 249         assertEquals(0, filteredList.size());
 250
 251         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.operational.common.Apex").build();
 252         filteredList = filter.filter(policyList);
 253         assertEquals(0, filteredList.size());
 254
 255         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.operational.common.Drools").build();
 256         filteredList = filter.filter(policyList);
 257         assertEquals(3, filteredList.size());
 258
 259         filter = ToscaPolicyFilter.builder().type("onap.policies.monitoring.cdap.tca.hi.lo.app").build();
 260         filteredList = filter.filter(policyList);
 261         assertEquals(3, filteredList.size());
 262
 263         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.NonOperational").build();
 264         filteredList = filter.filter(policyList);
 265         assertEquals(0, filteredList.size());
 266
 267         filter = ToscaPolicyFilter.builder().typeVersion(VERSION_000).build();
 268         filteredList = filter.filter(policyList);
 269         assertEquals(0, filteredList.size());
 270
 271         filter = ToscaPolicyFilter.builder().type("onap.policies.optimization.resource.HpaPolicy")
 272                 .typeVersion(VERSION_100).build();
 273         filteredList = filter.filter(policyList);
 274         assertEquals(2, filteredList.size());
 275
 276         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").typeVersion(VERSION_000)
 277                 .build();
 278         filteredList = filter.filter(policyList);
 279         assertEquals(0, filteredList.size());
 280     }
 281 }