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

.gitlab-ci.yml

@@ -4,10 +4,13 @@ stages:
   - package
   - deploy_docker
   - deploy_app
-  - test
+  - api_tests
   - release
   - reassign_labels
 
+include: 
+  - '/ci-scripts/.api_tests.yml'
+
 ## TEMPLATES:
 .ssh-config: &ssh
 - which ssh-agent
@@ -183,69 +186,6 @@ deploy_app-main:
   script:
     - curl --get --silent https://ahikar.sub.uni-goettingen.de/api/deploy
 
-# this serves for checking if a commit has accidentally broken the API
-test_api_status-test:
-  image: docker.gitlab.gwdg.de/mrodzis/test
-  stage: test
-  except:
-    - main
-    - tags
-    - develop
-  script:
-    - header=$(curl --head -s https://ahikar-test.sub.uni-goettingen.de/api/textapi/ahikar/3r9ps/collection.json)
-    - status=$(echo $header | head -n 1 | cut -d" " -f 2)
-    - echo "Current HTTP status is $status."
-    - if [[ "$status" == "200" ]]; then exit 0; else exit 1; fi
-
-test_api_status-develop:
-  image: docker.gitlab.gwdg.de/mrodzis/test
-  stage: test
-  only:
-    - develop
-  script: 
-    - header=$(curl --head -s https://ahikar-dev.sub.uni-goettingen.de/api/textapi/ahikar/3r9ps/collection.json)
-    - status=$(echo $header | head -n 1 | cut -d" " -f 2)
-    - echo "Current HTTP status is $status."
-    - if [[ "$status" == "200" ]]; then exit 0; else exit 1; fi
-
-test_api_status-main:
-  image: docker.gitlab.gwdg.de/mrodzis/test
-  stage: test
-  only:
-    - main
-  script: 
-    - header=$(curl --head -s https://ahikar.sub.uni-goettingen.de/api/textapi/ahikar/3r9ps/collection.json)
-    - status=$(echo $header | head -n 1 | cut -d" " -f 2)
-    - echo "Current HTTP status is $status."
-    - if [[ "$status" == "200" ]]; then exit 0; else exit 1; fi
-  retry: 2
-
-full_plain_text_api_status-test:
-  image: docker.gitlab.gwdg.de/mrodzis/test
-  stage: test
-  except:
-    - main
-    - tags
-    - develop
-  script:
-    - header=$(curl --head --silent https://ahikar-test.sub.uni-goettingen.de/api/content/ahikar-plain-text.zip)
-
-full_plain_text_api_status-develop:
-  image: docker.gitlab.gwdg.de/mrodzis/test
-  stage: test
-  only:
-    - develop
-  script:
-    - header=$(curl --head --silent https://ahikar-dev.sub.uni-goettingen.de/api/content/ahikar-plain-text.zip)
-
-full_plain_text_api_status-main:
-  image: docker.gitlab.gwdg.de/mrodzis/test
-  stage: test
-  only:
-    - main
-  script:
-    - header=$(curl --head --silent https://ahikar.sub.uni-goettingen.de/api/content/ahikar-plain-text.zip)
-
 # when a git flow release is made, a tag will be pushed starting this job. it
 # will keep the resulting artifact from job number one and it will set up a
 # Gitlab release at the repo. therefore the merge message starting at the release