-
Notifications
You must be signed in to change notification settings - Fork 2
/
ObjectGraphTraverserTest.java
351 lines (304 loc) · 15.5 KB
/
ObjectGraphTraverserTest.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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/**
* Copyright (C) 2022 Czech Technical University in Prague
* <p>
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
* version.
* <p>
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details. You should have received a copy of the GNU General Public License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*/
package cz.cvut.kbss.jsonld.serialization.traversal;
import cz.cvut.kbss.jopa.model.annotations.Id;
import cz.cvut.kbss.jopa.model.annotations.OWLClass;
import cz.cvut.kbss.jopa.model.annotations.OWLObjectProperty;
import cz.cvut.kbss.jopa.model.annotations.Types;
import cz.cvut.kbss.jopa.vocabulary.OWL;
import cz.cvut.kbss.jopa.vocabulary.RDFS;
import cz.cvut.kbss.jsonld.JsonLd;
import cz.cvut.kbss.jsonld.annotation.JsonLdAttributeOrder;
import cz.cvut.kbss.jsonld.environment.Generator;
import cz.cvut.kbss.jsonld.environment.Vocabulary;
import cz.cvut.kbss.jsonld.environment.model.*;
import cz.cvut.kbss.jsonld.exception.MissingIdentifierException;
import cz.cvut.kbss.jsonld.exception.MissingTypeInfoException;
import cz.cvut.kbss.jsonld.serialization.context.DummyJsonLdContext;
import org.hamcrest.core.StringStartsWith;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.ArgumentCaptor;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import java.lang.reflect.Field;
import java.net.URI;
import java.util.*;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;
@ExtendWith(MockitoExtension.class)
class ObjectGraphTraverserTest {
@Mock
private InstanceVisitor visitor;
private ObjectGraphTraverser traverser;
@BeforeEach
void setUp() {
this.traverser = new ObjectGraphTraverser(new SerializationContextFactory(DummyJsonLdContext.INSTANCE));
traverser.setVisitor(visitor);
when(visitor.visitObject(any())).thenReturn(true);
}
@Test
void traverseVisitsSerializableFieldsOfInstanceWithDataPropertiesOnly() throws Exception {
final User user = Generator.generateUser();
traverser.traverse(user);
final InOrder inOrder = inOrder(visitor);
// Verify that openInstance was called before visitAttribute
inOrder.verify(visitor).openObject(ctx(null, null, user));
inOrder.verify(visitor, atLeastOnce()).visitAttribute(any(SerializationContext.class));
inOrder.verify(visitor).closeObject(ctx(null, null, user));
verifyUserFieldsVisited(user);
}
private static <T> SerializationContext<T> ctx(String attId, Field field, T value) {
return new SerializationContext<>(attId, field, value, DummyJsonLdContext.INSTANCE);
}
private void verifyUserFieldsVisited(User user) throws NoSuchFieldException {
verify(visitor).visitIdentifier(
new SerializationContext<>(JsonLd.ID, Person.class.getDeclaredField("uri"), user.getUri().toString(),
DummyJsonLdContext.INSTANCE));
verify(visitor).visitAttribute(ctx(Vocabulary.FIRST_NAME, Person.getFirstNameField(), user.getFirstName()));
verify(visitor).visitAttribute(ctx(Vocabulary.LAST_NAME, Person.getLastNameField(), user.getLastName()));
verify(visitor).visitAttribute(ctx(Vocabulary.USERNAME, User.getUsernameField(), user.getUsername()));
}
private void generateEmployees(Organization org) {
org.setEmployees(new HashSet<>());
for (int i = 0; i < Generator.randomInt(10); i++) {
final Employee emp = new Employee();
emp.setUri(Generator.generateUri());
org.getEmployees().add(emp);
}
}
@Test
void traverseRecognizesAlreadyVisitedInstances() throws Exception {
final Employee employee = Generator.generateEmployee();
// Backward reference
employee.getEmployer().setEmployees(Collections.singleton(employee));
traverser.traverse(employee);
traverser.traverse(ctx(Vocabulary.HAS_MEMBER, Organization.getEmployeesField(), employee));
verify(visitor).openObject(ctx(null, null, employee));
verify(visitor).openObject(ctx(Vocabulary.HAS_MEMBER, Organization.getEmployeesField(), employee));
verify(visitor).visitTypes(new SerializationContext<>(JsonLd.TYPE, User.class.getDeclaredField("types"),
new HashSet<>(
Arrays.asList(Vocabulary.PERSON, Vocabulary.USER,
Vocabulary.EMPLOYEE)),
DummyJsonLdContext.INSTANCE));
}
@Test
void traverseOnCollectionOpensCollectionAddsInstancesAndClosesCollection() {
final Set<User> users = Generator.generateUsers();
traverser.traverse(users);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).openCollection(ctx(null, null, users));
for (User u : users) {
inOrder.verify(visitor).openObject(ctx(null, null, u));
inOrder.verify(visitor).closeObject(ctx(null, null, u));
}
inOrder.verify(visitor).closeCollection(ctx(null, null, users));
}
@Test
void traverseDoesNotPutPlainIdentifierObjectPropertyValueIntoKnownInstances() throws Exception {
final EmployeeWithUriEmployer employee = new EmployeeWithUriEmployer();
employee.setUri(Generator.generateUri());
employee.employer = Generator.generateUri();
traverser.traverse(employee);
final Map<Object, String> knownInstances = getKnownInstances();
assertFalse(knownInstances.containsKey(employee.employer));
}
private Map<Object, String> getKnownInstances() throws NoSuchFieldException, IllegalAccessException {
final Field knownField = ObjectGraphTraverser.class.getDeclaredField("knownInstances");
knownField.setAccessible(true);
return (Map<Object, String>) knownField.get(traverser);
}
@OWLClass(iri = Vocabulary.EMPLOYEE)
private static class EmployeeWithUriEmployer extends User {
@OWLObjectProperty(iri = Vocabulary.IS_MEMBER_OF)
private URI employer;
}
@Test
void traverseUsesAttributePropertyOrderingInformationWhenSerializingObject() throws Exception {
final Study study = generateStudy();
traverser.traverse(study);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor)
.visitIdentifier(ctx(JsonLd.ID, Study.class.getDeclaredField("uri"), study.getUri().toString()));
inOrder.verify(visitor).visitAttribute(ctx(RDFS.LABEL, Study.class.getDeclaredField("name"), study.getName()));
inOrder.verify(visitor).visitAttribute(
ctx(Vocabulary.HAS_PARTICIPANT, Study.class.getDeclaredField("participants"), study.getParticipants()));
inOrder.verify(visitor)
.visitAttribute(ctx(Vocabulary.HAS_MEMBER, Study.class.getDeclaredField("members"), study.getMembers()));
}
private Study generateStudy() {
final Study study = new Study();
study.setUri(Generator.generateUri());
study.setName("TestStudy");
study.setMembers(Collections.singleton(Generator.generateEmployee()));
study.setParticipants(Collections.singleton(Generator.generateEmployee()));
return study;
}
@Test
void traverseUsesPartialAttributePropertyOrderingWhenSerializingObject() throws Exception {
final PartiallyOrderedStudy ps = new PartiallyOrderedStudy();
ps.setUri(Generator.generateUri());
ps.setName("TestStudy");
ps.setMembers(Collections.singleton(Generator.generateEmployee()));
ps.setParticipants(Collections.singleton(Generator.generateEmployee()));
traverser.traverse(ps);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).visitAttribute(
ctx(Vocabulary.HAS_PARTICIPANT, Study.class.getDeclaredField("participants"), ps.getParticipants()));
inOrder.verify(visitor)
.visitAttribute(ctx(Vocabulary.HAS_MEMBER, Study.class.getDeclaredField("members"), ps.getMembers()));
inOrder.verify(visitor).visitAttribute(ctx(RDFS.LABEL, Study.class.getDeclaredField("name"), ps.getName()));
}
@JsonLdAttributeOrder({"participants", "members"})
private static class PartiallyOrderedStudy extends Study {
}
@Test
void traversePutsVisitedInstanceTogetherWithIdentifierIntoKnownInstancesOnOpeningObject() throws Exception {
final Person person = Generator.generatePerson();
traverser.traverse(person);
final Map<Object, String> knownInstances = getKnownInstances();
assertTrue(knownInstances.containsKey(person));
assertEquals(person.getUri().toString(), knownInstances.get(person));
}
@Test
void traverseGeneratesBlankNodeIdentifierWhenPuttingInstanceWithoutIdentifierIntoKnownInstances() throws
Exception {
final Person person = Generator.generatePerson();
person.setUri(null);
traverser.traverse(person);
final Map<Object, String> knownInstances = getKnownInstances();
assertTrue(knownInstances.containsKey(person));
assertThat(knownInstances.get(person), StringStartsWith.startsWith("_:"));
}
@Test
void traverseInvokesVisitIdentifierWithInstanceIdentifier() throws Exception {
final Person person = Generator.generatePerson();
traverser.traverse(person);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).openObject(ctx(null, null, person));
inOrder.verify(visitor)
.visitIdentifier(ctx(JsonLd.ID, Person.class.getDeclaredField("uri"), person.getUri().toString()));
}
@Test
void traverseInvokesVisitWhenInstanceIsPlainIdentifierPropertyValue() throws Exception {
final EmployeeWithUriEmployer employee = new EmployeeWithUriEmployer();
employee.setUri(Generator.generateUri());
employee.employer = Generator.generateUri();
traverser.traverse(ctx(Vocabulary.IS_MEMBER_OF, EmployeeWithUriEmployer.class.getDeclaredField("employer"),
employee.employer));
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).openObject(
ctx(Vocabulary.IS_MEMBER_OF, EmployeeWithUriEmployer.class.getDeclaredField("employer"),
employee.employer));
inOrder.verify(visitor).visitIdentifier(ctx(JsonLd.ID, null, employee.employer.toString()));
}
@Test
void traverseInvokesVisitTypesAfterOpeningInstance() throws Exception {
final Employee employee = Generator.generateEmployee();
traverser.traverse(employee);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).openObject(ctx(null, null, employee));
inOrder.verify(visitor).visitTypes(ctx(JsonLd.TYPE, User.class.getDeclaredField("types"),
new InstanceTypeResolver().resolveTypes(employee)));
}
@Test
void traverseThrowsMissingIdentifierExceptionWhenIdentifierIsRequiredAndMissing() {
final Person person = Generator.generatePerson();
person.setUri(null);
traverser.setRequireId(true);
assertThrows(MissingIdentifierException.class, () -> traverser.traverse(person));
}
@Test
void traverseThrowsMissingTypeInfoExceptionWhenObjectHasNoTypesAndIsNotOwlClass() {
final NoType instance = new NoType();
instance.uri = Generator.generateUri();
final MissingTypeInfoException result = assertThrows(MissingTypeInfoException.class,
() -> traverser.traverse(instance));
assertThat(result.getMessage(), containsString("@OWLClass"));
assertThat(result.getMessage(), containsString("@Types"));
}
@Test
void traverseSupportsInstanceOfClassWithoutOWLClassAnnotationButWithNonEmptyTypes() throws Exception {
final NoType instance = new NoType();
instance.uri = Generator.generateUri();
instance.types = Collections.singleton(Vocabulary.PERSON);
traverser.traverse(instance);
verify(visitor).visitTypes(ctx(JsonLd.TYPE, NoType.class.getDeclaredField("types"), instance.types));
}
private static class NoType {
@Id
private URI uri;
@Types
private Set<String> types;
}
@Test
void traverseSkipsNullValuesInCollectionAttribute() {
final Organization org = Generator.generateOrganization();
generateEmployees(org);
org.getEmployees().add(null);
traverser.traverse(org.getEmployees());
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).openCollection(ctx(null, null, org.getEmployees()));
inOrder.verify(visitor).closeCollection(ctx(null, null, org.getEmployees()));
org.getEmployees().stream().filter(Objects::nonNull)
.forEach(e -> verify(visitor).openObject(ctx(null, null, e)));
}
@Test
void traverseSkipsNullValuesInCollection() {
final Set<User> users = Generator.generateUsers();
users.add(null);
traverser.traverse(users);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).openCollection(ctx(null, null, users));
for (User u : users) {
if (u != null) {
inOrder.verify(visitor).openObject(ctx(null, null, u));
inOrder.verify(visitor).closeObject(ctx(null, null, u));
}
}
inOrder.verify(visitor).closeCollection(ctx(null, null, users));
}
@Test
void traverseInvokesVisitObjectBeforeOpeningIt() {
final Person p = Generator.generatePerson();
traverser.traverse(p);
final InOrder inOrder = inOrder(visitor);
inOrder.verify(visitor).visitObject(ctx(null, null, p));
inOrder.verify(visitor).openObject(ctx(null, null, p));
}
@Test
void traverseDoesNotOpenObjectWhenVisitObjectReturnedFalse() {
when(visitor.visitObject(any())).thenReturn(false);
final Person p = Generator.generatePerson();
traverser.traverse(p);
verify(visitor).visitObject(ctx(null, null, p));
verify(visitor, never()).openObject(any());
}
@Test
void traverseSingularEnumConstantOpensObjectAndAddsOnlyIdentifierToIt() {
final SerializationContext<OwlPropertyType> ctx =
new SerializationContext<>(OwlPropertyType.OBJECT_PROPERTY, DummyJsonLdContext.INSTANCE);
traverser.traverse(ctx);
verify(visitor).openObject(ctx);
final ArgumentCaptor<SerializationContext<String>> captor = ArgumentCaptor.forClass(SerializationContext.class);
verify(visitor).visitIdentifier(captor.capture());
assertEquals(OWL.OBJECT_PROPERTY, captor.getValue().getValue());
assertEquals(JsonLd.ID, captor.getValue().getTerm());
verify(visitor, never()).visitAttribute(any());
verify(visitor, never()).visitTypes(any());
}
}