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.OperationResult;
  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
  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 testMakeRequest() {
  85         oper.generateSubRequestId(2);
  86         String subreq = oper.getSubRequestId();
  87         assertNotNull(subreq);
  88
  89         Request request = oper.makeRequest(2, genvnf);
  90         assertEquals(DEFAULT_OPERATION, request.getAction());
  91
  92         assertNotNull(request.getPayload());
  93
  94         CommonHeader header = request.getCommonHeader();
  95         assertNotNull(header);
  96         assertEquals(params.getRequestId(), header.getRequestId());
  97
  98         assertEquals(subreq, header.getSubRequestId());
  99
 100         request = oper.makeRequest(2, genvnf);
 101         assertEquals(subreq, request.getCommonHeader().getSubRequestId());
 102
 103         // repeat using a null payload
 104         params = params.toBuilder().payload(null).build();
 105         oper = new MyOper(params, config);
 106         assertEquals(Map.of(AppcOperation.VNF_ID_KEY, MY_VNF), oper.makeRequest(2, genvnf).getPayload());
 107     }
 108
 109     @Test
 110     public void testConvertPayload() {
 111         Request request = oper.makeRequest(2, genvnf);
 112
 113         // @formatter:off
 114         assertEquals(
 115             Map.of(AppcOperation.VNF_ID_KEY, MY_VNF,
 116                     KEY1, Map.of("input", "hello"),
 117                     KEY2, Map.of("output", "world")),
 118             request.getPayload());
 119         // @formatter:on
 120
 121
 122         /*
 123          * insert invalid json text into the payload.
 124          */
 125         Map<String, Object> payload = new TreeMap<>(params.getPayload());
 126         payload.put("invalid-key", "{invalid json");
 127
 128         params = params.toBuilder().payload(payload).build();
 129
 130         oper = new MyOper(params, config);
 131         request = oper.makeRequest(2, genvnf);
 132
 133         // @formatter:off
 134         assertEquals(
 135             Map.of(AppcOperation.VNF_ID_KEY, MY_VNF,
 136                     KEY1, Map.of("input", "hello"),
 137                     KEY2, Map.of("output", "world")),
 138             request.getPayload());
 139         // @formatter:on
 140
 141
 142         /*
 143          * insert null item into the payload.
 144          */
 145         payload = new TreeMap<>();
 146         payload.put(KEY1, "abc");
 147         payload.put(KEY2, null);
 148         payload.put(KEY3, "def");
 149         params = params.toBuilder().payload(payload).build();
 150
 151         oper = new MyOper(params, config);
 152         request = oper.makeRequest(2, genvnf);
 153
 154         payload.put(AppcOperation.VNF_ID_KEY, MY_VNF);
 155         payload.put(KEY1, "abc");
 156         payload.put(KEY2, null);
 157         payload.put(KEY3, "def");
 158
 159         assertEquals(payload, request.getPayload());
 160     }
 161
 162     @Test
 163     public void testGetExpectedKeyValues() {
 164         oper.generateSubRequestId(2);
 165         Request request = oper.makeRequest(2, genvnf);
 166         assertEquals(Arrays.asList(request.getCommonHeader().getSubRequestId()),
 167                         oper.getExpectedKeyValues(50, request));
 168     }
 169
 170     @Test
 171     public void testDetmStatusStringResponse() {
 172         final ResponseStatus status = response.getStatus();
 173
 174         // null status (i.e., it's a Request, not a Response)
 175         response.setStatus(null);
 176         assertEquals(Status.STILL_WAITING, oper.detmStatus("", response));
 177         response.setStatus(status);
 178
 179         // invalid code
 180         status.setCode(-45);
 181         assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response))
 182                         .withMessage("unknown APPC-C response status code: -45");
 183
 184         status.setCode(ResponseCode.SUCCESS.getValue());
 185         assertEquals(Status.SUCCESS, oper.detmStatus("", response));
 186
 187         status.setCode(ResponseCode.FAILURE.getValue());
 188         assertEquals(Status.FAILURE, oper.detmStatus("", response));
 189
 190         status.setCode(ResponseCode.ERROR.getValue());
 191         assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response))
 192                         .withMessage("APP-C request was not accepted, code=" + ResponseCode.ERROR.getValue());
 193
 194         status.setCode(ResponseCode.REJECT.getValue());
 195         assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response))
 196                         .withMessage("APP-C request was not accepted, code=" + ResponseCode.REJECT.getValue());
 197
 198         status.setCode(ResponseCode.ACCEPT.getValue());
 199         assertEquals(Status.STILL_WAITING, oper.detmStatus("", response));
 200     }
 201
 202     @Test
 203     public void testSetOutcome() {
 204         final ResponseStatus status = response.getStatus();
 205
 206         // null status
 207         response.setStatus(null);
 208         assertSame(outcome, oper.setOutcome(outcome, OperationResult.SUCCESS, response));
 209         assertEquals(OperationResult.SUCCESS, outcome.getResult());
 210         assertNotNull(outcome.getMessage());
 211         assertSame(response, outcome.getResponse());
 212         response.setStatus(status);
 213
 214         // null description
 215         status.setDescription(null);
 216         assertSame(outcome, oper.setOutcome(outcome, OperationResult.FAILURE, response));
 217         assertEquals(OperationResult.FAILURE, outcome.getResult());
 218         assertNotNull(outcome.getMessage());
 219         assertSame(response, outcome.getResponse());
 220         status.setDescription(MY_DESCRIPTION);
 221
 222         for (OperationResult result : OperationResult.values()) {
 223             assertSame(outcome, oper.setOutcome(outcome, result, response));
 224             assertEquals(result, outcome.getResult());
 225             assertEquals(MY_DESCRIPTION, outcome.getMessage());
 226             assertSame(response, outcome.getResponse());
 227         }
 228     }
 229
 230     private class MyOper extends AppcOperation {
 231
 232         public MyOper(ControlLoopOperationParams params, BidirectionalTopicConfig config) {
 233             super(params, config, Collections.emptyList());
 234         }
 235
 236         @Override
 237         protected Request makeRequest(int attempt) {
 238             return makeRequest(attempt, genvnf);
 239         }
 240     }
 241 }