feat: refactor TextAPI (cf. #50)

Feature

Summary

This MR moves most of the functionality out of tapi.xqm into separate designated modules. As a result, tapi.xqm mainly contains the RESTXQ endpoints.

In detail, the following modules have been created:

• tapi-collection.xqm: creating all information necessary for the TextAPI collection endpoint (/collection.json)
• tapi-manifest.xqm: creating all information necessary for the TextAPI collection endpoint (/manifest.json)
• tapi-item.xqm: creating all information necessary for the TextAPI collection endpoint (/latest/item.json)
• tapi-html.xqm: handling the creation of the HTML presentation of a given page (/content/xxxx.html)
• tapi-txt.xqm: handling the creation of the TXT presentation of a given page (/content/xxxx.txt) which is needed for the collation

All modules have been provided with extensive tests. The module functions and expected parameters aim to be descriptive to such a degree that additional documentation can be kept to a minimum (following Robert Martin's and Martin Fowler's advice).

---

Furthermore, several testsuites are considered and inspected during the unit_test stage of the CI/CD since every module of the ones mentioned above has its own unit testing module.

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

Use Cases

As a developer, having clean and separate modules speeds up my work, and more tests assure my that everything is working fine.

Documentation

• I updated the README (if applicable)
• I provided my functions with appropriate 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

#50 (closed), #57 (closed)

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

exist-app/modules/testtrigger.xqm

@@ -6,7 +6,6 @@ xquery version "3.1";
  : since at this point the RESTXQ API isn't fired up yet which causes the tests to throw errors.
  : 
  : @author Michelle Weidling
- : @version 0.1.0
  : @since 0.4.0
  :)
 
@@ -14,7 +13,14 @@ module namespace testtrigger="http://ahikar.sub.uni-goettingen.de/ns/testtrigger
 
 import module namespace rest="http://exquery.org/ns/restxq";
 import module namespace test="http://exist-db.org/xquery/xqsuite" at "resource:org/exist/xquery/lib/xqsuite/xqsuite.xql";
-import module namespace tests="http://ahikar.sub.uni-goettingen.de/ns/tapi/tests" at "../tests.xqm";
+
+import module namespace ttt="http://ahikar.sub.uni-goettingen.de/ns/tapi/txt/tests" at "../tests/tapi-txt-tests.xqm";
+import module namespace ct="http://ahikar.sub.uni-goettingen.de/ns/commons-tests" at "../tests/commons-tests.xqm";
+import module namespace tct="http://ahikar.sub.uni-goettingen.de/ns/tapi/collection/tests" at "../tests/tapi-collection-tests.xqm";
+import module namespace thtmlt="http://ahikar.sub.uni-goettingen.de/ns/tapi/html/tests" at "../tests/tapi-html-tests.xqm";
+import module namespace titemt="http://ahikar.sub.uni-goettingen.de/ns/tapi/item/tests" at "../tests/tapi-item-tests.xqm";
+import module namespace tmt="http://ahikar.sub.uni-goettingen.de/ns/tapi/manifest/tests" at "../tests/tapi-manifest-tests.xqm";
+import module namespace tt="http://ahikar.sub.uni-goettingen.de/ns/tapi/tests" at "../tests/tapi-tests.xqm";
 
 (:~
  : Triggers the tests for the Ahikar backend. Called by the CI.
@@ -33,7 +39,16 @@ as item()? {
     then error(QName("error://1", "deploy"), "Deploy token incorrect.")
   else
     let $sysout := util:log-system-out("TextAPI and package installation done. running tests…")
-    let $tests := test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/tests"))
+    let $tests :=
+        (
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/tests")),
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/txt/tests")),
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/commons-tests")),
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/collection/tests")),
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/manifest/tests")),
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/item/tests")),
+            test:suite(util:list-functions("http://ahikar.sub.uni-goettingen.de/ns/tapi/html/tests"))
+        )
     
     let $fileSeparator := util:system-property("file.separator")
     let $system-path := system:get-exist-home() || $fileSeparator