-
Notifications
You must be signed in to change notification settings - Fork 18
/
UsersADME2ESpec.scala
1415 lines (1211 loc) · 55.2 KB
/
UsersADME2ESpec.scala
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
/*
* Copyright © 2021 - 2024 Swiss National Data and Service Center for the Humanities and/or DaSCH Service Platform contributors.
* SPDX-License-Identifier: Apache-2.0
*/
package org.knora.webapi.e2e.admin
import org.apache.pekko
import java.net.URLEncoder
import scala.concurrent.Await
import scala.concurrent.duration.*
import org.knora.webapi.*
import org.knora.webapi.e2e.ClientTestDataCollector
import org.knora.webapi.e2e.TestDataFileContent
import org.knora.webapi.e2e.TestDataFilePath
import org.knora.webapi.messages.admin.responder.groupsmessages.GroupADM
import org.knora.webapi.messages.admin.responder.groupsmessages.GroupsADMJsonProtocol
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectADM
import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectsADMJsonProtocol
import org.knora.webapi.messages.admin.responder.usersmessages.UsersADMJsonProtocol.*
import org.knora.webapi.messages.store.triplestoremessages.TriplestoreJsonProtocol
import org.knora.webapi.messages.util.KnoraSystemInstances
import org.knora.webapi.sharedtestdata.SharedTestDataADM
import org.knora.webapi.sharedtestdata.SharedTestDataADM2
import org.knora.webapi.slice.admin.domain.model.User
import org.knora.webapi.util.AkkaHttpUtils
import org.knora.webapi.util.MutableTestIri
import pekko.actor.ActorSystem
import pekko.http.scaladsl.model.*
import pekko.http.scaladsl.model.headers.*
import pekko.http.scaladsl.testkit.RouteTestTimeout
import pekko.http.scaladsl.unmarshalling.Unmarshal
/**
* End-to-End (E2E) test specification for testing users endpoint.
*/
class UsersADME2ESpec
extends E2ESpec
with ProjectsADMJsonProtocol
with GroupsADMJsonProtocol
with TriplestoreJsonProtocol {
implicit def default(implicit system: ActorSystem): RouteTestTimeout = RouteTestTimeout(30.seconds)
private val rootUser = SharedTestDataADM.rootUser
private val projectAdminUser = SharedTestDataADM.imagesUser01
private val normalUser = SharedTestDataADM.normalUser
private def addRootUserCredentials() = addCredentials(rootUser)
private def addProjectAdminUserCredentials() = addCredentials(projectAdminUser)
private def addNormalUserCredentials() = addCredentials(normalUser)
private def addCredentials(user: User): RequestTransformer = addCredentials(
BasicHttpCredentials(user.email, "test")
)
private val normalUserIri = SharedTestDataADM2.normalUser.userData.user_id.get
private val normalUserIriEnc = java.net.URLEncoder.encode(normalUserIri, "utf-8")
private val multiUserIri = SharedTestDataADM2.multiuserUser.userData.user_id.get
private val multiUserIriEnc = java.net.URLEncoder.encode(multiUserIri, "utf-8")
private val imagesProjectIri = SharedTestDataADM.imagesProject.id
private val imagesProjectIriEnc = java.net.URLEncoder.encode(imagesProjectIri, "utf-8")
private val imagesReviewerGroupIri = SharedTestDataADM.imagesReviewerGroup.id
private val imagesReviewerGroupIriEnc = java.net.URLEncoder.encode(imagesReviewerGroupIri, "utf-8")
private val customUserIri = "http://rdfh.ch/users/14pxW-LAQIaGcCRiNCPJcQ"
private val otherCustomUserIri = "http://rdfh.ch/users/v8_12VcJRlGNFCjYzqJ5cA"
private val donaldIri = new MutableTestIri
private val systemUserIriEncoded = java.net.URLEncoder.encode(KnoraSystemInstances.Users.SystemUser.id, "utf-8")
// Directory path for generated client test data
private val clientTestDataPath: Seq[String] = Seq("admin", "users")
// Collects client test data
private val clientTestDataCollector = new ClientTestDataCollector(appConfig)
/**
* Convenience method returning the users project memberships.
*
* @param userIri the user's IRI.
*/
private def getUserProjectMemberships(userIri: IRI) = {
val userIriEnc = java.net.URLEncoder.encode(userIri, "utf-8")
val request = Get(baseApiUrl + s"/admin/users/iri/$userIriEnc/project-memberships") ~> addRootUserCredentials()
val response = singleAwaitingRequest(request)
AkkaHttpUtils.httpResponseToJson(response).fields("projects").convertTo[Seq[ProjectADM]]
}
/**
* Convenience method returning the users project-admin memberships.
*
* @param userIri the user's IRI.
*/
private def getUserProjectAdminMemberships(userIri: IRI) = {
val userIriEnc = java.net.URLEncoder.encode(userIri, "utf-8")
val request =
Get(baseApiUrl + s"/admin/users/iri/$userIriEnc/project-admin-memberships") ~> addRootUserCredentials()
val response = singleAwaitingRequest(request)
AkkaHttpUtils.httpResponseToJson(response).fields("projects").convertTo[Seq[ProjectADM]]
}
/**
* Convenience method returning the users group memberships.
*
* @param userIri the user's IRI.
*/
private def getUserGroupMemberships(userIri: IRI) = {
val userIriEnc = java.net.URLEncoder.encode(userIri, "utf-8")
val request = Get(baseApiUrl + s"/admin/users/iri/$userIriEnc/group-memberships") ~> addRootUserCredentials()
val response = singleAwaitingRequest(request)
AkkaHttpUtils.httpResponseToJson(response).fields("groups").convertTo[Seq[GroupADM]]
}
"The Users Route ('admin/users')" when {
"used to query user information [FUNCTIONALITY]" should {
"return all users" in {
val request =
Get(baseApiUrl + s"/admin/users") ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
logger.debug(s"response: ${response.toString}")
response.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-users-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return a single user profile identified by iri" in {
/* Correct username and password */
val request =
Get(baseApiUrl + s"/admin/users/iri/${URLEncoder.encode(rootUser.id, "utf-8")}") ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-user-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return a single user profile identified by email" in {
/* Correct username and password */
val request =
Get(
baseApiUrl + s"/admin/users/email/${URLEncoder.encode(rootUser.email, "utf-8")}"
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
}
"return a single user profile identified by username" in {
/* Correct username and password */
val request = Get(
baseApiUrl + s"/admin/users/username/${SharedTestDataADM.rootUser.username}"
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
}
}
"used to query user information [PERMISSIONS]" should {
"return single user for SystemAdmin" in {
val request = Get(baseApiUrl + s"/admin/users/iri/$normalUserIriEnc") ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-user-for-SystemAdmin-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return single user for itself" in {
val request = Get(baseApiUrl + s"/admin/users/iri/$normalUserIriEnc") ~> addNormalUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-user-for-itself-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return only public information for single user for non SystemAdmin and self" in {
val request = Get(baseApiUrl + s"/admin/users/iri/$normalUserIriEnc") ~> addProjectAdminUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.givenName should be(SharedTestDataADM.normalUser.givenName)
result.familyName should be(SharedTestDataADM.normalUser.familyName)
result.status should be(false)
result.email should be("")
result.username should be("")
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-user-for-nonSystemAdmin-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return only public information for single user with anonymous access" in {
val request = Get(baseApiUrl + s"/admin/users/iri/$normalUserIriEnc")
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.givenName should be(SharedTestDataADM.normalUser.givenName)
result.familyName should be(SharedTestDataADM.normalUser.familyName)
result.status should be(false)
result.email should be("")
result.username should be("")
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-user-for-anonymous-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return all users for SystemAdmin" in {
val request = Get(baseApiUrl + s"/admin/users") ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-users-for-SystemAdmin-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return all users for ProjectAdmin" in {
val request = Get(baseApiUrl + s"/admin/users") ~> addProjectAdminUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "get-users-for-ProjectAdmin-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return 'Forbidden' for all users for normal user" in {
val request = Get(baseApiUrl + s"/admin/users") ~> addNormalUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.Forbidden)
}
}
"given a custom Iri" should {
"given no credentials in the request when creating a user it must be forbidden" in {
val validUserCreationRequest: String =
s"""{
| "id": "$customUserIri",
| "username": "userWithCustomIri",
| "email": "userWithCustomIri@example.org",
| "givenName": "a user",
| "familyName": "with a custom Iri",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, validUserCreationRequest)
)
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.Forbidden)
}
"create a user with the provided custom IRI" in {
val createUserWithCustomIriRequest: String =
s"""{
| "id": "$customUserIri",
| "username": "userWithCustomIri",
| "email": "userWithCustomIri@example.org",
| "givenName": "a user",
| "familyName": "with a custom Iri",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-with-custom-Iri-request",
fileExtension = "json"
),
text = createUserWithCustomIriRequest
)
)
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, createUserWithCustomIriRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
// check that the custom IRI is correctly assigned
result.id should be(customUserIri)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-with-custom-Iri-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return 'BadRequest' if the supplied IRI for the user is not unique" in {
val params =
s"""{
| "id": "$customUserIri",
| "username": "userWithDuplicateCustomIri",
| "email": "userWithDuplicateCustomIri@example.org",
| "givenName": "a user",
| "familyName": "with a duplicate custom Iri",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, params)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.BadRequest)
val errorMessage: String = Await.result(Unmarshal(response.entity).to[String], 1.second)
val invalidIri: Boolean =
errorMessage.contains(s"IRI: '$customUserIri' already exists, try another one.")
invalidIri should be(true)
}
}
"dealing with special characters" should {
"escape special characters when creating the user" in {
val createUserWithApostropheRequest: String =
s"""{
| "id": "$otherCustomUserIri",
| "username": "userWithApostrophe",
| "email": "userWithApostrophe@example.org",
| "givenName": "M\\"Given 'Name",
| "familyName": "M\\tFamily Name",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, createUserWithApostropheRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
// check that the special characters were escaped correctly
result.id should equal(otherCustomUserIri)
result.givenName should equal("M\"Given 'Name")
result.familyName should equal("M\tFamily Name")
}
"escape special characters when updating the user" in {
val updateUserRequest: String =
s"""{
| "givenName": "Updated\\tGivenName",
| "familyName": "Updated\\"FamilyName"
|}""".stripMargin
val userIriEncoded = java.net.URLEncoder.encode(otherCustomUserIri, "utf-8")
val request = Put(
baseApiUrl + s"/admin/users/iri/$userIriEncoded/BasicUserInformation",
HttpEntity(ContentTypes.`application/json`, updateUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.givenName should be("Updated\tGivenName")
result.familyName should be("Updated\"FamilyName")
}
"return the special characters correctly when getting a user with special characters in givenName and familyName" in {
val userIriEncoded = java.net.URLEncoder.encode(otherCustomUserIri, "utf-8")
val request = Get(baseApiUrl + s"/admin/users/iri/$userIriEncoded") ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.givenName should be("Updated\tGivenName")
result.familyName should be("Updated\"FamilyName")
}
}
"used to create a user" should {
"create the user if the supplied email and username are unique" in {
val createUserRequest: String =
s"""{
| "username": "donald.duck",
| "email": "donald.duck@example.org",
| "givenName": "Donald",
| "familyName": "Duck",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-request",
fileExtension = "json"
),
text = createUserRequest
)
)
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, createUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.username should be("donald.duck")
result.email should be("donald.duck@example.org")
result.givenName should be("Donald")
result.familyName should be("Duck")
result.status should be(true)
result.lang should be("en")
donaldIri.set(result.id)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return a 'BadRequest' if the supplied username is not unique" in {
val createUserRequest: String =
s"""{
| "username": "donald.duck",
| "email": "new.donald.duck@example.org",
| "givenName": "NewDonald",
| "familyName": "NewDuck",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-request-duplicate-username",
fileExtension = "json"
),
text = createUserRequest
)
)
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, createUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.BadRequest)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-response-duplicate-username",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return a 'BadRequest' if the supplied email is not unique" in {
val createUserRequest: String =
s"""{
| "username": "new.donald.duck",
| "email": "donald.duck@example.org",
| "givenName": "NewDonald",
| "familyName": "NewDuck",
| "password": "test",
| "status": true,
| "lang": "en",
| "systemAdmin": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-request-duplicate-email",
fileExtension = "json"
),
text = createUserRequest
)
)
val request = Post(
baseApiUrl + s"/admin/users",
HttpEntity(ContentTypes.`application/json`, createUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.BadRequest)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "create-user-response-duplicate-email",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"authenticate the newly created user using HttpBasicAuth" in {
val request = Get(baseApiUrl + s"/v2/authentication") ~> addCredentials(
BasicHttpCredentials("donald.duck@example.org", "test")
)
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
}
"authenticate the newly created user during login" in {
val params =
s"""
{
"email": "donald.duck@example.org",
"password": "test"
}
""".stripMargin
val request = Post(baseApiUrl + s"/v2/authentication", HttpEntity(ContentTypes.`application/json`, params))
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
}
}
"used to modify user information" should {
"update the user's basic information" in {
val updateUserRequest: String =
s"""{
| "username": "donald.big.duck",
| "email": "donald.big.duck@example.org",
| "givenName": "Big Donald",
| "familyName": "Duckmann",
| "lang": "de"
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-request",
fileExtension = "json"
),
text = updateUserRequest
)
)
val userIriEncoded = java.net.URLEncoder.encode(donaldIri.get, "utf-8")
val request = Put(
baseApiUrl + s"/admin/users/iri/$userIriEncoded/BasicUserInformation",
HttpEntity(ContentTypes.`application/json`, updateUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.username should be("donald.big.duck")
result.email should be("donald.big.duck@example.org")
result.givenName should be("Big Donald")
result.familyName should be("Duckmann")
result.lang should be("de")
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return 'BadRequest' if user IRI is None and 'NotFound' if user IRI is '' in update user request" in {
val updateUserRequest: String =
s"""{
| "username": "donald.without.iri.duck"
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-request-without-iri",
fileExtension = "json"
),
text = updateUserRequest
)
)
val missingUserIri = ""
val request = Put(
baseApiUrl + s"/admin/users/iri/$missingUserIri/BasicUserInformation",
HttpEntity(ContentTypes.`application/json`, updateUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.NotFound)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-response-without-iri-1",
fileExtension = "json"
),
text = responseToString(response)
)
)
val missingUserIriNone = None
val request2 = Put(
baseApiUrl + s"/admin/users/iri/$missingUserIriNone/BasicUserInformation",
HttpEntity(ContentTypes.`application/json`, updateUserRequest)
) ~> addRootUserCredentials()
val response2: HttpResponse = singleAwaitingRequest(request2)
response2.status should be(StatusCodes.BadRequest)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-response-without-iri-2",
fileExtension = "json"
),
text = responseToString(response2)
)
)
}
"update the user's password (by himself)" in {
val changeUserPasswordRequest: String =
s"""{
| "requesterPassword": "test",
| "newPassword": "test123456"
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-password-request",
fileExtension = "json"
),
text = changeUserPasswordRequest
)
)
val request1 = Put(
baseApiUrl + s"/admin/users/iri/${URLEncoder.encode(normalUser.id, "utf-8")}/Password",
HttpEntity(ContentTypes.`application/json`, changeUserPasswordRequest)
) ~> addCredentials(BasicHttpCredentials(normalUser.email, "test")) // requester's password
val response1: HttpResponse = singleAwaitingRequest(request1)
logger.debug(s"response: ${response1.toString}")
response1.status should be(StatusCodes.OK)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-password-response",
fileExtension = "json"
),
text = responseToString(response1)
)
)
// check if the password was changed, i.e. if the new one is accepted
val request2 = Get(baseApiUrl + s"/v2/authentication") ~> addCredentials(
BasicHttpCredentials(normalUser.email, "test123456")
) // new password
val response2: HttpResponse = singleAwaitingRequest(request2)
response2.status should be(StatusCodes.OK)
}
"update the user's password (by a system admin)" in {
val params01 =
s"""
{
"requesterPassword": "test",
"newPassword": "test654321"
}
""".stripMargin
val request1 = Put(
baseApiUrl + s"/admin/users/iri/${URLEncoder.encode(normalUser.id, "utf-8")}/Password",
HttpEntity(ContentTypes.`application/json`, params01)
) ~> addCredentials(BasicHttpCredentials(rootUser.email, "test")) // requester's password
val response1: HttpResponse = singleAwaitingRequest(request1)
logger.debug(s"response: ${response1.toString}")
response1.status should be(StatusCodes.OK)
// check if the password was changed, i.e. if the new one is accepted
val request2 = Get(baseApiUrl + s"/v2/authentication") ~> addCredentials(
BasicHttpCredentials(normalUser.email, "test654321")
) // new password
val response2: HttpResponse = singleAwaitingRequest(request2)
response2.status should be(StatusCodes.OK)
}
"return 'BadRequest' if new password in change password request is missing" in {
val changeUserPasswordRequest: String =
s"""{
| "requesterPassword": "test"
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "incomplete-update-user-password-request",
fileExtension = "json"
),
text = changeUserPasswordRequest
)
)
val request1 = Put(
baseApiUrl + s"/admin/users/iri/${URLEncoder.encode(normalUser.id, "utf-8")}/Password",
HttpEntity(ContentTypes.`application/json`, changeUserPasswordRequest)
) ~> addCredentials(BasicHttpCredentials(normalUser.email, "test")) // requester's password
val response1: HttpResponse = singleAwaitingRequest(request1)
response1.status should be(StatusCodes.BadRequest)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "incomplete-update-user-password-response",
fileExtension = "json"
),
text = responseToString(response1)
)
)
// check that the password was not changed, i.e. the old one is still accepted
val request2 = Get(baseApiUrl + s"/v2/authentication") ~> addCredentials(
BasicHttpCredentials(normalUser.email, "test654321")
) // old password (taken from previous test)
val response2: HttpResponse = singleAwaitingRequest(request2)
response2.status should be(StatusCodes.OK)
}
"return 'BadRequest' if requester's password in change password request is missing" in {
val changeUserPasswordRequest: String =
s"""{
| "newPassword": "testABC"
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "incomplete-update-user-password-request-2",
fileExtension = "json"
),
text = changeUserPasswordRequest
)
)
val request1 = Put(
baseApiUrl + s"/admin/users/iri/${URLEncoder.encode(normalUser.id, "utf-8")}/Password",
HttpEntity(ContentTypes.`application/json`, changeUserPasswordRequest)
) ~> addCredentials(BasicHttpCredentials(normalUser.email, "test")) // requester's password
val response1: HttpResponse = singleAwaitingRequest(request1)
response1.status should be(StatusCodes.BadRequest)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "incomplete-update-user-password-response-2",
fileExtension = "json"
),
text = responseToString(response1)
)
)
// check that the password was not changed, i.e. the old one is still accepted
val request2 = Get(baseApiUrl + s"/v2/authentication") ~> addCredentials(
BasicHttpCredentials(normalUser.email, "test654321")
) // old password
val response2: HttpResponse = singleAwaitingRequest(request2)
response2.status should be(StatusCodes.OK)
}
"change user's status" in {
val changeUserStatusRequest: String =
s"""{
| "status": false
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-status-request",
fileExtension = "json"
),
text = changeUserStatusRequest
)
)
val donaldIriEncoded = java.net.URLEncoder.encode(donaldIri.get, "utf-8")
val request = Put(
baseApiUrl + s"/admin/users/iri/$donaldIriEncoded/Status",
HttpEntity(ContentTypes.`application/json`, changeUserStatusRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.status should be(false)
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-status-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
}
"return 'BadRequest' if more than 1 parameter is provided in update status request" in {
val updateUserRequest: String =
s"""{
| "status": false,
| "username": "parameterDuck"
|}""".stripMargin
val donaldIriEncoded = java.net.URLEncoder.encode(donaldIri.get, "utf-8")
val request = Put(
baseApiUrl + s"/admin/users/iri/$donaldIriEncoded/Status",
HttpEntity(ContentTypes.`application/json`, updateUserRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.BadRequest)
}
"update the user's system admin membership status" in {
val changeUserSystemAdminMembershipRequest: String =
s"""{
| "systemAdmin": true
|}""".stripMargin
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-system-admin-membership-request",
fileExtension = "json"
),
text = changeUserSystemAdminMembershipRequest
)
)
val donaldIriEncoded = java.net.URLEncoder.encode(donaldIri.get, "utf-8")
val request = Put(
baseApiUrl + s"/admin/users/iri/$donaldIriEncoded/SystemAdmin",
HttpEntity(ContentTypes.`application/json`, changeUserSystemAdminMembershipRequest)
) ~> addRootUserCredentials()
val response: HttpResponse = singleAwaitingRequest(request)
response.status should be(StatusCodes.OK)
val result: User = AkkaHttpUtils.httpResponseToJson(response).fields("user").convertTo[User]
result.permissions.groupsPerProject
.get("http://www.knora.org/ontology/knora-admin#SystemProject")
.head should equal(List("http://www.knora.org/ontology/knora-admin#SystemAdmin"))
clientTestDataCollector.addFile(
TestDataFileContent(
filePath = TestDataFilePath(
directoryPath = clientTestDataPath,
filename = "update-user-system-admin-membership-response",
fileExtension = "json"
),
text = responseToString(response)
)
)
// Throw BadRequest exception if user is built-in user
val badRequest = Put(
baseApiUrl + s"/admin/users/iri/$systemUserIriEncoded/SystemAdmin",
HttpEntity(ContentTypes.`application/json`, changeUserSystemAdminMembershipRequest)
) ~> addRootUserCredentials()
val badResponse: HttpResponse = singleAwaitingRequest(badRequest)