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 org.onap.policy.appc.Response;
36 import org.onap.policy.appc.ResponseCode;
37 import org.onap.policy.appc.ResponseStatus;
38 import org.onap.policy.common.endpoints.event.comm.TopicSink;
39 import org.onap.policy.common.endpoints.event.comm.TopicSource;
40 import org.onap.policy.common.utils.coder.StandardCoderInstantAsMillis;
41 import org.onap.policy.common.utils.coder.StandardCoderObject;
42 import org.onap.policy.controlloop.actor.test.BasicBidirectionalTopicOperation;
43 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
44 import org.onap.policy.controlloop.actorserviceprovider.Util;
45 import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker;
46 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
47 import org.onap.policy.controlloop.policy.PolicyResult;
48 import org.onap.policy.controlloop.policy.Target;
49 import org.onap.policy.simulators.AppcLegacyTopicServer;
50 import org.onap.policy.simulators.TopicServer;
51 import org.powermock.reflect.Whitebox;
54 * Superclass for various operator tests.
56 public abstract class BasicAppcOperation extends BasicBidirectionalTopicOperation {
57 protected static final String[] IGNORE_FIELDS = {"RequestID", "subRequestID", "TimeStamp"};
58 protected static final String MY_DESCRIPTION = "my-description";
59 protected static final String MY_VNF = "my-vnf";
60 protected static final String KEY1 = "my-key-A";
61 protected static final String KEY2 = "my-key-B";
62 protected static final String KEY3 = "my-key-C";
63 protected static final String VALUE1 = "{\"input\":\"hello\"}";
64 protected static final String VALUE2 = "{\"output\":\"world\"}";
65 protected static final String RESOURCE_ID = "my-resource";
67 protected Response response;
70 * Constructs the object using a default actor and operation name.
72 public BasicAppcOperation() {
73 this.coder = new StandardCoderInstantAsMillis();
77 * Constructs the object.
79 * @param actor actor name
80 * @param operation operation name
82 public BasicAppcOperation(String actor, String operation) {
83 super(actor, operation);
84 this.coder = new StandardCoderInstantAsMillis();
88 * Initializes mocks and sets up.
90 public void setUp() throws Exception {
93 response = new Response();
95 ResponseStatus status = new ResponseStatus();
96 response.setStatus(status);
97 status.setCode(ResponseCode.SUCCESS.getValue());
98 status.setDescription(MY_DESCRIPTION);
101 public void tearDown() {
102 super.tearDownBasic();
105 @SuppressWarnings("rawtypes")
106 protected TopicServer makeServer(TopicSink sink, TopicSource source) {
107 return new AppcLegacyTopicServer(sink, source);
111 * Runs the operation and verifies that the response is successful.
113 * @param operation operation to run
115 protected void verifyOperation(AppcOperation operation)
116 throws InterruptedException, ExecutionException, TimeoutException {
118 CompletableFuture<OperationOutcome> future2 = operation.start();
119 executor.runAll(100);
120 assertFalse(future2.isDone());
122 verify(forwarder).register(any(), listenerCaptor.capture());
123 provideResponse(listenerCaptor.getValue(), ResponseCode.SUCCESS.getValue(), MY_DESCRIPTION);
125 executor.runAll(100);
126 assertTrue(future2.isDone());
128 outcome = future2.get();
129 assertEquals(PolicyResult.SUCCESS, outcome.getResult());
130 assertEquals(MY_DESCRIPTION, outcome.getMessage());
134 * Verifies that an exception is thrown if a field is missing from the enrichment
137 * @param fieldName name of the field to be removed from the enrichment data
138 * @param expectedText text expected in the exception message
140 protected void verifyMissing(String fieldName, String expectedText,
141 OperationMaker<BidirectionalTopicConfig, AppcOperation> maker) {
144 enrichment.remove(fieldName);
146 AppcOperation oper = maker.apply(params, config);
148 assertThatIllegalArgumentException().isThrownBy(() -> Whitebox.invokeMethod(oper, "makeRequest", 1))
149 .withMessageContaining("missing").withMessageContaining(expectedText);
153 protected void makeContext() {
156 Target target = new Target();
157 target.setResourceID(RESOURCE_ID);
159 params = params.toBuilder().target(target).build();
163 * Provides a response to the listener.
165 * @param listener listener to which to provide the response
166 * @param code response code
167 * @param description response description
169 protected void provideResponse(BiConsumer<String, StandardCoderObject> listener, int code, String description) {
170 Response response = new Response();
172 ResponseStatus status = new ResponseStatus();
173 response.setStatus(status);
174 status.setCode(code);
175 status.setDescription(description);
177 provideResponse(listener, Util.translate("", response, String.class));
181 protected Map<String, Object> makePayload() {
182 return Map.of(KEY1, VALUE1, KEY2, VALUE2);