models-tosca/src/test/java/org/onap/policy/models/tosca/authorative/concepts/ToscaPolicyTypeFilterTest.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 ToscaPolicyTypeFilter} class.
  48  *
  49  * @author Liam Fallon (liam.fallon@est.tech)
  50  */
  51 public class ToscaPolicyTypeFilterTest {
  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(ToscaPolicyTypeFilterTest.class);
  58
  59     // @formatter:off
  60     private static final String[] policyTypeResourceNames = {
  61         "policytypes/onap.policies.monitoring.dcaegen2.collectors.datafile.datafile-app-server.yaml",
  62         "policytypes/onap.policies.optimization.AffinityPolicy.yaml",
  63         "policytypes/onap.policies.optimization.DistancePolicy.yaml",
  64         "policytypes/onap.policies.optimization.HpaPolicy.yaml",
  65         "policytypes/onap.policies.optimization.OptimizationPolicy.yaml",
  66         "policytypes/onap.policies.optimization.PciPolicy.yaml",
  67         "policytypes/onap.policies.optimization.QueryPolicy.yaml",
  68         "policytypes/onap.policies.optimization.SubscriberPolicy.yaml",
  69         "policytypes/onap.policies.optimization.Vim_fit.yaml",
  70         "policytypes/onap.policies.optimization.VnfPolicy.yaml",
  71         "policytypes/onap.policies.monitoring.cdap.tca.hi.lo.app.yaml"
  72     };
  73     // @formatter:on
  74
  75     private static List<ToscaPolicyType> typeList = new ArrayList<>();
  76
  77     /**
  78      * Set up a Tosca Policy type list for filtering.
  79      *
  80      * @throws CoderException on JSON decoding errors
  81      */
  82     @BeforeClass
  83     public static void setupTypeList() throws CoderException {
  84         for (String policyTypeResourceName : policyTypeResourceNames) {
  85             String policyTypeString = ResourceUtils.getResourceAsString(policyTypeResourceName);
  86             Object yamlObject = new Yaml().load(policyTypeString);
  87             String yamlAsJsonString = new GsonBuilder().setPrettyPrinting().create().toJson(yamlObject);
  88
  89             ToscaServiceTemplate serviceTemplate =
  90                     new StandardCoder().decode(yamlAsJsonString, ToscaServiceTemplate.class);
  91             assertNotNull(serviceTemplate);
  92
  93             for (Map<String, ToscaPolicyType> foundPolicyTypeMap : serviceTemplate.getPolicyTypes()) {
  94                 addPolicyTypes(foundPolicyTypeMap);
  95             }
  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         ToscaPolicyTypeFilter filter = ToscaPolicyTypeFilter.builder().build();
 121
 122         assertThatThrownBy(() -> {
 123             filter.filter(null);
 124         }).hasMessage("originalList is marked @NonNull but is null");
 125     }
 126
 127     @Test
 128     public void testFilterNothing() {
 129         ToscaPolicyTypeFilter filter = ToscaPolicyTypeFilter.builder().build();
 130
 131         List<ToscaPolicyType> filteredList = filter.filter(typeList);
 132         assertTrue(filteredList.containsAll(typeList));
 133     }
 134
 135     @Test
 136     public void testFilterLatestVersion() {
 137         ToscaPolicyTypeFilter filter =
 138                 ToscaPolicyTypeFilter.builder().version(ToscaPolicyTypeFilter.LATEST_VERSION).build();
 139
 140         List<ToscaPolicyType> filteredList = filter.filter(typeList);
 141         assertEquals(13, filteredList.size());
 142         assertEquals(VERSION_100, filteredList.get(0).getVersion());
 143         assertEquals(VERSION_000, filteredList.get(4).getVersion());
 144
 145         typeList.get(12).setVersion("2.0.0");
 146         filteredList = filter.filter(typeList);
 147         assertEquals(13, filteredList.size());
 148         assertEquals("2.0.0", filteredList.get(0).getVersion());
 149         assertEquals(VERSION_000, filteredList.get(4).getVersion());
 150
 151         typeList.get(12).setVersion(VERSION_100);
 152         filteredList = filter.filter(typeList);
 153         assertEquals(13, filteredList.size());
 154         assertEquals(VERSION_100, filteredList.get(0).getVersion());
 155         assertEquals(VERSION_000, filteredList.get(4).getVersion());
 156     }
 157
 158     @Test
 159     public void testFilterNameVersion() {
 160         ToscaPolicyTypeFilter filter = ToscaPolicyTypeFilter.builder().name("onap.policies.Monitoring").build();
 161         List<ToscaPolicyType> filteredList = filter.filter(typeList);
 162         assertEquals(2, filteredList.size());
 163
 164         filter = ToscaPolicyTypeFilter.builder().name("onap.policies.monitoring.cdap.tca.hi.lo.app").build();
 165         filteredList = filter.filter(typeList);
 166         assertEquals(1, filteredList.size());
 167
 168         filter = ToscaPolicyTypeFilter.builder().name("onap.policies.optimization.LpaPolicy").build();
 169         filteredList = filter.filter(typeList);
 170         assertEquals(0, filteredList.size());
 171
 172         filter = ToscaPolicyTypeFilter.builder().version(VERSION_000).build();
 173         filteredList = filter.filter(typeList);
 174         assertEquals(9, filteredList.size());
 175
 176         filter = ToscaPolicyTypeFilter.builder().name("onap.policies.optimization.Vim_fit").version(VERSION_000)
 177                         .build();
 178         filteredList = filter.filter(typeList);
 179         assertEquals(1, filteredList.size());
 180
 181         filter = ToscaPolicyTypeFilter.builder().name("onap.policies.optimization.Vim_fit").version("0.0.1").build();
 182         filteredList = filter.filter(typeList);
 183         assertEquals(0, filteredList.size());
 184     }
 185 }