models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcOperationTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 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  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actor.appc;
  22
  23 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
  24 import static org.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertNotNull;
  26 import static org.junit.Assert.assertNull;
  27 import static org.junit.Assert.assertSame;
  28
  29 import java.util.Arrays;
  30 import java.util.Collections;
  31 import java.util.Map;
  32 import java.util.TreeMap;
  33 import org.junit.After;
  34 import org.junit.AfterClass;
  35 import org.junit.Before;
  36 import org.junit.BeforeClass;
  37 import org.junit.Test;
  38 import org.onap.policy.appc.CommonHeader;
  39 import org.onap.policy.appc.Request;
  40 import org.onap.policy.appc.ResponseCode;
  41 import org.onap.policy.appc.ResponseStatus;
  42 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation.Status;
  43 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
  44 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  45 import org.onap.policy.controlloop.policy.PolicyResult;
  46
  47 public class AppcOperationTest extends BasicAppcOperation {
  48     private AppcOperation oper;
  49
  50     @BeforeClass
  51     public static void setUpBeforeClass() throws Exception {
  52         // use same topic name for both sides
  53         initBeforeClass(MY_SINK, MY_SINK);
  54     }
  55
  56     @AfterClass
  57     public static void tearDownAfterClass() {
  58         destroyAfterClass();
  59     }
  60
  61     /**
  62      * Sets up.
  63      */
  64     @Before
  65     @Override
  66     public void setUp() throws Exception {
  67         super.setUp();
  68
  69         oper = new MyOper(params, config);
  70     }
  71
  72     @After
  73     @Override
  74     public void tearDown() {
  75         super.tearDown();
  76     }
  77
  78     @Test
  79     public void testConstructor() {
  80         assertEquals(DEFAULT_ACTOR, oper.getActorName());
  81         assertEquals(DEFAULT_OPERATION, oper.getName());
  82     }
  83
  84     @Test
  85     public void testStartPreprocessorAsync() {
  86         assertNotNull(oper.startPreprocessorAsync());
  87     }
  88
  89     /**
  90      * Tests startPreprocessorAsync(), when preprocessing is disabled.
  91      */
  92     @Test
  93     public void testStartPreprocessorAsyncDisabled() {
  94         params = params.toBuilder().preprocessed(true).build();
  95         assertNull(new MyOper(params, config).startPreprocessorAsync());
  96     }
  97
  98     @Test
  99     public void testMakeRequest() {
 100         oper.generateSubRequestId(2);
 101         String subreq = oper.getSubRequestId();
 102         assertNotNull(subreq);
 103
 104         Request request = oper.makeRequest(2, MY_VNF);
 105         assertEquals(DEFAULT_OPERATION, request.getAction());
 106
 107         assertNotNull(request.getPayload());
 108
 109         CommonHeader header = request.getCommonHeader();
 110         assertNotNull(header);
 111         assertEquals(params.getRequestId(), header.getRequestId());
 112
 113         assertEquals(subreq, header.getSubRequestId());
 114
 115         request = oper.makeRequest(2, MY_VNF);
 116         assertEquals(subreq, request.getCommonHeader().getSubRequestId());
 117
 118         // repeat using a null payload
 119         params = params.toBuilder().payload(null).build();
 120         oper = new MyOper(params, config);
 121         assertEquals(Map.of(AppcOperation.VNF_ID_KEY, MY_VNF), oper.makeRequest(2, MY_VNF).getPayload());
 122     }
 123
 124     @Test
 125     public void testConvertPayload() {
 126         Request request = oper.makeRequest(2, MY_VNF);
 127
 128         // @formatter:off
 129         assertEquals(
 130             Map.of(AppcOperation.VNF_ID_KEY, MY_VNF,
 131                     KEY1, Map.of("input", "hello"),
 132                     KEY2, Map.of("output", "world")),
 133             request.getPayload());
 134         // @formatter:on
 135
 136
 137         /*
 138          * insert invalid json text into the payload.
 139          */
 140         Map<String, Object> payload = new TreeMap<>(params.getPayload());
 141         payload.put("invalid-key", "{invalid json");
 142
 143         params = params.toBuilder().payload(payload).build();
 144
 145         oper = new MyOper(params, config);
 146         request = oper.makeRequest(2, MY_VNF);
 147
 148         // @formatter:off
 149         assertEquals(
 150             Map.of(AppcOperation.VNF_ID_KEY, MY_VNF,
 151                     KEY1, Map.of("input", "hello"),
 152                     KEY2, Map.of("output", "world")),
 153             request.getPayload());
 154         // @formatter:on
 155
 156
 157         /*
 158          * insert null item into the payload.
 159          */
 160         payload = new TreeMap<>();
 161         payload.put(KEY1, "abc");
 162         payload.put(KEY2, null);
 163         payload.put(KEY3, "def");
 164         params = params.toBuilder().payload(payload).build();
 165
 166         oper = new MyOper(params, config);
 167         request = oper.makeRequest(2, MY_VNF);
 168
 169         payload.put(AppcOperation.VNF_ID_KEY, MY_VNF);
 170         payload.put(KEY1, "abc");
 171         payload.put(KEY2, null);
 172         payload.put(KEY3, "def");
 173
 174         assertEquals(payload, request.getPayload());
 175     }
 176
 177     @Test
 178     public void testGetExpectedKeyValues() {
 179         oper.generateSubRequestId(2);
 180         Request request = oper.makeRequest(2, MY_VNF);
 181         assertEquals(Arrays.asList(request.getCommonHeader().getSubRequestId()),
 182                         oper.getExpectedKeyValues(50, request));
 183     }
 184
 185     @Test
 186     public void testDetmStatusStringResponse() {
 187         final ResponseStatus status = response.getStatus();
 188
 189         // null status (i.e., it's a Request, not a Response)
 190         response.setStatus(null);
 191         assertEquals(Status.STILL_WAITING, oper.detmStatus("", response));
 192         response.setStatus(status);
 193
 194         // invalid code
 195         status.setCode(-45);
 196         assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response))
 197                         .withMessage("unknown APPC-C response status code: -45");
 198
 199         status.setCode(ResponseCode.SUCCESS.getValue());
 200         assertEquals(Status.SUCCESS, oper.detmStatus("", response));
 201
 202         status.setCode(ResponseCode.FAILURE.getValue());
 203         assertEquals(Status.FAILURE, oper.detmStatus("", response));
 204
 205         status.setCode(ResponseCode.ERROR.getValue());
 206         assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response))
 207                         .withMessage("APP-C request was not accepted, code=" + ResponseCode.ERROR.getValue());
 208
 209         status.setCode(ResponseCode.REJECT.getValue());
 210         assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response))
 211                         .withMessage("APP-C request was not accepted, code=" + ResponseCode.REJECT.getValue());
 212
 213         status.setCode(ResponseCode.ACCEPT.getValue());
 214         assertEquals(Status.STILL_WAITING, oper.detmStatus("", response));
 215     }
 216
 217     @Test
 218     public void testSetOutcome() {
 219         final ResponseStatus status = response.getStatus();
 220
 221         // null status
 222         response.setStatus(null);
 223         assertSame(outcome, oper.setOutcome(outcome, PolicyResult.SUCCESS, response));
 224         assertEquals(PolicyResult.SUCCESS, outcome.getResult());
 225         assertNotNull(outcome.getMessage());
 226         assertSame(response, outcome.getResponse());
 227         response.setStatus(status);
 228
 229         // null description
 230         status.setDescription(null);
 231         assertSame(outcome, oper.setOutcome(outcome, PolicyResult.FAILURE, response));
 232         assertEquals(PolicyResult.FAILURE, outcome.getResult());
 233         assertNotNull(outcome.getMessage());
 234         assertSame(response, outcome.getResponse());
 235         status.setDescription(MY_DESCRIPTION);
 236
 237         for (PolicyResult result : PolicyResult.values()) {
 238             assertSame(outcome, oper.setOutcome(outcome, result, response));
 239             assertEquals(result, outcome.getResult());
 240             assertEquals(MY_DESCRIPTION, outcome.getMessage());
 241             assertSame(response, outcome.getResponse());
 242         }
 243     }
 244
 245     private static class MyOper extends AppcOperation {
 246
 247         public MyOper(ControlLoopOperationParams params, BidirectionalTopicConfig config) {
 248             super(params, config, Collections.emptyList());
 249         }
 250
 251         @Override
 252         protected Request makeRequest(int attempt) {
 253             return makeRequest(attempt, MY_VNF);
 254         }
 255     }
 256 }