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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  *  Modifications Copyright (C) 2019 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     // Logger for this class
  53     private static final Logger LOGGER = LoggerFactory.getLogger(ToscaPolicyFilterTest.class);
  54
  55     // @formatter:off
  56     private static final String[] policyResourceNames = {
  57         "policies/vCPE.policies.optimization.input.tosca.yaml",
  58         "policies/vCPE.policy.monitoring.input.tosca.json",
  59         "policies/vCPE.policy.monitoring.input.tosca.yaml",
  60         "policies/vCPE.policy.operational.input.tosca.yaml",
  61         "policies/vDNS.policy.guard.frequency.input.tosca.json",
  62         "policies/vDNS.policy.guard.frequency.input.tosca.yaml",
  63         "policies/vDNS.policy.guard.minmax.input.tosca.yaml",
  64         "policies/vDNS.policy.monitoring.input.tosca.json",
  65         "policies/vDNS.policy.monitoring.input.tosca.yaml",
  66         "policies/vDNS.policy.operational.input.tosca.yaml",
  67         "policies/vFirewall.policy.monitoring.input.tosca.json",
  68         "policies/vFirewall.policy.monitoring.input.tosca.yaml",
  69         "policies/vFirewall.policy.operational.input.tosca.json",
  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                 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                 for (Entry<String, ToscaPolicy> policyEntry : foundPolicyMap.entrySet()) {
  95                     ToscaPolicy policy = policyEntry.getValue();
  96                     if (policy.getName() == null) {
  97                         policy.setName(policyEntry.getKey());
  98                     }
  99
 100                     if (policy.getVersion() == null) {
 101                         policy.setVersion(PfKey.NULL_KEY_VERSION);
 102                     }
 103                     if (policy.getTypeVersion() == null) {
 104                         policy.setTypeVersion(PfKey.NULL_KEY_VERSION);
 105                     }
 106                     if (!policyList.contains(policy)) {
 107                         policyList.add(policy);
 108                     }
 109                 }
 110             }
 111         }
 112
 113         for (ToscaPolicy policy : policyList) {
 114             LOGGER.info("using policy-" + policy.getName() + ":" + policy.getVersion() + ", type-" + policy.getType()
 115                     + ":" + policy.getTypeVersion());
 116         }
 117     }
 118
 119     @Test
 120     public void testNullList() {
 121         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 122
 123         assertThatThrownBy(() -> {
 124             filter.filter(null);
 125         }).hasMessage("originalList is marked @NonNull but is null");
 126     }
 127
 128     @Test
 129     public void testFilterNothing() {
 130         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().build();
 131
 132         List<ToscaPolicy> filteredList = filter.filter(policyList);
 133         assertTrue(filteredList.containsAll(policyList));
 134     }
 135
 136     @Test
 137     public void testFilterLatestVersion() {
 138         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().version(ToscaPolicyFilter.LATEST_VERSION).build();
 139
 140         List<ToscaPolicy> filteredList = filter.filter(policyList);
 141         assertEquals(15, filteredList.size());
 142         assertEquals("1.0.0", filteredList.get(7).getVersion());
 143         assertEquals("1.0.0", filteredList.get(12).getVersion());
 144
 145         assertEquals(17, policyList.size());
 146         assertEquals(15, filteredList.size());
 147
 148         policyList.get(10).setVersion("2.0.0");
 149         policyList.get(16).setVersion("3.4.5");
 150         filteredList = filter.filter(policyList);
 151         assertEquals(15, filteredList.size());
 152         assertEquals("2.0.0", filteredList.get(7).getVersion());
 153         assertEquals("3.4.5", filteredList.get(12).getVersion());
 154
 155         policyList.get(10).setVersion("1.0.0");
 156         policyList.get(16).setVersion("1.0.0");
 157         filteredList = filter.filter(policyList);
 158         assertEquals(15, filteredList.size());
 159         assertEquals("1.0.0", filteredList.get(7).getVersion());
 160         assertEquals("1.0.0", filteredList.get(12).getVersion());
 161     }
 162
 163     @Test
 164     public void testFilterNameVersion() {
 165         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").build();
 166         List<ToscaPolicy> filteredList = filter.filter(policyList);
 167         assertEquals(2, filteredList.size());
 168
 169         filter = ToscaPolicyFilter.builder().name("guard.frequency.scaleout").build();
 170         filteredList = filter.filter(policyList);
 171         assertEquals(2, filteredList.size());
 172
 173         filter = ToscaPolicyFilter.builder().name("guard.frequency.scalein").build();
 174         filteredList = filter.filter(policyList);
 175         assertEquals(0, filteredList.size());
 176
 177         filter = ToscaPolicyFilter.builder().version("1.0.0").build();
 178         filteredList = filter.filter(policyList);
 179         assertEquals(17, filteredList.size());
 180
 181         filter = ToscaPolicyFilter.builder().name("OSDF_CASABLANCA.SubscriberPolicy_v1").version("1.0.0").build();
 182         filteredList = filter.filter(policyList);
 183         assertEquals(1, filteredList.size());
 184
 185         filter = ToscaPolicyFilter.builder().name("operational.modifyconfig").version("1.0.0").build();
 186         filteredList = filter.filter(policyList);
 187         assertEquals(2, filteredList.size());
 188     }
 189
 190     @Test
 191     public void testFilterVersionPrefix() {
 192         // null pattern
 193         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().versionPrefix(null).build();
 194         List<ToscaPolicy> filteredList = filter.filter(policyList);
 195         assertEquals(17, filteredList.size());
 196
 197         filter = ToscaPolicyFilter.builder().versionPrefix("1.").build();
 198         filteredList = filter.filter(policyList);
 199         assertEquals(17, filteredList.size());
 200
 201         filter = ToscaPolicyFilter.builder().versionPrefix("100.").build();
 202         filteredList = filter.filter(policyList);
 203         assertEquals(0, filteredList.size());
 204     }
 205
 206     @Test
 207     public void testFilterTypeVersion() {
 208         ToscaPolicyFilter filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").build();
 209         List<ToscaPolicy> filteredList = filter.filter(policyList);
 210         assertEquals(4, filteredList.size());
 211
 212         filter = ToscaPolicyFilter.builder().type("onap.policies.monitoring.cdap.tca.hi.lo.app").build();
 213         filteredList = filter.filter(policyList);
 214         assertEquals(2, filteredList.size());
 215
 216         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.NonOperational").build();
 217         filteredList = filter.filter(policyList);
 218         assertEquals(0, filteredList.size());
 219
 220         filter = ToscaPolicyFilter.builder().typeVersion("0.0.0").build();
 221         filteredList = filter.filter(policyList);
 222         assertEquals(17, filteredList.size());
 223
 224         filter = ToscaPolicyFilter.builder().type("onap.policies.optimization.HpaPolicy").typeVersion("0.0.0").build();
 225         filteredList = filter.filter(policyList);
 226         assertEquals(1, filteredList.size());
 227
 228         filter = ToscaPolicyFilter.builder().type("onap.policies.controlloop.Operational").typeVersion("0.0.0").build();
 229         filteredList = filter.filter(policyList);
 230         assertEquals(4, filteredList.size());
 231     }
 232 }