-
Notifications
You must be signed in to change notification settings - Fork 18
/
KnoraSipiIntegrationV2ITSpec.scala
1412 lines (1159 loc) · 58.9 KB
/
KnoraSipiIntegrationV2ITSpec.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 - 2023 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.it.v2
import org.apache.pekko.http.scaladsl.model._
import org.apache.pekko.http.scaladsl.model.headers.BasicHttpCredentials
import org.apache.pekko.http.scaladsl.unmarshalling.Unmarshal
import java.net.URLEncoder
import java.nio.file.Paths
import scala.concurrent.Await
import scala.concurrent.duration._
import dsp.errors.AssertionException
import dsp.errors.BadRequestException
import dsp.valueobjects.Iri
import org.knora.webapi._
import org.knora.webapi.messages.IriConversions._
import org.knora.webapi.messages.OntologyConstants
import org.knora.webapi.messages.SmartIri
import org.knora.webapi.messages.StringFormatter
import org.knora.webapi.messages.store.sipimessages._
import org.knora.webapi.messages.store.triplestoremessages.TriplestoreJsonProtocol
import org.knora.webapi.messages.util.rdf._
import org.knora.webapi.messages.v2.routing.authenticationmessages._
import org.knora.webapi.models.filemodels._
import org.knora.webapi.routing.UnsafeZioRun
import org.knora.webapi.sharedtestdata.SharedTestDataADM
import org.knora.webapi.testservices.FileToUpload
import org.knora.webapi.util.MutableTestIri
/**
* Tests interaction between Knora and Sipi using Knora API v2.
*/
class KnoraSipiIntegrationV2ITSpec
extends ITKnoraLiveSpec
with AuthenticationV2JsonProtocol
with TriplestoreJsonProtocol {
private implicit val stringFormatter: StringFormatter = StringFormatter.getGeneralInstance
private val anythingUserEmail = SharedTestDataADM.anythingAdminUser.email
private val password = SharedTestDataADM.testPass
private val stillImageResourceIri = new MutableTestIri
private val stillImageFileValueIri = new MutableTestIri
private val pdfResourceIri = new MutableTestIri
private val pdfValueIri = new MutableTestIri
private val xmlResourceIri = new MutableTestIri
private val xmlValueIri = new MutableTestIri
private val csvResourceIri = new MutableTestIri
private val csvValueIri = new MutableTestIri
private val zipResourceIri = new MutableTestIri
private val zipValueIri = new MutableTestIri
private val wavResourceIri = new MutableTestIri
private val wavValueIri = new MutableTestIri
private val videoResourceIri = new MutableTestIri
private val videoValueIri = new MutableTestIri
private val marblesOriginalFilename = "marbles.tif"
private val pathToMarbles = Paths.get("..", s"test_data/test_route/images/$marblesOriginalFilename")
private val marblesWidth = 1419
private val marblesHeight = 1001
private val pathToMarblesWithWrongExtension =
Paths.get("..", "test_data/test_route/images/marbles_with_wrong_extension.jpg")
private val jp2OriginalFilename = "67352ccc-d1b0-11e1-89ae-279075081939.jp2"
private val pathToJp2 = Paths.get("..", s"test_data/test_route/images/$jp2OriginalFilename")
private val trp88OriginalFilename = "Trp88.tiff"
private val pathToTrp88 = Paths.get("..", s"test_data/test_route/images/$trp88OriginalFilename")
private val trp88Width = 499
private val trp88Height = 630
private val minimalPdfOriginalFilename = "minimal.pdf"
private val pathToMinimalPdf = Paths.get("..", s"test_data/test_route/files/$minimalPdfOriginalFilename")
private val testPdfOriginalFilename = "test.pdf"
private val pathToTestPdf = Paths.get("..", s"test_data/test_route/files/$testPdfOriginalFilename")
private val csv1OriginalFilename = "eggs.csv"
private val pathToCsv1 = Paths.get("..", s"test_data/test_route/files/$csv1OriginalFilename")
private val csv2OriginalFilename = "spam.csv"
private val pathToCsv2 = Paths.get("..", s"test_data/test_route/files/$csv2OriginalFilename")
private val xml1OriginalFilename = "test1.xml"
private val pathToXml1 = Paths.get("..", s"test_data/test_route/files/$xml1OriginalFilename")
private val xml2OriginalFilename = "test2.xml"
private val pathToXml2 = Paths.get("..", s"test_data/test_route/files/$xml2OriginalFilename")
private val minimalZipOriginalFilename = "minimal.zip"
private val pathToMinimalZip = Paths.get("..", s"test_data/test_route/files/$minimalZipOriginalFilename")
private val testZipOriginalFilename = "test.zip"
private val pathToTestZip = Paths.get("..", s"test_data/test_route/files/$testZipOriginalFilename")
private val test7zOriginalFilename = "test.7z"
private val pathToTest7z = Paths.get("..", s"test_data/test_route/files/$test7zOriginalFilename")
private val minimalWavOriginalFilename = "minimal.wav"
private val pathToMinimalWav = Paths.get("..", s"test_data/test_route/files/$minimalWavOriginalFilename")
private val testWavOriginalFilename = "test.wav"
private val pathToTestWav = Paths.get("..", s"test_data/test_route/files/$testWavOriginalFilename")
private val testVideoOriginalFilename = "testVideo.mp4"
private val pathToTestVideo = Paths.get("..", s"test_data/test_route/files/$testVideoOriginalFilename")
private val testVideo2OriginalFilename = "testVideo2.mp4"
private val pathToTestVideo2 = Paths.get("..", s"test_data/test_route/files/$testVideo2OriginalFilename")
private val thingDocumentIRI = "http://0.0.0.0:3333/ontology/0001/anything/v2#ThingDocument"
private val validationFun: (String, => Nothing) => String = (s, e) => Iri.validateAndEscapeIri(s).getOrElse(e)
/**
* Represents the information that Knora returns about an image file value that was created.
*
* @param internalFilename the image's internal filename.
* @param iiifUrl the image's IIIF URL.
* @param width the image's width in pixels.
* @param height the image's height in pixels.
*/
case class SavedImage(internalFilename: String, iiifUrl: String, width: Int, height: Int)
/**
* Represents the information that Knora returns about a document file value that was created.
*
* @param internalFilename the files's internal filename.
* @param url the file's URL.
*/
case class SavedDocument(
internalFilename: String,
url: String
)
/**
* Represents the information that Knora returns about a text file value that was created.
*
* @param internalFilename the file's internal filename.
* @param url the file's URL.
*/
case class SavedTextFile(internalFilename: String, url: String)
/**
* Represents the information that Knora returns about an audio file value that was created.
*
* @param internalFilename the file's internal filename.
* @param url the file's URL.
*/
case class SavedAudioFile(internalFilename: String, url: String)
/**
* Represents the information that Knora returns about a video file value that was created.
*
* @param internalFilename the file's internal filename.
* @param url the file's URL.
*/
case class SavedVideoFile(
internalFilename: String,
url: String
)
/**
* Given a JSON-LD document representing a resource, returns a JSON-LD array containing the values of the specified
* property.
*
* @param resource the JSON-LD document.
* @param propertyIriInResult the property IRI.
* @return a JSON-LD array containing the values of the specified property.
*/
private def getValuesFromResource(resource: JsonLDDocument, propertyIriInResult: SmartIri): JsonLDArray =
resource.body.getRequiredArray(propertyIriInResult.toString).fold(e => throw BadRequestException(e), identity)
/**
* Given a JSON-LD document representing a resource, returns a JSON-LD object representing the expected single
* value of the specified property.
*
* @param resource the JSON-LD document.
* @param propertyIriInResult the property IRI.
* @param expectedValueIri the IRI of the expected value.
* @return a JSON-LD object representing the expected single value of the specified property.
*/
private def getValueFromResource(
resource: JsonLDDocument,
propertyIriInResult: SmartIri,
expectedValueIri: IRI
): JsonLDObject = {
val resourceIri: IRI =
resource.body.requireStringWithValidation(JsonLDKeywords.ID, validationFun)
val propertyValues: JsonLDArray =
getValuesFromResource(resource = resource, propertyIriInResult = propertyIriInResult)
val matchingValues: Seq[JsonLDObject] = propertyValues.value.collect {
case jsonLDObject: JsonLDObject
if jsonLDObject.requireStringWithValidation(
JsonLDKeywords.ID,
validationFun
) == expectedValueIri =>
jsonLDObject
}
if (matchingValues.isEmpty) {
throw AssertionException(
s"Property <$propertyIriInResult> of resource <$resourceIri> does not have value <$expectedValueIri>"
)
}
if (matchingValues.size > 1) {
throw AssertionException(
s"Property <$propertyIriInResult> of resource <$resourceIri> has more than one value with the IRI <$expectedValueIri>"
)
}
matchingValues.head
}
/**
* Given a JSON-LD object representing a Knora image file value, returns a [[SavedImage]] containing the same information.
*
* @param savedValue a JSON-LD object representing a Knora image file value.
* @return a [[SavedImage]] containing the same information.
*/
private def savedValueToSavedImage(savedValue: JsonLDObject): SavedImage = {
val internalFilename = savedValue
.getRequiredString(OntologyConstants.KnoraApiV2Complex.FileValueHasFilename)
.fold(msg => throw BadRequestException(msg), identity)
val validationFun: (String, => Nothing) => String = (s, errorFun) =>
Iri.toSparqlEncodedString(s).getOrElse(errorFun)
val iiifUrl = savedValue.requireDatatypeValueInObject(
key = OntologyConstants.KnoraApiV2Complex.FileValueAsUrl,
expectedDatatype = OntologyConstants.Xsd.Uri.toSmartIri,
validationFun
)
val width = savedValue
.getRequiredInt(OntologyConstants.KnoraApiV2Complex.StillImageFileValueHasDimX)
.fold(e => throw BadRequestException(e), identity)
val height = savedValue
.getRequiredInt(OntologyConstants.KnoraApiV2Complex.StillImageFileValueHasDimY)
.fold(e => throw BadRequestException(e), identity)
SavedImage(
internalFilename = internalFilename,
iiifUrl = iiifUrl,
width = width,
height = height
)
}
/**
* Given a JSON-LD object representing a Knora document file value, returns a [[SavedDocument]] containing the same information.
*
* @param savedValue a JSON-LD object representing a Knora document file value.
* @return a [[SavedDocument]] containing the same information.
*/
private def savedValueToSavedDocument(savedValue: JsonLDObject): SavedDocument = {
val internalFilename = savedValue
.getRequiredString(OntologyConstants.KnoraApiV2Complex.FileValueHasFilename)
.fold(msg => throw BadRequestException(msg), identity)
val validationFun: (String, => Nothing) => String = (s, errorFun) =>
Iri.toSparqlEncodedString(s).getOrElse(errorFun)
val url: String = savedValue.requireDatatypeValueInObject(
key = OntologyConstants.KnoraApiV2Complex.FileValueAsUrl,
expectedDatatype = OntologyConstants.Xsd.Uri.toSmartIri,
validationFun
)
SavedDocument(
internalFilename = internalFilename,
url = url
)
}
/**
* Given a JSON-LD object representing a Knora text file value, returns a [[SavedTextFile]] containing the same information.
*
* @param savedValue a JSON-LD object representing a Knora document file value.
* @return a [[SavedTextFile]] containing the same information.
*/
private def savedValueToSavedTextFile(savedValue: JsonLDObject): SavedTextFile = {
val internalFilename = savedValue
.getRequiredString(OntologyConstants.KnoraApiV2Complex.FileValueHasFilename)
.fold(msg => throw BadRequestException(msg), identity)
val validationFun: (String, => Nothing) => String = (s, errorFun) =>
Iri.toSparqlEncodedString(s).getOrElse(errorFun)
val url: String = savedValue.requireDatatypeValueInObject(
key = OntologyConstants.KnoraApiV2Complex.FileValueAsUrl,
expectedDatatype = OntologyConstants.Xsd.Uri.toSmartIri,
validationFun
)
SavedTextFile(
internalFilename = internalFilename,
url = url
)
}
/**
* Given a JSON-LD object representing a Knora audio file value, returns a [[SavedAudioFile]] containing the same information.
*
* @param savedValue a JSON-LD object representing a Knora audio file value.
* @return a [[SavedAudioFile]] containing the same information.
*/
private def savedValueToSavedAudioFile(savedValue: JsonLDObject): SavedAudioFile = {
val internalFilename = savedValue
.getRequiredString(OntologyConstants.KnoraApiV2Complex.FileValueHasFilename)
.fold(msg => throw BadRequestException(msg), identity)
val validationFun: (String, => Nothing) => String = (s, errorFun) =>
Iri.toSparqlEncodedString(s).getOrElse(errorFun)
val url: String = savedValue.requireDatatypeValueInObject(
key = OntologyConstants.KnoraApiV2Complex.FileValueAsUrl,
expectedDatatype = OntologyConstants.Xsd.Uri.toSmartIri,
validationFun
)
SavedAudioFile(
internalFilename = internalFilename,
url = url
)
}
/**
* Given a JSON-LD object representing a Knora video file value, returns a [[SavedVideoFile]] containing the same information.
*
* @param savedValue a JSON-LD object representing a Knora video file value.
* @return a [[SavedVideoFile]] containing the same information.
*/
private def savedValueToSavedVideoFile(savedValue: JsonLDObject): SavedVideoFile = {
val internalFilename = savedValue
.getRequiredString(OntologyConstants.KnoraApiV2Complex.FileValueHasFilename)
.fold(msg => throw BadRequestException(msg), identity)
val validationFun: (String, => Nothing) => String = (s, errorFun) =>
Iri.toSparqlEncodedString(s).getOrElse(errorFun)
val url: String = savedValue.requireDatatypeValueInObject(
key = OntologyConstants.KnoraApiV2Complex.FileValueAsUrl,
expectedDatatype = OntologyConstants.Xsd.Uri.toSmartIri,
validationFun
)
SavedVideoFile(
internalFilename = internalFilename,
url = url
)
}
"The Knora/Sipi integration" should {
var loginToken: String = ""
"log in as a Knora user" in {
/* Correct username and correct password */
val params =
s"""
|{
| "email": "$anythingUserEmail",
| "password": "$password"
|}
""".stripMargin
val request = Post(baseApiUrl + s"/v2/authentication", HttpEntity(ContentTypes.`application/json`, params))
val response: HttpResponse = singleAwaitingRequest(request)
assert(response.status == StatusCodes.OK)
val lr: LoginResponse = Await.result(Unmarshal(response.entity).to[LoginResponse], 1.seconds)
loginToken = lr.token
loginToken.nonEmpty should be(true)
}
"create a resource with a still image file" in {
// Upload the image to Sipi.
val sipiUploadResponse: SipiUploadResponse =
uploadToSipi(
loginToken = loginToken,
filesToUpload =
Seq(FileToUpload(path = pathToMarbles, mimeType = org.apache.http.entity.ContentType.IMAGE_TIFF))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(marblesOriginalFilename)
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(
fileType = FileType.StillImageFile(),
internalFilename = uploadedFile.internalFilename
)
.toJsonLd(
className = Some("ThingPicture"),
ontologyName = "anything"
)
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
stillImageResourceIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(stillImageResourceIri.get, "UTF-8")}")
val resource: JsonLDDocument = getResponseJsonLD(knoraGetRequest)
assert(
UnsafeZioRun
.runOrThrow(resource.body.getRequiredTypeAsKnoraApiV2ComplexTypeIri)
.toString == "http://0.0.0.0:3333/ontology/0001/anything/v2#ThingPicture"
)
// Get the new file value from the resource.
val savedValues: JsonLDArray = getValuesFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasStillImageFileValue.toSmartIri
)
val savedValue: JsonLDValue = if (savedValues.value.size == 1) {
savedValues.value.head
} else {
throw AssertionException(s"Expected one file value, got ${savedValues.value.size}")
}
val savedValueObj: JsonLDObject = savedValue match {
case jsonLDObject: JsonLDObject => jsonLDObject
case other => throw AssertionException(s"Invalid value object: $other")
}
stillImageFileValueIri.set(UnsafeZioRun.runOrThrow(savedValueObj.getRequiredIdValueAsKnoraDataIri).toString)
val savedImage = savedValueToSavedImage(savedValueObj)
assert(savedImage.internalFilename == uploadedFile.internalFilename)
assert(savedImage.width == marblesWidth)
assert(savedImage.height == marblesHeight)
}
"create a resource with a still image file without processing" in {
// Upload the image to Sipi.
val sipiUploadResponse: SipiUploadWithoutProcessingResponse =
uploadWithoutProcessingToSipi(
loginToken = loginToken,
filesToUpload = Seq(FileToUpload(path = pathToJp2, mimeType = org.apache.http.entity.ContentType.IMAGE_JPEG))
)
val uploadedFile: SipiUploadWithoutProcessingResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.filename should ===(jp2OriginalFilename)
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(
fileType = FileType.StillImageFile(),
internalFilename = uploadedFile.filename
)
.toJsonLd(
className = Some("ThingPicture"),
ontologyName = "anything"
)
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
stillImageResourceIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(stillImageResourceIri.get, "UTF-8")}")
val resource: JsonLDDocument = getResponseJsonLD(knoraGetRequest)
assert(
UnsafeZioRun
.runOrThrow(resource.body.getRequiredTypeAsKnoraApiV2ComplexTypeIri)
.toString == "http://0.0.0.0:3333/ontology/0001/anything/v2#ThingPicture"
)
// Get the new file value from the resource.
val savedValues: JsonLDArray = getValuesFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasStillImageFileValue.toSmartIri
)
val savedValue = savedValues.value.head
val savedValueObj: JsonLDObject = savedValue match {
case jsonLDObject: JsonLDObject => jsonLDObject
case other => throw AssertionException(s"Invalid value object: $other")
}
stillImageFileValueIri.set(UnsafeZioRun.runOrThrow(savedValueObj.getRequiredIdValueAsKnoraDataIri).toString)
val savedImage = savedValueToSavedImage(savedValueObj)
assert(savedImage.internalFilename == uploadedFile.filename)
}
"create a resource with a still image file that has already been ingested" in {
copyFileToImageFolderInContainer("0001", "De6XyNL4H71-D9QxghOuOPJ.jp2")
copyFileToImageFolderInContainer("0001", "De6XyNL4H71-D9QxghOuOPJ.info")
copyFileToImageFolderInContainer("0001", "De6XyNL4H71-D9QxghOuOPJ.png.orig")
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(fileType = FileType.StillImageFile(), internalFilename = "De6XyNL4H71-D9QxghOuOPJ.jp2")
.toJsonLd(className = Some("ThingPicture"), ontologyName = "anything")
val request = Post(s"$baseApiUrl/v2/resources", HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)) ~>
addCredentials(BasicHttpCredentials(anythingUserEmail, password)) ~>
addHeader("X-Asset-Ingested", "true")
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
// Get the resource from the API.
val resIri = UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString
val getRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(resIri, "UTF-8")}")
checkResponseOK(getRequest)
}
"not create a resource with a still image file that has already been ingested if the header is not provided" in {
copyFileToImageFolderInContainer("0001", "De6XyNL4H71-D9QxghOuOPJ.jp2")
copyFileToImageFolderInContainer("0001", "De6XyNL4H71-D9QxghOuOPJ.info")
copyFileToImageFolderInContainer("0001", "De6XyNL4H71-D9QxghOuOPJ.png.orig")
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(fileType = FileType.StillImageFile(), internalFilename = "De6XyNL4H71-D9QxghOuOPJ.jp2")
.toJsonLd(className = Some("ThingPicture"), ontologyName = "anything")
val request = Post(s"$baseApiUrl/v2/resources", HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)) ~>
addCredentials(BasicHttpCredentials(anythingUserEmail, password)) // no X-Asset-Ingested header
val res = singleAwaitingRequest(request)
assert(res.status == StatusCodes.BadRequest)
}
"reject an image file with the wrong file extension" in {
val exception = intercept[BadRequestException] {
uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(
FileToUpload(
path = pathToMarblesWithWrongExtension,
mimeType = org.apache.http.entity.ContentType.IMAGE_TIFF
)
)
)
}
assert(exception.getMessage.contains("MIME type and/or file extension are inconsistent"))
}
"change a still image file value" in {
// Upload the image to Sipi.
val sipiUploadResponse: SipiUploadResponse =
uploadToSipi(
loginToken = loginToken,
filesToUpload =
Seq(FileToUpload(path = pathToTrp88, mimeType = org.apache.http.entity.ContentType.IMAGE_TIFF))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(trp88OriginalFilename)
// JSON describing the new image to the API.
val jsonLdEntity = ChangeFileRequest
.make(
fileType = FileType.StillImageFile(),
internalFilename = uploadedFile.internalFilename,
resourceIri = stillImageResourceIri.get,
valueIri = stillImageFileValueIri.get,
className = Some("ThingPicture"),
ontologyName = "anything"
)
.toJsonLd
// Send the JSON in a PUT request to the API.
val knoraPostRequest =
Put(baseApiUrl + "/v2/values", HttpEntity(ContentTypes.`application/json`, jsonLdEntity)) ~> addCredentials(
BasicHttpCredentials(anythingUserEmail, password)
)
val responseJsonDoc = getResponseJsonLD(knoraPostRequest)
stillImageFileValueIri.set(
UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString
)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(stillImageResourceIri.get, "UTF-8")}")
val resource = getResponseJsonLD(knoraGetRequest)
// Get the new file value from the resource.
val savedValue: JsonLDObject = getValueFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasStillImageFileValue.toSmartIri,
expectedValueIri = stillImageFileValueIri.get
)
val savedImage = savedValueToSavedImage(savedValue)
assert(savedImage.internalFilename == uploadedFile.internalFilename)
assert(savedImage.width == trp88Width)
assert(savedImage.height == trp88Height)
// Request the permanently stored image from Sipi.
val sipiGetImageRequest = Get(savedImage.iiifUrl.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetImageRequest)
}
"create a resource with a PDF file" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(
FileToUpload(path = pathToMinimalPdf, mimeType = org.apache.http.entity.ContentType.create("application/pdf"))
)
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(minimalPdfOriginalFilename)
// Create the resource in the API.
val jsonLdEntity =
UploadFileRequest
.make(
fileType = FileType.DocumentFile(),
internalFilename = uploadedFile.internalFilename
)
.toJsonLd(
className = Some("ThingDocument"),
ontologyName = "anything"
)
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
pdfResourceIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(pdfResourceIri.get, "UTF-8")}")
val resource: JsonLDDocument = getResponseJsonLD(knoraGetRequest)
assert(
UnsafeZioRun.runOrThrow(resource.body.getRequiredTypeAsKnoraApiV2ComplexTypeIri).toString == thingDocumentIRI
)
// Get the new file value from the resource.
val savedValues: JsonLDArray = getValuesFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasDocumentFileValue.toSmartIri
)
val savedValue: JsonLDValue = if (savedValues.value.size == 1) {
savedValues.value.head
} else {
throw AssertionException(s"Expected one file value, got ${savedValues.value.size}")
}
val savedValueObj: JsonLDObject = savedValue match {
case jsonLDObject: JsonLDObject => jsonLDObject
case other => throw AssertionException(s"Invalid value object: $other")
}
pdfValueIri.set(UnsafeZioRun.runOrThrow(savedValueObj.getRequiredIdValueAsKnoraDataIri).toString)
val savedDocument: SavedDocument = savedValueToSavedDocument(savedValueObj)
assert(savedDocument.internalFilename == uploadedFile.internalFilename)
// Request the permanently stored file from Sipi.
val sipiGetFileRequest = Get(savedDocument.url.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetFileRequest)
}
"change a PDF file value" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(
FileToUpload(path = pathToTestPdf, mimeType = org.apache.http.entity.ContentType.create("application/pdf"))
)
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(testPdfOriginalFilename)
// Update the value.
val jsonLdEntity = ChangeFileRequest
.make(
fileType = FileType.DocumentFile(),
internalFilename = uploadedFile.internalFilename,
resourceIri = pdfResourceIri.get,
valueIri = pdfValueIri.get,
className = Some("ThingDocument"),
ontologyName = "anything"
)
.toJsonLd
val request =
Put(s"$baseApiUrl/v2/values", HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)) ~> addCredentials(
BasicHttpCredentials(anythingUserEmail, password)
)
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
pdfValueIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(pdfResourceIri.get, "UTF-8")}")
val resource = getResponseJsonLD(knoraGetRequest)
// Get the new file value from the resource.
val savedValue: JsonLDObject = getValueFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasDocumentFileValue.toSmartIri,
expectedValueIri = pdfValueIri.get
)
val savedDocument: SavedDocument = savedValueToSavedDocument(savedValue)
assert(savedDocument.internalFilename == uploadedFile.internalFilename)
// Request the permanently stored file from Sipi.
val sipiGetFileRequest = Get(savedDocument.url.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetFileRequest)
}
"not create a document resource if the file is actually a zip file" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(
FileToUpload(path = pathToMinimalZip, mimeType = org.apache.http.entity.ContentType.create("application/zip"))
)
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(minimalZipOriginalFilename)
uploadedFile.fileType should equal("archive")
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(
fileType = FileType.DocumentFile(),
internalFilename = uploadedFile.internalFilename
)
.toJsonLd(
className = Some("ThingDocument"),
ontologyName = "anything"
)
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val response = singleAwaitingRequest(request)
assert(response.status == StatusCodes.BadRequest)
}
"create a resource with a CSV file" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload =
Seq(FileToUpload(path = pathToCsv1, mimeType = org.apache.http.entity.ContentType.create("text/csv")))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(csv1OriginalFilename)
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(
fileType = FileType.TextFile,
internalFilename = uploadedFile.internalFilename
)
.toJsonLd()
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
val resourceIri: IRI =
responseJsonDoc.body.requireStringWithValidation(JsonLDKeywords.ID, validationFun)
csvResourceIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(resourceIri, "UTF-8")}")
val resource = getResponseJsonLD(knoraGetRequest)
// Get the new file value from the resource.
val savedValues: JsonLDArray = getValuesFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasTextFileValue.toSmartIri
)
val savedValue: JsonLDValue = if (savedValues.value.size == 1) {
savedValues.value.head
} else {
throw AssertionException(s"Expected one file value, got ${savedValues.value.size}")
}
val savedValueObj: JsonLDObject = savedValue match {
case jsonLDObject: JsonLDObject => jsonLDObject
case other => throw AssertionException(s"Invalid value object: $other")
}
csvValueIri.set(UnsafeZioRun.runOrThrow(savedValueObj.getRequiredIdValueAsKnoraDataIri).toString)
val savedTextFile: SavedTextFile = savedValueToSavedTextFile(savedValueObj)
assert(savedTextFile.internalFilename == uploadedFile.internalFilename)
// Request the permanently stored file from Sipi.
val sipiGetFileRequest = Get(savedTextFile.url.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetFileRequest)
}
"change a CSV file value" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload =
Seq(FileToUpload(path = pathToCsv2, mimeType = org.apache.http.entity.ContentType.create("text/csv")))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(csv2OriginalFilename)
// Update the value.
val jsonLdEntity = ChangeFileRequest
.make(
fileType = FileType.TextFile,
internalFilename = uploadedFile.internalFilename,
resourceIri = csvResourceIri.get,
valueIri = csvValueIri.get
)
.toJsonLd
val request =
Put(s"$baseApiUrl/v2/values", HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)) ~> addCredentials(
BasicHttpCredentials(anythingUserEmail, password)
)
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
csvValueIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(csvResourceIri.get, "UTF-8")}")
val resource = getResponseJsonLD(knoraGetRequest)
// Get the new file value from the resource.
val savedValue: JsonLDObject = getValueFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasTextFileValue.toSmartIri,
expectedValueIri = csvValueIri.get
)
val savedTextFile: SavedTextFile = savedValueToSavedTextFile(savedValue)
assert(savedTextFile.internalFilename == uploadedFile.internalFilename)
// Request the permanently stored file from Sipi.
val sipiGetFileRequest = Get(savedTextFile.url.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetFileRequest)
}
"not create a resource with a still image file that's actually a text file" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload =
Seq(FileToUpload(path = pathToCsv1, mimeType = org.apache.http.entity.ContentType.create("text/csv")))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(csv1OriginalFilename)
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(fileType = FileType.StillImageFile(), internalFilename = uploadedFile.internalFilename)
.toJsonLd()
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val response = singleAwaitingRequest(request)
assert(response.status == StatusCodes.BadRequest)
}
"create a resource with an XML file" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(FileToUpload(path = pathToXml1, mimeType = org.apache.http.entity.ContentType.TEXT_XML))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(xml1OriginalFilename)
// Create the resource in the API.
val jsonLdEntity = UploadFileRequest
.make(fileType = FileType.TextFile, internalFilename = uploadedFile.internalFilename)
.toJsonLd()
val request = Post(
s"$baseApiUrl/v2/resources",
HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)
) ~> addCredentials(BasicHttpCredentials(anythingUserEmail, password))
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
val resourceIri: IRI =
responseJsonDoc.body.requireStringWithValidation(JsonLDKeywords.ID, validationFun)
xmlResourceIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(resourceIri, "UTF-8")}")
val resource = getResponseJsonLD(knoraGetRequest)
// Get the new file value from the resource.
val savedValues: JsonLDArray = getValuesFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasTextFileValue.toSmartIri
)
val savedValue: JsonLDValue = if (savedValues.value.size == 1) {
savedValues.value.head
} else {
throw AssertionException(s"Expected one file value, got ${savedValues.value.size}")
}
val savedValueObj: JsonLDObject = savedValue match {
case jsonLDObject: JsonLDObject => jsonLDObject
case other => throw AssertionException(s"Invalid value object: $other")
}
xmlValueIri.set(UnsafeZioRun.runOrThrow(savedValueObj.getRequiredIdValueAsKnoraDataIri).toString)
val savedTextFile: SavedTextFile = savedValueToSavedTextFile(savedValueObj)
assert(savedTextFile.internalFilename == uploadedFile.internalFilename)
// Request the permanently stored file from Sipi.
val sipiGetFileRequest = Get(savedTextFile.url.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetFileRequest)
}
"change an XML file value" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(FileToUpload(path = pathToXml2, mimeType = org.apache.http.entity.ContentType.TEXT_XML))
)
val uploadedFile: SipiUploadResponseEntry = sipiUploadResponse.uploadedFiles.head
uploadedFile.originalFilename should ===(xml2OriginalFilename)
// Update the value.
val jsonLdEntity = ChangeFileRequest
.make(
fileType = FileType.TextFile,
internalFilename = uploadedFile.internalFilename,
resourceIri = xmlResourceIri.get,
valueIri = xmlValueIri.get
)
.toJsonLd
val request =
Put(s"$baseApiUrl/v2/values", HttpEntity(RdfMediaTypes.`application/ld+json`, jsonLdEntity)) ~> addCredentials(
BasicHttpCredentials(anythingUserEmail, password)
)
val responseJsonDoc: JsonLDDocument = getResponseJsonLD(request)
xmlValueIri.set(UnsafeZioRun.runOrThrow(responseJsonDoc.body.getRequiredIdValueAsKnoraDataIri).toString)
// Get the resource from Knora.
val knoraGetRequest = Get(s"$baseApiUrl/v2/resources/${URLEncoder.encode(xmlResourceIri.get, "UTF-8")}")
val resource = getResponseJsonLD(knoraGetRequest)
// Get the new file value from the resource.
val savedValue: JsonLDObject = getValueFromResource(
resource = resource,
propertyIriInResult = OntologyConstants.KnoraApiV2Complex.HasTextFileValue.toSmartIri,
expectedValueIri = xmlValueIri.get
)
val savedTextFile: SavedTextFile = savedValueToSavedTextFile(savedValue)
assert(savedTextFile.internalFilename == uploadedFile.internalFilename)
// Request the permanently stored file from Sipi.
val sipiGetFileRequest = Get(savedTextFile.url.replace("http://0.0.0.0:1024", baseInternalSipiUrl))
checkResponseOK(sipiGetFileRequest)
}
"not create a resource of type TextRepresentation with a Zip file" in {
// Upload the file to Sipi.
val sipiUploadResponse: SipiUploadResponse = uploadToSipi(
loginToken = loginToken,
filesToUpload = Seq(