-
Notifications
You must be signed in to change notification settings - Fork 2
/
ContextBuildingJsonLdSerializerTest.java
367 lines (322 loc) · 18.3 KB
/
ContextBuildingJsonLdSerializerTest.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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
package cz.cvut.kbss.jsonld.serialization;
import com.github.jsonldjava.utils.JsonUtils;
import cz.cvut.kbss.jopa.model.MultilingualString;
import cz.cvut.kbss.jopa.model.annotations.Id;
import cz.cvut.kbss.jopa.model.annotations.OWLClass;
import cz.cvut.kbss.jopa.model.annotations.OWLDataProperty;
import cz.cvut.kbss.jopa.model.annotations.OWLObjectProperty;
import cz.cvut.kbss.jopa.vocabulary.DC;
import cz.cvut.kbss.jopa.vocabulary.OWL;
import cz.cvut.kbss.jopa.vocabulary.RDFS;
import cz.cvut.kbss.jopa.vocabulary.XSD;
import cz.cvut.kbss.jsonld.ConfigParam;
import cz.cvut.kbss.jsonld.JsonLd;
import cz.cvut.kbss.jsonld.common.IdentifierUtil;
import cz.cvut.kbss.jsonld.environment.Generator;
import cz.cvut.kbss.jsonld.environment.TestUtil;
import cz.cvut.kbss.jsonld.environment.Vocabulary;
import cz.cvut.kbss.jsonld.environment.model.*;
import cz.cvut.kbss.jsonld.serialization.model.JsonNode;
import org.eclipse.rdf4j.model.Model;
import org.eclipse.rdf4j.model.impl.LinkedHashModel;
import org.eclipse.rdf4j.model.util.Models;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import java.net.URI;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.*;
import static org.junit.jupiter.api.Assertions.*;
@SuppressWarnings("unchecked")
class ContextBuildingJsonLdSerializerTest extends JsonLdSerializerTestBase {
@BeforeEach
void setUp() {
this.sut = new ContextBuildingJsonLdSerializer(jsonWriter);
}
@Test
void jsonLdContextContainsCorrectAttributeToPropertyMapping() throws Exception {
final User user = Generator.generateUser();
final Map<String, ?> jsonMap = serializeAndRead(user);
assertThat(jsonMap, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, jsonMap.get(JsonLd.CONTEXT));
final Map<String, String> context = (Map<String, String>) jsonMap.get(JsonLd.CONTEXT);
assertEquals(Vocabulary.FIRST_NAME, context.get(User.getFirstNameField().getName()));
assertEquals(Vocabulary.LAST_NAME, context.get(User.getLastNameField().getName()));
assertEquals(Vocabulary.USERNAME, context.get(User.getUsernameField().getName()));
assertEquals(Vocabulary.IS_ADMIN, context.get(User.class.getDeclaredField("admin").getName()));
}
@Test
void serializeWithContextUsesFieldNamesAsJsonLdAttributeNames() throws Exception {
final User user = Generator.generateUser();
final Map<String, ?> jsonMap = serializeAndRead(user);
assertEquals(user.getFirstName(), jsonMap.get(User.getFirstNameField().getName()));
assertEquals(user.getLastName(), jsonMap.get(User.getLastNameField().getName()));
assertEquals(user.getUsername(), jsonMap.get(User.getUsernameField().getName()));
assertEquals(user.getAdmin(), jsonMap.get(User.class.getDeclaredField("admin").getName()));
}
@Test
void serializeWithContextSupportsTypesAndIdMapping() throws Exception {
final User user = Generator.generateUser();
user.setTypes(Collections.singleton(Generator.generateUri().toString()));
final Map<String, ?> jsonMap = serializeAndRead(user);
assertThat(jsonMap, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, jsonMap.get(JsonLd.CONTEXT));
final Map<String, String> context = (Map<String, String>) jsonMap.get(JsonLd.CONTEXT);
assertEquals(JsonLd.ID, context.get(Person.class.getDeclaredField("uri").getName()));
assertEquals(JsonLd.TYPE, context.get(User.class.getDeclaredField("types").getName()));
}
@Test
void serializeWithContextBuildsContextForObjectProperty() throws Exception {
final Employee employee = Generator.generateEmployee();
final Map<String, ?> jsonMap = serializeAndRead(employee);
assertThat(jsonMap, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, jsonMap.get(JsonLd.CONTEXT));
final Map<String, ?> context = (Map<String, JsonNode>) jsonMap.get(JsonLd.CONTEXT);
assertEquals(Vocabulary.IS_MEMBER_OF, context.get(Employee.getEmployerField().getName()));
assertEquals(RDFS.LABEL, context.get(Organization.class.getDeclaredField("name").getName()));
assertEquals(Vocabulary.BRAND, context.get(Organization.class.getDeclaredField("brands").getName()));
final Object dateDefinition = context.get(Organization.class.getDeclaredField("dateCreated").getName());
assertInstanceOf(Map.class, dateDefinition);
final Map<String, String> expected = new HashMap<>();
expected.put(JsonLd.TYPE, XSD.DATETIME);
expected.put(JsonLd.ID, Vocabulary.DATE_CREATED);
assertEquals(expected, dateDefinition);
}
@Test
void serializeWithContextUsesReferencedEntityFieldNamesAsAttributeNames() throws Exception {
final Employee employee = Generator.generateEmployee();
final Map<String, ?> jsonMap = serializeAndRead(employee);
assertInstanceOf(Map.class, jsonMap.get(Employee.getEmployerField().getName()));
final Map<String, Object> orgMap = (Map<String, Object>) jsonMap.get(Employee.getEmployerField().getName());
assertEquals(employee.getEmployer().getName(),
orgMap.get(Organization.class.getDeclaredField("name").getName()));
assertEquals(
DateTimeFormatter.ISO_DATE_TIME.format(employee.getEmployer().getDateCreated().toInstant().atOffset(
ZoneOffset.UTC)), orgMap.get(Organization.class.getDeclaredField("dateCreated").getName()));
assertInstanceOf(Collection.class, orgMap.get(Organization.class.getDeclaredField("brands").getName()));
final Collection<String> jsonBrands =
(Collection<String>) orgMap.get(Organization.class.getDeclaredField("brands").getName());
assertEquals(employee.getEmployer().getBrands().size(), jsonBrands.size());
assertThat(jsonBrands, hasItems(employee.getEmployer().getBrands().toArray(new String[]{})));
}
@Test
void serializationSkipsNullDataPropertyValues() throws Exception {
final User user = Generator.generateUser();
user.setAdmin(null);
final Map<String, ?> json = serializeAndRead(user);
assertThat(json, not(hasKey(User.class.getDeclaredField("admin").getName())));
}
@Test
void serializationSkipsNullObjectPropertyValues() throws Exception {
final Employee employee = Generator.generateEmployee();
employee.setEmployer(null);
final Map<String, ?> json = serializeAndRead(employee);
assertThat(json, not(hasKey(Employee.getEmployerField().getName())));
}
@Test
void serializeWithContextSupportsCompactedIrisBasedOnJOPANamespacesInContext() throws Exception {
final StudyWithNamespaces study = new StudyWithNamespaces();
study.setUri(Generator.generateUri());
study.setName("Test study");
study.setParticipants(Collections.singleton(Generator.generateEmployee()));
study.setMembers(Collections.singleton(Generator.generateEmployee()));
final Map<String, ?> json = serializeAndRead(study);
final Map<String, String> context = (Map<String, String>) json.get(JsonLd.CONTEXT);
assertEquals(RDFS.LABEL, context.get(StudyWithNamespaces.class.getDeclaredField("name").getName()));
assertEquals(Vocabulary.HAS_PARTICIPANT,
context.get(StudyWithNamespaces.class.getDeclaredField("participants").getName()));
assertEquals(Vocabulary.HAS_MEMBER,
context.get(StudyWithNamespaces.class.getDeclaredField("members").getName()));
}
@Test
void serializationGeneratesBlankNodeIfInstancesDoesNotHaveIdentifierValue() throws Exception {
final Organization company = Generator.generateOrganization();
company.setUri(null);
final Map<String, ?> json = serializeAndRead(company);
assertThat(json, hasKey(TestUtil.ID_FIELD_NAME));
assertThat(json.get(TestUtil.ID_FIELD_NAME).toString(), startsWith(IdentifierUtil.B_NODE_PREFIX));
}
@Test
void serializationOfCollectionReturnsJsonObjectWithContextAndGraphWithSerializedCollection() throws Exception {
final List<User> users =
IntStream.range(0, 5).mapToObj(i -> Generator.generateUser()).collect(Collectors.toList());
final Map<String, ?> json = serializeAndRead(users);
assertThat(json, hasKey(JsonLd.CONTEXT));
assertThat(json, hasKey(JsonLd.GRAPH));
assertInstanceOf(List.class, json.get(JsonLd.GRAPH));
final Model result = readJson(jsonWriter.getResult());
users.forEach(u -> {
final Model pModel = new LinkedHashModel();
u.toRdf(new LinkedHashModel(), vf(), new HashSet<>());
assertTrue(Models.isSubset(pModel, result));
});
}
@Test
void serializationOfCollectionReusesReferences() throws Exception {
final List<Employee> employees = Arrays.asList(Generator.generateEmployee(), Generator.generateEmployee());
employees.get(1).setEmployer(employees.get(0).getEmployer());
final Map<String, ?> json = serializeAndRead(employees);
final List<?> items = (List<?>) json.get(JsonLd.GRAPH);
final Map<String, ?> eOne = (Map<String, ?>) items.get(0);
final Map<String, ?> orgOne = (Map<String, ?>) eOne.get(Employee.getEmployerField().getName());
assertThat(orgOne.size(), greaterThan(1));
assertEquals(employees.get(0).getEmployer().getUri().toString(), orgOne.get(TestUtil.ID_FIELD_NAME));
final Map<String, ?> eTwo = (Map<String, ?>) items.get(1);
final Map<String, ?> orgTwo = (Map<String, ?>) eTwo.get(Employee.getEmployerField().getName());
assertEquals(
Collections.singletonMap(TestUtil.ID_FIELD_NAME, employees.get(1).getEmployer().getUri().toString()),
orgTwo);
final Model result = readJson(jsonWriter.getResult());
final Model orgModel = toRdf(employees.get(0).getEmployer());
assertTrue(Models.isSubset(orgModel, result));
}
@Test
void serializationBuildsCorrectlyContextBasedOnAnnotationPropertyAttribute() throws Exception {
final ObjectWithMultilingualString instance = new ObjectWithMultilingualString(Generator.generateUri());
instance.setScopeNote(MultilingualString.create("Test scope note", "en"));
final Map<String, ?> json = serializeAndRead(instance);
assertThat(json, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, json.get(JsonLd.CONTEXT));
final Map<String, ?> context = (Map<String, JsonNode>) json.get(JsonLd.CONTEXT);
assertThat(context, hasKey(ObjectWithMultilingualString.getScopeNoteField().getName()));
}
@Test
void serializationUsesMappedTermForTypesWhenItIsRegisteredInReferencedObject() throws Exception {
final Study instance = new Study();
instance.setUri(Generator.generateUri());
final Employee emp = Generator.generateEmployee();
instance.setMembers(Collections.singleton(emp));
final Map<String, ?> json = serializeAndRead(instance);
assertThat(json, hasKey("types"));
assertEquals(Collections.singletonList(Vocabulary.STUDY), json.get("types"));
}
@Test
void serializationCreatesEmbeddedContextToOverrideIncompatibleTermMapping() throws Exception {
final StudyWithTitle instance = new StudyWithTitle();
instance.uri = Generator.generateUri();
instance.name = "Test study";
instance.organization = Generator.generateOrganization();
final Map<String, ?> json = serializeAndRead(instance);
verifyEmbeddedContext(json);
}
private void verifyEmbeddedContext(Map<String, ?> json) {
assertThat(json, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, json.get(JsonLd.CONTEXT));
final Map<String, ?> context = (Map<String, JsonNode>) json.get(JsonLd.CONTEXT);
assertEquals(DC.Terms.TITLE, context.get("name"));
assertThat(json, hasKey("organization"));
assertInstanceOf(Map.class, json.get("organization"));
final Map<String, ?> organization = (Map<String, ?>) json.get("organization");
assertThat(organization, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, organization.get(JsonLd.CONTEXT));
final Map<String, ?> embeddedCtx = (Map<String, ?>) organization.get(JsonLd.CONTEXT);
assertEquals(RDFS.LABEL, embeddedCtx.get("name"));
}
@OWLClass(iri = Vocabulary.STUDY)
private static class StudyWithTitle {
@Id
private URI uri;
// Organization name uses rdfs:label
@OWLDataProperty(iri = DC.Terms.TITLE)
private String name;
@OWLObjectProperty(iri = Vocabulary.HAS_PARTICIPANT)
private Organization organization;
}
@Test
void serializationUsesRegisteredIdentifierTermWhenSerializingPlainIdentifierObjectPropertyValue() throws Exception {
final Organization instance = Generator.generateOrganization();
instance.setCountry(URI.create("http://dbpedia.org/resource/Czech_Republic"));
final Map<String, ?> json = serializeAndRead(instance);
assertThat(json, hasKey("country"));
assertInstanceOf(Map.class, json.get("country"));
final Map<String, ?> country = (Map<String, ?>) json.get("country");
assertThat(country, hasKey("uri"));
assertEquals(instance.getCountry().toString(), country.get("uri"));
}
@Test
void serializationSerializesRootCollectionOfEnumConstantsMappedToIndividualsAsArrayOfIndividuals() throws Exception {
final List<OwlPropertyType> value = Arrays.asList(OwlPropertyType.values());
sut.serialize(new LinkedHashSet<>(value));
Object jsonObject = JsonUtils.fromString(jsonWriter.getResult());
assertInstanceOf(Map.class, jsonObject);
final Map<?, ?> map = (Map<?, ?>) jsonObject;
assertThat(map, hasKey(JsonLd.GRAPH));
assertInstanceOf(List.class, map.get(JsonLd.GRAPH));
final List<?> lst = (List<?>) map.get(JsonLd.GRAPH);
assertEquals(value.size(), lst.size());
for (int i = 0; i < value.size(); i++) {
assertInstanceOf(Map.class, lst.get(i));
final Map<?, ?> element = (Map<?, ?>) lst.get(i);
assertThat(element, hasKey(JsonLd.ID));
assertEquals(OwlPropertyType.getMappedIndividual(value.get(i)), element.get(JsonLd.ID));
}
}
/**
* Bug #51
*/
@Test
void serializationCreatesEmbeddedContextOnCorrectLevel() throws Exception {
final StudyWithTitle instance = new StudyWithTitle();
instance.uri = Generator.generateUri();
instance.name = "Test study";
instance.organization = Generator.generateOrganization();
instance.organization.addEmployee(Generator.generateEmployee());
instance.organization.addEmployee(Generator.generateEmployee());
instance.organization.getEmployees().forEach(e -> e.setEmployer(instance.organization));
final Map<String, ?> json = serializeAndRead(instance);
verifyEmbeddedContext(json);
}
@Test
void serializationSerializesIndividualsAsStringWithExpandedTermDefinitionInContextWhenConfiguredTo() throws Exception {
sut.configuration().set(ConfigParam.SERIALIZE_INDIVIDUALS_USING_EXPANDED_DEFINITION, Boolean.TRUE.toString());
final Attribute instance = new Attribute();
instance.setUri(Generator.generateUri());
instance.setPropertyType(OwlPropertyType.DATATYPE_PROPERTY);
instance.setPluralPropertyType(
new HashSet<>(Arrays.asList(OwlPropertyType.ANNOTATION_PROPERTY, OwlPropertyType.OBJECT_PROPERTY)));
final Map<String, ?> json = serializeAndRead(instance);
assertThat(json, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, json.get(JsonLd.CONTEXT));
final Map<String, ?> context = (Map<String, JsonNode>) json.get(JsonLd.CONTEXT);
assertThat(context, hasKey("propertyType"));
assertInstanceOf(Map.class, context.get("propertyType"));
final Map<String, ?> termDef = (Map<String, ?>) context.get("propertyType");
assertThat(termDef, hasKey(JsonLd.ID));
assertEquals(termDef.get(JsonLd.ID), Vocabulary.HAS_PROPERTY_TYPE);
assertThat(termDef, hasKey(JsonLd.TYPE));
assertEquals(termDef.get(JsonLd.TYPE), JsonLd.ID);
assertThat(context, hasKey("pluralPropertyType"));
assertInstanceOf(Map.class, context.get("propertyType"));
final Map<String, ?> pluralTermDef = (Map<String, ?>) context.get("pluralPropertyType");
assertThat(pluralTermDef, hasKey(JsonLd.ID));
assertEquals(pluralTermDef.get(JsonLd.ID), Vocabulary.HAS_PLURAL_PROPERTY_TYPE);
assertThat(pluralTermDef, hasKey(JsonLd.TYPE));
assertEquals(pluralTermDef.get(JsonLd.TYPE), JsonLd.ID);
assertThat(json, hasKey("propertyType"));
assertEquals(OWL.DATATYPE_PROPERTY, json.get("propertyType"));
assertThat(json, hasKey("pluralPropertyType"));
assertInstanceOf(List.class, json.get("pluralPropertyType"));
assertThat((List<String>) json.get("pluralPropertyType"),
hasItems(OWL.ANNOTATION_PROPERTY, OWL.OBJECT_PROPERTY));
}
@Test
void serializationSerializesPlainIdentifierAsStringWithExpandedTermDefinitionInContextWhenConfiguredTo() throws Exception {
sut.configuration().set(ConfigParam.SERIALIZE_INDIVIDUALS_USING_EXPANDED_DEFINITION, Boolean.TRUE.toString());
final Organization instance = Generator.generateOrganization();
instance.setCountry(URI.create("http://dbpedia.org/resource/Czech_Republic"));
final Map<String, ?> json = serializeAndRead(instance);
assertThat(json, hasKey(JsonLd.CONTEXT));
assertInstanceOf(Map.class, json.get(JsonLd.CONTEXT));
final Map<String, ?> context = (Map<String, JsonNode>) json.get(JsonLd.CONTEXT);
assertThat(context, hasKey("country"));
assertInstanceOf(Map.class, context.get("country"));
final Map<String, ?> termDef = (Map<String, ?>) context.get("country");
assertEquals(Vocabulary.ORIGIN, termDef.get(JsonLd.ID));
assertEquals(JsonLd.ID, termDef.get(JsonLd.TYPE));
assertEquals(instance.getCountry().toString(), json.get("country"));
}
}