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
|
/*-
* ============LICENSE_START=======================================================
* ONAP - SO
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* Copyright (C) 2017 Huawei Technologies Co., Ltd. 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.so.openstack.utils;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.onap.so.db.catalog.beans.CloudSite;
import org.onap.so.logger.MessageEnum;
import org.onap.so.logger.MsoLogger;
import org.onap.so.openstack.beans.StackInfo;
import org.onap.so.openstack.exceptions.MsoCloudSiteNotFound;
import org.onap.so.openstack.exceptions.MsoException;
import org.onap.so.openstack.exceptions.MsoOpenstackException;
import org.onap.so.openstack.exceptions.MsoStackNotFound;
import org.onap.so.openstack.mappers.StackInfoMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.woorea.openstack.base.client.OpenStackBaseException;
import com.woorea.openstack.base.client.OpenStackRequest;
import com.woorea.openstack.heat.Heat;
import com.woorea.openstack.heat.model.Stack;
import com.woorea.openstack.heat.model.Stack.Output;
import com.woorea.openstack.heat.model.UpdateStackParam;
@Component
public class MsoHeatUtilsWithUpdate extends MsoHeatUtils {
private static final String UPDATE_STACK = "UpdateStack";
private static final MsoLogger LOGGER = MsoLogger.getMsoLogger (MsoLogger.Catalog.RA, MsoHeatUtilsWithUpdate.class);
private static final ObjectMapper JSON_MAPPER = new ObjectMapper();
@Autowired
private Environment environment;
/*
* Keep these methods around for backward compatibility
*/
public StackInfo updateStack (String cloudSiteId,
String tenantId,
String stackName,
String heatTemplate,
Map <String, Object> stackInputs,
boolean pollForCompletion,
int timeoutMinutes) throws MsoException {
// Keeping this method to allow compatibility with no environment or files variable sent. In this case,
// simply return the new method with the environment variable set to null.
return this.updateStack (cloudSiteId,
tenantId,
stackName,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
null,
null,
null);
}
public StackInfo updateStack (String cloudSiteId,
String tenantId,
String stackName,
String heatTemplate,
Map <String, Object> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment) throws MsoException {
// Keeping this method to allow compatibility with no environment variable sent. In this case,
// simply return the new method with the files variable set to null.
return this.updateStack (cloudSiteId,
tenantId,
stackName,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
environment,
null,
null);
}
public StackInfo updateStack (String cloudSiteId,
String tenantId,
String stackName,
String heatTemplate,
Map <String, Object> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment,
Map <String, Object> files) throws MsoException {
return this.updateStack (cloudSiteId,
tenantId,
stackName,
heatTemplate,
stackInputs,
pollForCompletion,
timeoutMinutes,
environment,
files,
null);
}
/**
* Update a Stack in the specified cloud location and tenant. The Heat template
* and parameter map are passed in as arguments, along with the cloud access credentials.
* It is expected that parameters have been validated and contain at minimum the required
* parameters for the given template with no extra (undefined) parameters..
*
* The Stack name supplied by the caller must be unique in the scope of this tenant.
* However, it should also be globally unique, as it will be the identifier for the
* resource going forward in Inventory. This latter is managed by the higher levels
* invoking this function.
*
* The caller may choose to let this function poll Openstack for completion of the
* stack creation, or may handle polling itself via separate calls to query the status.
* In either case, a StackInfo object will be returned containing the current status.
* When polling is enabled, a status of CREATED is expected. When not polling, a
* status of BUILDING is expected.
*
* An error will be thrown if the requested Stack already exists in the specified
* Tenant and Cloud.
*
* @param tenantId The Openstack ID of the tenant in which to create the Stack
* @param cloudSiteId The cloud identifier (may be a region) in which to create the tenant.
* @param stackName The name of the stack to update
* @param heatTemplate The Heat template
* @param stackInputs A map of key/value inputs
* @param pollForCompletion Indicator that polling should be handled in Java vs. in the client
* @param environment An optional yaml-format string to specify environmental parameters
* @param files a Map<String, Object> for listing child template IDs
* @param heatFiles a Map<String, Object> for listing get_file entries (fileName, fileBody)
* @return A StackInfo object
* @throws MsoException Thrown if the Openstack API call returns an exception.
*/
public StackInfo updateStack (String cloudSiteId,
String tenantId,
String stackName,
String heatTemplate,
Map <String, Object> stackInputs,
boolean pollForCompletion,
int timeoutMinutes,
String environment,
Map <String, Object> files,
Map <String, Object> heatFiles) throws MsoException {
boolean heatEnvtVariable = true;
if (environment == null || "".equalsIgnoreCase (environment.trim ())) {
heatEnvtVariable = false;
}
boolean haveFiles = true;
if (files == null || files.isEmpty ()) {
haveFiles = false;
}
boolean haveHeatFiles = true;
if (heatFiles == null || heatFiles.isEmpty ()) {
haveHeatFiles = false;
}
// Obtain the cloud site information where we will create the stack
CloudSite cloudSite = cloudConfig.getCloudSite(cloudSiteId).orElseThrow(
() -> new MsoCloudSiteNotFound(cloudSiteId));
// Get a Heat client. They are cached between calls (keyed by tenantId:cloudId)
// This could throw MsoTenantNotFound or MsoOpenstackException (both propagated)
Heat heatClient = getHeatClient (cloudSite, tenantId);
// Perform a query first to get the current status
Stack heatStack = queryHeatStack (heatClient, stackName);
if (heatStack == null || "DELETE_COMPLETE".equals (heatStack.getStackStatus ())) {
// Not found. Return a StackInfo with status NOTFOUND
throw new MsoStackNotFound (stackName, tenantId, cloudSiteId);
}
// Use canonical name "<stack name>/<stack-id>" to update the stack.
// Otherwise, update by name returns a 302 redirect.
// NOTE: This is specific to the v1 Orchestration API.
String canonicalName = heatStack.getStackName () + "/" + heatStack.getId ();
LOGGER.debug ("Ready to Update Stack (" + canonicalName + ") with input params: " + stackInputs);
//force entire stackInput object to generic Map<String, Object> for openstack compatibility
ObjectMapper mapper = new ObjectMapper();
Map<String, Object> normalized = new HashMap<>();
try {
normalized = mapper.readValue(mapper.writeValueAsString(stackInputs), new TypeReference<HashMap<String,Object>>() {});
} catch (IOException e1) {
LOGGER.debug("could not map json", e1);
}
// Build up the stack update parameters
// Disable auto-rollback, because error reason is lost. Always rollback in the code.
UpdateStackParam stack = new UpdateStackParam ();
stack.setTimeoutMinutes (timeoutMinutes);
stack.setParameters (normalized);
stack.setTemplate (heatTemplate);
stack.setDisableRollback (true);
// TJM add envt to stack
if (heatEnvtVariable) {
stack.setEnvironment (environment);
}
// Handle nested templates & get_files here. if we have both - must combine
// and then add to stack (both are part of "files:" being added to stack)
if (haveFiles && haveHeatFiles) {
// Let's do this here - not in the bean
LOGGER.debug ("Found files AND heatFiles - combine and add!");
Map <String, Object> combinedFiles = new HashMap<>();
for (String keyString : files.keySet ()) {
combinedFiles.put (keyString, files.get (keyString));
}
for (String keyString : heatFiles.keySet ()) {
combinedFiles.put (keyString, heatFiles.get (keyString));
}
stack.setFiles (combinedFiles);
} else {
// Handle case where we have one or neither
if (haveFiles) {
stack.setFiles (files);
}
if (haveHeatFiles) {
// setFiles method modified to handle adding a map.
stack.setFiles (heatFiles);
}
}
try {
// Execute the actual Openstack command to update the Heat stack
OpenStackRequest <Void> request = heatClient.getStacks ().update (canonicalName, stack);
executeAndRecordOpenstackRequest (request);
} catch (OpenStackBaseException e) {
// Since this came on the 'Update Stack' command, nothing was changed
// in the cloud. Rethrow the error as an MSO exception.
throw heatExceptionToMsoException (e, UPDATE_STACK);
} catch (RuntimeException e) {
// Catch-all
throw runtimeExceptionToMsoException (e, UPDATE_STACK);
}
// If client has requested a final response, poll for stack completion
Stack updateStack = null;
if (pollForCompletion) {
// Set a time limit on overall polling.
// Use the resource (template) timeout for Openstack (expressed in minutes)
// and add one poll interval to give Openstack a chance to fail on its own.
int createPollInterval = Integer.parseInt(this.environment.getProperty(createPollIntervalProp, createPollIntervalDefault));
int pollTimeout = (timeoutMinutes * 60) + createPollInterval;
boolean loopAgain = true;
while (loopAgain) {
try {
updateStack = queryHeatStack (heatClient, canonicalName);
LOGGER.debug (updateStack.getStackStatus () + " (" + canonicalName + ")");
try {
LOGGER.debug("Current stack " + this.getOutputsAsStringBuilderWithUpdate(heatStack).toString());
} catch (Exception e) {
LOGGER.debug("an error occurred trying to print out the current outputs of the stack", e);
}
if ("UPDATE_IN_PROGRESS".equals (updateStack.getStackStatus ())) {
// Stack update is still running.
// Sleep and try again unless timeout has been reached
if (pollTimeout <= 0) {
// Note that this should not occur, since there is a timeout specified
// in the Openstack call.
LOGGER.error (MessageEnum.RA_UPDATE_STACK_TIMEOUT, cloudSiteId, tenantId, stackName, updateStack.getStackStatus(), "", "", MsoLogger.ErrorCode.AvailabilityError, "Update stack timeout");
loopAgain = false;
} else {
try {
Thread.sleep (createPollInterval * 1000L);
} catch (InterruptedException e) {
// If we are interrupted, we should stop ASAP.
loopAgain = false;
// Set again the interrupted flag
Thread.currentThread().interrupt();
}
}
pollTimeout -= createPollInterval;
LOGGER.debug("pollTimeout remaining: " + pollTimeout);
} else {
loopAgain = false;
}
} catch (MsoException e) {
// Cannot query the stack. Something is wrong.
// TODO: No way to roll back the stack at this point. What to do?
e.addContext (UPDATE_STACK);
throw e;
}
}
if (!"UPDATE_COMPLETE".equals (updateStack.getStackStatus ())) {
LOGGER.error (MessageEnum.RA_UPDATE_STACK_ERR, updateStack.getStackStatus(), updateStack.getStackStatusReason(), "", "", MsoLogger.ErrorCode.DataError, "Update Stack error");
// TODO: No way to roll back the stack at this point. What to do?
// Throw a 'special case' of MsoOpenstackException to report the Heat status
MsoOpenstackException me = null;
if ("UPDATE_IN_PROGRESS".equals (updateStack.getStackStatus ())) {
me = new MsoOpenstackException (0, "", "Stack Update Timeout");
} else {
String error = "Stack error (" + updateStack.getStackStatus ()
+ "): "
+ updateStack.getStackStatusReason ();
me = new MsoOpenstackException (0, "", error);
}
me.addContext (UPDATE_STACK);
throw me;
}
} else {
// Return the current status.
updateStack = queryHeatStack (heatClient, canonicalName);
if (updateStack != null) {
LOGGER.debug ("UpdateStack, status = " + updateStack.getStackStatus ());
} else {
LOGGER.debug ("UpdateStack, stack not found");
}
}
return new StackInfoMapper(updateStack).map();
}
private StringBuilder getOutputsAsStringBuilderWithUpdate(Stack heatStack) {
// This should only be used as a utility to print out the stack outputs
// to the log
StringBuilder sb = new StringBuilder("");
if (heatStack == null) {
sb.append("(heatStack is null)");
return sb;
}
List<Output> outputList = heatStack.getOutputs();
if (outputList == null || outputList.isEmpty()) {
sb.append("(outputs is empty)");
return sb;
}
Map<String, Object> outputs = new HashMap<>();
for (Output outputItem : outputList) {
outputs.put(outputItem.getOutputKey(), outputItem.getOutputValue());
}
int counter = 0;
sb.append("OUTPUTS:\n");
for (String key : outputs.keySet()) {
sb.append("outputs[").append(counter++).append("]: ").append(key).append("=");
Object obj = outputs.get(key);
if (obj instanceof String) {
sb.append((String) obj).append(" (a string)");
} else if (obj instanceof JsonNode) {
sb.append(this.convertNodeWithUpdate((JsonNode) obj)).append(" (a JsonNode)");
} else if (obj instanceof java.util.LinkedHashMap) {
try {
String str = JSON_MAPPER.writeValueAsString(obj);
sb.append(str).append(" (a java.util.LinkedHashMap)");
} catch (Exception e) {
LOGGER.debug("Exception :", e);
sb.append("(a LinkedHashMap value that would not convert nicely)");
}
} else if (obj instanceof Integer) {
String str = "";
try {
str = obj.toString() + " (an Integer)\n";
} catch (Exception e) {
LOGGER.debug("Exception :", e);
str = "(an Integer unable to call .toString() on)";
}
sb.append(str);
} else if (obj instanceof ArrayList) {
String str = "";
try {
str = obj.toString() + " (an ArrayList)";
} catch (Exception e) {
LOGGER.debug("Exception :", e);
str = "(an ArrayList unable to call .toString() on?)";
}
sb.append(str);
} else if (obj instanceof Boolean) {
String str = "";
try {
str = obj.toString() + " (a Boolean)";
} catch (Exception e) {
LOGGER.debug("Exception :", e);
str = "(an Boolean unable to call .toString() on?)";
}
sb.append(str);
}
else {
String str = "";
try {
str = obj.toString() + " (unknown Object type)";
} catch (Exception e) {
LOGGER.debug("Exception :", e);
str = "(a value unable to call .toString() on?)";
}
sb.append(str);
}
sb.append("\n");
}
sb.append("[END]");
return sb;
}
private String convertNodeWithUpdate(final JsonNode node) {
try {
final Object obj = JSON_MAPPER.treeToValue(node, Object.class);
final String json = JSON_MAPPER.writeValueAsString(obj);
return json;
} catch (Exception e) {
LOGGER.debug("Error converting json to string " + e.getMessage(), e);
}
return "[Error converting json to string]";
}
}
|