main/src/test/java/org/onap/policy/pdpx/main/rest/XacmlPdpApplicationManagerTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2020-2022 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pdpx.main.rest;
  22
  23 import static org.assertj.core.api.Assertions.assertThat;
  24 import static org.assertj.core.api.Assertions.assertThatCode;
  25 import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
  26
  27 import java.io.File;
  28 import java.io.IOException;
  29 import java.nio.file.Files;
  30 import java.nio.file.Path;
  31 import java.nio.file.Paths;
  32 import java.nio.file.StandardCopyOption;
  33 import java.util.Map;
  34 import org.junit.BeforeClass;
  35 import org.junit.ClassRule;
  36 import org.junit.Test;
  37 import org.junit.rules.TemporaryFolder;
  38 import org.onap.policy.common.utils.coder.CoderException;
  39 import org.onap.policy.common.utils.coder.StandardYamlCoder;
  40 import org.onap.policy.common.utils.resources.ResourceUtils;
  41 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  42 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  43 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  44 import org.onap.policy.models.tosca.simple.concepts.JpaToscaServiceTemplate;
  45 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
  46 import org.onap.policy.pdpx.main.parameters.CommonTestData;
  47 import org.onap.policy.pdpx.main.parameters.XacmlApplicationParameters;
  48 import org.onap.policy.xacml.pdp.application.nativ.NativePdpApplication;
  49 import org.onap.policy.xacml.pdp.application.optimization.OptimizationPdpApplication;
  50 import org.slf4j.Logger;
  51 import org.slf4j.LoggerFactory;
  52
  53 public class XacmlPdpApplicationManagerTest {
  54     private static final Logger LOGGER = LoggerFactory.getLogger(XacmlPdpApplicationManagerTest.class);
  55     private static final StandardYamlCoder yamlCoder = new StandardYamlCoder();
  56     private static Path appsDirectory;
  57     private static ToscaServiceTemplate completedJtst;
  58     private static CommonTestData testData = new CommonTestData();
  59
  60     @ClassRule
  61     public static final TemporaryFolder appsFolder = new TemporaryFolder();
  62
  63     /**
  64      * setupTestEnvironment.
  65      *
  66      * @throws Exception Exception if anything is missing
  67      */
  68     @BeforeClass
  69     public static void setupTestEnvironment() throws Exception {
  70         //
  71         // Load an example policy
  72         //
  73         String policyYaml = ResourceUtils
  74                 .getResourceAsString("../applications/monitoring/src/test/resources/vDNS.policy.input.yaml");
  75         //
  76         // Serialize it into a class
  77         //
  78         ToscaServiceTemplate serviceTemplate;
  79         try {
  80             serviceTemplate = yamlCoder.decode(policyYaml, ToscaServiceTemplate.class);
  81         } catch (CoderException e) {
  82             throw new XacmlApplicationException("Failed to decode policy from resource file", e);
  83         }
  84         //
  85         // Make sure all the fields are setup properly
  86         //
  87         JpaToscaServiceTemplate jtst = new JpaToscaServiceTemplate();
  88         jtst.fromAuthorative(serviceTemplate);
  89         completedJtst = jtst.toAuthorative();
  90         //
  91         // We need at least 1 policies
  92         //
  93         assertThat(completedJtst).isNotNull();
  94         assertThat(completedJtst.getToscaTopologyTemplate().getPolicies()).isNotEmpty();
  95         //
  96         // Copy test directory over of the application directories
  97         //
  98         Path src = Paths.get("src/test/resources/apps");
  99         File apps = appsFolder.newFolder("apps");
 100         Files.walk(src).forEach(source -> {
 101             copy(source, apps.toPath().resolve(src.relativize(source)));
 102         });
 103         appsDirectory = apps.toPath();
 104     }
 105
 106     @Test
 107     public void testXacmlPdpApplicationManagerBadPath() throws Exception {
 108         //
 109         // Make up a non existent directory to initialize from
 110         //
 111         Path nonExistentPath = Paths.get(appsFolder.getRoot().getAbsolutePath(), "nonexistent");
 112         final XacmlApplicationParameters xacmlApplicationParameters =
 113                 testData.toObject(testData.getXacmlapplicationParametersMap(false,
 114                         nonExistentPath.toString()), XacmlApplicationParameters.class);
 115         //
 116         // Create our app manager
 117         //
 118         XacmlPdpApplicationManager manager = new XacmlPdpApplicationManager(xacmlApplicationParameters, null);
 119         //
 120         // Still creates the manager, but the apps were not able to initialize
 121         //
 122         assertThat(manager).isNotNull();
 123         assertThat(manager.findNativeApplication()).isNull();
 124         //
 125         // Now create the directory
 126         //
 127         Files.createDirectory(nonExistentPath);
 128         manager = new XacmlPdpApplicationManager(xacmlApplicationParameters, null);
 129         //
 130         // Now it should have initialized the apps
 131         //
 132         assertThat(manager).isNotNull();
 133         assertThat(manager.findNativeApplication()).isNull();
 134     }
 135
 136     @Test
 137     public void testXacmlPdpApplicationManagerSimple() {
 138         final String[] exclusions = {"org.onap.policy.xacml.pdp.application.guard.GuardPdpApplication",
 139             "org.onap.policy.xacml.pdp.application.match.MatchPdpApplication" };
 140         final XacmlApplicationParameters xacmlApplicationParameters =
 141                 testData.toObject(testData.getXacmlapplicationParametersMap(false,
 142                         appsDirectory.toString(), exclusions), XacmlApplicationParameters.class);
 143         XacmlPdpApplicationManager manager = new XacmlPdpApplicationManager(xacmlApplicationParameters, null);
 144         //
 145         // Test the basics from the startup
 146         //
 147         assertThat(manager).isNotNull();
 148         assertThat(manager.getPolicyCount()).isZero();
 149         assertThat(manager.getPolicyTypeCount()).isEqualTo(18);
 150         assertThat(manager.getToscaPolicies()).isEmpty();
 151         assertThat(manager.getToscaPolicyIdentifiers()).isEmpty();
 152         assertThat(manager.getToscaPolicyTypeIdents()).hasSize(18);
 153
 154         assertThat(manager.findNativeApplication()).isInstanceOf(NativePdpApplication.class);
 155
 156         DecisionRequest request = new DecisionRequest();
 157         request.setAction("optimize");
 158         assertThat(manager.findApplication(request)).isInstanceOf(OptimizationPdpApplication.class);
 159         request.setAction("guard");
 160         assertThat(manager.findApplication(request)).isInstanceOf(TestGuardOverrideApplication.class);
 161         //
 162         // Test Exclusion
 163         //
 164         request.setAction("match");
 165         assertThat(manager.findApplication(request)).isNull();
 166         //
 167         // Try to unload a policy that isn't loaded
 168         //
 169         ToscaPolicy policy = null;
 170         for (Map<String, ToscaPolicy> map : completedJtst.getToscaTopologyTemplate().getPolicies()) {
 171             policy = map.get("onap.scaleout.tca");
 172         }
 173         assertThat(policy).isNotNull();
 174         //
 175         // Without this being set, it throws NonNull Exception
 176         //
 177         policy.setTypeVersion("1.0.0");
 178         //
 179         // Try loading and unloading
 180         //
 181         final ToscaPolicy policyFinal = policy;
 182         assertThatCode(() -> {
 183             manager.removeUndeployedPolicy(policyFinal);
 184             assertThat(manager.getPolicyCount()).isZero();
 185             manager.loadDeployedPolicy(policyFinal);
 186             assertThat(manager.getPolicyCount()).isEqualTo(1);
 187             manager.removeUndeployedPolicy(policyFinal);
 188             assertThat(manager.getPolicyCount()).isZero();
 189         }).doesNotThrowAnyException();
 190         //
 191         // try loading something unsupported
 192         //
 193         assertThatExceptionOfType(XacmlApplicationException.class).isThrownBy(() -> {
 194             ToscaPolicy unsupportedPolicy = new ToscaPolicy();
 195             unsupportedPolicy.setType("I.am.not.supported");
 196             unsupportedPolicy.setTypeVersion("5.5.5");
 197             manager.loadDeployedPolicy(unsupportedPolicy);
 198         });
 199     }
 200
 201     private static void copy(Path source, Path dest) {
 202         try {
 203             Files.copy(source, dest, StandardCopyOption.REPLACE_EXISTING);
 204         } catch (IOException e) {
 205             LOGGER.error("Failed to copy {} to {}", source, dest);
 206         }
 207     }
 208
 209 }