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
|
/*-
* ============LICENSE_START=======================================================
* sdc-distribution-client
* ================================================================================
* 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.onap.sdc.utils.heat;
import java.util.Map;
import org.onap.sdc.utils.YamlToObjectConverter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HeatParser {
private static Logger log = LoggerFactory.getLogger(HeatParser.class.getName());
/**
* Parses and returns the contents of the "parameters" section of YAML-formatted HEAT template.
*
* @param heatFileContents - the string contents of HEAT template
* @return map of parameter name to HeatParameter object.
* For the following YAML snippet:
* <b>parameters:
* image_name_1:
* type: string
* label: Image Name
* description: SCOIMAGE Specify an image name for instance1
* default: cirros-0.3.1-x86_64
* </b>
* the map with one entry will be returned, the key will be "image_name_1".
* For a HeatParameter object, getConstraints() returns the list of all constraints,
* regardless of constraint type.
* For that reason, for each constraint type a sugaring function were added on the HeatParameter type,
* for example getLengthConstraint(). A correct way to fetch the "length" constraint values map would be
* parameter.getLengthConstraint().getLength(). Same logic was implemented for all other constraint types.
*
* In case of parse error, null will be returned.
*
*/
public Map<String, HeatParameter> getHeatParameters(String heatFileContents){
log.debug("Start of extracting HEAT parameters from file, file contents: {}", heatFileContents);
Map<String, HeatParameter> heatParameters = null;
YamlToObjectConverter yamlToObjectConverter = new YamlToObjectConverter();
HeatConfiguration heatConfiguration = yamlToObjectConverter.convertFromString(heatFileContents, HeatConfiguration.class);
if (heatConfiguration != null){
heatParameters = heatConfiguration.getParameters();
} else {
log.error("Couldn't parse HEAT template.");
}
if (heatParameters != null && heatParameters.size() > 0){
System.out.println("Found HEAT parameters: "+heatParameters.toString());
log.debug("Found HEAT parameters: {}", heatParameters.toString());
} else {
log.warn("HEAT template parameters section wasn't found or is empty.");
}
return heatParameters;
}
}
|
