forked from DSpace/DSpace
-
Notifications
You must be signed in to change notification settings - Fork 7
/
BrowsesResourceControllerIT.java
1499 lines (1277 loc) · 79.2 KB
/
BrowsesResourceControllerIT.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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* The contents of this file are subject to the license and copyright
* detailed in the LICENSE and NOTICE files at the root of the source
* tree and available online at
*
* http://www.dspace.org/license/
*/
package org.dspace.app.rest;
import static org.dspace.app.rest.matcher.MetadataMatcher.matchMetadata;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.nullValue;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import org.dspace.app.rest.matcher.BrowseEntryResourceMatcher;
import org.dspace.app.rest.matcher.BrowseIndexMatcher;
import org.dspace.app.rest.matcher.ItemMatcher;
import org.dspace.app.rest.test.AbstractControllerIntegrationTest;
import org.dspace.builder.CollectionBuilder;
import org.dspace.builder.CommunityBuilder;
import org.dspace.builder.GroupBuilder;
import org.dspace.builder.ItemBuilder;
import org.dspace.content.Collection;
import org.dspace.content.Community;
import org.dspace.content.Item;
import org.dspace.content.authority.service.MetadataAuthorityService;
import org.dspace.eperson.Group;
import org.dspace.services.ConfigurationService;
import org.dspace.services.factory.DSpaceServicesFactory;
import org.hamcrest.Matchers;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
/**
* Integration test to test the /api/discover/browses endpoint
* (Class has to start or end with IT to be picked up by the failsafe plugin)
*
* @author Frederic Van Reet (frederic dot vanreet at atmire dot com)
* @author Tom Desair (tom dot desair at atmire dot com)
*/
public class BrowsesResourceControllerIT extends AbstractControllerIntegrationTest {
@Autowired
ConfigurationService configurationService;
@Autowired
MetadataAuthorityService metadataAuthorityService;
@Test
public void findAll() throws Exception {
//When we call the root endpoint
getClient().perform(get("/api/discover/browses"))
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//Our default Discovery config has 4 browse indexes so we expect this to be reflected in the page
// object
.andExpect(jsonPath("$.page.size", is(20)))
.andExpect(jsonPath("$.page.totalElements", is(4)))
.andExpect(jsonPath("$.page.totalPages", is(1)))
.andExpect(jsonPath("$.page.number", is(0)))
//The array of browse index should have a size 4
.andExpect(jsonPath("$._embedded.browses", hasSize(4)))
//Check that all (and only) the default browse indexes are present
.andExpect(jsonPath("$._embedded.browses", containsInAnyOrder(
BrowseIndexMatcher.dateIssuedBrowseIndex("asc"),
BrowseIndexMatcher.contributorBrowseIndex("asc"),
BrowseIndexMatcher.titleBrowseIndex("asc"),
BrowseIndexMatcher.subjectBrowseIndex("asc")
)))
;
}
@Test
public void findBrowseByTitle() throws Exception {
//When we call the root endpoint
getClient().perform(get("/api/discover/browses/title"))
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//Check that the JSON root matches the expected browse index
.andExpect(jsonPath("$", BrowseIndexMatcher.titleBrowseIndex("asc")))
;
}
@Test
public void findBrowseByDateIssued() throws Exception {
//When we call the root endpoint
getClient().perform(get("/api/discover/browses/dateissued"))
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//Check that the JSON root matches the expected browse index
.andExpect(jsonPath("$", BrowseIndexMatcher.dateIssuedBrowseIndex("asc")))
;
}
@Test
public void findBrowseByContributor() throws Exception {
//When we call the root endpoint
getClient().perform(get("/api/discover/browses/author"))
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//Check that the JSON root matches the expected browse index
.andExpect(jsonPath("$", BrowseIndexMatcher.contributorBrowseIndex("asc")))
;
}
@Test
public void findBrowseBySubject() throws Exception {
//When we call the root endpoint
getClient().perform(get("/api/discover/browses/subject"))
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//Check that the JSON root matches the expected browse index
.andExpect(jsonPath("$", BrowseIndexMatcher.subjectBrowseIndex("asc")))
;
}
@Test
public void findBrowseBySubjectEntries() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. Three public items that are readable by Anonymous with different subjects
Item publicItem1 = ItemBuilder.createItem(context, col1)
.withTitle("Public item 1")
.withIssueDate("2017-10-17")
.withAuthor("Smith, Donald").withAuthor("Doe, John")
.withSubject("ExtraEntry")
.build();
Item publicItem2 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 2")
.withIssueDate("2016-02-13")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("TestingForMore").withSubject("ExtraEntry")
.build();
Item publicItem3 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 2")
.withIssueDate("2016-02-13")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("AnotherTest").withSubject("TestingForMore")
.withSubject("ExtraEntry")
.build();
context.restoreAuthSystemState();
//** WHEN **
//An anonymous user browses this endpoint to find which subjects are currently in the repository
getClient().perform(get("/api/discover/browses/subject/entries")
.param("projection", "full"))
//** THEN **
//The status has to be 200
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
.andExpect(jsonPath("$.page.size", is(20)))
//Check that there are indeed 3 different subjects
.andExpect(jsonPath("$.page.totalElements", is(3)))
//Check the embedded resources and that they're sorted alphabetically
//Check that the subject matches as expected
//Verify that they're sorted alphabetically
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("AnotherTest", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("ExtraEntry", 3),
BrowseEntryResourceMatcher.matchBrowseEntry("TestingForMore", 2)
)));
getClient().perform(get("/api/discover/browses/subject/entries")
.param("sort", "value,desc"))
//** THEN **
//The status has to be 200
.andExpect(status().isOk())
.andDo(MockMvcResultHandlers.print())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
.andExpect(jsonPath("$.page.size", is(20)))
//Check that there are indeed 3 different subjects
.andExpect(jsonPath("$.page.totalElements", is(3)))
//Check the embedded resources and that they're sorted alphabetically
//Check that the subject matches as expected
//Verify that they're sorted alphabetically
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("TestingForMore", 2),
BrowseEntryResourceMatcher.matchBrowseEntry("ExtraEntry", 3),
BrowseEntryResourceMatcher.matchBrowseEntry("AnotherTest", 1)
)));
}
@Test
public void findBrowseBySubjectEntriesWithAuthority() throws Exception {
configurationService.setProperty("choices.plugin.dc.subject",
"SolrSubjectAuthority");
configurationService.setProperty("authority.controlled.dc.subject",
"true");
metadataAuthorityService.clearCache();
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. Three public items that are readable by Anonymous with different subjects
Item publicItem1 = ItemBuilder.createItem(context, col1)
.withTitle("Public item 1")
.withIssueDate("2017-10-17")
.withAuthor("Smith, Donald").withAuthor("Doe, John")
.withSubject("History of religion", "VR110102", 600)
.build();
Item publicItem2 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 2")
.withIssueDate("2016-02-13")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("Church studies", "VR110103", 600)
.withSubject("History of religion", "VR110102", 600)
.build();
Item publicItem3 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 2")
.withIssueDate("2016-02-13")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("Missionary studies", "VR110104", 600)
.withSubject("Church studies", "VR110103", 600)
.withSubject("History of religion", "VR110102", 600)
.build();
context.restoreAuthSystemState();
//** WHEN **
//An anonymous user browses this endpoint to find which subjects are currently in the repository
getClient().perform(get("/api/discover/browses/subject/entries")
.param("projection", "full"))
//** THEN **
//The status has to be 200
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
.andExpect(jsonPath("$.page.size", is(20)))
//Check that there are indeed 3 different subjects
.andExpect(jsonPath("$.page.totalElements", is(3)))
//Check the embedded resources and that they're sorted alphabetically
//Check that the subject matches as expected
//Verify that they're sorted alphabetically
.andExpect(
jsonPath("$._embedded.entries",
contains(
BrowseEntryResourceMatcher.matchBrowseEntry("Church studies", "VR110103", 2),
BrowseEntryResourceMatcher.matchBrowseEntry("History of religion", "VR110102", 3),
BrowseEntryResourceMatcher.matchBrowseEntry("Missionary studies", "VR110104", 1)
)
)
);
getClient().perform(get("/api/discover/browses/subject/entries")
.param("sort", "value,desc"))
//** THEN **
//The status has to be 200
.andExpect(status().isOk())
.andDo(MockMvcResultHandlers.print())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
.andExpect(jsonPath("$.page.size", is(20)))
//Check that there are indeed 3 different subjects
.andExpect(jsonPath("$.page.totalElements", is(3)))
//Check the embedded resources and that they're sorted alphabetically
//Check that the subject matches as expected
//Verify that they're sorted alphabetically descending
.andExpect(
jsonPath("$._embedded.entries",
contains(
BrowseEntryResourceMatcher.matchBrowseEntry("Missionary studies", "VR110104", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("History of religion", "VR110102", 3),
BrowseEntryResourceMatcher.matchBrowseEntry("Church studies", "VR110103", 2)
)
)
);
DSpaceServicesFactory.getInstance().getConfigurationService().reloadConfig();
metadataAuthorityService.clearCache();
}
@Test
public void findBrowseBySubjectItems() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. Two public items with the same subject and another public item that contains that same subject, but also
// another one
// All of the items are readable by an Anonymous user
Item publicItem1 = ItemBuilder.createItem(context, col1)
.withTitle("zPublic item more")
.withIssueDate("2017-10-17")
.withAuthor("Smith, Donald").withAuthor("Doe, John")
.withSubject("ExtraEntry").withSubject("AnotherTest")
.build();
Item publicItem2 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 2")
.withIssueDate("2016-02-13")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("AnotherTest")
.build();
Item publicItem3 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 3")
.withIssueDate("2016-02-14")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("AnotherTest")
.build();
context.restoreAuthSystemState();
//** WHEN **
//An anonymous user browses the items that correspond with the ExtraEntry subject query
getClient().perform(get("/api/discover/browses/subject/items")
.param("filterValue", "ExtraEntry"))
//** THEN **
//The status has to be 200
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect there to be only one element, the one that we've added with the requested subject
.andExpect(jsonPath("$.page.totalElements", is(1)))
.andExpect(jsonPath("$.page.size", is(20)))
//Verify that the title of the public and embargoed items are present and sorted descending
.andExpect(jsonPath("$._embedded.items", contains(
ItemMatcher.matchItemWithTitleAndDateIssued(publicItem1, "zPublic item more", "2017-10-17")
)));
//** WHEN **
//An anonymous user browses the items that correspond with the AnotherTest subject query
getClient().perform(get("/api/discover/browses/subject/items")
.param("filterValue", "AnotherTest"))
//** THEN **
//The status has to be 200
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect there to be only three elements, the ones that we've added with the requested subject
.andExpect(jsonPath("$.page.totalElements", is(3)))
.andExpect(jsonPath("$.page.size", is(20)))
//Verify that the title of the public and embargoed items are present and sorted descending
.andExpect(jsonPath("$._embedded.items", contains(
ItemMatcher.matchItemWithTitleAndDateIssued(publicItem2, "Public item 2", "2016-02-13"),
ItemMatcher.matchItemWithTitleAndDateIssued(publicItem3, "Public item 3", "2016-02-14"),
ItemMatcher.matchItemWithTitleAndDateIssued(publicItem1, "zPublic item more", "2017-10-17")
)));
}
@Test
public void findBrowseByTitleItems() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. Two public items that are readable by Anonymous
Item publicItem1 = ItemBuilder.createItem(context, col1)
.withTitle("Public item 1")
.withIssueDate("2017-10-17")
.withAuthor("Smith, Donald").withAuthor("Doe, John")
.withSubject("Java").withSubject("Unit Testing")
.build();
Item publicItem2 = ItemBuilder.createItem(context, col2)
.withTitle("Public item 2")
.withIssueDate("2016-02-13")
.withAuthor("Smith, Maria").withAuthor("Doe, Jane")
.withSubject("Angular").withSubject("Unit Testing")
.build();
//3. An item that has been made private
Item privateItem = ItemBuilder.createItem(context, col1)
.withTitle("This is a private item")
.withIssueDate("2015-03-12")
.withAuthor("Duck, Donald")
.withSubject("Cartoons").withSubject("Ducks")
.makeUnDiscoverable()
.build();
//4. An item with an item-level embargo
Item embargoedItem = ItemBuilder.createItem(context, col2)
.withTitle("An embargoed publication")
.withIssueDate("2017-08-10")
.withAuthor("Mouse, Mickey")
.withSubject("Cartoons").withSubject("Mice")
.withEmbargoPeriod("12 months")
.build();
//5. An item that is only readable for an internal groups
Group internalGroup = GroupBuilder.createGroup(context)
.withName("Internal Group")
.build();
Item internalItem = ItemBuilder.createItem(context, col2)
.withTitle("Internal publication")
.withIssueDate("2016-09-19")
.withAuthor("Doe, John")
.withSubject("Unknown")
.withReaderGroup(internalGroup)
.build();
context.restoreAuthSystemState();
//** WHEN **
//An anonymous user browses the items in the Browse by item endpoint
//sorted descending by tile
getClient().perform(get("/api/discover/browses/title/items")
.param("sort", "title,desc"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
.andExpect(jsonPath("$.page.size", is(20)))
.andExpect(jsonPath("$.page.totalElements", is(2)))
.andExpect(jsonPath("$.page.totalPages", is(1)))
.andExpect(jsonPath("$.page.number", is(0)))
.andExpect(jsonPath("$._embedded.items",
contains(ItemMatcher.matchItemWithTitleAndDateIssued(publicItem2,
"Public item 2",
"2016-02-13"),
ItemMatcher.matchItemWithTitleAndDateIssued(publicItem1,
"Public item 1",
"2017-10-17"))))
//The private and internal items must not be present
.andExpect(jsonPath("$._embedded.items[*].metadata", Matchers.allOf(
not(matchMetadata("dc.title", "This is a private item")),
not(matchMetadata("dc.title", "Internal publication")))));
}
@Test
/**
* This test was introduced to reproduce the bug DS-4269 Pagination links must be consistent also when there is not
* explicit pagination parameters in the request (i.e. defaults apply)
*
* @throws Exception
*/
public void browsePaginationWithoutExplicitParams() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community and one collection.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, parentCommunity).withName("Collection 1").build();
//2. Twenty-one public items that are readable by Anonymous
for (int i = 0; i <= 20; i++) {
ItemBuilder.createItem(context, col1)
.withTitle("Public item " + String.format("%02d", i))
.withIssueDate("2017-10-17")
.withAuthor("Test, Author" + String.format("%02d", i))
.withSubject("Java").withSubject("Unit Testing")
.build();
}
context.restoreAuthSystemState();
//** WHEN **
//An anonymous user browses the items in the Browse by item endpoint
getClient().perform(get("/api/discover/browses/title/items"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect 21 public items
.andExpect(jsonPath("$.page.size", is(20)))
.andExpect(jsonPath("$.page.totalElements", is(21)))
.andExpect(jsonPath("$.page.totalPages", is(2)))
.andExpect(jsonPath("$.page.number", is(0)))
// embedded items are already checked by other test, we focus on links here
.andExpect(jsonPath("$._links.next.href", Matchers.containsString("/api/discover/browses/title/items?")))
.andExpect(jsonPath("$._links.last.href", Matchers.containsString("/api/discover/browses/title/items?")))
.andExpect(jsonPath("$._links.self.href", Matchers.endsWith("/api/discover/browses/title/items")));
//** WHEN **
//An anonymous user browses the items in the Browse by item endpoint
getClient().perform(get("/api/discover/browses/author/entries"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect 21 public items
.andExpect(jsonPath("$.page.size", is(20)))
.andExpect(jsonPath("$.page.totalElements", is(21)))
.andExpect(jsonPath("$.page.totalPages", is(2)))
.andExpect(jsonPath("$.page.number", is(0)))
// embedded items are already checked by other test, we focus on links here
.andExpect(jsonPath("$._links.next.href",
Matchers.containsString("/api/discover/browses/author/entries?")))
.andExpect(jsonPath("$._links.last.href",
Matchers.containsString("/api/discover/browses/author/entries?")))
.andExpect(jsonPath("$._links.self.href", Matchers.endsWith("/api/discover/browses/author/entries")));
}
@Test
public void testPaginationBrowseByDateIssuedItems() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. 7 public items that are readable by Anonymous
Item item1 = ItemBuilder.createItem(context, col1)
.withTitle("Item 1")
.withIssueDate("2017-10-17")
.build();
Item item2 = ItemBuilder.createItem(context, col2)
.withTitle("Item 2")
.withIssueDate("2016-02-13")
.build();
Item item3 = ItemBuilder.createItem(context, col1)
.withTitle("Item 3")
.withIssueDate("2016-02-12")
.build();
Item item4 = ItemBuilder.createItem(context, col2)
.withTitle("Item 4")
.withIssueDate("2016-02-11")
.build();
Item item5 = ItemBuilder.createItem(context, col1)
.withTitle("Item 5")
.withIssueDate("2016-02-10")
.build();
Item item6 = ItemBuilder.createItem(context, col2)
.withTitle("Item 6")
.withIssueDate("2016-01-13")
.build();
Item item7 = ItemBuilder.createItem(context, col1)
.withTitle("Item 7")
.withIssueDate("2016-01-12")
.build();
context.restoreAuthSystemState();
//** WHEN **
//An anonymous user browses the items in the Browse by date issued endpoint
//sorted ascending by tile with a page size of 5
getClient().perform(get("/api/discover/browses/dateissued/items")
.param("sort", "title,asc")
.param("size", "5"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect only the first five items to be present
.andExpect(jsonPath("$.page.size", is(5)))
.andExpect(jsonPath("$.page.totalElements", is(7)))
.andExpect(jsonPath("$.page.totalPages", is(2)))
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the title and date of the items match and that they are sorted ascending
.andExpect(jsonPath("$._embedded.items",
contains(ItemMatcher.matchItemWithTitleAndDateIssued(item1,
"Item 1", "2017-10-17"),
ItemMatcher.matchItemWithTitleAndDateIssued(item2,
"Item 2", "2016-02-13"),
ItemMatcher.matchItemWithTitleAndDateIssued(item3,
"Item 3", "2016-02-12"),
ItemMatcher.matchItemWithTitleAndDateIssued(item4,
"Item 4", "2016-02-11"),
ItemMatcher.matchItemWithTitleAndDateIssued(item5,
"Item 5", "2016-02-10")
)));
//The next page gives us the last two items
getClient().perform(get("/api/discover/browses/dateissued/items")
.param("sort", "title,asc")
.param("size", "5")
.param("page", "1"))
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect only the first five items to be present
.andExpect(jsonPath("$.page.size", is(5)))
.andExpect(jsonPath("$.page.totalElements", is(7)))
.andExpect(jsonPath("$.page.totalPages", is(2)))
.andExpect(jsonPath("$.page.number", is(1)))
//Verify that the title and date of the items match and that they are sorted ascending
.andExpect(jsonPath("$._embedded.items",
contains(ItemMatcher.matchItemWithTitleAndDateIssued(item6,
"Item 6", "2016-01-13"),
ItemMatcher.matchItemWithTitleAndDateIssued(item7,
"Item 7", "2016-01-12")
)));
}
@Test
public void testBrowseByEntriesStartsWith() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. 7 public items that are readable by Anonymous
Item item1 = ItemBuilder.createItem(context, col1)
.withTitle("Alan Turing")
.withAuthor("Turing, Alan Mathison")
.withIssueDate("1912-06-23")
.withSubject("Computing")
.build();
Item item2 = ItemBuilder.createItem(context, col1)
.withTitle("Blade Runner")
.withAuthor("Scott, Ridley")
.withIssueDate("1982-06-25")
.withSubject("Science Fiction")
.build();
Item item3 = ItemBuilder.createItem(context, col1)
.withTitle("Python")
.withAuthor("Van Rossum, Guido")
.withIssueDate("1990")
.withSubject("Computing")
.build();
Item item4 = ItemBuilder.createItem(context, col2)
.withTitle("Java")
.withAuthor("Gosling, James")
.withIssueDate("1995-05-23")
.withSubject("Computing")
.build();
Item item5 = ItemBuilder.createItem(context, col2)
.withTitle("Zeta Reticuli")
.withAuthor("Universe")
.withIssueDate("2018-01-01")
.withSubject("Astronomy")
.build();
Item item6 = ItemBuilder.createItem(context, col2)
.withTitle("Moon")
.withAuthor("Universe")
.withIssueDate("2018-01-02")
.withSubject("Astronomy")
.build();
Item item7 = ItemBuilder.createItem(context, col2)
.withTitle("T-800")
.withAuthor("Cameron, James")
.withIssueDate("2029")
.withSubject("Science Fiction")
.build();
context.restoreAuthSystemState();
// ---- BROWSES BY ENTRIES ----
//** WHEN **
//An anonymous user browses the entries in the Browse by Author endpoint
//with startsWith set to U
getClient().perform(get("/api/discover/browses/author/entries?startsWith=U")
.param("size", "2")
.param("projection", "full"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect only the "Universe" entry to be present
.andExpect(jsonPath("$.page.totalElements", is(1)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Universe" entries and Counts 2 Items.
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Universe", 2)
)))
//Verify startsWith parameter is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=U")));
//** WHEN **
//An anonymous user browses the entries in the Browse by Author endpoint
//with startsWith set to T and scope set to Col 1
getClient().perform(get("/api/discover/browses/author/entries?startsWith=T")
.param("scope", col1.getID().toString()))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect only the entry "Turing, Alan Mathison" to be present
.andExpect(jsonPath("$.page.totalElements", is(1)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Turing, Alan'" items.
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Turing, Alan Mathison", 1)
)))
//Verify that the startsWith paramater is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=T")));
//** WHEN **
//An anonymous user browses the entries in the Browse by Subject endpoint
//with startsWith set to C
getClient().perform(get("/api/discover/browses/subject/entries?startsWith=C"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect only the entry "Computing" to be present
.andExpect(jsonPath("$.page.totalElements", is(1)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Computing'" items.
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Computing", 3)
)))
//Verify that the startsWith paramater is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=C")));
};
@Test
public void testBrowseByEntriesStartsWithAndDiacritics() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. 4 public items that are readable by Anonymous
Item item1 = ItemBuilder.createItem(context, col1)
.withTitle("Item1")
.withAuthor("Álvarez, Nombre")
.withIssueDate("1912-06-23")
.withSubject("Teléfono")
.build();
Item item2 = ItemBuilder.createItem(context, col1)
.withTitle("Item2")
.withAuthor("Ögren, Name")
.withIssueDate("1982-06-25")
.withSubject("Televisor")
.build();
Item item3 = ItemBuilder.createItem(context, col2)
.withTitle("Item3")
.withAuthor("Azuaga, Nombre")
.withIssueDate("1990")
.withSubject("Telecomunicaciones")
.build();
Item item4 = ItemBuilder.createItem(context, col2)
.withTitle("Item4")
.withAuthor("Alonso, Nombre")
.withAuthor("Ortiz, Nombre")
.withIssueDate("1995-05-23")
.withSubject("Guion")
.build();
// ---- BROWSES BY ENTRIES ----
//** WHEN **
//An anonymous user browses the entries in the Browse by Author endpoint
//with startsWith set to A
getClient().perform(get("/api/discover/browses/author/entries?startsWith=A")
.param("size", "4"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect 3 elements
.andExpect(jsonPath("$.page.totalElements", is(3)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Alonso, Nombre", "Álvarez, Nombre" and "Azuaga, Nombre"
// and diacritics are ignored in sorting
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Alonso, Nombre", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("Álvarez, Nombre", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("Azuaga, Nombre", 1)
)))
//Verify startsWith parameter is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=A")));
//** WHEN **
//An anonymous user browses the entries in the Browse by Author endpoint
//with startsWith set to Ó (accented)
getClient().perform(get("/api/discover/browses/author/entries?startsWith=Ó"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect 2 elements
.andExpect(jsonPath("$.page.totalElements", is(2)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Ögren, Name"" and "Ortiz, Nombre"
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Ögren, Name", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("Ortiz, Nombre", 1)
)))
//Verify that the startsWith paramater is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=Ó")));
//** WHEN **
//An anonymous user browses the entries in the Browse by Subject endpoint
//with startsWith set to Tele
getClient().perform(get("/api/discover/browses/subject/entries?startsWith=Tele"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect 3 elements
.andExpect(jsonPath("$.page.totalElements", is(3)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Telecomunicaciones', "Teléfono" and "Televisor" and
// it is sorted ignoring diacritics
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Telecomunicaciones", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("Teléfono", 1),
BrowseEntryResourceMatcher.matchBrowseEntry("Televisor", 1)
)))
//Verify that the startsWith paramater is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=Tele")));
//** WHEN **
//An anonymous user browses the entries in the Browse by Subject endpoint
//with startsWith set to Guión
getClient().perform(get("/api/discover/browses/subject/entries?startsWith=Guión"))
//** THEN **
//The status has to be 200 OK
.andExpect(status().isOk())
//We expect the content type to be "application/hal+json;charset=UTF-8"
.andExpect(content().contentType(contentType))
//We expect only the entry "Guion" to be present
.andExpect(jsonPath("$.page.totalElements", is(1)))
//As entry browsing works as a filter, we expect to be on page 0
.andExpect(jsonPath("$.page.number", is(0)))
//Verify that the index filters to the "Guion"
.andExpect(jsonPath("$._embedded.entries",
contains(BrowseEntryResourceMatcher.matchBrowseEntry("Guion", 1)
)))
//Verify that the startsWith paramater is included in the links
.andExpect(jsonPath("$._links.self.href", containsString("?startsWith=Guión")));
};
@Test
public void testBrowseByItemsStartsWith() throws Exception {
context.turnOffAuthorisationSystem();
//** GIVEN **
//1. A community-collection structure with one parent community with sub-community and two collections.
parentCommunity = CommunityBuilder.createCommunity(context)
.withName("Parent Community")
.build();
Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
.withName("Sub Community")
.build();
Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
Collection col2 = CollectionBuilder.createCollection(context, child1).withName("Collection 2").build();
//2. 7 public items that are readable by Anonymous
Item item1 = ItemBuilder.createItem(context, col1)
.withTitle("Alan Turing")
.withAuthor("Turing, Alan Mathison")