applications/common/src/test/java/org/onap/policy/pdp/xacml/application/common/std/StdXacmlApplicationServiceProviderTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2019 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.pdp.xacml.application.common.std;
  22
  23 import static org.assertj.core.api.Assertions.assertThatThrownBy;
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertFalse;
  26 import static org.junit.Assert.assertNotNull;
  27 import static org.junit.Assert.assertNull;
  28 import static org.junit.Assert.assertSame;
  29 import static org.junit.Assert.assertTrue;
  30 import static org.mockito.Matchers.any;
  31 import static org.mockito.Mockito.mock;
  32 import static org.mockito.Mockito.times;
  33 import static org.mockito.Mockito.verify;
  34 import static org.mockito.Mockito.when;
  35
  36 import com.att.research.xacml.api.Request;
  37 import com.att.research.xacml.api.Response;
  38 import com.att.research.xacml.api.pdp.PDPEngine;
  39 import com.att.research.xacml.api.pdp.PDPEngineFactory;
  40 import com.att.research.xacml.api.pdp.PDPException;
  41 import com.att.research.xacml.util.FactoryException;
  42 import com.att.research.xacml.util.XACMLProperties;
  43 import com.google.common.io.Files;
  44 import java.io.File;
  45 import java.nio.file.Path;
  46 import java.util.HashSet;
  47 import java.util.Properties;
  48 import java.util.Set;
  49 import oasis.names.tc.xacml._3_0.core.schema.wd_17.PolicyType;
  50 import org.apache.commons.lang3.tuple.Pair;
  51 import org.junit.AfterClass;
  52 import org.junit.Before;
  53 import org.junit.BeforeClass;
  54 import org.junit.Test;
  55 import org.mockito.Mock;
  56 import org.mockito.MockitoAnnotations;
  57 import org.onap.policy.common.endpoints.parameters.RestServerParameters;
  58 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  59 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  60 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  61 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyConversionException;
  62 import org.onap.policy.pdp.xacml.application.common.ToscaPolicyTranslator;
  63 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
  64 import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
  65 import org.slf4j.Logger;
  66 import org.slf4j.LoggerFactory;
  67
  68 public class StdXacmlApplicationServiceProviderTest {
  69     private static final Logger logger = LoggerFactory.getLogger(StdXacmlApplicationServiceProviderTest.class);
  70
  71     private static final String TEMP_DIR_NAME = "src/test/resources/temp";
  72     private static File TEMP_DIR = new File(TEMP_DIR_NAME);
  73     private static Path TEMP_PATH = TEMP_DIR.toPath();
  74     private static File SOURCE_PROP_FILE = new File("src/test/resources/test.properties");
  75     private static File PROP_FILE = new File(TEMP_DIR, XacmlPolicyUtils.XACML_PROPERTY_FILE);
  76     private static final String EXPECTED_EXCEPTION = "expected exception";
  77     private static final String POLICY_NAME = "my-name";
  78     private static final String POLICY_VERSION = "1.2.3";
  79     private static final String POLICY_TYPE = "my-type";
  80     private static final RestServerParameters apiRestParameters = new RestServerParameters();
  81
  82     @Mock
  83     private ToscaPolicyTranslator trans;
  84
  85     @Mock
  86     private PDPEngineFactory engineFactory;
  87
  88     @Mock
  89     private PDPEngine engine;
  90
  91     @Mock
  92     private Request req;
  93
  94     @Mock
  95     private Response resp;
  96
  97     private ToscaPolicy policy;
  98     private PolicyType internalPolicy;
  99
 100     private StdXacmlApplicationServiceProvider prov;
 101
 102     /**
 103      * Creates the temp directory.
 104      */
 105     @BeforeClass
 106     public static void setUpBeforeClass() {
 107         assertTrue(TEMP_DIR.mkdir());
 108     }
 109
 110     /**
 111      * Deletes the temp directory and its contents.
 112      */
 113     @AfterClass
 114     public static void tearDownAfterClass() {
 115         for (File file : TEMP_DIR.listFiles()) {
 116             if (!file.delete()) {
 117                 logger.warn("cannot delete: {}", file);
 118             }
 119         }
 120
 121         if (!TEMP_DIR.delete()) {
 122             logger.warn("cannot delete: {}", TEMP_DIR);
 123         }
 124     }
 125
 126     /**
 127      * Initializes objects, including the provider.
 128      *
 129      * @throws Exception if an error occurs
 130      */
 131     @Before
 132     public void setUp() throws Exception {
 133         MockitoAnnotations.initMocks(this);
 134
 135         policy = new ToscaPolicy();
 136         policy.setType(POLICY_TYPE);
 137         policy.setName(POLICY_NAME);
 138         policy.setVersion(POLICY_VERSION);
 139
 140         internalPolicy = new PolicyType();
 141         internalPolicy.setPolicyId(POLICY_NAME);
 142         internalPolicy.setVersion(POLICY_VERSION);
 143
 144         when(engineFactory.newEngine(any())).thenReturn(engine);
 145
 146         when(engine.decide(req)).thenReturn(resp);
 147
 148         when(trans.convertPolicy(policy)).thenReturn(internalPolicy);
 149
 150         prov = new MyProv();
 151
 152         Files.copy(SOURCE_PROP_FILE, PROP_FILE);
 153     }
 154
 155     @Test
 156     public void testApplicationName() {
 157         assertNotNull(prov.applicationName());
 158     }
 159
 160     @Test
 161     public void testActionDecisionsSupported() {
 162         assertTrue(prov.actionDecisionsSupported().isEmpty());
 163     }
 164
 165     @Test
 166     public void testInitialize_testGetXxx() throws XacmlApplicationException {
 167         prov.initialize(TEMP_PATH, apiRestParameters);
 168
 169         assertEquals(TEMP_PATH, prov.getDataPath());
 170         assertNotNull(prov.getEngine());
 171
 172         Properties props = prov.getProperties();
 173         assertEquals("rootstart", props.getProperty("xacml.rootPolicies"));
 174     }
 175
 176     @Test
 177     public void testInitialize_Ex() throws XacmlApplicationException {
 178         assertThatThrownBy(() -> prov.initialize(new File(TEMP_DIR_NAME + "-nonExistent").toPath(), apiRestParameters))
 179                         .isInstanceOf(XacmlApplicationException.class).hasMessage("Failed to load xacml.properties");
 180     }
 181
 182     @Test
 183     public void testSupportedPolicyTypes() {
 184         assertThatThrownBy(() -> prov.supportedPolicyTypes()).isInstanceOf(UnsupportedOperationException.class);
 185     }
 186
 187     @Test
 188     public void testCanSupportPolicyType() {
 189         assertThatThrownBy(() -> prov.canSupportPolicyType(null)).isInstanceOf(UnsupportedOperationException.class);
 190     }
 191
 192     @Test
 193     public void testLoadPolicy_ConversionError() throws ToscaPolicyConversionException {
 194         when(trans.convertPolicy(policy)).thenReturn(null);
 195
 196         assertFalse(prov.loadPolicy(policy));
 197     }
 198
 199     @Test
 200     public void testLoadPolicy_testUnloadPolicy() throws Exception {
 201         prov.initialize(TEMP_PATH, apiRestParameters);
 202         PROP_FILE.delete();
 203
 204         final Set<String> set = XACMLProperties.getRootPolicyIDs(prov.getProperties());
 205
 206         assertTrue(prov.loadPolicy(policy));
 207
 208         // policy file should have been created
 209         File policyFile = new File(TEMP_DIR, "my-name_1.2.3.xml");
 210         assertTrue(policyFile.exists());
 211
 212         // new property file should have been created
 213         assertTrue(PROP_FILE.exists());
 214
 215         // should have re-created the engine
 216         verify(engineFactory, times(2)).newEngine(any());
 217
 218         final Set<String> set2 = XACMLProperties.getRootPolicyIDs(prov.getProperties());
 219         assertEquals(set.size() + 1, set2.size());
 220
 221         Set<String> set3 = new HashSet<>(set2);
 222         set3.removeAll(set);
 223         assertEquals("[root1]", set3.toString());
 224
 225
 226         /*
 227          * Prepare for unload.
 228          */
 229         PROP_FILE.delete();
 230
 231         assertTrue(prov.unloadPolicy(policy));
 232
 233         // policy file should have been removed
 234         assertFalse(policyFile.exists());
 235
 236         // new property file should have been created
 237         assertTrue(PROP_FILE.exists());
 238
 239         // should have re-created the engine
 240         verify(engineFactory, times(3)).newEngine(any());
 241
 242         set3 = XACMLProperties.getRootPolicyIDs(prov.getProperties());
 243         assertEquals(set.toString(), set3.toString());
 244     }
 245
 246     @Test
 247     public void testUnloadPolicy_NotDeployed() throws Exception {
 248         prov.initialize(TEMP_PATH, apiRestParameters);
 249
 250         assertFalse(prov.unloadPolicy(policy));
 251
 252         // no additional calls
 253         verify(engineFactory, times(1)).newEngine(any());
 254     }
 255
 256     @Test
 257     public void testMakeDecision() {
 258         prov.createEngine(null);
 259
 260         DecisionRequest decreq = mock(DecisionRequest.class);
 261         when(trans.convertRequest(decreq)).thenReturn(req);
 262
 263         DecisionResponse decresp = mock(DecisionResponse.class);
 264         when(trans.convertResponse(resp)).thenReturn(decresp);
 265
 266         Pair<DecisionResponse, Response> result = prov.makeDecision(decreq);
 267         assertSame(decresp, result.getKey());
 268         assertSame(resp, result.getValue());
 269
 270         verify(trans).convertRequest(decreq);
 271         verify(trans).convertResponse(resp);
 272     }
 273
 274     @Test
 275     public void testGetTranslator() {
 276         assertSame(trans, prov.getTranslator());
 277     }
 278
 279     @Test
 280     public void testCreateEngine() throws FactoryException {
 281         // success
 282         prov.createEngine(null);
 283         assertSame(engine, prov.getEngine());
 284
 285         // null - should be unchanged
 286         when(engineFactory.newEngine(any())).thenReturn(null);
 287         prov.createEngine(null);
 288         assertSame(engine, prov.getEngine());
 289
 290         // exception - should be unchanged
 291         when(engineFactory.newEngine(any())).thenThrow(new FactoryException(EXPECTED_EXCEPTION));
 292         prov.createEngine(null);
 293         assertSame(engine, prov.getEngine());
 294     }
 295
 296     @Test
 297     public void testXacmlDecision() throws PDPException {
 298         prov.createEngine(null);
 299
 300         // success
 301         assertSame(resp, prov.xacmlDecision(req));
 302
 303         // exception
 304         when(engine.decide(req)).thenThrow(new PDPException(EXPECTED_EXCEPTION));
 305         assertNull(prov.xacmlDecision(req));
 306     }
 307
 308     @Test
 309     public void testGetPdpEngineFactory() throws XacmlApplicationException {
 310         // use the real engine factory
 311         engineFactory = null;
 312
 313         prov = new MyProv();
 314         prov.initialize(TEMP_PATH, apiRestParameters);
 315
 316         assertNotNull(prov.getEngine());
 317     }
 318
 319     private class MyProv extends StdXacmlApplicationServiceProvider {
 320
 321         @Override
 322         protected ToscaPolicyTranslator getTranslator(String type) {
 323             return trans;
 324         }
 325
 326         @Override
 327         protected PDPEngineFactory getPdpEngineFactory() throws FactoryException {
 328             return (engineFactory != null ? engineFactory : super.getPdpEngineFactory());
 329         }
 330     }
 331 }