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
|
/*-
* ============LICENSE_START=======================================================
* Copyright (C) 2020 Bell Canada. 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.cds;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.protobuf.InvalidProtocolBufferException;
import com.google.protobuf.Struct;
import com.google.protobuf.Struct.Builder;
import com.google.protobuf.util.JsonFormat;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import lombok.Getter;
import org.onap.ccsdk.cds.controllerblueprints.common.api.ActionIdentifiers;
import org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader;
import org.onap.ccsdk.cds.controllerblueprints.processing.api.ExecutionServiceInput;
import org.onap.policy.aai.AaiConstants;
import org.onap.policy.aai.AaiCqResponse;
import org.onap.policy.cds.client.CdsProcessorGrpcClient;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.controlloop.actor.aai.AaiCustomQueryOperation;
import org.onap.policy.controlloop.actor.cds.constants.CdsActorConstants;
import org.onap.policy.controlloop.actor.cds.request.CdsActionRequest;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
/**
* Operation that uses gRPC to send request to CDS.
*
*/
@Getter
public class GrpcOperation extends OperationPartial {
public static final String NAME = "gRPC";
private CdsProcessorGrpcClient client;
/**
* Configuration for this operation.
*/
private final GrpcConfig config;
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
*/
public GrpcOperation(ControlLoopOperationParams params, GrpcConfig config) {
super(params, config);
this.config = config;
}
/**
* If no timeout is specified, then it returns the operator's configured timeout.
*/
@Override
protected long getTimeoutMs(Integer timeoutSec) {
return (timeoutSec == null || timeoutSec == 0 ? config.getTimeoutMs() : super.getTimeoutMs(timeoutSec));
}
/**
* Ensures that A&AI customer query has been performed.
*/
@Override
@SuppressWarnings("unchecked")
protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
ControlLoopOperationParams cqParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
.operation(AaiCustomQueryOperation.NAME).payload(null).retry(null).timeoutSec(null).build();
// run Custom Query and Guard, in parallel
return allOf(() -> params.getContext().obtain(AaiCqResponse.CONTEXT_KEY, cqParams), this::startGuardAsync);
}
@Override
public void generateSubRequestId(int attempt) {
setSubRequestId("0");
}
/**
* {@inheritDoc}.
*/
@Override
protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
CompletableFuture<OperationOutcome> future = new CompletableFuture<>();
client = new CdsProcessorGrpcClient(new CdsActorServiceManager(outcome, future),
config.getCdsServerProperties());
ExecutionServiceInput request = constructRequest(params);
client.sendRequest(request);
return future;
}
/**
* Build the CDS ExecutionServiceInput request from the policy object and the AAI
* enriched parameters. TO-DO: Avoid leaking Exceptions to the Kie Session thread. TBD
* item for Frankfurt release.
*
* @param params the control loop parameters specifying the onset, payload, etc.
* @return an ExecutionServiceInput instance.
*/
public ExecutionServiceInput constructRequest(ControlLoopOperationParams params) {
// For the current operational TOSCA policy model (yaml) CBA name and version are
// embedded in the payload
// section, with the new policy type model being proposed in Frankfurt we will be
// able to move it out.
if (!validateCdsMandatoryParams(params)) {
throw new IllegalArgumentException("missing cds mandatory params - " + params);
}
Map<String, String> payload = convertPayloadMap(params.getPayload());
String cbaName = payload.get(CdsActorConstants.KEY_CBA_NAME);
String cbaVersion = payload.get(CdsActorConstants.KEY_CBA_VERSION);
// Retain only the payload by removing CBA name and version once they are
// extracted
// to be put in CDS request header.
payload.remove(CdsActorConstants.KEY_CBA_NAME);
payload.remove(CdsActorConstants.KEY_CBA_VERSION);
// Embed payload from policy to ConfigDeployRequest object, serialize and inject
// into grpc request.
String cbaActionName = params.getOperation();
CdsActionRequest request = new CdsActionRequest();
request.setPolicyPayload(payload);
request.setActionName(cbaActionName);
request.setResolutionKey(UUID.randomUUID().toString());
// Inject AAI properties into payload map. Offer flexibility to the usecase
// implementation to inject whatever AAI parameters are of interest to them.
// E.g. For vFW usecase El-Alto inject service-instance-id, generic-vnf-id as
// needed by CDS.
request.setAaiProperties(params.getContext().getEnrichment());
// Inject any additional event parameters that may be present in the onset event
if (params.getContext().getEvent().getAdditionalEventParams() != null) {
request.setAdditionalEventParams(params.getContext().getEvent().getAdditionalEventParams());
}
Builder struct = Struct.newBuilder();
try {
String requestStr = request.generateCdsPayload();
Preconditions.checkState(!Strings.isNullOrEmpty(requestStr),
"Unable to build " + "config-deploy-request from payload parameters: {}", payload);
JsonFormat.parser().merge(requestStr, struct);
} catch (InvalidProtocolBufferException | CoderException e) {
throw new IllegalArgumentException("Failed to embed CDS payload string into the input request. blueprint({"
+ cbaName + "}:{" + cbaVersion + "}) for action({" + cbaActionName + "})", e);
}
// Build CDS gRPC request common-header
CommonHeader commonHeader = CommonHeader.newBuilder().setOriginatorId(CdsActorConstants.ORIGINATOR_ID)
.setRequestId(params.getContext().getEvent().getRequestId().toString())
.setSubRequestId(getSubRequestId()).build();
// Build CDS gRPC request action-identifier
ActionIdentifiers actionIdentifiers =
ActionIdentifiers.newBuilder().setBlueprintName(cbaName).setBlueprintVersion(cbaVersion)
.setActionName(cbaActionName).setMode(CdsActorConstants.CDS_MODE).build();
// Finally build & return the ExecutionServiceInput gRPC request object.
return ExecutionServiceInput.newBuilder().setCommonHeader(commonHeader).setActionIdentifiers(actionIdentifiers)
.setPayload(struct.build()).build();
}
private Map<String, String> convertPayloadMap(Map<String, Object> payload) {
Map<String, String> convertedPayload = new HashMap<>();
for (Entry<String, Object> entry : payload.entrySet()) {
convertedPayload.put(entry.getKey(), entry.getValue().toString());
}
return convertedPayload;
}
private boolean validateCdsMandatoryParams(ControlLoopOperationParams params) {
if (params == null || params.getPayload() == null) {
return false;
}
Map<String, Object> payload = params.getPayload();
if (payload.get(CdsActorConstants.KEY_CBA_NAME) == null
|| payload.get(CdsActorConstants.KEY_CBA_VERSION) == null) {
return false;
}
return !Strings.isNullOrEmpty(payload.get(CdsActorConstants.KEY_CBA_NAME).toString())
&& !Strings.isNullOrEmpty(payload.get(CdsActorConstants.KEY_CBA_VERSION).toString())
&& !Strings.isNullOrEmpty(params.getOperation());
}
}
|
