/
DefaultValidator.java
244 lines (207 loc) · 6.84 KB
/
DefaultValidator.java
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
/*
* Copyright 2021-2022 the original author or authors.
*
* 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
*
* https://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.opentest4j.reporting.tooling.validator;
import org.opentest4j.reporting.schema.Namespace;
import org.opentest4j.reporting.tooling.converter.Converter;
import org.w3c.dom.ls.LSInput;
import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import javax.xml.catalog.CatalogFeatures;
import javax.xml.catalog.CatalogFeatures.Feature;
import javax.xml.catalog.CatalogResolver;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.SchemaFactory;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import static java.util.Objects.requireNonNull;
import static javax.xml.XMLConstants.W3C_XML_SCHEMA_NS_URI;
import static javax.xml.catalog.CatalogManager.catalogResolver;
import static org.opentest4j.reporting.tooling.validator.Severity.ERROR;
import static org.opentest4j.reporting.tooling.validator.Severity.WARNING;
/**
* Default implementation of {@link Validator}.
*/
public class DefaultValidator implements Validator {
private static final Map<Namespace, String> SCHEMAS = Map.of( //
Namespace.REPORTING_EVENTS, "/org/opentest4j/reporting/schema/events.xsd", //
Namespace.REPORTING_HIERARCHY, "/org/opentest4j/reporting/schema/hierarchy.xsd", //
Namespace.REPORTING_CORE, "/org/opentest4j/reporting/schema/core.xsd", //
Namespace.REPORTING_JAVA, "/org/opentest4j/reporting/schema/java.xsd");
private final SchemaFactory schemaFactory = SchemaFactory.newInstance(W3C_XML_SCHEMA_NS_URI);
private final CatalogResolver catalogResolver;
/**
* Create a new instance.
*
* @param catalogs for resolving references to XML schemas
*/
public DefaultValidator(URI... catalogs) {
var features = CatalogFeatures.builder().with(Feature.RESOLVE, "continue").build();
this.catalogResolver = catalogResolver(features, catalogs);
}
@Override
public ValidationResult validate(Path xmlFile) {
try (var in = Files.newInputStream(xmlFile)) {
return validateSafely(xmlFile, new StreamSource(in));
}
catch (Exception e) {
throw new RuntimeException("Failure during validation: " + xmlFile, e);
}
}
private ValidationResult validateSafely(Path xmlFile, Source source) throws SAXException, IOException {
var errorHandler = new CollectingErrorHandler(xmlFile);
validate(source, errorHandler);
return errorHandler.toValidationResult();
}
private void validate(Source source, ErrorHandler errorHandler) throws SAXException, IOException {
var validator = schemaFactory.newSchema().newValidator();
validator.setResourceResolver(createResourceResolver());
validator.setErrorHandler(errorHandler);
validator.validate(source);
}
private LSResourceResolver createResourceResolver() {
return (type, namespaceURI, publicId, systemId, baseURI) -> {
if (namespaceURI != null) {
var namespace = Namespace.of(namespaceURI);
if (SCHEMAS.containsKey(namespace)) {
LSInputImpl input = new LSInputImpl();
input.setPublicId(publicId);
var schema = SCHEMAS.get(namespace);
input.setSystemId(requireNonNull(Namespace.class.getResource(schema)).toExternalForm());
input.setBaseURI(baseURI);
var stream = Namespace.class.getResourceAsStream(schema);
input.setCharacterStream(new InputStreamReader(requireNonNull(stream)));
return input;
}
}
if (systemId != null) {
return catalogResolver.resolveResource(type, namespaceURI, publicId, systemId, baseURI);
}
return null;
};
}
static class LSInputImpl implements LSInput {
private Reader characterStream;
private InputStream byteStream;
private String stringData;
private String systemId;
private String publicId;
private String baseURI;
private String encoding;
private boolean certifiedText;
@Override
public Reader getCharacterStream() {
return characterStream;
}
@Override
public void setCharacterStream(Reader characterStream) {
this.characterStream = characterStream;
}
@Override
public InputStream getByteStream() {
return byteStream;
}
@Override
public void setByteStream(InputStream byteStream) {
this.byteStream = byteStream;
}
@Override
public String getStringData() {
return stringData;
}
@Override
public void setStringData(String stringData) {
this.stringData = stringData;
}
@Override
public String getSystemId() {
return systemId;
}
@Override
public void setSystemId(String systemId) {
this.systemId = systemId;
}
@Override
public String getPublicId() {
return publicId;
}
@Override
public void setPublicId(String publicId) {
this.publicId = publicId;
}
@Override
public String getBaseURI() {
return baseURI;
}
@Override
public void setBaseURI(String baseURI) {
this.baseURI = baseURI;
}
@Override
public String getEncoding() {
return encoding;
}
@Override
public void setEncoding(String encoding) {
this.encoding = encoding;
}
@Override
public boolean getCertifiedText() {
return certifiedText;
}
@Override
public void setCertifiedText(boolean certifiedText) {
this.certifiedText = certifiedText;
}
}
private static class CollectingErrorHandler implements ErrorHandler {
private final Path xmlFile;
private final List<ValidationMessage> messages = new ArrayList<>();
public CollectingErrorHandler(Path xmlFile) {
this.xmlFile = xmlFile;
}
@Override
public void warning(SAXParseException e) {
addValidationMessage(WARNING, e);
}
@Override
public void error(SAXParseException e) {
addValidationMessage(ERROR, e);
}
private void addValidationMessage(Severity severity, SAXParseException e) {
var path = e.getSystemId() == null ? xmlFile.toString() : e.getSystemId();
var location = new Location(path, e.getLineNumber(), e.getColumnNumber());
messages.add(new ValidationMessage(severity, location, e.getMessage()));
}
@Override
public void fatalError(SAXParseException e) throws SAXParseException {
throw e;
}
public ValidationResult toValidationResult() {
return new ValidationResult(messages);
}
}
}