applications/guard/src/test/java/org/onap/policy/xacml/pdp/application/guard/GuardPdpApplicationTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.xacml.pdp.application.guard;
  24
  25 import static org.assertj.core.api.Assertions.assertThat;
  26 import static org.assertj.core.api.Assertions.assertThatCode;
  27
  28 import com.att.research.xacml.api.Response;
  29 import java.io.File;
  30 import java.io.FileNotFoundException;
  31 import java.io.IOException;
  32 import java.sql.Date;
  33 import java.time.Instant;
  34 import java.util.Iterator;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Properties;
  38 import java.util.ServiceLoader;
  39 import java.util.UUID;
  40 import javax.persistence.EntityManager;
  41 import javax.persistence.Persistence;
  42 import org.apache.commons.lang3.tuple.Pair;
  43 import org.junit.AfterClass;
  44 import org.junit.Before;
  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.parameters.RestServerParameters;
  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.resources.TextFileUtils;
  55 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  56 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  57 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  58 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
  59 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
  60 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
  61 import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
  62 import org.onap.policy.pdp.xacml.application.common.operationshistory.CountRecentOperationsPip;
  63 import org.onap.policy.pdp.xacml.application.common.operationshistory.Dbao;
  64 import org.onap.policy.pdp.xacml.xacmltest.TestUtils;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
  69 public class GuardPdpApplicationTest {
  70
  71     private static final Logger LOGGER = LoggerFactory.getLogger(GuardPdpApplicationTest.class);
  72     private static Properties properties = new Properties();
  73     private static File propertiesFile;
  74     private static RestServerParameters clientParams = new RestServerParameters();
  75     private static XacmlApplicationServiceProvider service;
  76     private static DecisionRequest requestVfCount;
  77     private static StandardCoder gson = new StandardCoder();
  78     private static EntityManager em;
  79     private static final String DENY = "Deny";
  80     private static final String PERMIT = "Permit";
  81
  82     @ClassRule
  83     public static final TemporaryFolder policyFolder = new TemporaryFolder();
  84
  85     /**
  86      * Copies the xacml.properties and policies files into temporary folder and loads the service provider saving
  87      * instance of provider off for other tests to use.
  88      */
  89     @BeforeClass
  90     public static void setup() throws Exception {
  91         LOGGER.info("Setting up class");
  92         //
  93         // Setup our temporary folder
  94         //
  95         XacmlPolicyUtils.FileCreator myCreator = (String filename) -> policyFolder.newFile(filename);
  96         propertiesFile = XacmlPolicyUtils.copyXacmlPropertiesContents("src/test/resources/xacml.properties", properties,
  97                 myCreator);
  98         //
  99         // Load service
 100         //
 101         ServiceLoader<XacmlApplicationServiceProvider> applicationLoader =
 102                 ServiceLoader.load(XacmlApplicationServiceProvider.class);
 103         //
 104         // Find the guard service application and save for use in all the tests
 105         //
 106         StringBuilder strDump = new StringBuilder("Loaded applications:" + XacmlPolicyUtils.LINE_SEPARATOR);
 107         Iterator<XacmlApplicationServiceProvider> iterator = applicationLoader.iterator();
 108         while (iterator.hasNext()) {
 109             XacmlApplicationServiceProvider application = iterator.next();
 110             //
 111             // Is it our service?
 112             //
 113             if (application instanceof GuardPdpApplication) {
 114                 //
 115                 // Should be the first and only one
 116                 //
 117                 assertThat(service).isNull();
 118                 service = application;
 119             }
 120             strDump.append(application.applicationName());
 121             strDump.append(" supports ");
 122             strDump.append(application.supportedPolicyTypes());
 123             strDump.append(XacmlPolicyUtils.LINE_SEPARATOR);
 124         }
 125         LOGGER.info("{}", strDump);
 126         //
 127         // Tell it to initialize based on the properties file
 128         // we just built for it.
 129         //
 130         service.initialize(propertiesFile.toPath().getParent(), clientParams);
 131         //
 132         // Load Decision Requests
 133         //
 134         requestVfCount =
 135                 gson.decode(TextFileUtils.getTextFileAsString("src/test/resources/requests/guard.vfCount.json"),
 136                         DecisionRequest.class);
 137         //
 138         // Create EntityManager for manipulating DB
 139         //
 140         String persistenceUnit = CountRecentOperationsPip.ISSUER_NAME + ".persistenceunit";
 141         em = Persistence
 142                 .createEntityManagerFactory(GuardPdpApplicationTest.properties.getProperty(persistenceUnit), properties)
 143                 .createEntityManager();
 144     }
 145
 146     /**
 147      * Close the entity manager.
 148      */
 149     @AfterClass
 150     public static void cleanup() throws Exception {
 151         if (em != null) {
 152             em.close();
 153         }
 154     }
 155
 156     /**
 157      * Clears the database before each test so there are no operations in it.
 158      *
 159      */
 160     @Before
 161     public void startClean() throws Exception {
 162         em.getTransaction().begin();
 163         em.createQuery("DELETE FROM Dbao").executeUpdate();
 164         em.getTransaction().commit();
 165     }
 166
 167     /**
 168      * Check that decision matches expectation.
 169      *
 170      * @param expected from the response
 171      * @param response received
 172      *
 173      **/
 174     public void checkDecision(String expected, DecisionResponse response) throws CoderException {
 175         LOGGER.info("Looking for {} Decision", expected);
 176         assertThat(response).isNotNull();
 177         assertThat(response.getStatus()).isNotNull();
 178         assertThat(response.getStatus()).isEqualTo(expected);
 179         //
 180         // Dump it out as Json
 181         //
 182         LOGGER.info(gson.encode(response));
 183     }
 184
 185     /**
 186      * Request a decision and check that it matches expectation.
 187      *
 188      * @param request to send to Xacml PDP
 189      * @param expected from the response
 190      *
 191      **/
 192     public void requestAndCheckDecision(DecisionRequest request, String expected) throws CoderException {
 193         //
 194         // Ask for a decision
 195         //
 196         Pair<DecisionResponse, Response> decision = service.makeDecision(request, null);
 197         //
 198         // Check decision
 199         //
 200         checkDecision(expected, decision.getKey());
 201     }
 202
 203     @Test
 204     public void test1Basics() throws CoderException, IOException {
 205         LOGGER.info("**************** Running test1Basics ****************");
 206         //
 207         // Make sure there's an application name
 208         //
 209         assertThat(service.applicationName()).isNotEmpty();
 210         //
 211         // Decisions
 212         //
 213         assertThat(service.actionDecisionsSupported().size()).isEqualTo(1);
 214         assertThat(service.actionDecisionsSupported()).contains("guard");
 215         //
 216         // Ensure it has the supported policy types and
 217         // can support the correct policy types.
 218         //
 219         assertThat(service.supportedPolicyTypes()).isNotEmpty();
 220         assertThat(service.supportedPolicyTypes().size()).isEqualTo(4);
 221         assertThat(service.canSupportPolicyType(
 222                 new ToscaPolicyTypeIdentifier("onap.policies.controlloop.guard.common.FrequencyLimiter", "1.0.0")))
 223                         .isTrue();
 224         assertThat(service.canSupportPolicyType(
 225                 new ToscaPolicyTypeIdentifier("onap.policies.controlloop.guard.common.FrequencyLimiter", "1.0.1")))
 226                         .isFalse();
 227         assertThat(service.canSupportPolicyType(
 228                 new ToscaPolicyTypeIdentifier("onap.policies.controlloop.guard.common.MinMax", "1.0.0"))).isTrue();
 229         assertThat(service.canSupportPolicyType(
 230                 new ToscaPolicyTypeIdentifier("onap.policies.controlloop.guard.common.MinMax", "1.0.1"))).isFalse();
 231         assertThat(service.canSupportPolicyType(
 232                 new ToscaPolicyTypeIdentifier("onap.policies.controlloop.guard.common.Blacklist", "1.0.0"))).isTrue();
 233         assertThat(service.canSupportPolicyType(
 234                 new ToscaPolicyTypeIdentifier("onap.policies.controlloop.guard.common.Blacklist", "1.0.1"))).isFalse();
 235         assertThat(service.canSupportPolicyType(new ToscaPolicyTypeIdentifier(
 236                 "onap.policies.controlloop.guard.coordination.FirstBlocksSecond", "1.0.0"))).isTrue();
 237         assertThat(service.canSupportPolicyType(new ToscaPolicyTypeIdentifier(
 238                 "onap.policies.controlloop.guard.coordination.FirstBlocksSecond", "1.0.1"))).isFalse();
 239         assertThat(service.canSupportPolicyType(new ToscaPolicyTypeIdentifier("onap.foo", "1.0.1"))).isFalse();
 240     }
 241
 242     @Test
 243     public void test2NoPolicies() throws CoderException {
 244         LOGGER.info("**************** Running test2NoPolicies ****************");
 245         assertThatCode(() -> requestAndCheckDecision(requestVfCount, PERMIT)).doesNotThrowAnyException();
 246     }
 247
 248     @Test
 249     public void test3FrequencyLimiter()
 250             throws CoderException, FileNotFoundException, IOException, XacmlApplicationException {
 251         LOGGER.info("**************** Running test3FrequencyLimiter ****************");
 252         //
 253         // Now load the vDNS frequency limiter Policy - make sure
 254         // the pdp can support it and have it load
 255         // into the PDP.
 256         //
 257         List<ToscaPolicy> loadedPolicies =
 258                 TestUtils.loadPolicies("policies/vDNS.policy.guard.frequencylimiter.input.tosca.yaml", service);
 259         assertThat(loadedPolicies).hasSize(1);
 260         assertThat(loadedPolicies.get(0).getName()).isEqualTo("guard.frequency.scaleout");
 261         //
 262         // Zero recent actions: should get permit
 263         //
 264         requestAndCheckDecision(requestVfCount, PERMIT);
 265         //
 266         // Add entry into operations history DB
 267         //
 268         insertOperationEvent(requestVfCount);
 269         //
 270         // Two recent actions, more than specified limit of 2: should get deny
 271         //
 272         requestAndCheckDecision(requestVfCount, DENY);
 273     }
 274
 275     @SuppressWarnings("unchecked")
 276     @Test
 277     public void test4MinMax() throws CoderException, FileNotFoundException, IOException, XacmlApplicationException {
 278         LOGGER.info("**************** Running test4MinMax ****************");
 279         //
 280         // Now load the vDNS min max Policy - make sure
 281         // the pdp can support it and have it load
 282         // into the PDP.
 283         //
 284         List<ToscaPolicy> loadedPolicies =
 285                 TestUtils.loadPolicies("policies/vDNS.policy.guard.minmaxvnfs.input.tosca.yaml", service);
 286         assertThat(loadedPolicies).hasSize(1);
 287         assertThat(loadedPolicies.get(0).getName()).isEqualTo("guard.minmax.scaleout");
 288         //
 289         // vfcount=0 below min of 1: should get a Permit
 290         //
 291         requestAndCheckDecision(requestVfCount, PERMIT);
 292         //
 293         // vfcount=1 between min of 1 and max of 2: should get a Permit
 294         //
 295         ((Map<String, Object>) requestVfCount.getResource().get("guard")).put("vfCount", 1);
 296         requestAndCheckDecision(requestVfCount, PERMIT);
 297         //
 298         // vfcount=2 hits the max of 2: should get a Deny
 299         //
 300         ((Map<String, Object>) requestVfCount.getResource().get("guard")).put("vfCount", 2);
 301         requestAndCheckDecision(requestVfCount, DENY);
 302         //
 303         // vfcount=3 above max of 2: should get a Deny
 304         //
 305         ((Map<String, Object>) requestVfCount.getResource().get("guard")).put("vfCount", 3);
 306         requestAndCheckDecision(requestVfCount, DENY);
 307         //
 308         // Insert entry into operations history DB - to indicate a successful
 309         // VF Module Create.
 310         //
 311         insertOperationEvent(requestVfCount);
 312         //
 313         // vfcount=1 between min of 1 and max of 2; MinMax should succeed,
 314         // BUT the frequency limiter should fail
 315         //
 316         ((Map<String, Object>) requestVfCount.getResource().get("guard")).put("vfCount", 1);
 317         requestAndCheckDecision(requestVfCount, DENY);
 318     }
 319
 320     @SuppressWarnings("unchecked")
 321     @Test
 322     public void test5Blacklist() throws CoderException, XacmlApplicationException {
 323         LOGGER.info("**************** Running test5Blacklist ****************");
 324         //
 325         // Load the blacklist policy in with the others.
 326         //
 327         List<ToscaPolicy> loadedPolicies =
 328                 TestUtils.loadPolicies("policies/vDNS.policy.guard.blacklist.input.tosca.yaml", service);
 329         assertThat(loadedPolicies).hasSize(1);
 330         assertThat(loadedPolicies.get(0).getName()).isEqualTo("guard.blacklist.scaleout");
 331         //
 332         // vfcount=0 below min of 1: should get a Permit because target is NOT blacklisted
 333         //
 334         requestAndCheckDecision(requestVfCount, PERMIT);
 335         //
 336         // vfcount=1 between min of 1 and max of 2: change the
 337         //
 338         ((Map<String, Object>) requestVfCount.getResource().get("guard")).put("target",
 339                 "the-vfmodule-where-root-is-true");
 340         //
 341         // vfcount=0 below min of 1: should get a Deny because target IS blacklisted
 342         //
 343         requestAndCheckDecision(requestVfCount, DENY);
 344     }
 345
 346     @SuppressWarnings("unchecked")
 347     private void insertOperationEvent(DecisionRequest request) {
 348         //
 349         // Get the properties
 350         //
 351         Map<String, Object> properties = (Map<String, Object>) request.getResource().get("guard");
 352         assertThat(properties).isNotNull();
 353         //
 354         // Add an entry
 355         //
 356         Dbao newEntry = new Dbao();
 357         newEntry.setActor(properties.get("actor").toString());
 358         newEntry.setOperation(properties.get("operation").toString());
 359         newEntry.setClosedLoopName(properties.get("clname").toString());
 360         newEntry.setOutcome("SUCCESS");
 361         newEntry.setStarttime(Date.from(Instant.now().minusMillis(20000)));
 362         newEntry.setEndtime(Date.from(Instant.now()));
 363         newEntry.setRequestId(UUID.randomUUID().toString());
 364         newEntry.setTarget(properties.get("target").toString());
 365         LOGGER.info("Inserting {}", newEntry);
 366         em.getTransaction().begin();
 367         em.persist(newEntry);
 368         em.getTransaction().commit();
 369     }
 370
 371 }