-
Notifications
You must be signed in to change notification settings - Fork 42
/
RdfUnitJunitRunner.java
256 lines (223 loc) · 9.55 KB
/
RdfUnitJunitRunner.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
245
246
247
248
249
250
251
252
253
254
package org.aksw.rdfunit.junit;
import org.aksw.rdfunit.io.reader.RdfModelReader;
import org.aksw.rdfunit.io.reader.RdfReader;
import org.aksw.rdfunit.io.reader.RdfReaderException;
import org.aksw.rdfunit.io.reader.RdfReaderFactory;
import org.aksw.rdfunit.model.interfaces.TestCase;
import org.aksw.rdfunit.sources.SchemaSource;
import org.aksw.rdfunit.sources.SchemaSourceFactory;
import org.aksw.rdfunit.validate.wrappers.RDFUnitTestSuiteGenerator;
import org.apache.jena.rdf.model.ModelFactory;
import org.junit.Ignore;
import org.junit.runner.Description;
import org.junit.runner.notification.RunNotifier;
import org.junit.runners.ParentRunner;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.InitializationError;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import static org.aksw.rdfunit.junit.InitializationSupport.checkNotNull;
/**
* <p>RdfUnitJunitRunner class.</p>
*
* @author Michael Leuthold
* @version $Id: $Id
*/
public class RdfUnitJunitRunner extends ParentRunner<RdfUnitJunitTestCase> {
/**
* Constant <code>INPUT_DATA_RETURN_TYPE</code>
*/
public static final Class<?> INPUT_DATA_RETURN_TYPE = RdfReader.class;
private final List<RdfUnitJunitTestCase> testCases = new ArrayList<>();
private final RdfUnitJunitStatusTestExecutor rdfUnitJunitStatusTestExecutor = new RdfUnitJunitStatusTestExecutor();
private RdfReader additionalData = new RdfModelReader(ModelFactory.createDefaultModel());
private RdfReader schemaReader;
private Object testCaseInstance;
/**
* <p>Constructor for RdfUnitJunitRunner.</p>
*
* @param testClass a {@link java.lang.Class} object.
* @throws org.junit.runners.model.InitializationError if any.
*/
public RdfUnitJunitRunner(Class<?> testClass) throws InitializationError {
super(testClass);
setUpSchemaReader();
setAdditionalData();
generateRdfUnitTestCases();
}
/** {@inheritDoc} */
@Override
protected void collectInitializationErrors(List<Throwable> errors) {
super.collectInitializationErrors(errors);
verifySchemaAnnotation(errors);
verifyTestInputAnnotatedMethods(errors);
verifyAtMostOneAdditionalDataMethodWithMatchingReturnType(errors);
}
private void verifySchemaAnnotation(List<Throwable> errors) {
if (!getTestClass().getJavaClass().isAnnotationPresent(Schema.class)) {
errors.add(new Exception(
String.format(
"@%s annotation is required!",
Schema.class.getSimpleName())));
}
}
private void verifyTestInputAnnotatedMethods(List<Throwable> errors) {
List<FrameworkMethod> testInputMethods = getTestInputMethods();
if (testInputMethods.isEmpty()) {
errors.add(new Exception(String.format(
"At least one method with @%s annotation is required!",
TestInput.class.getSimpleName()
)));
}
for (FrameworkMethod m : testInputMethods) {
if (!m.getReturnType().equals(INPUT_DATA_RETURN_TYPE)) {
errors.add(new Exception(String.format(
"Method %s marked @%s must return %s",
m.getName(),
TestInput.class.getSimpleName(),
INPUT_DATA_RETURN_TYPE.getCanonicalName()
)));
}
}
}
private void verifyAtMostOneAdditionalDataMethodWithMatchingReturnType(List<Throwable> errors) {
final List<FrameworkMethod> additionalDataAnnotatedMethods = getTestClass().getAnnotatedMethods
(AdditionalData.class);
if (additionalDataAnnotatedMethods.isEmpty()) {
return;
}
if (additionalDataAnnotatedMethods.size() > 1) {
errors.add(new Exception(
String.format(
"At most one method annotated with @%s allowed!",
AdditionalData.class.getSimpleName()
)
)
);
}
for (FrameworkMethod additionalDataMethod : additionalDataAnnotatedMethods) {
if (!additionalDataMethod.getReturnType().equals(INPUT_DATA_RETURN_TYPE)) {
errors.add(
new Exception(
String.format(
"Method %s annotated with @%s must return a %s!",
additionalDataMethod.getName(),
AdditionalData.class.getSimpleName(),
INPUT_DATA_RETURN_TYPE.getCanonicalName()
)
)
);
}
}
}
private List<FrameworkMethod> getTestInputMethods() {
return getTestClass().getAnnotatedMethods(TestInput.class);
}
private void generateRdfUnitTestCases() throws InitializationError {
final SchemaSource schemaSource = createSchemaSourceFromSchema();
final Object testCaseInstance = getTestCaseInstance();
final Collection<TestCase> testCases = createTestCases();
for (FrameworkMethod testInputMethod : getTestInputMethods()) {
final RdfUnitJunitTestCaseDataProvider rdfUnitJunitTestCaseDataProvider = new
RdfUnitJunitTestCaseDataProvider(testInputMethod, testCaseInstance, schemaSource,
additionalData);
for (TestCase t : testCases) {
this.testCases.add(new RdfUnitJunitTestCase(t, rdfUnitJunitTestCaseDataProvider));
}
}
}
private void setUpSchemaReader() throws InitializationError {
try {
schemaReader = new RdfModelReader(RdfReaderFactory.createResourceOrFileOrDereferenceReader(getSchema().uri()).read());
} catch (RdfReaderException e) {
throw new InitializationError(e);
}
}
private synchronized Object getTestCaseInstance() throws InitializationError {
if (testCaseInstance == null) {
try {
testCaseInstance = getTestClass().getJavaClass().newInstance();
} catch (InstantiationException | IllegalAccessException e) {
throw new InitializationError(e);
}
}
return testCaseInstance;
}
private void setAdditionalData() throws InitializationError {
try {
final List<FrameworkMethod> annotatedMethods = getTestClass().getAnnotatedMethods(AdditionalData.class);
if (annotatedMethods.isEmpty()) {
return;
}
final FrameworkMethod additionalDataMethod = annotatedMethods.get(0);
additionalData =
checkNotNull(
(RdfReader) additionalDataMethod.invokeExplosively(getTestCaseInstance()),
"Method %s annotated with @%s returned null!",
additionalDataMethod.getMethod().getName(),
AdditionalData.class.getSimpleName()
);
} catch (Throwable e) {
throw new InitializationError(e);
}
}
private SchemaSource createSchemaSourceFromSchema() throws InitializationError {
return SchemaSourceFactory.createSchemaSourceSimple(getSchema().uri(), getSchemaReader());
}
private Collection<TestCase> createTestCases() throws InitializationError {
return new RDFUnitTestSuiteGenerator.Builder()
.addSchemaURI("custom", getSchema().uri(), getSchemaReader())
.enableAutotests()
.build().getTestSuite().getTestCases();
}
private RdfReader getSchemaReader() {
return schemaReader;
}
private Schema getSchema() throws InitializationError {
Schema schema = getTestClass().getAnnotation(Schema.class);
if (schema == null) {
throw new InitializationError("Cannot read Schema");
}
return schema;
}
RdfReader getAdditionalDataModel() {
return additionalData;
}
/** {@inheritDoc} */
@Override
protected List<RdfUnitJunitTestCase> getChildren() {
return Collections.unmodifiableList(testCases);
}
/** {@inheritDoc} */
@Override
protected Description describeChild(RdfUnitJunitTestCase child) {
return Description.createTestDescription(
child.getTestInputMethod().getDeclaringClass(),
String.format(
"[%s] %s",
getTestInputBaseName(child.getTestInputMethod()),
child.getTestCase().getAbrTestURI()
)
);
}
private String getTestInputBaseName(FrameworkMethod method) {
final String basename = method.getAnnotation(TestInput.class).name();
return basename.isEmpty() ? method.getName() : basename;
}
/** {@inheritDoc} */
@Override
protected boolean isIgnored(RdfUnitJunitTestCase child) {
return child.getTestInputMethod().getAnnotation(Ignore.class) != null;
}
/** {@inheritDoc} */
@Override
protected void runChild(final RdfUnitJunitTestCase child, RunNotifier notifier) {
if(isIgnored(child)) {
notifier.fireTestIgnored(describeChild(child));
} else {
this.runLeaf(new ShaclResultStatement(rdfUnitJunitStatusTestExecutor, child), describeChild(child), notifier);
}
}
}