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.json",
  64         "policies/vCPE.policy.monitoring.input.tosca.yaml",
  65         "policies/vCPE.policy.operational.input.tosca.yaml",
  66         "policies/vDNS.policy.monitoring.input.tosca.json",
  67         "policies/vDNS.policy.monitoring.input.tosca.yaml",
  68         "policies/vDNS.policy.operational.input.tosca.yaml",
  69         "policies/vDNS.policy.guard.frequencylimiter.input.tosca.yaml",
  70         "policies/vDNS.policy.guard.minmaxvnfs.input.tosca.yaml",
  71         "policies/vFirewall.policy.monitoring.input.tosca.json",
  72         "policies/vFirewall.policy.monitoring.input.tosca.yaml",
  73         "policies/vFirewall.policy.operational.input.tosca.json",
  74         "policies/vFirewall.policy.operational.input.tosca.yaml"
  75     };
  76     // @formatter:on
  77
  78     private static List<ToscaPolicy> policyList = new ArrayList<>();
  79
  80     /**
  81      * Set up a Tosca Policy type list for filtering.
  82      *
  83      * @throws CoderException on JSON decoding errors
  84      */
  85     @BeforeClass
  86     public static void setupTypeList() throws CoderException {
  87         for (String policyResourceName : policyResourceNames) {
  88             String policyString = ResourceUtils.getResourceAsString(policyResourceName);
  89             if (policyResourceName.endsWith("yaml")) {
  90                 LOGGER.info("loading {}", policyResourceName);
  91                 Object yamlObject = new Yaml().load(policyString);
  92                 policyString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
  93             }
  94
  95             ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
  96             assertNotNull(serviceTemplate);
  97
  98             for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
  99                 addPolicies(foundPolicyMap);
 100             }
 101         }
 102
 103         for (ToscaPolicy policy : policyList) {
 104             LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
 105                     + ":" + policy.getTypeVersion());
 106         }
 107     }
 108
 109     private static void addPolicies(Map<String, ToscaPolicy> foundPolicyMap) {
 110         for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
 111             ToscaPolicy policy = policyEntry.getValue();
 112             if (policy.getName() == null) {
 113                 policy.setName(policyEntry.getKey());
 114             }
 115
 116             if (policy.getVersion() == null) {
 117                 policy.setVersion(PfKey.NULL_KEY_VERSION);
 118             }
 119             if (policy.getTypeVersion() == null) {
 120                 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
 121             }
 122             if (!policyList.contains(policy)) {
 123                 policyList.add(policy);
 124             }
 125         }
 126     }
 127
 128     @Test
 129     public void testNullList() {
 130         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 131
 132         assertThatThrownBy(() -> {
 133             filter.filter(null);
 134         }).hasMessageMatching("originalList is marked .*on.*ull but is null");
 135     }
 136
 137     @Test
 138     public void testFilterNothing() {
 139         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 140
 141         List<ToscaPolicy> filteredList = filter.filter(policyList);
 142         assertTrue(filteredList.containsAll(policyList));
 143     }
 144
 145     @Test
 146     public void testFilterLatestVersion() {
 147         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().version(ToscaPolicyFilter.LATEST_VERSION).build();
 148
 149         List<ToscaPolicy> filteredList = filter.filter(policyList);
 150         assertEquals(22, filteredList.size());
 151         assertEquals(VERSION_100, filteredList.get(7).getVersion());
 152         assertEquals(VERSION_100, filteredList.get(12).getVersion());
 153
 154         assertEquals(22, policyList.size());
 155         assertEquals(22, filteredList.size());
 156
 157         //
 158         // Change versions to a couple of policies
 159         //
 160         policyList.forEach(policy -> {
 161             if ("onap.vfirewall.tca".equals(policy.getName())) {
 162                 policy.setVersion("2.0.0");
 163             } else if ("operational.modifyconfig".equals(policy.getName())) {
 164                 policy.setVersion("3.4.5");
 165             }
 166         });
 167         //
 168         // We'll still get back the same number of policies
 169         //
 170         filteredList = filter.filter(policyList);
 171         assertEquals(22, filteredList.size());
 172         //
 173         // Assert that the correct versions are returned
 174         //
 175         policyList.forEach(policy -> {
 176             if ("onap.vfirewall.tca".equals(policy.getName())) {
 177                 assertThat(policy.getVersion()).isEqualTo("2.0.0");
 178             } else if ("operational.modifyconfig".equals(policy.getName())) {
 179                 assertThat(policy.getVersion()).isEqualTo("3.4.5");
 180             } else if ("operational.scaleout".equals(policy.getName())) {
 181                 assertThat(policy.getVersion()).isEqualTo(VERSION_000);
 182             } else {
 183                 assertThat(policy.getVersion()).isEqualTo(VERSION_100);
 184             }
 185         });
 186
 187         //
 188         // Change versions back
 189         //
 190         policyList.forEach(policy -> {
 191             if ("onap.vfirewall.tca".equals(policy.getName())) {
 192                 policy.setVersion(VERSION_100);
 193             } else if ("operational.modifyconfig".equals(policy.getName())) {
 194                 policy.setVersion(VERSION_100);
 195             }
 196         });
 197         //
 198         // We'll still get back the same number of policies
 199         //
 200         filteredList = filter.filter(policyList);
 201         assertEquals(22, filteredList.size());
 202         //
 203         // Assert that the correct versions are returned
 204         //
 205         policyList.forEach(policy -> {
 206             //
 207             // Should we fix this to be 1.0.0??
 208             //
 209             if ("operational.scaleout".equals(policy.getName())) {
 210                 assertThat(policy.getVersion()).isEqualTo(VERSION_000);
 211             } else {
 212                 assertThat(policy.getVersion()).isEqualTo(VERSION_100);
 213             }
 214         });
 215     }
 216
 217     @Test
 218     public void testFilterNameVersion() {
 219         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").build();
 220         List<ToscaPolicy> filteredList = filter.filter(policyList);
 221         assertEquals(1, filteredList.size());
 222
 223         filter = ToscaPolicyFilter.builder().name("guard.frequency.scaleout").build();
 224         filteredList = filter.filter(policyList);
 225         assertEquals(1, filteredList.size());
 226
 227         filter = ToscaPolicyFilter.builder().name("guard.frequency.scalein").build();
 228         filteredList = filter.filter(policyList);
 229         assertEquals(0, filteredList.size());
 230
 231         filter = ToscaPolicyFilter.builder().version(VERSION_100).build();
 232         filteredList = filter.filter(policyList);
 233         assertEquals(21, filteredList.size());
 234
 235         filter = ToscaPolicyFilter.builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1").version(VERSION_100).build();
 236         filteredList = filter.filter(policyList);
 237         assertEquals(1, filteredList.size());
 238
 239         filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").version(VERSION_100).build();
 240         filteredList = filter.filter(policyList);
 241         assertEquals(1, filteredList.size());
 242     }
 243
 244     @Test
 245     public void testFilterVersionPrefix() {
 246         // null pattern
 247         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().versionPrefix(null).build();
 248         List<ToscaPolicy> filteredList = filter.filter(policyList);
 249         assertEquals(22, filteredList.size());
 250
 251         filter = ToscaPolicyFilter.builder().versionPrefix("1.").build();
 252         filteredList = filter.filter(policyList);
 253         assertEquals(20, filteredList.size());
 254
 255         filter = ToscaPolicyFilter.builder().versionPrefix("100.").build();
 256         filteredList = filter.filter(policyList);
 257         assertEquals(0, filteredList.size());
 258     }
 259
 260     @Test
 261     public void testFilterTypeVersion() {
 262         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").build();
 263         List<ToscaPolicy> filteredList = filter.filter(policyList);
 264         assertEquals(0, filteredList.size());
 265
 266         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.operational.common.Apex").build();
 267         filteredList = filter.filter(policyList);
 268         assertEquals(0, filteredList.size());
 269
 270         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.operational.common.Drools").build();
 271         filteredList = filter.filter(policyList);
 272         assertEquals(3, filteredList.size());
 273
 274         filter = ToscaPolicyFilter.builder().type("onap.policies.monitoring.cdap.tca.hi.lo.app").build();
 275         filteredList = filter.filter(policyList);
 276         assertEquals(3, filteredList.size());
 277
 278         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.NonOperational").build();
 279         filteredList = filter.filter(policyList);
 280         assertEquals(0, filteredList.size());
 281
 282         filter = ToscaPolicyFilter.builder().typeVersion(VERSION_000).build();
 283         filteredList = filter.filter(policyList);
 284         assertEquals(0, filteredList.size());
 285
 286         filter = ToscaPolicyFilter.builder().type("onap.policies.optimization.resource.HpaPolicy")
 287                 .typeVersion(VERSION_100).build();
 288         filteredList = filter.filter(policyList);
 289         assertEquals(2, filteredList.size());
 290
 291         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").typeVersion(VERSION_000)
 292                 .build();
 293         filteredList = filter.filter(policyList);
 294         assertEquals(0, filteredList.size());
 295     }
 296 }