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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2018 Intel Corp. All rights reserved.
* ================================================================================
* Modifications Copyright (c) 2019 Samsung
* ================================================================================
* 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.so.bpmn.common.scripts
import org.camunda.bpm.engine.delegate.DelegateExecution
import org.onap.so.bpmn.common.scripts.AbstractServiceTaskProcessor
import org.onap.so.bpmn.common.scripts.ExceptionUtil
import org.onap.so.bpmn.core.UrnPropertiesReader
import org.onap.so.bpmn.core.domain.HomingSolution
import org.onap.so.bpmn.core.domain.ModelInfo
import org.onap.so.bpmn.core.domain.Resource
import org.onap.so.bpmn.core.domain.AllottedResource
import org.onap.so.bpmn.core.domain.ServiceDecomposition
import org.onap.so.bpmn.core.domain.ServiceInstance
import org.onap.so.bpmn.core.domain.Subscriber
import org.onap.so.bpmn.core.domain.VnfResource
import org.onap.so.bpmn.core.json.JsonUtils
import org.onap.so.client.HttpClient
import org.onap.so.client.HttpClientFactory
import org.onap.so.db.catalog.beans.CloudSite
import org.onap.so.db.catalog.beans.HomingInstance
import org.onap.so.utils.TargetEntity
import org.springframework.http.HttpEntity
import org.springframework.http.HttpHeaders
import org.springframework.http.HttpMethod
import org.springframework.http.ResponseEntity
import org.springframework.http.client.BufferingClientHttpRequestFactory
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory
import org.springframework.web.client.RestTemplate
import org.springframework.web.util.UriComponentsBuilder
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import javax.ws.rs.core.MediaType
import javax.ws.rs.core.Response
import javax.xml.ws.http.HTTPException
import static org.onap.so.bpmn.common.scripts.GenericUtils.*
class OofUtils {
private static final Logger logger = LoggerFactory.getLogger( OofUtils.class);
ExceptionUtil exceptionUtil = new ExceptionUtil()
JsonUtils jsonUtil = new JsonUtils()
private AbstractServiceTaskProcessor utils
OofUtils(AbstractServiceTaskProcessor taskProcessor) {
this.utils = taskProcessor
}
/**
* This method builds the service-agnostic
* OOF json request to get a homing solution
* and license solution
*
* @param execution
* @param requestId
* @param decomposition - ServiceDecomposition object
* @param customerLocation -
* @param existingCandidates -
* @param excludedCandidates -
* @param requiredCandidates -
*
* @return request - OOF v1 payload - https://wiki.onap.org/pages/viewpage.action?pageId=25435066
*/
String buildRequest(DelegateExecution execution,
String requestId,
ServiceDecomposition decomposition,
Subscriber subscriber = null,
Map customerLocation,
ArrayList existingCandidates = null,
ArrayList excludedCandidates = null,
ArrayList requiredCandidates = null) {
logger.debug( "Started Building OOF Request")
String callbackEndpoint = UrnPropertiesReader.getVariable("mso.oof.callbackEndpoint", execution)
logger.debug( "mso.oof.callbackEndpoint is: " + callbackEndpoint)
try {
def callbackUrl = utils.createHomingCallbackURL(callbackEndpoint, "oofResponse", requestId)
logger.debug( "callbackUrl is: " + callbackUrl)
def transactionId = requestId
logger.debug( "transactionId is: " + transactionId)
//ServiceInstance Info
ServiceInstance serviceInstance = decomposition.getServiceInstance()
def serviceInstanceId = ""
def serviceName = ""
serviceInstanceId = execution.getVariable("serviceInstanceId")
logger.debug( "serviceInstanceId is: " + serviceInstanceId)
serviceName = execution.getVariable("subscriptionServiceType")
logger.debug( "serviceName is: " + serviceName)
if (serviceInstanceId == null || serviceInstanceId == "null") {
logger.debug( "Unable to obtain Service Instance Id")
exceptionUtil.buildAndThrowWorkflowException(execution, 400, "Internal Error - Unable to " +
"obtain Service Instance Id, execution.getVariable(\"serviceInstanceId\") is null")
}
if (serviceName == null || serviceName == "null") {
logger.debug( "Unable to obtain Service Name")
exceptionUtil.buildAndThrowWorkflowException(execution, 400, "Internal Error - Unable to " +
"obtain Service Name, execution.getVariable(\"subscriptionServiceType\") is null")
}
//Model Info
ModelInfo model = decomposition.getModelInfo()
logger.debug( "ModelInfo: " + model.toString())
String modelType = model.getModelType()
String modelInvariantId = model.getModelInvariantUuid()
String modelVersionId = model.getModelUuid()
String modelName = model.getModelName()
String modelVersion = model.getModelVersion()
//Subscriber Info
String subscriberId = ""
String subscriberName = ""
String commonSiteId = ""
if (subscriber != null) {
subscriberId = subscriber.getGlobalId()
subscriberName = subscriber.getName()
commonSiteId = subscriber.getCommonSiteId()
}
//Determine RequestType
//TODO Figure out better way to determine this
String requestType = "create"
List<Resource> resources = decomposition.getServiceResources()
for (Resource r : resources) {
HomingSolution currentSolution = (HomingSolution) r.getCurrentHomingSolution()
if (currentSolution != null) {
requestType = "speed changed"
}
}
//Demands
String placementDemands = ""
StringBuilder sb = new StringBuilder()
List<AllottedResource> allottedResourceList = decomposition.getAllottedResources()
List<VnfResource> vnfResourceList = decomposition.getVnfResources()
if (allottedResourceList == null || allottedResourceList.isEmpty()) {
logger.debug( "Allotted Resources List is empty - will try to get service VNFs instead.")
} else {
for (AllottedResource resource : allottedResourceList) {
logger.debug( "Allotted Resource: " + resource.toString())
def serviceResourceId = resource.getResourceId()
def toscaNodeType = resource.getToscaNodeType()
def resourceModuleName = toscaNodeType.substring(toscaNodeType.lastIndexOf(".") + 1)
def resourceModelInvariantId = resource.getModelInfo().getModelInvariantUuid()
def resourceModelVersionId = resource.getModelInfo().getModelUuid()
def resourceModelName = resource.getModelInfo().getModelName()
def resourceModelVersion = resource.getModelInfo().getModelVersion()
def resourceModelType = resource.getModelInfo().getModelType()
def tenantId = execution.getVariable("tenantId")
def requiredCandidatesJson = ""
requiredCandidatesJson = createCandidateJson(
existingCandidates,
excludedCandidates,
requiredCandidates)
String demand =
" {\n" +
" \"resourceModuleName\": \"${resourceModuleName}\",\n" +
" \"serviceResourceId\": \"${serviceResourceId}\",\n" +
" \"tenantId\": \"${tenantId}\",\n" +
" \"resourceModelInfo\": {\n" +
" \"modelInvariantId\": \"${resourceModelInvariantId}\",\n" +
" \"modelVersionId\": \"${resourceModelVersionId}\",\n" +
" \"modelName\": \"${resourceModelName}\",\n" +
" \"modelType\": \"${resourceModelType}\",\n" +
" \"modelVersion\": \"${resourceModelVersion}\",\n" +
" \"modelCustomizationName\": \"\"\n" +
" }" + requiredCandidatesJson + "\n" +
" },"
placementDemands = sb.append(demand)
}
}
if (vnfResourceList == null || vnfResourceList.isEmpty()) {
logger.debug( "VNF Resources List is empty")
} else {
for (VnfResource vnfResource : vnfResourceList) {
logger.debug( "VNF Resource: " + vnfResource.toString())
ModelInfo vnfResourceModelInfo = vnfResource.getModelInfo()
def toscaNodeType = vnfResource.getToscaNodeType()
def resourceModuleName = toscaNodeType.substring(toscaNodeType.lastIndexOf(".") + 1)
def serviceResourceId = vnfResource.getResourceId()
def resourceModelInvariantId = vnfResourceModelInfo.getModelInvariantUuid()
def resourceModelName = vnfResourceModelInfo.getModelName()
def resourceModelVersion = vnfResourceModelInfo.getModelVersion()
def resourceModelVersionId = vnfResourceModelInfo.getModelUuid()
def resourceModelType = vnfResourceModelInfo.getModelType()
def tenantId = execution.getVariable("tenantId")
def requiredCandidatesJson = ""
String placementDemand =
" {\n" +
" \"resourceModuleName\": \"${resourceModuleName}\",\n" +
" \"serviceResourceId\": \"${serviceResourceId}\",\n" +
" \"tenantId\": \"${tenantId}\",\n" +
" \"resourceModelInfo\": {\n" +
" \"modelInvariantId\": \"${resourceModelInvariantId}\",\n" +
" \"modelVersionId\": \"${resourceModelVersionId}\",\n" +
" \"modelName\": \"${resourceModelName}\",\n" +
" \"modelType\": \"${resourceModelType}\",\n" +
" \"modelVersion\": \"${resourceModelVersion}\",\n" +
" \"modelCustomizationName\": \"\"\n" +
" }" + requiredCandidatesJson + "\n" +
" },"
placementDemands = sb.append(placementDemand)
}
placementDemands = placementDemands.substring(0, placementDemands.length() - 1)
}
/* Commenting Out Licensing as OOF doesn't support for Beijing
String licenseDemands = ""
sb = new StringBuilder()
if (vnfResourceList.isEmpty() || vnfResourceList == null) {
logger.debug( "Vnf Resources List is Empty")
} else {
for (VnfResource vnfResource : vnfResourceList) {
ModelInfo vnfResourceModelInfo = vnfResource.getModelInfo()
def resourceInstanceType = vnfResource.getResourceType()
def serviceResourceId = vnfResource.getResourceId()
def resourceModuleName = vnfResource.getResourceType()
def resouceModelInvariantId = vnfResourceModelInfo.getModelInvariantUuid()
def resouceModelName = vnfResourceModelInfo.getModelName()
def resouceModelVersion = vnfResourceModelInfo.getModelVersion()
def resouceModelVersionId = vnfResourceModelInfo.getModelUuid()
def resouceModelType = vnfResourceModelInfo.getModelType()
// TODO Add Existing Licenses to demand
//"existingLicenses": {
//"entitlementPoolUUID": ["87257b49-9602-4ca1-9817-094e52bc873b",
// "43257b49-9602-4fe5-9337-094e52bc9435"],
//"licenseKeyGroupUUID": ["87257b49-9602-4ca1-9817-094e52bc873b",
// "43257b49-9602-4fe5-9337-094e52bc9435"]
//}
String licenseDemand =
"{\n" +
"\"resourceModuleName\": \"${resourceModuleName}\",\n" +
"\"serviceResourceId\": \"${serviceResourceId}\",\n" +
"\"resourceInstanceType\": \"${resourceInstanceType}\",\n" +
"\"resourceModelInfo\": {\n" +
" \"modelInvariantId\": \"${resouceModelInvariantId}\",\n" +
" \"modelVersionId\": \"${resouceModelVersionId}\",\n" +
" \"modelName\": \"${resouceModelName}\",\n" +
" \"modelType\": \"${resouceModelType}\",\n" +
" \"modelVersion\": \"${resouceModelVersion}\",\n" +
" \"modelCustomizationName\": \"\"\n" +
" }\n"
"},"
licenseDemands = sb.append(licenseDemand)
}
licenseDemands = licenseDemands.substring(0, licenseDemands.length() - 1)
}*/
String request =
"{\n" +
" \"requestInfo\": {\n" +
" \"transactionId\": \"${transactionId}\",\n" +
" \"requestId\": \"${requestId}\",\n" +
" \"callbackUrl\": \"${callbackUrl}\",\n" +
" \"sourceId\": \"so\",\n" +
" \"requestType\": \"${requestType}\"," +
" \"numSolutions\": 1,\n" +
" \"optimizers\": [\"placement\"],\n" +
" \"timeout\": 600\n" +
" },\n" +
" \"placementInfo\": {\n" +
" \"requestParameters\": {\n" +
" \"customerLatitude\": \"${customerLocation.customerLatitude}\",\n" +
" \"customerLongitude\": \"${customerLocation.customerLongitude}\",\n" +
" \"customerName\": \"${customerLocation.customerName}\"\n" +
" }," +
" \"subscriberInfo\": { \n" +
" \"globalSubscriberId\": \"${subscriberId}\",\n" +
" \"subscriberName\": \"${subscriberName}\",\n" +
" \"subscriberCommonSiteId\": \"${commonSiteId}\"\n" +
" },\n" +
" \"placementDemands\": [\n" +
" ${placementDemands}\n" +
" ]\n" +
" },\n" +
" \"serviceInfo\": {\n" +
" \"serviceInstanceId\": \"${serviceInstanceId}\",\n" +
" \"serviceName\": \"${serviceName}\",\n" +
" \"modelInfo\": {\n" +
" \"modelType\": \"${modelType}\",\n" +
" \"modelInvariantId\": \"${modelInvariantId}\",\n" +
" \"modelVersionId\": \"${modelVersionId}\",\n" +
" \"modelName\": \"${modelName}\",\n" +
" \"modelVersion\": \"${modelVersion}\",\n" +
" \"modelCustomizationName\": \"\"\n" +
" }\n" +
" }\n" +
"}"
logger.debug( "Completed Building OOF Request")
return request
} catch (Exception ex) {
logger.debug( "buildRequest Exception: " + ex)
}
}
/**
* This method validates the callback response
* from OOF. If the response contains an
* exception the method will build and throw
* a workflow exception.
*
* @param execution
* @param response - the async callback response from oof
*/
Void validateCallbackResponse(DelegateExecution execution, String response) {
String placements = ""
if (isBlank(response)) {
exceptionUtil.buildAndThrowWorkflowException(execution, 5000, "OOF Async Callback Response is Empty")
} else {
if (JsonUtils.jsonElementExist(response, "solutions.placementSolutions")) {
placements = jsonUtil.getJsonValue(response, "solutions.placementSolutions")
if (isBlank(placements) || placements.equalsIgnoreCase("[]")) {
String statusMessage = jsonUtil.getJsonValue(response, "statusMessage")
if (isBlank(statusMessage)) {
logger.debug( "Error Occurred in Homing: OOF Async Callback Response does " +
"not contain placement solution.")
exceptionUtil.buildAndThrowWorkflowException(execution, 400,
"OOF Async Callback Response does not contain placement solution.")
} else {
logger.debug( "Error Occurred in Homing: " + statusMessage)
exceptionUtil.buildAndThrowWorkflowException(execution, 400, statusMessage)
}
} else {
return
}
} else if (response.contains("error") || response.contains("Error") ) {
String errorMessage = ""
if (response.contains("policyException")) {
String text = jsonUtil.getJsonValue(response, "requestError.policyException.text")
errorMessage = "OOF Async Callback Response contains a Request Error Policy Exception: " + text
} else if (response.contains("Unable to find any candidate for demand")) {
errorMessage = "OOF Async Callback Response contains error: Unable to find any candidate for " +
"demand *** Response: " + response.toString()
} else if (response.contains("serviceException")) {
String text = jsonUtil.getJsonValue(response, "requestError.serviceException.text")
errorMessage = "OOF Async Callback Response contains a Request Error Service Exception: " + text
} else {
errorMessage = "OOF Async Callback Response contains a Request Error. Unable to determine the Request Error Exception."
}
logger.debug( "Error Occurred in Homing: " + errorMessage)
exceptionUtil.buildAndThrowWorkflowException(execution, 400, errorMessage)
} else {
logger.debug( "Error Occurred in Homing: Received an Unknown Async Callback Response from OOF.")
exceptionUtil.buildAndThrowWorkflowException(execution, 2500, "Received an Unknown Async Callback Response from OOF.")
}
}
}
/**
* This method creates candidates json for placement Demands.
*
* @param execution
* @param existingCandidates -
* @param excludedCandidates -
* @param requiredCandidates -
*
* @return candidatesJson - a JSON string with candidates
*/
String createCandidateJson(ArrayList existingCandidates = null,
ArrayList excludedCandidates = null,
ArrayList requiredCandidates = null) {
def candidatesJson = ""
def type = ""
if (existingCandidates != null && existingCandidates != {}) {
sb = new StringBuilder()
sb.append(",\n" +
" \"existingCandidates\": [\n")
def existingCandidateJson = ""
existingCandidates.each { existingCandidate ->
type = existingCandidate.get('identifierType')
if (type == 'vimId') {
def cloudOwner = existingCandidate.get('cloudOwner')
def cloudRegionId = existingCandidate.get('identifiers')
existingCandidateJson = "{\n" +
" \"identifierType\": \"vimId\",\n" +
" \"cloudOwner\": \"${cloudOwner}\",\n" +
" \"identifiers\": [\"${cloudRegionId}\"]\n" +
" },"
sb.append(existingCandidateJson)
}
if (type == 'serviceInstanceId') {
def serviceInstanceId = existingCandidate.get('identifiers')
existingCandidateJson += "{\n" +
" \"identifierType\": \"serviceInstanceId\",\n" +
" \"identifiers\": [\"${serviceInstanceId}\"]\n" +
" },"
sb.append(existingCandidateJson)
}
}
if (existingCandidateJson != "") {
sb.setLength(sb.length() - 1)
candidatesJson = sb.append(",\n],")
}
}
if (excludedCandidates != null && excludedCandidates != {}) {
sb = new StringBuilder()
sb.append(",\n" +
" \"excludedCandidates\": [\n")
def excludedCandidateJson = ""
excludedCandidates.each { excludedCandidate ->
type = excludedCandidate.get('identifierType')
if (type == 'vimId') {
def cloudOwner = excludedCandidate.get('cloudOwner')
def cloudRegionId = excludedCandidate.get('identifiers')
excludedCandidateJson = "{\n" +
" \"identifierType\": \"vimId\",\n" +
" \"cloudOwner\": \"${cloudOwner}\",\n" +
" \"identifiers\": [\"${cloudRegionId}\"]\n" +
" },"
sb.append(excludedCandidateJson)
}
if (type == 'serviceInstanceId') {
def serviceInstanceId = excludedCandidate.get('identifiers')
excludedCandidateJson += "{\n" +
" \"identifierType\": \"serviceInstanceId\",\n" +
" \"identifiers\": [\"${serviceInstanceId}\"]\n" +
" },"
sb.append(excludedCandidateJson)
}
}
if (excludedCandidateJson != "") {
sb.setLength(sb.length() - 1)
candidatesJson = sb.append(",\n],")
}
}
if (requiredCandidates != null && requiredCandidates != {}) {
sb = new StringBuilder()
sb.append(",\n" +
" \"requiredCandidates\": [\n")
def requiredCandidatesJson = ""
requiredCandidates.each { requiredCandidate ->
type = requiredCandidate.get('identifierType')
if (type == 'vimId') {
def cloudOwner = requiredCandidate.get('cloudOwner')
def cloudRegionId = requiredCandidate.get('identifiers')
requiredCandidatesJson = "{\n" +
" \"identifierType\": \"vimId\",\n" +
" \"cloudOwner\": \"${cloudOwner}\",\n" +
" \"identifiers\": [\"${cloudRegionId}\"]\n" +
" },"
sb.append(requiredCandidatesJson)
}
if (type == 'serviceInstanceId') {
def serviceInstanceId = requiredCandidate.get('identifiers')
requiredCandidatesJson += "{\n" +
" \"identifierType\": \"serviceInstanceId\",\n" +
" \"identifiers\": [\"${serviceInstanceId}\"]\n" +
" },"
sb.append(requiredCandidatesJson)
}
}
if (requiredCandidatesJson != "") {
sb.setLength(sb.length() - 1)
candidatesJson = sb.append(",\n],")
}
}
if (candidatesJson != "") {candidatesJson = candidatesJson.substring(0, candidatesJson.length() - 1)}
return candidatesJson
}
/**
* This method creates a cloudsite in catalog database.
*
* @param CloudSite cloudSite
*
* @return void
*/
Void createCloudSiteCatalogDb(CloudSite cloudSite, DelegateExecution execution) {
String endpoint = UrnPropertiesReader.getVariable("mso.catalog.db.spring.endpoint", execution)
String auth = UrnPropertiesReader.getVariable("mso.db.auth", execution)
String uri = "/cloudSite"
URL url = new URL(endpoint + uri)
HttpClient client = new HttpClientFactory().newJsonClient(url, TargetEntity.EXTERNAL)
client.addAdditionalHeader(HttpHeaders.AUTHORIZATION, auth)
client.addAdditionalHeader(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON)
Response response = client.post(request.getBody().toString())
int responseCode = response.getStatus()
logger.debug("CatalogDB response code is: " + responseCode)
String syncResponse = response.readEntity(String.class)
logger.debug("CatalogDB response is: " + syncResponse)
if(responseCode != 202){
exceptionUtil.buildAndThrowWorkflowException(execution, responseCode, "Received a Bad Sync Response from CatalogDB.")
}
}
/**
* This method creates a HomingInstance in catalog database.
*
* @param HomingInstance homingInstance
*
* @return void
*/
Void createHomingInstance(HomingInstance homingInstance, DelegateExecution execution) {
oofInfraUtils.createHomingInstance(homingInstance, execution)
}
String getMsbHost(DelegateExecution execution) {
String msbHost = UrnPropertiesReader.getVariable("mso.msb.host", execution, "msb-iag.onap")
Integer msbPort = UrnPropertiesReader.getVariable("mso.msb.port", execution, "80").toInteger()
return UriBuilder.fromPath("").host(msbHost).port(msbPort).scheme("http").build().toString()
}
}
|