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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
/*
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2017 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.openecomp.mso.bpmn.common.scripts
import org.camunda.bpm.engine.delegate.BpmnError
import org.camunda.bpm.engine.delegate.DelegateExecution
import org.openecomp.mso.bpmn.common.scripts.AaiUtil
import org.openecomp.mso.bpmn.common.scripts.ExceptionUtil
import org.openecomp.mso.bpmn.common.scripts.SDNCAdapterUtils
import org.openecomp.mso.bpmn.core.domain.InventoryType
import org.openecomp.mso.bpmn.core.domain.Resource
import org.openecomp.mso.bpmn.core.domain.ServiceDecomposition
import org.openecomp.mso.bpmn.core.domain.Subscriber
import org.openecomp.mso.bpmn.core.domain.VnfResource
import org.openecomp.mso.bpmn.core.json.JsonUtils
import org.openecomp.mso.rest.APIResponse
import org.openecomp.mso.rest.RESTClient
import org.openecomp.mso.rest.RESTConfig
import org.openecomp.mso.bpmn.common.scripts.AbstractServiceTaskProcessor
import org.json.JSONArray
import org.json.JSONObject
import static org.openecomp.mso.bpmn.common.scripts.GenericUtils.*;
/**
* This class is contains the scripts used
* by the Homing Subflow building block. The
* subflow attempts to home the provided
* resources by calling sniro.
*
* @author cb645j
*
*/
class Homing extends AbstractServiceTaskProcessor{
ExceptionUtil exceptionUtil = new ExceptionUtil()
JsonUtils jsonUtil = new JsonUtils()
SNIROUtils sniroUtils = new SNIROUtils(this)
/**
* This method validates the incoming variables.
* The method then prepares the sniro request
* and posts it to sniro's rest api.
*
* @param execution
*
* @author cb645j
*/
public void callSniro(DelegateExecution execution){
def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
execution.setVariable("prefix","HOME_")
utils.log("DEBUG", "*** Started Homing Call Sniro ***", isDebugEnabled)
try{
execution.setVariable("rollbackData", null)
execution.setVariable("rolledBack", false)
String requestId = execution.getVariable("msoRequestId")
utils.log("DEBUG", "Incoming Request Id is: " + requestId, isDebugEnabled)
String serviceInstanceId = execution.getVariable("serviceInstanceId")
utils.log("DEBUG", "Incoming Service Instance Id is: " + serviceInstanceId, isDebugEnabled)
ServiceDecomposition serviceDecomposition = execution.getVariable("serviceDecomposition")
utils.log("DEBUG", "Incoming Service Decomposition is: " + serviceDecomposition, isDebugEnabled)
String subscriberInfo = execution.getVariable("subscriberInfo")
utils.log("DEBUG", "Incoming Subscriber Information is: " + subscriberInfo, isDebugEnabled)
if(isBlank(requestId) || isBlank(serviceInstanceId) || isBlank(serviceDecomposition.toString()) || isBlank(subscriberInfo)){
exceptionUtil.buildAndThrowWorkflowException(execution, 4000, "A required input variable is missing or null")
}else{
String subId = jsonUtil.getJsonValue(subscriberInfo, "globalSubscriberId")
String subName = jsonUtil.getJsonValue(subscriberInfo, "subscriberName")
String subCommonSiteId = ""
if(jsonUtil.jsonElementExist(subscriberInfo, "subscriberCommonSiteId")){
subCommonSiteId = jsonUtil.getJsonValue(subscriberInfo, "subscriberCommonSiteId")
}
Subscriber subscriber = new Subscriber(subId, subName, subCommonSiteId)
String cloudConfiguration = execution.getVariable("cloudConfiguration") // TODO Currently not being used
String homingParameters = execution.getVariable("homingParameters") // (aka. request parameters) Should be json format. TODO confirm its json format
//Authentication
def authHeader = ""
String basicAuth = execution.getVariable("URN_mso_sniro_auth")
String msokey = execution.getVariable("URN_mso_msoKey")
String basicAuthValue = utils.encrypt(basicAuth, msokey)
if(basicAuthValue != null){
utils.log("DEBUG", "Obtained BasicAuth username and password for SNIRO Adapter: " + basicAuthValue, isDebugEnabled)
try {
authHeader = utils.getBasicAuth(basicAuthValue, msokey)
execution.setVariable("BasicAuthHeaderValue",authHeader)
} catch (Exception ex) {
utils.log("DEBUG", "Unable to encode username and password string: " + ex, isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 401, "Internal Error - Unable to encode username and password string")
}
}else{
utils.log("DEBUG", "Unable to obtain BasicAuth - BasicAuth value null" , isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 401, "Internal Error - BasicAuth value null")
}
//Prepare Callback
String timeout = execution.getVariable("timeout")
if(isBlank(timeout)){
timeout = execution.getVariable("URN_mso_sniro_timeout");
if(isBlank(timeout)) {
timeout = "PT30M";
}
}
utils.log("DEBUG", "Async Callback Timeout will be: " + timeout, isDebugEnabled)
execution.setVariable("timeout", timeout);
execution.setVariable("correlator", requestId);
execution.setVariable("messageType", "SNIROResponse");
//Build Request & Call Sniro
String sniroRequest = sniroUtils.buildRequest(execution, requestId, serviceDecomposition, subscriber, homingParameters)
execution.setVariable("sniroRequest", sniroRequest)
utils.log("DEBUG", "SNIRO Request is: " + sniroRequest, isDebugEnabled)
String endpoint = execution.getVariable("URN_mso_service_agnostic_sniro_endpoint")
String host = execution.getVariable("URN_mso_service_agnostic_sniro_host")
String url = host + endpoint
utils.log("DEBUG", "Posting to Sniro Url: " + url, isDebugEnabled)
logDebug( "URL to be used is: " + url, isDebugEnabled)
RESTConfig config = new RESTConfig(url);
RESTClient client = new RESTClient(config).addAuthorizationHeader(authHeader).addHeader("Content-Type", "application/json")
APIResponse response = client.httpPost(sniroRequest)
int responseCode = response.getStatusCode()
execution.setVariable("syncResponseCode", responseCode);
logDebug("SNIRO sync response code is: " + responseCode, isDebugEnabled)
String syncResponse = response.getResponseBodyAsString()
execution.setVariable("syncResponse", syncResponse);
logDebug("SNIRO sync response is: " + syncResponse, isDebugEnabled)
utils.log("DEBUG", "*** Completed Homing Call Sniro ***", isDebugEnabled)
}
}catch(BpmnError b){
throw b
}catch(Exception e){
utils.log("DEBUG", "Error encountered within Homing CallSniro method: " + e, isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Internal Error - Occured in Homing CallSniro: " + e.getMessage())
}
}
/**
* This method processes the callback response
* and the contained homing solution. It sets
* homing solution assignment and license
* information to the corresponding resources
*
* @param execution
*
* @author cb645j
*/
public void processHomingSolution(DelegateExecution execution){
def isDebugEnabled = execution.getVariable("isDebugLogEnabled")
utils.log("DEBUG", "*** Started Homing Process Homing Solution ***", isDebugEnabled)
try{
String response = execution.getVariable("asyncCallbackResponse")
utils.log("DEBUG", "Sniro Async Callback Response is: " + response, isDebugEnabled)
utils.logAudit("Sniro Async Callback Response is: " + response)
sniroUtils.validateCallbackResponse(execution, response)
String placements = jsonUtil.getJsonValue(response, "solutionInfo.placementInfo")
ServiceDecomposition decomposition = execution.getVariable("serviceDecomposition")
utils.log("DEBUG", "Service Decomposition: " + decomposition, isDebugEnabled)
List<Resource> resourceList = decomposition.getServiceResources()
JSONArray arr = new JSONArray(placements)
for(int i = 0; i < arr.length(); i++){
JSONObject placement = arr.getJSONObject(i)
String jsonServiceResourceId = placement.getString("serviceResourceId")
for(Resource resource:resourceList){
String serviceResourceId = resource.getResourceId()
if(serviceResourceId.equalsIgnoreCase(jsonServiceResourceId)){
//match
String inventoryType = placement.getString("inventoryType")
resource.getHomingSolution().setInventoryType(InventoryType.valueOf(inventoryType))
resource.getHomingSolution().setCloudRegionId(placement.getString("cloudRegionId"))
resource.getHomingSolution().setRehome(placement.getBoolean("isRehome"))
JSONArray assignmentArr = placement.getJSONArray("assignmentInfo")
Map<String, String> assignmentMap = jsonUtil.entryArrayToMap(execution, assignmentArr.toString(), "variableName", "variableValue")
resource.getHomingSolution().setCloudOwner(assignmentMap.get("cloudOwner"))
resource.getHomingSolution().setAicClli(assignmentMap.get("aicClli"))
resource.getHomingSolution().setAicVersion(assignmentMap.get("aicVersion"))
if(inventoryType.equalsIgnoreCase("service")){
VnfResource vnf = new VnfResource()
vnf.setVnfHostname(assignmentMap.get("vnfHostName"))
resource.getHomingSolution().setVnf(vnf)
resource.getHomingSolution().setServiceInstanceId(placement.getString("serviceInstanceId"))
}
}
}
}
if(JsonUtils.jsonElementExist(response, "solutionInfo.licenseInfo")){
String licenseInfo = jsonUtil.getJsonValue(response, "solutionInfo.licenseInfo")
JSONArray licenseArr = new JSONArray(licenseInfo)
for(int l = 0; l < licenseArr.length(); l++){
JSONObject license = licenseArr.getJSONObject(l)
String jsonServiceResourceId = license.getString("serviceResourceId")
for(Resource resource:resourceList){
String serviceResourceId = resource.getResourceId()
if(serviceResourceId.equalsIgnoreCase(jsonServiceResourceId)){
//match
String jsonEntitlementPoolList = jsonUtil.getJsonValue(license.toString(), "entitlementPoolList")
List<String> entitlementPoolList = jsonUtil.StringArrayToList(execution, jsonEntitlementPoolList)
resource.getHomingSolution().getLicense().setEntitlementPoolList(entitlementPoolList)
String jsonLicenseKeyGroupList = jsonUtil.getJsonValue(license.toString(), "licenseKeyGroupList")
List<String> licenseKeyGroupList = jsonUtil.StringArrayToList(execution, jsonLicenseKeyGroupList)
resource.getHomingSolution().getLicense().setLicenseKeyGroupList(licenseKeyGroupList)
}
}
}
}
execution.setVariable("serviceDecomposition", decomposition)
execution.setVariable("homingSolution", placements) //TODO - can be removed as output variable
utils.log("DEBUG", "*** Completed Homing Process Homing Solution ***", isDebugEnabled)
}catch(BpmnError b){
throw b
}catch(Exception e){
utils.log("DEBUG", "Error encountered within Homing ProcessHomingSolution method: " + e, isDebugEnabled)
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Internal Error - Occured in Homing ProcessHomingSolution")
}
}
/**
* This method logs the start of DHVCreateService
* to make debugging easier.
*
* @param - execution
* @author cb645j
*/
public String logStart(DelegateExecution execution){
def isDebugEnabled=execution.getVariable("isDebugLogEnabled")
String requestId = execution.getVariable("testReqId")
if(isBlank(requestId)){
requestId = execution.getVariable("msoRequestId")
}
execution.setVariable("DHVCS_requestId", requestId)
utils.log("DEBUG", "***** STARTED Homing Subflow for request: " + requestId + " *****", "true")
utils.log("DEBUG", "****** Homing Subflow Global Debug Enabled: " + isDebugEnabled + " *****", "true")
utils.logAudit("***** STARTED Homing Subflow for request: " + requestId + " *****")
}
/**
* Auto-generated method stub
*/
public void preProcessRequest(DelegateExecution execution){}
}
|