applications/optimization/src/test/java/org/onap/policy/xacml/pdp/application/optimization/OptimizationPdpApplicationTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2019-2021 Nordix Foundation.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.xacml.pdp.application.optimization;
  25
  26 import static org.assertj.core.api.Assertions.assertThat;
  27 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
  28 import static org.mockito.Mockito.mock;
  29 import static org.mockito.Mockito.when;
  30
  31 import com.att.research.xacml.api.Response;
  32 import com.google.common.collect.Lists;
  33 import java.io.File;
  34 import java.nio.file.Files;
  35 import java.nio.file.Paths;
  36 import java.util.Collection;
  37 import java.util.Iterator;
  38 import java.util.List;
  39 import java.util.Map;
  40 import java.util.Map.Entry;
  41 import java.util.Properties;
  42 import java.util.ServiceLoader;
  43 import org.apache.commons.lang3.tuple.Pair;
  44 import org.assertj.core.api.Condition;
  45 import org.junit.BeforeClass;
  46 import org.junit.ClassRule;
  47 import org.junit.FixMethodOrder;
  48 import org.junit.Test;
  49 import org.junit.rules.TemporaryFolder;
  50 import org.junit.runners.MethodSorters;
  51 import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
  52 import org.onap.policy.common.utils.coder.CoderException;
  53 import org.onap.policy.common.utils.coder.StandardCoder;
  54 import org.onap.policy.common.utils.coder.StandardYamlCoder;
  55 import org.onap.policy.common.utils.resources.ResourceUtils;
  56 import org.onap.policy.common.utils.resources.TextFileUtils;
  57 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  58 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  59 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifier;
  60 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  61 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  62 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  63 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
  64 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
  65 import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
  66 import org.onap.policy.pdp.xacml.xacmltest.TestUtils;
  67 import org.slf4j.Logger;
  68 import org.slf4j.LoggerFactory;
  69
  70 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
  71 public class OptimizationPdpApplicationTest {
  72
  73     private static final Logger LOGGER = LoggerFactory.getLogger(OptimizationPdpApplicationTest.class);
  74     private static Properties properties = new Properties();
  75     private static File propertiesFile;
  76     private static XacmlApplicationServiceProvider service;
  77     private static StandardCoder gson = new StandardCoder();
  78     private static DecisionRequest baseRequest;
  79     private static BusTopicParams clientParams;
  80     private static String[] listPolicyTypeFiles = {
  81         "onap.policies.Optimization",
  82         "onap.policies.optimization.Resource",
  83         "onap.policies.optimization.Service",
  84         "onap.policies.optimization.resource.AffinityPolicy",
  85         "onap.policies.optimization.resource.DistancePolicy",
  86         "onap.policies.optimization.resource.HpaPolicy",
  87         "onap.policies.optimization.resource.OptimizationPolicy",
  88         "onap.policies.optimization.resource.PciPolicy",
  89         "onap.policies.optimization.service.QueryPolicy",
  90         "onap.policies.optimization.service.SubscriberPolicy",
  91         "onap.policies.optimization.resource.Vim_fit",
  92         "onap.policies.optimization.resource.VnfPolicy"};
  93
  94     @ClassRule
  95     public static final TemporaryFolder policyFolder = new TemporaryFolder();
  96
  97     /**
  98      * Copies the xacml.properties and policies files into
  99      * temporary folder and loads the service provider saving
 100      * instance of provider off for other tests to use.
 101      */
 102     @BeforeClass
 103     public static void setUp() throws Exception {
 104         clientParams = mock(BusTopicParams.class);
 105         when(clientParams.getHostname()).thenReturn("localhost");
 106         when(clientParams.getPort()).thenReturn(6969);
 107         //
 108         // Load Single Decision Request
 109         //
 110         baseRequest = gson.decode(
 111                 TextFileUtils
 112                     .getTextFileAsString(
 113                             "src/test/resources/decision.optimization.input.json"),
 114                     DecisionRequest.class);
 115         //
 116         // Setup our temporary folder
 117         //
 118         XacmlPolicyUtils.FileCreator myCreator = (String filename) -> policyFolder.newFile(filename);
 119         propertiesFile = XacmlPolicyUtils.copyXacmlPropertiesContents("src/test/resources/xacml.properties",
 120                 properties, myCreator);
 121         //
 122         // Copy the test policy types into data area
 123         //
 124         for (String policy : listPolicyTypeFiles) {
 125             String policyType = ResourceUtils.getResourceAsString("policytypes/" + policy + ".yaml");
 126             LOGGER.info("Copying {}", policyType);
 127             Files.write(Paths.get(policyFolder.getRoot().getAbsolutePath(), policy + "-1.0.0.yaml"),
 128                     policyType.getBytes());
 129         }
 130         //
 131         // Load service
 132         //
 133         ServiceLoader<XacmlApplicationServiceProvider> applicationLoader =
 134                 ServiceLoader.load(XacmlApplicationServiceProvider.class);
 135         //
 136         // Iterate through Xacml application services and find
 137         // the optimization service. Save it for use throughout
 138         // all the Junit tests.
 139         //
 140         StringBuilder strDump = new StringBuilder("Loaded applications:" + XacmlPolicyUtils.LINE_SEPARATOR);
 141         Iterator<XacmlApplicationServiceProvider> iterator = applicationLoader.iterator();
 142         while (iterator.hasNext()) {
 143             XacmlApplicationServiceProvider application = iterator.next();
 144             //
 145             // Is it our service?
 146             //
 147             if (application instanceof OptimizationPdpApplication) {
 148                 //
 149                 // Should be the first and only one
 150                 //
 151                 assertThat(service).isNull();
 152                 service = application;
 153             }
 154             strDump.append(application.applicationName());
 155             strDump.append(" supports ");
 156             strDump.append(application.supportedPolicyTypes());
 157             strDump.append(XacmlPolicyUtils.LINE_SEPARATOR);
 158         }
 159         LOGGER.debug("{}", strDump);
 160         assertThat(service).isNotNull();
 161         //
 162         // Tell it to initialize based on the properties file
 163         // we just built for it.
 164         //
 165         service.initialize(propertiesFile.toPath().getParent(), clientParams);
 166     }
 167
 168     /**
 169      * Simply test some of the simple methods for the application.
 170      */
 171     @Test
 172     public void test01Basics() {
 173         //
 174         // Make sure there's an application name
 175         //
 176         assertThat(service.applicationName()).isNotEmpty();
 177         //
 178         // Does it return the correct decisions
 179         //
 180         assertThat(service.actionDecisionsSupported().size()).isEqualTo(1);
 181         assertThat(service.actionDecisionsSupported()).contains("optimize");
 182         //
 183         // Ensure it has the supported policy types and
 184         // can support the correct policy types.
 185         //
 186         assertThat(service.canSupportPolicyType(new ToscaConceptIdentifier(
 187                 "onap.policies.optimization.resource.AffinityPolicy", "1.0.0"))).isTrue();
 188         assertThat(service.canSupportPolicyType(new ToscaConceptIdentifier(
 189                 "onap.policies.optimization.service.SubscriberPolicy", "1.0.0"))).isTrue();
 190         assertThat(service.canSupportPolicyType(new ToscaConceptIdentifier(
 191                 "onap.policies.optimization.service.CustomUseCase", "1.0.0"))).isTrue();
 192         assertThat(service.canSupportPolicyType(new ToscaConceptIdentifier(
 193                 "onap.foobar", "1.0.0"))).isFalse();
 194     }
 195
 196     /**
 197      * With no policies loaded, there should be 0 policies returned.
 198      *
 199      * @throws CoderException CoderException
 200      */
 201     @Test
 202     public void test02NoPolicies() throws CoderException {
 203         //
 204         // Ask for a decision when there are no policies loaded
 205         //
 206         LOGGER.info("Request {}", gson.encode(baseRequest));
 207         Pair<DecisionResponse, Response> decision = service.makeDecision(baseRequest, null);
 208         LOGGER.info("Decision {}", decision.getKey());
 209
 210         assertThat(decision.getKey()).isNotNull();
 211         assertThat(decision.getKey().getPolicies()).isEmpty();
 212     }
 213
 214     /**
 215      * Should return ONLY default policies.
 216      *
 217      * @throws XacmlApplicationException could not load policies
 218      */
 219     @Test
 220     public void test03OptimizationDefault() throws XacmlApplicationException {
 221         //
 222         // Now load all the optimization policies
 223         //
 224         List<ToscaPolicy> loadedPolicies = TestUtils.loadPolicies("src/test/resources/test-optimization-policies.yaml",
 225                 service);
 226         assertThat(loadedPolicies).isNotNull().hasSize(14);
 227
 228         validateDecisionCount(2);
 229     }
 230
 231     /**
 232      * Should only return default HPA policy type.
 233      */
 234     @SuppressWarnings("unchecked")
 235     @Test
 236     public void test04OptimizationDefaultHpa() {
 237         //
 238         // Add in policy type
 239         //
 240         List<String> policyTypes = Lists.newArrayList("onap.policies.optimization.resource.HpaPolicy");
 241         baseRequest.getResource().put("policy-type", policyTypes);
 242         //
 243         // Ask for a decision for default HPA policy
 244         //
 245         DecisionResponse response = makeDecision();
 246
 247         assertThat(response).isNotNull();
 248         assertThat(response.getPolicies()).hasSize(1);
 249         response.getPolicies().forEach((key, value) -> {
 250             assertThat(((Map<String, Object>) value)).containsEntry("type",
 251                             "onap.policies.optimization.resource.HpaPolicy");
 252         });
 253         //
 254         // Validate it
 255         //
 256         validateDecision(response, baseRequest);
 257     }
 258
 259     /**
 260      * Refine for US only policies.
 261      */
 262     @SuppressWarnings("unchecked")
 263     @Test
 264     public void test05OptimizationDefaultGeography() throws CoderException {
 265         //
 266         // Remove all the policy-type resources from the request
 267         //
 268         cleanOutResources();
 269         //
 270         // Add US to the geography list
 271         //
 272         ((List<String>) baseRequest.getResource().get("geography")).add("US");
 273
 274         validateDecisionCount(2);
 275     }
 276
 277     /**
 278      * Add more refinement for service.
 279      */
 280     @SuppressWarnings("unchecked")
 281     @Test
 282     public void test06OptimizationDefaultGeographyAndService() {
 283         //
 284         // Add vCPE to the service list
 285         //
 286         ((List<String>) baseRequest.getResource().get("services")).add("vCPE");
 287
 288         validateDecisionCount(3);
 289     }
 290
 291     /**
 292      * Add more refinement for specific resource.
 293      */
 294     @SuppressWarnings("unchecked")
 295     @Test
 296     public void test07OptimizationDefaultGeographyAndServiceAndResource() {
 297         //
 298         // Add vG to the resource list
 299         //
 300         ((List<String>) baseRequest.getResource().get("resources")).add("vG");
 301
 302         validateDecisionCount(6);
 303     }
 304
 305     /**
 306      * Now we need to add in subscriberName in order to get scope for gold.
 307      */
 308     @SuppressWarnings("unchecked")
 309     @Test
 310     public void test08OptimizationGeographyAndServiceAndResourceAndScopeIsGoldSubscriber() {
 311         //
 312         // Add gold as a scope
 313         //
 314         ((List<String>) baseRequest.getContext().get("subscriberName")).add("subscriber_a");
 315
 316         validateDecisionCount(6, 2);
 317     }
 318
 319     /**
 320      * Add a subscriber that should be platinum.
 321      */
 322     @SuppressWarnings("unchecked")
 323     @Test
 324     public void test09OptimizationGeographyAndServiceAndResourceAndScopeGoldOrPlatinumSubscriber() {
 325         //
 326         // Add platinum to the scope list: this is now gold OR platinum
 327         //
 328         ((List<String>) baseRequest.getResource().get("scope")).remove("gold");
 329         ((List<String>) baseRequest.getContext().get("subscriberName")).add("subscriber_x");
 330
 331         validateDecisionCount(8, 2);
 332     }
 333
 334     /**
 335      * Remove gold subscriber, keep the platinum one.
 336      */
 337     @SuppressWarnings("unchecked")
 338     @Test
 339     public void test10OptimizationGeographyAndServiceAndResourceAndScopeNotGoldStillPlatinum() {
 340         //
 341         // Add gold as a scope
 342         //
 343         ((List<String>) baseRequest.getResource().get("scope")).remove("gold");
 344         ((List<String>) baseRequest.getResource().get("scope")).remove("platinum");
 345         ((List<String>) baseRequest.getContext().get("subscriberName")).remove("subscriber_a");
 346
 347         validateDecisionCount(7);
 348     }
 349
 350     /**
 351      * Filter by Affinity policy.
 352      */
 353     @Test
 354     public void test11OptimizationPolicyTypeDefault() {
 355         //
 356         // Add in policy type
 357         //
 358         List<String> policyTypes = Lists.newArrayList("onap.policies.optimization.resource.AffinityPolicy");
 359         baseRequest.getResource().put("policy-type", policyTypes);
 360
 361         validateDecisionCount(1);
 362     }
 363
 364     /**
 365      * Now filter by HPA policy type.
 366      */
 367     @SuppressWarnings("unchecked")
 368     @Test
 369     public void test12OptimizationPolicyTypeDefault() {
 370         //
 371         // Add in another policy type
 372         //
 373         ((List<String>) baseRequest.getResource().get("policy-type"))
 374             .add("onap.policies.optimization.resource.HpaPolicy");
 375
 376         validateDecisionCount(2);
 377     }
 378
 379     @Test
 380     public void test999BadSubscriberPolicies() throws Exception {
 381         final StandardYamlCoder yamlCoder = new StandardYamlCoder();
 382         //
 383         // Decode it
 384         //
 385         String policyYaml = ResourceUtils.getResourceAsString("src/test/resources/bad-subscriber-policies.yaml");
 386         //
 387         // Serialize it into a class
 388         //
 389         JpaToscaServiceTemplate jtst = new JpaToscaServiceTemplate();
 390         ToscaServiceTemplate serviceTemplate = yamlCoder.decode(policyYaml, ToscaServiceTemplate.class);
 391         jtst.fromAuthorative(serviceTemplate);
 392         //
 393         // Make sure all the fields are setup properly
 394         //
 395         ToscaServiceTemplate completedJtst = jtst.toAuthorative();
 396         //
 397         // Get the policies
 398         //
 399         for (Map<String, ToscaPolicy> policies : completedJtst.getToscaTopologyTemplate().getPolicies()) {
 400             for (ToscaPolicy policy : policies.values()) {
 401                 if ("missing-subscriberProperties".equals(policy.getName())) {
 402                     assertThatExceptionOfType(XacmlApplicationException.class).isThrownBy(() ->
 403                         service.loadPolicy(policy));
 404                 } else if ("missing-subscriberName".equals(policy.getName())) {
 405                     assertThatExceptionOfType(XacmlApplicationException.class).isThrownBy(() ->
 406                         service.loadPolicy(policy));
 407                 } else if ("missing-subscriberRole".equals(policy.getName())) {
 408                     assertThatExceptionOfType(XacmlApplicationException.class).isThrownBy(() ->
 409                         service.loadPolicy(policy));
 410                 }
 411             }
 412         }
 413     }
 414
 415     private DecisionResponse makeDecision() {
 416         Pair<DecisionResponse, Response> decision = service.makeDecision(baseRequest, null);
 417         LOGGER.info("Request Resources {}", baseRequest.getResource());
 418         LOGGER.info("Decision {}", decision.getKey());
 419         for (Entry<String, Object> entrySet : decision.getKey().getPolicies().entrySet()) {
 420             LOGGER.info("Policy {}", entrySet.getKey());
 421         }
 422         return decision.getKey();
 423     }
 424
 425     private DecisionResponse validateDecisionCount(int expectedPolicyCount) {
 426         //
 427         // Ask for a decision for default
 428         //
 429         DecisionResponse response = makeDecision();
 430
 431         assertThat(response).isNotNull();
 432         assertThat(response.getPolicies()).hasSize(expectedPolicyCount);
 433         //
 434         // Validate it
 435         //
 436         validateDecision(response, baseRequest);
 437
 438         return response;
 439     }
 440
 441     private void validateDecisionCount(int expectedPolicyCount, int expectedAdviceCount) {
 442         DecisionResponse response = validateDecisionCount(expectedPolicyCount);
 443
 444         assertThat(response.getAdvice()).hasSize(expectedAdviceCount);
 445     }
 446
 447     @SuppressWarnings("unchecked")
 448     private void validateDecision(DecisionResponse decision, DecisionRequest request) {
 449         for (Entry<String, Object> entrySet : decision.getPolicies().entrySet()) {
 450             LOGGER.info("Decision Returned Policy {}", entrySet.getKey());
 451             assertThat(entrySet.getValue()).isInstanceOf(Map.class);
 452             Map<String, Object> policyContents = (Map<String, Object>) entrySet.getValue();
 453             assertThat(policyContents).containsKey("properties");
 454             assertThat(policyContents.get("properties")).isInstanceOf(Map.class);
 455             Map<String, Object> policyProperties = (Map<String, Object>) policyContents.get("properties");
 456
 457             validateMatchable((Collection<String>) request.getResource().get("scope"),
 458                     (Collection<String>) policyProperties.get("scope"));
 459
 460             validateMatchable((Collection<String>) request.getResource().get("services"),
 461                     (Collection<String>) policyProperties.get("services"));
 462
 463             validateMatchable((Collection<String>) request.getResource().get("resources"),
 464                     (Collection<String>) policyProperties.get("resources"));
 465
 466             validateMatchable((Collection<String>) request.getResource().get("geography"),
 467                     (Collection<String>) policyProperties.get("geography"));
 468         }
 469     }
 470
 471     private void validateMatchable(Collection<String> requestList, Collection<String> policyProperties) {
 472         LOGGER.info("Validating matchable: {} with {}", policyProperties, requestList);
 473         //
 474         // Null or empty implies '*' - that is any value is acceptable
 475         // for this policy.
 476         //
 477         if (policyProperties == null || policyProperties.isEmpty()) {
 478             return;
 479         }
 480         Condition<String> condition = new Condition<>(
 481                 requestList::contains,
 482                 "Request list is contained");
 483         assertThat(policyProperties).haveAtLeast(1, condition);
 484
 485     }
 486
 487     @SuppressWarnings("unchecked")
 488     private void cleanOutResources() {
 489         ((List<String>) baseRequest.getResource().get("scope")).clear();
 490         ((List<String>) baseRequest.getResource().get("services")).clear();
 491         ((List<String>) baseRequest.getResource().get("resources")).clear();
 492         ((List<String>) baseRequest.getResource().get("geography")).clear();
 493         if (((List<String>) baseRequest.getResource().get("policy-type")) != null) {
 494             baseRequest.getResource().remove("policy-type");
 495         }
 496     }
 497 }