gerrit.onap Code Review - policy/models.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2023, 2024 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  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.actor.xacml;
  23
  24 import static org.assertj.core.api.Assertions.assertThat;
  25 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
  26 import static org.junit.jupiter.api.Assertions.assertEquals;
  27 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
  28 import static org.junit.jupiter.api.Assertions.assertNotNull;
  29 import static org.junit.jupiter.api.Assertions.assertSame;
  30 import static org.mockito.Mockito.mock;
  31 import static org.mockito.Mockito.when;
  32
  33 import java.util.Map;
  34 import java.util.TreeMap;
  35 import java.util.function.Consumer;
  36 import org.junit.jupiter.api.AfterAll;
  37 import org.junit.jupiter.api.BeforeAll;
  38 import org.junit.jupiter.api.BeforeEach;
  39 import org.junit.jupiter.api.Test;
  40 import org.junit.jupiter.api.extension.ExtendWith;
  41 import org.mockito.Mock;
  42 import org.mockito.Mockito;
  43 import org.mockito.junit.jupiter.MockitoExtension;
  44 import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
  45 import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
  46 import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
  47 import org.onap.policy.common.utils.coder.CoderException;
  48 import org.onap.policy.controlloop.actor.test.BasicHttpOperation;
  49 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  50 import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
  51 import org.onap.policy.models.decisions.concepts.DecisionRequest;
  52 import org.onap.policy.models.decisions.concepts.DecisionResponse;
  53 import org.onap.policy.simulators.XacmlSimulatorJaxRs;
  54
  55 @ExtendWith(MockitoExtension.class)
  56  class GuardOperationTest extends BasicHttpOperation {
  57
  58     @Mock
  59     private Consumer<OperationOutcome> started;
  60     @Mock
  61     private Consumer<OperationOutcome> completed;
  62
  63     private DecisionConfig guardConfig;
  64     private GuardOperation oper;
  65
  66     /**
  67      * Starts the simulator.
  68      */
  69     @BeforeAll
  70      static void setUpBeforeClass() throws Exception {
  71         org.onap.policy.simulators.Util.buildXacmlSim();
  72
  73         BusTopicParams clientParams = BusTopicParams.builder().clientName(MY_CLIENT).basePath("policy/pdpx/v1/")
  74                         .hostname("localhost").managed(true).port(org.onap.policy.simulators.Util.XACMLSIM_SERVER_PORT)
  75                         .build();
  76         HttpClientFactoryInstance.getClientFactory().build(clientParams);
  77     }
  78
  79     @AfterAll
  80      static void tearDownAfterClass() {
  81         HttpClientFactoryInstance.getClientFactory().destroy();
  82         HttpServletServerFactoryInstance.getServerFactory().destroy();
  83     }
  84
  85     /**
  86      * Sets up.
  87      */
  88     @BeforeEach
  89      void setUp() throws Exception {
  90         super.setUpBasic();
  91
  92         guardConfig = mock(DecisionConfig.class);
  93         Mockito.lenient().when(guardConfig.makeRequest()).thenAnswer(args -> {
  94             DecisionRequest req = new DecisionRequest();
  95             req.setAction("guard");
  96             req.setOnapComponent("my-onap-component");
  97             req.setOnapInstance("my-onap-instance");
  98             req.setOnapName("my-onap-name");
  99             return req;
 100         });
 101
 102         config = guardConfig;
 103         initConfig();
 104
 105         params = params.toBuilder().startCallback(started).completeCallback(completed).build();
 106
 107         oper = new GuardOperation(params, config);
 108     }
 109
 110     /**
 111      * Tests "success" case with simulator.
 112      */
 113     @Test
 114      void testSuccess() throws Exception {
 115         DecisionParams opParams =
 116                         DecisionParams.builder().clientName(MY_CLIENT).path("decision").action("guard").build();
 117         config = new DecisionConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
 118
 119         params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build();
 120         oper = new GuardOperation(params, config);
 121
 122         outcome = oper.start().get();
 123         assertEquals(OperationResult.SUCCESS, outcome.getResult());
 124         assertInstanceOf(DecisionResponse.class, outcome.getResponse());
 125     }
 126
 127     /**
 128      * Tests "failure" case with simulator.
 129      */
 130     @Test
 131      void testFailure() throws Exception {
 132         DecisionParams opParams =
 133                         DecisionParams.builder().clientName(MY_CLIENT).path("decision").action("guard").build();
 134         config = new DecisionConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
 135
 136         params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor)
 137                         .payload(Map.of("clname", XacmlSimulatorJaxRs.DENY_CLNAME)).build();
 138         oper = new GuardOperation(params, config);
 139
 140         outcome = oper.start().get();
 141         assertEquals(OperationResult.FAILURE, outcome.getResult());
 142         assertInstanceOf(DecisionResponse.class, outcome.getResponse());
 143     }
 144
 145     @Test
 146      void testConstructor() {
 147         assertEquals(DEFAULT_ACTOR, oper.getActorName());
 148         assertEquals(DEFAULT_OPERATION, oper.getName());
 149     }
 150
 151     @Test
 152      void testGetPropertyNames() {
 153         assertThat(oper.getPropertyNames()).isEmpty();
 154     }
 155
 156     @Test
 157      void testMakeRequest() throws CoderException {
 158         oper.generateSubRequestId(2);
 159
 160         verifyPayload("makeReqStd.json", makePayload());
 161         verifyPayload("makeReqDefault.json", new TreeMap<>());
 162
 163         // null payload - start with fresh parameters and operation
 164         params = params.toBuilder().payload(null).build();
 165         oper = new GuardOperation(params, config);
 166         assertThatIllegalArgumentException().isThrownBy(() -> oper.makeRequest());
 167     }
 168
 169     private void verifyPayload(String expectedJsonFile, Map<String, Object> payload) throws CoderException {
 170         params.getPayload().clear();
 171         params.getPayload().putAll(payload);
 172
 173         DecisionRequest request = oper.makeRequest();
 174
 175         assertEquals("guard", request.getAction());
 176         assertEquals("my-onap-component", request.getOnapComponent());
 177         assertEquals("my-onap-instance", request.getOnapInstance());
 178         assertEquals("my-onap-name", request.getOnapName());
 179         assertNotNull(request.getRequestId());
 180         assertEquals(Map.of("guard", payload), request.getResource());
 181
 182         verifyRequest(expectedJsonFile, request, "requestId");
 183     }
 184
 185     @Test
 186      void testPostProcessResponse() {
 187         DecisionResponse response = new DecisionResponse();
 188
 189         // null status
 190         response.setStatus(null);
 191         verifyOutcome(response, OperationResult.FAILURE, "response contains no status");
 192
 193         // permit, mixed case
 194         response.setStatus("peRmit");
 195         verifyOutcome(response, OperationResult.SUCCESS, "peRmit");
 196
 197         // indeterminate, mixed case
 198         response.setStatus("inDETerminate");
 199         verifyOutcome(response, OperationResult.SUCCESS, "inDETerminate");
 200
 201         // deny, mixed case
 202         response.setStatus("deNY");
 203         verifyOutcome(response, OperationResult.FAILURE, "deNY");
 204
 205         // unknown status
 206         response.setStatus("unknown");
 207         verifyOutcome(response, OperationResult.FAILURE, "unknown");
 208     }
 209
 210     private void verifyOutcome(DecisionResponse response, OperationResult expectedResult, String expectedMessage) {
 211         oper.postProcessResponse(outcome, BASE_URI, rawResponse, response);
 212         assertEquals(expectedResult, outcome.getResult());
 213         assertEquals(expectedMessage, outcome.getMessage());
 214         assertSame(response, outcome.getResponse());
 215     }
 216
 217     @Override
 218     protected Map<String, Object> makePayload() {
 219         return new TreeMap<>(Map.of("hello", "world", "abc", "123"));
 220     }
 221 }