1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.controlloop.actor.test;
import static org.junit.Assert.assertEquals;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import java.util.Map;
import java.util.TreeMap;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
import javax.ws.rs.core.Response;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.onap.policy.aai.AaiConstants;
import org.onap.policy.aai.AaiCqResponse;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.common.utils.time.PseudoExecutor;
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.actorserviceprovider.ActorService;
import org.onap.policy.controlloop.actorserviceprovider.Operation;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.Operator;
import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
import org.onap.policy.controlloop.policy.PolicyResult;
/**
* Superclass for various Operation tests.
*/
public class BasicOperation {
protected static final UUID REQ_ID = UUID.randomUUID();
protected static final String SUB_REQ_ID = "my-sub-request-id";
protected static final String DEFAULT_ACTOR = "default-Actor";
protected static final String DEFAULT_OPERATION = "default-Operation";
protected static final String TARGET_ENTITY = "my-target";
protected static final String CL_NAME = "my-closed-loop";
protected static final String EVENT_POLICY_NAME = "my-event-policy-name";
protected static final String EVENT_POLICY_VERSION = "my-event-policy-version";
protected static final String EVENT_VERSION = "my-event-version";
protected static final Executor blockingExecutor = command -> {
Thread thread = new Thread(command);
thread.setDaemon(true);
thread.start();
};
protected final String actorName;
protected final String operationName;
protected Coder coder = new StandardCoder();
@Mock
protected ActorService service;
@Mock
protected Actor guardActor;
@Mock
protected Operator guardOperator;
@Mock
protected Operation guardOperation;
@Mock
protected Actor cqActor;
@Mock
protected Operator cqOperator;
@Mock
protected Operation cqOperation;
@Mock
protected AaiCqResponse cqResponse;
protected CompletableFuture<OperationOutcome> cqFuture;
protected CompletableFuture<Response> future;
protected ControlLoopOperationParams params;
protected Map<String, String> enrichment;
protected VirtualControlLoopEvent event;
protected ControlLoopEventContext context;
protected OperationOutcome outcome;
protected PseudoExecutor executor;
/**
* Constructs the object using a default actor and operation name.
*/
public BasicOperation() {
this.actorName = DEFAULT_ACTOR;
this.operationName = DEFAULT_OPERATION;
}
/**
* Constructs the object.
*
* @param actor actor name
* @param operation operation name
*/
public BasicOperation(String actor, String operation) {
this.actorName = actor;
this.operationName = operation;
}
/**
* Initializes mocks and sets up.
*/
public void setUpBasic() {
MockitoAnnotations.initMocks(this);
cqFuture = new CompletableFuture<>();
future = new CompletableFuture<>();
executor = new PseudoExecutor();
makeContext();
when(service.getActor(OperationPartial.GUARD_ACTOR_NAME)).thenReturn(guardActor);
when(guardActor.getOperator(OperationPartial.GUARD_OPERATION_NAME)).thenReturn(guardOperator);
when(guardOperator.buildOperation(any())).thenReturn(guardOperation);
outcome = params.makeOutcome(TARGET_ENTITY);
outcome.setResult(PolicyResult.SUCCESS);
when(guardOperation.start()).thenReturn(CompletableFuture.completedFuture(outcome));
when(service.getActor(AaiConstants.ACTOR_NAME)).thenReturn(cqActor);
when(cqActor.getOperator("CustomQuery")).thenReturn(cqOperator);
when(cqOperator.buildOperation(any())).thenReturn(cqOperation);
when(cqOperation.start()).thenReturn(cqFuture);
// get a fresh outcome
outcome = params.makeOutcome(TARGET_ENTITY);
}
/**
* Reinitializes {@link #enrichment}, {@link #event}, {@link #context}, and
* {@link #params}.
* <p/>
* Note: {@link #params} is configured to use {@link #executor}.
*/
protected void makeContext() {
enrichment = new TreeMap<>(makeEnrichment());
event = new VirtualControlLoopEvent();
event.setRequestId(REQ_ID);
event.setAai(enrichment);
event.setClosedLoopControlName(CL_NAME);
event.setPolicyName(EVENT_POLICY_NAME);
event.setPolicyVersion(EVENT_POLICY_VERSION);
event.setVersion(EVENT_VERSION);
context = new ControlLoopEventContext(event);
params = ControlLoopOperationParams.builder().executor(executor).context(context).actorService(service)
.actor(actorName).operation(operationName).targetEntity(TARGET_ENTITY).payload(makePayload())
.build();
}
/**
* Makes enrichment data.
*
* @return enrichment data
*/
protected Map<String, String> makeEnrichment() {
return new TreeMap<>();
}
/**
* Makes payload data.
*
* @return payload data
*/
protected Map<String, Object> makePayload() {
return null;
}
/**
* Pretty-prints a request and verifies that the result matches the expected JSON.
*
* @param <R> request type
* @param expectedJsonFile name of the file containing the expected JSON
* @param request request to verify
* @param ignore names of fields to be ignored, because they change with each request
* @throws CoderException if the request cannot be pretty-printed
*/
protected <R> void verifyRequest(String expectedJsonFile, R request, String... ignore) throws CoderException {
String json = coder.encode(request, true);
String expected = ResourceUtils.getResourceAsString(expectedJsonFile);
// strip various items, because they change for each request
for (String stripper : ignore) {
stripper += "[^,]*";
json = json.replaceAll(stripper, "");
expected = expected.replaceAll(stripper, "");
}
json = json.trim();
expected = expected.trim();
assertEquals(expected, json);
}
/**
* Provides a response to a custom query.
*
* @param cq response to provide
*/
protected void provideCqResponse(AaiCqResponse cq) {
context.setProperty(AaiCqResponse.CONTEXT_KEY, cq);
OperationOutcome outcome2 = params.makeOutcome(TARGET_ENTITY);
outcome2.setResult(PolicyResult.SUCCESS);
cqFuture.complete(outcome2);
}
}
|
