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
|
/*
* Copyright © 2016-2018 European Support Limited
*
* 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.
*/
package org.openecomp.sdc.tosca.services.impl;
import org.apache.commons.io.FilenameUtils;
import org.onap.sdc.tosca.parser.config.ConfigurationManager;
import org.onap.sdc.tosca.parser.exceptions.SdcToscaParserException;
import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory;
import org.onap.sdc.toscaparser.api.common.JToscaValidationIssue;
import org.openecomp.core.utilities.file.FileContentHandler;
import org.openecomp.core.utilities.file.FileUtils;
import org.openecomp.core.utilities.orchestration.OnboardingTypesEnum;
import org.openecomp.core.validation.ErrorMessageCode;
import org.openecomp.core.validation.errors.ErrorMessagesFormatBuilder;
import org.openecomp.sdc.datatypes.error.ErrorLevel;
import org.openecomp.sdc.datatypes.error.ErrorMessage;
import org.openecomp.sdc.logging.api.Logger;
import org.openecomp.sdc.logging.api.LoggerFactory;
import org.openecomp.sdc.tosca.services.ToscaValidationService;
import org.yaml.snakeyaml.Yaml;
import java.nio.file.Files;
import java.nio.file.Path;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
public class ToscaValidationServiceImpl implements ToscaValidationService {
private static final Logger LOGGER = LoggerFactory.getLogger(ToscaValidationServiceImpl.class);
private static final String SDCPARSER_JTOSCA_VALIDATIONISSUE_CONFIG =
"SDCParser_jtosca-validation-issue-configuration.yaml";
private static final String SDCPARSER_ERROR_CONFIG = "SDCParser_error-configuration.yaml";
private static final String TOSCA_DEFINITION_VERSION = "tosca_definitions_version";
static {
// Override default SDC Parser configuration
ConfigurationManager configurationManager = ConfigurationManager.getInstance();
configurationManager.setJtoscaValidationIssueConfiguration(SDCPARSER_JTOSCA_VALIDATIONISSUE_CONFIG);
configurationManager.setErrorConfiguration(SDCPARSER_ERROR_CONFIG);
SdcToscaParserFactory.setConfigurationManager(configurationManager);
}
@Override
public Map<String, List<ErrorMessage>> validate(FileContentHandler fileContentHandler)
throws IOException {
Path dir =
Files.createTempDirectory(OnboardingTypesEnum.CSAR + "_" + System.currentTimeMillis());
try {
// Write temporary files and folders to File System
Map<String, String> filePaths = FileUtils.writeFilesFromFileContentHandler
(fileContentHandler, dir);
// Process Tosca Yaml validation
return processToscaYamls(filePaths);
} finally {
// Cleanup temporary files and folders from file system
org.apache.commons.io.FileUtils.deleteDirectory(dir.toFile());
}
}
private Map<String, List<ErrorMessage>> processToscaYamls(Map<String, String> filePaths) {
Map<String, String> validFilePaths = getValidFilePaths(filePaths);
Map<String, List<ErrorMessage>> validationIssues = new HashMap<>();
// Process Yaml Files
for (Map.Entry<String, String> fileEntry : validFilePaths.entrySet()) {
try {
SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();
factory.getSdcCsarHelper(fileEntry.getValue());
processValidationIssues(fileEntry.getKey(), factory, validationIssues);
} catch (SdcToscaParserException stpe) {
LOGGER.error("SDC Parser Exception from SDC Parser Library : " + stpe);
ErrorMessage.ErrorMessageUtil.addMessage(fileEntry.getKey(), validationIssues).add(
new ErrorMessage(ErrorLevel.ERROR, ErrorMessagesFormatBuilder
.getErrorWithParameters(new ErrorMessageCode("JE000"), "Unexpected Error "
+ "occurred")));
}
catch (RuntimeException rte) {
LOGGER.error("Runtime Exception from SDC Parser Library : " + rte);
ErrorMessage.ErrorMessageUtil.addMessage(fileEntry.getKey(), validationIssues).add(
new ErrorMessage(ErrorLevel.ERROR, ErrorMessagesFormatBuilder
.getErrorWithParameters(new ErrorMessageCode("JE000"), "Unexpected Error "
+ "occurred")));
}
}
return validationIssues;
}
private Map<String, String> getValidFilePaths(Map<String, String> filePaths) {
return filePaths.entrySet()
.stream()
.filter(map -> FileUtils.isValidYamlExtension(FilenameUtils.getExtension(map.getKey()))
&& isToscaYaml(map.getValue()))
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
}
private boolean isToscaYaml(String filePath) {
boolean retValue = false;
try (InputStream input = new BufferedInputStream(new FileInputStream(new File(filePath)));) {
Yaml yaml = new Yaml();
LinkedHashMap<String,Object> data = (LinkedHashMap) yaml.load(input);
if(data.get(TOSCA_DEFINITION_VERSION) != null) {
retValue = true;
}
}
catch(Exception e){
LOGGER.info("Ignore the exception as the input file may not be a Tosca Yaml; let the " +
"default value return", e);
}
return retValue;
}
private void processValidationIssues(String fileName, SdcToscaParserFactory factory, Map<String,
List<ErrorMessage>> validationIssues) {
List<JToscaValidationIssue> criticalsReport = factory.getCriticalExceptions();
criticalsReport.stream().forEach(err ->
ErrorMessage.ErrorMessageUtil.addMessage(fileName, validationIssues).add(
new ErrorMessage(ErrorLevel.ERROR, ErrorMessagesFormatBuilder
.getErrorWithParameters(new ErrorMessageCode(err.getCode()), err.getMessage()))));
List<JToscaValidationIssue> warningsReport = factory.getWarningExceptions();
warningsReport.stream().forEach(err ->
ErrorMessage.ErrorMessageUtil.addMessage(fileName, validationIssues).add(
new ErrorMessage(ErrorLevel.WARNING, ErrorMessagesFormatBuilder
.getErrorWithParameters(new ErrorMessageCode(err.getCode()), err.getMessage()))));
List<JToscaValidationIssue> notAnalyzedReport = factory.getNotAnalyzadExceptions();
notAnalyzedReport.stream().forEach(err ->
ErrorMessage.ErrorMessageUtil.addMessage(fileName, validationIssues).add(
new ErrorMessage(ErrorLevel.WARNING, ErrorMessagesFormatBuilder
.getErrorWithParameters(new ErrorMessageCode(err.getCode()), err.getMessage()))));
}
}
|
