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
|
package org.openecomp.sdc.validation.util;
import org.apache.commons.collections4.CollectionUtils;
import org.openecomp.core.utilities.json.JsonUtil;
import org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder;
import org.openecomp.core.validation.types.GlobalValidationContext;
import org.openecomp.sdc.common.errors.Messages;
import org.openecomp.sdc.common.utils.SdcCommon;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
import org.openecomp.sdc.heat.datatypes.manifest.ManifestContent;
import org.openecomp.sdc.heat.datatypes.model.Environment;
import org.openecomp.sdc.heat.datatypes.model.HeatOrchestrationTemplate;
import org.openecomp.sdc.heat.datatypes.model.HeatResourcesTypes;
import org.openecomp.sdc.heat.datatypes.model.Resource;
import org.openecomp.sdc.heat.datatypes.model.ResourceReferenceFunctions;
import org.openecomp.sdc.heat.services.HeatStructureUtil;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.logging.context.impl.MdcDataDebugMessage;
import org.openecomp.sdc.logging.context.impl.MdcDataErrorMessage;
import org.openecomp.sdc.logging.types.LoggerConstants;
import org.openecomp.sdc.logging.types.LoggerErrorCode;
import org.openecomp.sdc.logging.types.LoggerErrorDescription;
import org.openecomp.sdc.logging.types.LoggerTragetServiceName;
import org.openecomp.sdc.tosca.services.YamlUtil;
import java.io.InputStream;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Pattern;
import static java.util.Objects.nonNull;
public class ValidationUtil {
private static MdcDataDebugMessage mdcDataDebugMessage = new MdcDataDebugMessage();
private final static Logger log = (Logger) LoggerFactory.getLogger(ValidationUtil.class.getName());
public static void removeExposedResourcesCalledByGetResource(String fileName,
Set<String> actualExposedResources,
HeatOrchestrationTemplate
heatOrchestrationTemplate,
GlobalValidationContext globalContext) {
Map<String, Resource> resourcesMap = heatOrchestrationTemplate.getResources();
for (Map.Entry<String, Resource> resourceEntry : resourcesMap.entrySet()) {
Set<String> referencedResources =
HeatStructureUtil.getReferencedValuesByFunctionName(fileName, ResourceReferenceFunctions
.GET_RESOURCE
.getFunction(), resourceEntry.getValue().getProperties(), globalContext);
removeExposedResourcesCalledByGetResource(referencedResources, actualExposedResources,
resourcesMap);
}
}
private static void removeExposedResourcesCalledByGetResource(Set<String> referencedResources,
Set<String>
actualExposedResources,
Map<String, Resource> resourcesMap) {
for (String referencedResourceName : referencedResources) {
Resource currResource = resourcesMap.get(referencedResourceName);
if (Objects.nonNull(currResource)) {
if (isExpectedToBeExposed(currResource.getType())) {
actualExposedResources.add(referencedResourceName);
}
}
}
}
public static boolean isExpectedToBeExposed(String type) {
return HeatResourcesTypes.isResourceExpectedToBeExposed(type);
}
public static String getWantedNameFromPropertyValueGetParam(Object value) {
Set<String> paramName = HeatStructureUtil
.getReferencedValuesByFunctionName(null, ResourceReferenceFunctions.GET_PARAM.getFunction(),
value, null);
if (paramName != null && CollectionUtils.isNotEmpty(paramName)) {
return (String) paramName.toArray()[0];
}
return null;
}
public static boolean evalPattern(Object paramVal, String[] regexList) {
String value = "";
if (paramVal instanceof String) {
value = ((String) paramVal);
}
if (paramVal instanceof Integer) {
value = paramVal.toString();
}
return evalPattern(value, regexList);
}
private static boolean evalPattern(String paramVal, String[] regexList) {
for (String regex : regexList) {
if (Pattern.matches(regex, paramVal)) {
return true;
}
}
return false;
}
public static String getMessagePartAccordingToResourceType(Map.Entry<String, Resource>
resourceEntry) {
HeatResourcesTypes resourcesType =
HeatResourcesTypes.findByHeatResource(resourceEntry.getValue().getType());
if (resourcesType == HeatResourcesTypes.NOVA_SERVER_RESOURCE_TYPE) {
return "Server";
} else if (resourcesType == HeatResourcesTypes.CONTRAIL_SERVICE_TEMPLATE) {
return "Service Template";
} else if (resourcesType == HeatResourcesTypes.CONTRAIL_SERVICE_INSTANCE) {
return "Service Instance";
} else {
return "";
}
}
public static Environment validateEnvContent(String envFileName,
GlobalValidationContext globalContext) {
mdcDataDebugMessage.debugEntryMessage("file", envFileName);
Environment envContent;
try {
Optional<InputStream> fileContent = globalContext.getFileContent(envFileName);
if (fileContent.isPresent()) {
envContent = new YamlUtil().yamlToObject(fileContent.get(), Environment.class);
} else {
MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_API,
LoggerTragetServiceName.VALIDATE_ENV_FILE, ErrorLevel.ERROR.name(),
LoggerErrorCode.DATA_ERROR.getErrorCode(), LoggerErrorDescription.EMPTY_FILE);
throw new Exception("The file '" + envFileName + "' has no content");
}
} catch (Exception exception) {
log.debug("",exception);
mdcDataDebugMessage.debugExitMessage("file", envFileName);
return null;
}
mdcDataDebugMessage.debugExitMessage("file", envFileName);
return envContent;
}
public static boolean validateMapPropertyValue(String fileName,
Map.Entry<String, Resource> resourceEntry,
GlobalValidationContext globalContext,
String propertyName, Object nameValue,
String[] regexList) {
mdcDataDebugMessage.debugEntryMessage("file", fileName);
String propertyValue = getWantedNameFromPropertyValueGetParam(nameValue);
if (nonNull(propertyValue)) {
if (!evalPattern(propertyValue, regexList)) {
globalContext.addMessage(
fileName,
ErrorLevel.WARNING,
ErrorMessagesFormatBuilder.getErrorWithParameters(globalContext.getMessageCode(),
Messages.PARAMETER_NAME_NOT_ALIGNED_WITH_GUIDELINES.getErrorMessage(),
getMessagePartAccordingToResourceType(resourceEntry), propertyName, propertyValue,
resourceEntry.getKey()),
LoggerTragetServiceName.VALIDATE_IMAGE_AND_FLAVOR_NAME,
LoggerErrorDescription.NAME_NOT_ALIGNED_WITH_GUIDELINES);
mdcDataDebugMessage.debugExitMessage("file", fileName);
return true;
}
}
mdcDataDebugMessage.debugExitMessage("file", fileName);
return false;
}
public static ManifestContent checkValidationPreCondition(GlobalValidationContext globalContext) {
Optional<InputStream> manifest = globalContext.getFileContent(SdcCommon.MANIFEST_NAME);
if (!manifest.isPresent()) {
MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_API,
LoggerTragetServiceName.VALIDATE_MANIFEST_CONTENT, ErrorLevel.ERROR.name(),
LoggerErrorCode.DATA_ERROR.getErrorCode(), LoggerErrorDescription.MISSING_FILE);
throw new RuntimeException("Can't load manifest file for Heat Validator");
}
ManifestContent manifestContent;
try {
manifestContent = JsonUtil.json2Object(manifest.get(), ManifestContent.class);
} catch (Exception exception) {
log.debug("",exception);
MdcDataErrorMessage.createErrorMessageAndUpdateMdc(LoggerConstants.TARGET_ENTITY_API,
LoggerTragetServiceName.VALIDATE_MANIFEST_CONTENT, ErrorLevel.ERROR.name(),
LoggerErrorCode.DATA_ERROR.getErrorCode(), LoggerErrorDescription.INVALID_MANIFEST);
throw new RuntimeException("Can't load manifest file for Heat Validator");
}
return manifestContent;
}
public static String getParserExceptionReason(Exception exception) {
String reason;
if (exception.getCause() != null && exception.getCause().getCause() != null) {
reason = exception.getCause().getCause().getMessage();
} else if (exception.getCause() != null) {
reason = exception.getCause().getMessage();
} else {
reason = Messages.GENERAL_HEAT_PARSER_ERROR.getErrorMessage();
}
return reason;
}
public static HeatOrchestrationTemplate checkHeatOrchestrationPreCondition(String fileName,
GlobalValidationContext globalContext) {
mdcDataDebugMessage.debugEntryMessage("file", fileName);
HeatOrchestrationTemplate heatOrchestrationTemplate;
try {
Optional<InputStream> fileContent = globalContext.getFileContent(fileName);
if (fileContent.isPresent()) {
heatOrchestrationTemplate =
new YamlUtil().yamlToObject(fileContent.get(), HeatOrchestrationTemplate.class);
} else {
heatOrchestrationTemplate = null;
}
} catch (Exception exception) {
globalContext.addMessage(fileName, ErrorLevel.ERROR, ErrorMessagesFormatBuilder
.getErrorWithParameters(globalContext.getMessageCode(),
Messages.INVALID_HEAT_FORMAT_REASON.getErrorMessage()
, getParserExceptionReason(exception)),
LoggerTragetServiceName.VALIDATE_HEAT_FORMAT,
LoggerErrorDescription.INVALID_HEAT_FORMAT);
mdcDataDebugMessage.debugExitMessage("file", fileName);
return null;
}
mdcDataDebugMessage.debugExitMessage("file", fileName);
return heatOrchestrationTemplate;
}
}
|
