-
Notifications
You must be signed in to change notification settings - Fork 26
/
RenderingTest.java
448 lines (347 loc) · 18.6 KB
/
RenderingTest.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
package com.theoryinpractise.halbuilder;
import com.damnhandy.uri.template.UriTemplate;
import com.google.common.base.Charsets;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import com.google.common.io.Resources;
import com.theoryinpractise.halbuilder.spi.ReadableRepresentation;
import com.theoryinpractise.halbuilder.spi.Representation;
import com.theoryinpractise.halbuilder.spi.RepresentationException;
import com.theoryinpractise.halbuilder.spi.Serializable;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import javax.ws.rs.core.UriBuilder;
import java.io.IOException;
import java.net.URI;
import static org.fest.assertions.api.Assertions.assertThat;
public class RenderingTest {
private RepresentationFactory representationFactory = new RepresentationFactory("https://example.com/api/")
.withNamespace("ns", "/apidocs/accounts")
.withNamespace("role", "/apidocs/roles");
private String exampleXml;
private String exampleJson;
private String exampleXmlWithoutHref;
private String exampleJsonWithoutHref;
private String exampleWithSubresourceXml;
private String exampleWithSubresourceJson;
private String exampleWithSubresourceLinkingToItselfXml;
private String exampleWithSubresourceLinkingToItselfJson;
private String exampleWithMultipleSubresourcesXml;
private String exampleWithMultipleSubresourcesJson;
private String exampleWithNullPropertyXml;
private String exampleWithNullPropertyJson;
private String exampleWithLiteralNullPropertyXml;
private String exampleWithLiteralNullPropertyJson;
private String exampleWithMultipleNestedSubresourcesXml;
private String exampleWithMultipleNestedSubresourcesJson;
private String exampleWithTemplateXml;
private String exampleWithTemplateJson;
@BeforeMethod
public void setup() throws IOException {
exampleXmlWithoutHref = Resources.toString(RenderingTest.class.getResource("exampleWithoutHref.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleJsonWithoutHref = Resources.toString(RenderingTest.class.getResource("exampleWithoutHref.json"), Charsets.UTF_8)
.trim();
exampleXml = Resources.toString(RenderingTest.class.getResource("example.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleJson = Resources.toString(RenderingTest.class.getResource("example.json"), Charsets.UTF_8)
.trim();
exampleWithSubresourceXml = Resources.toString(RenderingTest.class.getResource("exampleWithSubresource.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithSubresourceJson = Resources.toString(RenderingTest.class.getResource("exampleWithSubresource.json"), Charsets.UTF_8)
.trim();
exampleWithSubresourceLinkingToItselfXml = Resources.toString(RenderingTest.class.getResource("exampleWithSubresourceLinkingToItself.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithSubresourceLinkingToItselfJson = Resources.toString(RenderingTest.class.getResource("exampleWithSubresourceLinkingToItself.json"), Charsets.UTF_8)
.trim();
exampleWithMultipleSubresourcesXml = Resources.toString(RenderingTest.class.getResource("exampleWithMultipleSubresources.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithMultipleSubresourcesJson = Resources.toString(RenderingTest.class.getResource("exampleWithMultipleSubresources.json"), Charsets.UTF_8)
.trim();
exampleWithNullPropertyXml = Resources.toString(RenderingTest.class.getResource("exampleWithNullProperty.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithNullPropertyJson = Resources.toString(RenderingTest.class.getResource("exampleWithNullProperty.json"), Charsets.UTF_8)
.trim();
exampleWithLiteralNullPropertyXml = Resources.toString(RenderingTest.class.getResource("exampleWithLiteralNullProperty.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithLiteralNullPropertyJson = Resources.toString(RenderingTest.class.getResource("exampleWithLiteralNullProperty.json"), Charsets.UTF_8)
.trim();
exampleWithMultipleNestedSubresourcesXml = Resources.toString(RenderingTest.class.getResource("exampleWithMultipleNestedSubresources.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithMultipleNestedSubresourcesJson = Resources.toString(RenderingTest.class.getResource("exampleWithMultipleNestedSubresources.json"), Charsets.UTF_8)
.trim();
exampleWithTemplateXml = Resources.toString(RenderingTest.class.getResource("exampleWithTemplate.xml"), Charsets.UTF_8)
.trim().replaceAll("\n", "\r\n");
exampleWithTemplateJson = Resources.toString(RenderingTest.class.getResource("exampleWithTemplate.json"), Charsets.UTF_8)
.trim();
}
private Representation newBaseResource(final Representation resource) {
return resource.withLink("ns:parent", "/api/customer/1234",
Optional.<Predicate<ReadableRepresentation>>absent(),
Optional.of("bob"),
Optional.of("The Parent"),
Optional.of("en"));
}
private Representation newBaseResource(final URI uri) {
return newBaseResource(representationFactory.newResource(uri));
}
private Representation newBaseResource(final String href) {
return newBaseResource(representationFactory.newResource(href));
}
@Test
public void testFactoryWithLinks() {
RepresentationFactory representationFactory = new RepresentationFactory("https://example.com/api/")
.withLink("/home", "home");
Representation resource = representationFactory.newResource("/");
assertThat(resource.getCanonicalLinks()).hasSize(2);
assertThat(resource.getLinksByRel("home")).hasSize(1);
assertThat(resource.getLinksByRel("home").iterator().next().toString()).isEqualTo("<link rel=\"home\" href=\"https://example.com/home\"/>");
}
@Test(expectedExceptions = RepresentationException.class)
public void testFactoryWithDuplicateNamespaces() {
new RepresentationFactory()
.withNamespace("home", "https://example.com/api/")
.withNamespace("home", "https://example.com/api/");
}
@Test
public void testUriBuilderHal() {
URI path = UriBuilder.fromPath("customer/{id}").buildFromMap(ImmutableMap.of("id", "123456"));
ReadableRepresentation party = newBaseResource(path)
.withLink("ns:users", "?users")
.withProperty("id", 123456)
.withProperty("age", 33)
.withProperty("name", "Example Resource")
.withProperty("optional", Boolean.TRUE)
.withProperty("expired", Boolean.FALSE);
assertThat(party.getResourceLink().get().getHref()).isEqualTo("https://example.com/api/customer/123456");
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleJson);
}
@Test
public void testResourcesWithoutHref() {
ReadableRepresentation party = new RepresentationFactory().newResource()
.withProperty("name", "Example Resource");
assertThat(party.getResourceLink().isPresent()).isFalse();
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleXmlWithoutHref);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleJsonWithoutHref);
}
@Test
public void testCustomerHal() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withProperty("id", 123456)
.withProperty("age", 33)
.withProperty("name", "Example Resource")
.withProperty("optional", Boolean.TRUE)
.withProperty("expired", Boolean.FALSE);
assertThat(party.getResourceLink().get().getHref()).isEqualTo("https://example.com/api/customer/123456");
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleJson);
}
@Test
public void testWithSerializable() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withSerializable(new Serializable() {
public void serializeResource(Representation resource) {
resource.withProperty("id", 123456)
.withProperty("age", 33)
.withProperty("name", "Example Resource")
.withProperty("optional", Boolean.TRUE)
.withProperty("expired", Boolean.FALSE);
}
});
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleJson);
}
@Test
public void testHalWithBean() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withBean(new Customer(123456, "Example Resource", 33));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleJson);
}
@Test
public void testHalWithFields() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withFields(new OtherCustomer(123456, "Example Resource", 33));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleJson);
}
@Test
public void testHalWithSubResources() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withSubresource("ns:user", representationFactory
.newResource("/user/11")
.withProperty("id", 11)
.withProperty("name", "Example User")
.withProperty("expired", false)
.withProperty("age", 32)
.withProperty("optional", true));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithSubresourceXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithSubresourceJson);
}
@Test
public void testHalWithSubResourceLinkingToItself() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withSubresource("ns:user", representationFactory
.newResource("/user/11")
.withLink("role:admin", "/user/11")
.withProperty("id", 11)
.withProperty("name", "Example User")
.withProperty("expired", false)
.withProperty("age", 32)
.withProperty("optional", true));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithSubresourceLinkingToItselfXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithSubresourceLinkingToItselfJson);
}
@Test
public void testHalWithBeanSubResource() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withBeanBasedSubresource("ns:user", "/user/11", new Customer(11, "Example User", 32));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithSubresourceXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithSubresourceJson);
}
@Test
public void testHalWithBeanMultipleSubResources() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withLink("ns:users", "?users")
.withBeanBasedSubresource("ns:user", "/user/11", new Customer(11, "Example User", 32))
.withBeanBasedSubresource("ns:user", "/user/12", new Customer(12, "Example User", 32));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithMultipleSubresourcesXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithMultipleSubresourcesJson);
}
@Test
public void testLinkWithDamnHandyUriTemplate() {
Phone phone = new Phone(1234, "phone-123");
String uri = UriTemplate.fromExpression("/customer/phone{?id,number}")
.set("id", phone.getId())
.set("number", phone.getNumber())
.expand();
ReadableRepresentation representation = newBaseResource("/test").withLink("phone", uri);
assertThat(representation.getLinkByRel("phone").get().getHref()).isEqualTo("https://example.com" + uri);
}
@Test
public void testNullPropertyHal() {
URI path = UriBuilder.fromPath("customer/{id}").buildFromMap(ImmutableMap.of("id", "123456"));
ReadableRepresentation party = newBaseResource(path)
.withLink("ns:users", "?users")
.withProperty("id", 123456)
.withProperty("age", 33)
.withProperty("name", "Example Resource")
.withProperty("optional", Boolean.TRUE)
.withProperty("expired", Boolean.FALSE)
.withProperty("nullprop", null);
assertThat(party.getResourceLink().get().getHref()).isEqualTo("https://example.com/api/customer/123456");
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithNullPropertyXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithNullPropertyJson);
}
@Test
public void testLiteralNullPropertyHal() {
URI path = UriBuilder.fromPath("customer/{id}").buildFromMap(ImmutableMap.of("id", "123456"));
ReadableRepresentation party = newBaseResource(path)
.withLink("ns:users", "?users")
.withProperty("id", 123456)
.withProperty("age", 33)
.withProperty("name", "Example Resource")
.withProperty("optional", Boolean.TRUE)
.withProperty("expired", Boolean.FALSE)
.withProperty("nullval", "null");
assertThat(party.getResourceLink().get().getHref()).isEqualTo("https://example.com/api/customer/123456");
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithLiteralNullPropertyXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithLiteralNullPropertyJson);
}
@Test
public void testHalWithUriTemplate() {
ReadableRepresentation party = newBaseResource("customer")
.withLink("ns:query", "/api/customer/search{?queryParam}");
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithTemplateXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithTemplateJson);
}
@Test
public void testHalWithBeanMultipleNestedSubResources() {
ReadableRepresentation party = newBaseResource("customer/123456")
.withNamespace("phone", "https://example.com/apidocs/phones")
.withLink("ns:users", "?users")
.withBeanBasedSubresource("ns:user", "/user/11", new Customer(11, "Example User", 32))
.withBeanBasedSubresource("ns:user", "/user/12", new Customer(12, "Example User", 32));
Iterables.getFirst(party.getResources().values(), null).withBeanBasedSubresource("phone:cell", "/phone/1", new Phone(1, "555-666-7890"));
assertThat(party.renderContent(RepresentationFactory.HAL_XML)).isEqualTo(exampleWithMultipleNestedSubresourcesXml);
assertThat(party.renderContent(RepresentationFactory.HAL_JSON)).isEqualTo(exampleWithMultipleNestedSubresourcesJson);
}
public static class Phone {
private final Integer id;
private final String number;
public Phone(Integer id, String number) {
this.id = id;
this.number = number;
}
public Integer getId() {
return id;
}
public String getNumber() {
return number;
}
}
public static class OtherCustomer {
public final Integer id;
public final String name;
public final Integer age;
public final Boolean expired = false;
public final Boolean optional = true;
public OtherCustomer(Integer id, String name, Integer age) {
this.id = id;
this.name = name;
this.age = age;
}
}
public static class Customer {
private Integer id;
private String name;
private Integer age;
private Boolean expired = false;
private Boolean optional = true;
public Customer(Integer id, String name, Integer age) {
this.id = id;
this.name = name;
this.age = age;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public Boolean getExpired() {
return expired;
}
public void setExpired(Boolean expired) {
this.expired = expired;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
public Boolean getOptional() {
return optional;
}
public void setOptional(Boolean optional) {
this.optional = optional;
}
}
}