2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.policy.controlloop.actor.appc;
23 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
24 import static org.junit.Assert.assertEquals;
25 import static org.junit.Assert.assertFalse;
26 import static org.junit.Assert.assertTrue;
27 import static org.mockito.ArgumentMatchers.any;
28 import static org.mockito.Mockito.verify;
31 import java.util.concurrent.CompletableFuture;
32 import java.util.concurrent.ExecutionException;
33 import java.util.concurrent.TimeoutException;
34 import java.util.function.BiConsumer;
35 import java.util.function.BiFunction;
36 import org.onap.policy.appc.Response;
37 import org.onap.policy.appc.ResponseCode;
38 import org.onap.policy.appc.ResponseStatus;
39 import org.onap.policy.common.utils.coder.StandardCoderObject;
40 import org.onap.policy.controlloop.actor.test.BasicBidirectionalTopicOperation;
41 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
42 import org.onap.policy.controlloop.actorserviceprovider.Util;
43 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
44 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
45 import org.onap.policy.controlloop.policy.PolicyResult;
46 import org.onap.policy.controlloop.policy.Target;
47 import org.powermock.reflect.Whitebox;
50 * Superclass for various operator tests.
52 public abstract class BasicAppcOperation extends BasicBidirectionalTopicOperation {
53 protected static final String[] IGNORE_FIELDS = {"RequestID", "subRequestID", "seconds", "nanos"};
54 protected static final String MY_DESCRIPTION = "my-description";
55 protected static final String MY_VNF = "my-vnf";
56 protected static final String KEY1 = "my-key-A";
57 protected static final String KEY2 = "my-key-B";
58 protected static final String VALUE1 = "{\"input\":\"hello\"}";
59 protected static final String VALUE2 = "{\"output\":\"world\"}";
60 protected static final String RESOURCE_ID = "my-resource";
62 protected Response response;
65 * Constructs the object using a default actor and operation name.
67 public BasicAppcOperation() {
72 * Constructs the object.
74 * @param actor actor name
75 * @param operation operation name
77 public BasicAppcOperation(String actor, String operation) {
78 super(actor, operation);
82 * Initializes mocks and sets up.
84 public void setUp() throws Exception {
87 response = new Response();
89 ResponseStatus status = new ResponseStatus();
90 response.setStatus(status);
91 status.setCode(ResponseCode.SUCCESS.getValue());
92 status.setDescription(MY_DESCRIPTION);
96 * Runs the operation and verifies that the response is successful.
98 * @param operation operation to run
100 protected void verifyOperation(AppcOperation operation)
101 throws InterruptedException, ExecutionException, TimeoutException {
103 CompletableFuture<OperationOutcome> future2 = operation.start();
104 executor.runAll(100);
105 assertFalse(future2.isDone());
107 verify(forwarder).register(any(), listenerCaptor.capture());
108 provideResponse(listenerCaptor.getValue(), ResponseCode.SUCCESS.getValue(), MY_DESCRIPTION);
110 executor.runAll(100);
111 assertTrue(future2.isDone());
113 outcome = future2.get();
114 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
115 assertEquals(MY_DESCRIPTION, outcome.getMessage());
119 * Verifies that an exception is thrown if a field is missing from the enrichment
122 * @param fieldName name of the field to be removed from the enrichment data
123 * @param expectedText text expected in the exception message
125 protected void verifyMissing(String fieldName, String expectedText,
126 BiFunction<ControlLoopOperationParams, BidirectionalTopicOperator, AppcOperation> maker) {
129 enrichment.remove(fieldName);
131 AppcOperation oper = maker.apply(params, operator);
133 assertThatIllegalArgumentException().isThrownBy(() -> Whitebox.invokeMethod(oper, "makeRequest", 1))
134 .withMessageContaining("missing").withMessageContaining(expectedText);
138 protected void makeContext() {
141 Target target = new Target();
142 target.setResourceID(RESOURCE_ID);
144 params = params.toBuilder().target(target).build();
148 * Provides a response to the listener.
150 * @param listener listener to which to provide the response
151 * @param code response code
152 * @param description response description
154 protected void provideResponse(BiConsumer<String, StandardCoderObject> listener, int code, String description) {
155 Response response = new Response();
157 ResponseStatus status = new ResponseStatus();
158 response.setStatus(status);
159 status.setCode(code);
160 status.setDescription(description);
162 provideResponse(listener, Util.translate("", response, String.class));
166 protected Map<String, String> makePayload() {
167 return Map.of(KEY1, VALUE1, KEY2, VALUE2);