Feature/#52 annotationapi tests

Feature

Summary

This MR provides…

• extensive tests for the AnnotationAPI. For this, some minor changes several functions have been made and several minor bugs fixed.
• the annotation module has been split to annotation.xqm and annotation-rest.xqm, the latter holding only the REST interface definitions. Both reside now in their own collection, modules/AnnotationAPI, which makes the app a bit more clear.
• a better structure of the modules by moving the fragment retrieval to commons.xqm. This way, annotations.xqm doesn't have to import tapi-html.xqm which makes no sense (the HTML creation is logically independent from the annotations).
• test-runner.xq which can be used for local unit testing now inherits from test-trigger.xqm, thus reducing duplications (DRY!). Cf. #62 (closed)
• The output of the tests have been remodeled to be both human and machine readable which addresses #61 (closed).
• The sample files have been renamed for clarity and slightly altered/enhanced to better depict the project's data structure.
• The content of repo.xml has been shortened in order to avoid having version information on two places.

Compliance to “Definition of Done”

• Unit tests passed
• Code reviewed
• Acceptance criteria met
• Functional tests passed
• Non-Functional requirements met
• Product Owner accepts the User Story

Documentation

• I updated existing documentation

Tests

Are we able to test this new feature?

• Yes, everything can be done via unit tests.

Changelog

• I added a statement to the CHANGELOG.

Version number

• I bumped the version number in build.properties.

Related Tickets

Closes

Closes #52 (closed), #61 (closed), #62 (closed).

/cc Mathias Göbel, Frank Schneider, Michelle Weidling

exist-app/tests/tapi-txt-tests.xqm

@@ -18,11 +18,11 @@ declare variable $ttt:kant-transcription := $ttt:kant-sample//tei:text[@type = "
 declare 
     %test:tearDown
 function ttt:_test-teardown() {
-    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample-transcription-first_narrative_section.txt"),
-    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample-transcription-sayings.txt"),
-    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample-transcription-second_narrative_section.txt"),
-    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample-transcription-third_narrative_section.txt"),
-    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample-transcription-parables.txt"),
+    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample_teixml-transcription-first_narrative_section.txt"),
+    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample_teixml-transcription-sayings.txt"),
+    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample_teixml-transcription-second_narrative_section.txt"),
+    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample_teixml-transcription-third_narrative_section.txt"),
+    xmldb:remove("/db/apps/sade/textgrid/txt", "arabic--kant_sample_teixml-transcription-parables.txt"),
     
     xmldb:remove("/db/apps/sade/textgrid/txt", "karshuni-Beispieldatei_zum_Testen-ahiqar_sample-transcription-first_narrative_section.txt"),
     xmldb:remove("/db/apps/sade/textgrid/txt", "karshuni-Beispieldatei_zum_Testen-ahiqar_sample-transcription-sayings.txt"),
@@ -527,7 +527,7 @@ declare
     %test:assertEquals(" Es ist also wenigstens eine der näheren Untersuchung noch benötigte und nicht auf den")
 function ttt:check-contents($chunk-type as xs:string) {
     let $serialize := tapi-txt:main()
-    let $filepath := "/db/apps/sade/textgrid/txt/arabic--kant_sample-transcription-" || $chunk-type || ".txt"
+    let $filepath := "/db/apps/sade/textgrid/txt/arabic--kant_sample_teixml-transcription-" || $chunk-type || ".txt"
     return
         util:binary-doc($filepath)
         => util:base64-decode()