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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2021 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 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Map.Entry;
  34 import org.junit.BeforeClass;
  35 import org.junit.Test;
  36 import org.onap.policy.common.utils.coder.CoderException;
  37 import org.onap.policy.common.utils.coder.StandardCoder;
  38 import org.onap.policy.common.utils.resources.ResourceUtils;
  39 import org.onap.policy.models.base.PfKey;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42 import org.yaml.snakeyaml.Yaml;
  43
  44 /**
  45  * Test of the {@link ToscaEntityFilter} class.
  46  *
  47  * @author Liam Fallon (liam.fallon@est.tech)
  48  */
  49 public class ToscaEntityFilterTest {
  50     // Logger for this class
  51     private static final Logger LOGGER = LoggerFactory.getLogger(ToscaEntityFilterTest.class);
  52
  53     private static final String VERSION_100 = "1.0.0";
  54     private static final String VERSION_000 = "0.0.0";
  55
  56     // @formatter:off
  57     private static final String[] policyTypeResourceNames = {
  58         "policytypes/onap.policies.optimization.resource.DistancePolicy.yaml",
  59         "policytypes/onap.policies.optimization.resource.VnfPolicy.yaml",
  60         "policytypes/onap.policies.optimization.resource.PciPolicy.yaml",
  61         "policytypes/onap.policies.optimization.resource.OptimizationPolicy.yaml",
  62         "policytypes/onap.policies.controlloop.guard.common.Blacklist.yaml",
  63         "policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.yaml",
  64         "policytypes/onap.policies.optimization.resource.HpaPolicy.yaml",
  65         "policytypes/onap.policies.optimization.resource.Vim_fit.yaml",
  66         "policytypes/onap.policies.optimization.service.SubscriberPolicy.yaml",
  67         "policytypes/onap.policies.optimization.resource.AffinityPolicy.yaml",
  68         "policytypes/onap.policies.optimization.service.QueryPolicy.yaml",
  69         "policytypes/onap.policies.controlloop.guard.common.MinMax.yaml",
  70         "policytypes/onap.policies.controlloop.guard.common.FrequencyLimiter.yaml",
  71         "policytypes/onap.policies.controlloop.guard.coordination.FirstBlocksSecond.yaml",
  72         "policytypes/onap.policies.Optimization.yaml",
  73         "policytypes/onap.policies.monitoring.tcagen2.yaml"
  74     };
  75     // @formatter:on
  76
  77     private static List<ToscaPolicyType> typeList = new ArrayList<>();
  78
  79     /**
  80      * Set up a Tosca Policy type list for filtering.
  81      *
  82      * @throws CoderException on JSON decoding errors
  83      */
  84     @BeforeClass
  85     public static void setupTypeList() throws CoderException {
  86         for (String policyTypeResourceName : policyTypeResourceNames) {
  87             String policyTypeString = ResourceUtils.getResourceAsString(policyTypeResourceName);
  88             Object yamlObject = new Yaml().load(policyTypeString);
  89             String yamlAsJsonString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
  90
  91             ToscaServiceTemplate serviceTemplate =
  92                     new StandardCoder().decode(yamlAsJsonString, ToscaServiceTemplate.class);
  93             assertNotNull(serviceTemplate);
  94
  95             addPolicyTypes(serviceTemplate.getPolicyTypes());
  96         }
  97
  98         for (ToscaPolicyType type : typeList) {
  99             LOGGER.info("using policy type-" + type.getName() + ":" + type.getVersion());
 100         }
 101     }
 102
 103     private static void addPolicyTypes(Map<String, ToscaPolicyType> foundPolicyTypeMap) {
 104         for (Entry<String, ToscaPolicyType> policyTypeEntry : foundPolicyTypeMap.entrySet()) {
 105             ToscaPolicyType policyType = policyTypeEntry.getValue();
 106             if (policyType.getName() == null) {
 107                 policyType.setName(policyTypeEntry.getKey());
 108             }
 109             if (policyType.getVersion() == null) {
 110                 policyType.setVersion(PfKey.NULL_KEY_VERSION);
 111             }
 112             if (!typeList.contains(policyType)) {
 113                 typeList.add(policyType);
 114             }
 115         }
 116     }
 117
 118     @Test
 119     public void testNullList() {
 120         ToscaEntityFilter<ToscaPolicyType> filter = ToscaEntityFilter.<ToscaPolicyType>builder().build();
 121
 122         assertThatThrownBy(() -> {
 123             filter.filter(null);
 124         }).hasMessageMatching("originalList is marked .*on.*ull but is null");
 125     }
 126
 127     @Test
 128     public void testFilterNothing() {
 129         ToscaEntityFilter<ToscaPolicyType> filter = ToscaEntityFilter.<ToscaPolicyType>builder().build();
 130
 131         List<ToscaPolicyType> filteredList = filter.filter(typeList);
 132         assertTrue(filteredList.containsAll(typeList));
 133     }
 134
 135     @Test
 136     public void testFilterLatestVersion() {
 137         ToscaEntityFilter<ToscaPolicyType> filter =
 138                 ToscaEntityFilter.<ToscaPolicyType>builder().version(ToscaEntityFilter.LATEST_VERSION).build();
 139
 140         List<ToscaPolicyType> filteredList = filter.filter(typeList);
 141         assertEquals(19, filteredList.size());
 142         assertEquals(VERSION_100, filteredList.get(0).getVersion());
 143         assertEquals(VERSION_100, filteredList.get(11).getVersion());
 144
 145         typeList.get(12).setVersion("2.0.0");
 146         filteredList = filter.filter(typeList);
 147         assertEquals(19, filteredList.size());
 148         //
 149         // This seems to change around as to where this policy type
 150         // got changed - perhaps we change this test to find a specific name
 151         // to test for vs an index which never remains consistent?
 152         //
 153         // assertEquals("2.0.0", filteredList.get(18).getVersion());
 154         //
 155         // And now this index changes again??
 156         //
 157         // assertEquals(VERSION_100, filteredList.get(17).getVersion());
 158
 159         typeList.get(12).setVersion(VERSION_100);
 160         filteredList = filter.filter(typeList);
 161         assertEquals(19, filteredList.size());
 162         assertEquals(VERSION_100, filteredList.get(0).getVersion());
 163         assertEquals(VERSION_100, filteredList.get(18).getVersion());
 164     }
 165
 166     @Test
 167     public void testFilterNameVersion() {
 168         ToscaEntityFilter<ToscaPolicyType> filter =
 169                 ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.Monitoring").build();
 170         List<ToscaPolicyType> filteredList = filter.filter(typeList);
 171         assertEquals(1, filteredList.size());
 172
 173         filter = ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.monitoring.tcagen2").build();
 174         filteredList = filter.filter(typeList);
 175         assertEquals(1, filteredList.size());
 176
 177         filter = ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.optimization.LpaPolicy").build();
 178         filteredList = filter.filter(typeList);
 179         assertEquals(0, filteredList.size());
 180
 181         filter = ToscaEntityFilter.<ToscaPolicyType>builder().version(VERSION_100).build();
 182         filteredList = filter.filter(typeList);
 183         assertEquals(19, filteredList.size());
 184
 185         filter = ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.optimization.Vim_fit")
 186                 .version(VERSION_000).build();
 187         filteredList = filter.filter(typeList);
 188         assertEquals(0, filteredList.size());
 189
 190         filter = ToscaEntityFilter.<ToscaPolicyType>builder().name("onap.policies.optimization.Vim_fit")
 191                 .version("0.0.1").build();
 192         filteredList = filter.filter(typeList);
 193         assertEquals(0, filteredList.size());
 194     }
 195 }