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