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.assertThatThrownBy;
  25 import static org.junit.Assert.assertEquals;
  26 import static org.junit.Assert.assertNotNull;
  27 import static org.junit.Assert.assertTrue;
  28
  29 import com.google.gson.GsonBuilder;
  30
  31 import java.util.ArrayList;
  32 import java.util.List;
  33 import java.util.Map;
  34 import java.util.Map.Entry;
  35
  36 import org.junit.BeforeClass;
  37 import org.junit.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 ToscaPolicyFilter} class.
  48  *
  49  * @author Liam Fallon (liam.fallon@est.tech)
  50  */
  51 public class ToscaPolicyFilterTest {
  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(ToscaPolicyFilterTest.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.json",
  63         "policies/vCPE.policy.monitoring.input.tosca.yaml",
  64         "policies/vCPE.policy.operational.input.tosca.yaml",
  65         "policies/vDNS.policy.guard.frequency.input.tosca.json",
  66         "policies/vDNS.policy.guard.frequency.input.tosca.yaml",
  67         "policies/vDNS.policy.guard.minmax.input.tosca.yaml",
  68         "policies/vDNS.policy.monitoring.input.tosca.json",
  69         "policies/vDNS.policy.monitoring.input.tosca.yaml",
  70         "policies/vDNS.policy.operational.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                 Object yamlObject = new Yaml().load(policyString);
  91                 policyString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
  92             }
  93
  94             ToscaServiceTemplate serviceTemplate = new StandardCoder().decode(policyString, ToscaServiceTemplate.class);
  95             assertNotNull(serviceTemplate);
  96
  97             for (Map<String, ToscaPolicy> foundPolicyMap : serviceTemplate.getToscaTopologyTemplate().getPolicies()) {
  98                 addPolicies(foundPolicyMap);
  99             }
 100         }
 101
 102         for (ToscaPolicy policy : policyList) {
 103             LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
 104                     + ":" + policy.getTypeVersion());
 105         }
 106     }
 107
 108     private static void addPolicies(Map<String, ToscaPolicy> foundPolicyMap) {
 109         for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
 110             ToscaPolicy policy = policyEntry.getValue();
 111             if (policy.getName() == null) {
 112                 policy.setName(policyEntry.getKey());
 113             }
 114
 115             if (policy.getVersion() == null) {
 116                 policy.setVersion(PfKey.NULL_KEY_VERSION);
 117             }
 118             if (policy.getTypeVersion() == null) {
 119                 policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
 120             }
 121             if (!policyList.contains(policy)) {
 122                 policyList.add(policy);
 123             }
 124         }
 125     }
 126
 127     @Test
 128     public void testNullList() {
 129         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 130
 131         assertThatThrownBy(() -> {
 132             filter.filter(null);
 133         }).hasMessageMatching("originalList is marked .*on.*ull but is null");
 134     }
 135
 136     @Test
 137     public void testFilterNothing() {
 138         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 139
 140         List<ToscaPolicy> filteredList = filter.filter(policyList);
 141         assertTrue(filteredList.containsAll(policyList));
 142     }
 143
 144     @Test
 145     public void testFilterLatestVersion() {
 146         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().version(ToscaPolicyFilter.LATEST_VERSION).build();
 147
 148         List<ToscaPolicy> filteredList = filter.filter(policyList);
 149         assertEquals(22, filteredList.size());
 150         assertEquals(VERSION_100, filteredList.get(7).getVersion());
 151         assertEquals(VERSION_100, filteredList.get(12).getVersion());
 152
 153         assertEquals(24, policyList.size());
 154         assertEquals(22, filteredList.size());
 155
 156         policyList.get(10).setVersion("2.0.0");
 157         policyList.get(16).setVersion("3.4.5");
 158         filteredList = filter.filter(policyList);
 159         assertEquals(22, filteredList.size());
 160         assertEquals("2.0.0", filteredList.get(12).getVersion());
 161         assertEquals("3.4.5", filteredList.get(14).getVersion());
 162
 163         policyList.get(10).setVersion(VERSION_100);
 164         policyList.get(16).setVersion(VERSION_100);
 165         filteredList = filter.filter(policyList);
 166         assertEquals(22, filteredList.size());
 167         assertEquals(VERSION_100, filteredList.get(12).getVersion());
 168         assertEquals(VERSION_100, filteredList.get(14).getVersion());
 169     }
 170
 171     @Test
 172     public void testFilterNameVersion() {
 173         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").build();
 174         List<ToscaPolicy> filteredList = filter.filter(policyList);
 175         assertEquals(2, filteredList.size());
 176
 177         filter = ToscaPolicyFilter.builder().name("guard.frequency.scaleout").build();
 178         filteredList = filter.filter(policyList);
 179         assertEquals(2, filteredList.size());
 180
 181         filter = ToscaPolicyFilter.builder().name("guard.frequency.scalein").build();
 182         filteredList = filter.filter(policyList);
 183         assertEquals(0, filteredList.size());
 184
 185         filter = ToscaPolicyFilter.builder().version(VERSION_100).build();
 186         filteredList = filter.filter(policyList);
 187         assertEquals(22, filteredList.size());
 188
 189         filter = ToscaPolicyFilter.builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1").version(VERSION_100).build();
 190         filteredList = filter.filter(policyList);
 191         assertEquals(1, filteredList.size());
 192
 193         filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").version(VERSION_100).build();
 194         filteredList = filter.filter(policyList);
 195         assertEquals(1, filteredList.size());
 196     }
 197
 198     @Test
 199     public void testFilterVersionPrefix() {
 200         // null pattern
 201         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().versionPrefix(null).build();
 202         List<ToscaPolicy> filteredList = filter.filter(policyList);
 203         assertEquals(24, filteredList.size());
 204
 205         filter = ToscaPolicyFilter.builder().versionPrefix("1.").build();
 206         filteredList = filter.filter(policyList);
 207         assertEquals(22, filteredList.size());
 208
 209         filter = ToscaPolicyFilter.builder().versionPrefix("100.").build();
 210         filteredList = filter.filter(policyList);
 211         assertEquals(0, filteredList.size());
 212     }
 213
 214     @Test
 215     public void testFilterTypeVersion() {
 216         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").build();
 217         List<ToscaPolicy> filteredList = filter.filter(policyList);
 218         assertEquals(1, filteredList.size());
 219
 220         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.operational.common.Drools").build();
 221         filteredList = filter.filter(policyList);
 222         assertEquals(3, filteredList.size());
 223
 224         filter = ToscaPolicyFilter.builder().type("onap.policies.monitoring.cdap.tca.hi.lo.app").build();
 225         filteredList = filter.filter(policyList);
 226         assertEquals(3, filteredList.size());
 227
 228         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.NonOperational").build();
 229         filteredList = filter.filter(policyList);
 230         assertEquals(0, filteredList.size());
 231
 232         filter = ToscaPolicyFilter.builder().typeVersion(VERSION_000).build();
 233         filteredList = filter.filter(policyList);
 234         assertEquals(4, filteredList.size());
 235
 236         filter = ToscaPolicyFilter.builder().type("onap.policies.optimization.resource.HpaPolicy")
 237                 .typeVersion(VERSION_100).build();
 238         filteredList = filter.filter(policyList);
 239         assertEquals(2, filteredList.size());
 240
 241         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").typeVersion(VERSION_000)
 242                 .build();
 243         filteredList = filter.filter(policyList);
 244         assertEquals(1, filteredList.size());
 245     }
 246 }