From 43436a11c4fe7f11da3a9e5dfd38713a54e1ccc2 Mon Sep 17 00:00:00 2001 From: mamunozgil <miguel.munoz-gil@hft-stuttgart.de> Date: Thu, 20 Feb 2025 15:29:09 +0100 Subject: [PATCH] Update readme --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 284fcf9..d1b043d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# DTABackend +# CoTA Backend Backend Rest Web Service for the Moodle Dockerized Test Agent (DTA) plugin. ## Name -Moodle Dockerized Test Agent (MoDTA) backend. +Moodle Containerized Test Agent (CoTA) backend. ## Visuals -See plugin docs at the Moodle HQ or the readme at https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/moodledta. +See plugin docs at the Moodle HQ or the readme at [Moodle Assign Submission DTA repo](https://transfer.hft-stuttgart.de/gitlab/cota/moodle-assignsubmission_dta) ## Installation Assumption for usage: git, Java JDK 21, maven and docker installed, docker running. @@ -24,7 +24,7 @@ Assumption: members of a system group named 'docker' have access rights to the d Then build the docker image using (Hint: There are backticks in front of 'getent' and after 'f3') - docker build --build-arg AGID=`getent group docker | cut -d: -f3` --build-arg BUILD_NUMBER=$BUILD_NUMBER -t <YOUR_DOCKERHUB_ORGANISATION>/dta-backend:latest . + docker build --build-arg AGID=`getent group docker | cut -d: -f3` --build-arg BUILD_NUMBER=$BUILD_NUMBER -t <YOUR_DOCKERHUB_ORGANISATION>/cota-backend:latest . The default image is provided with the organisation hftstuttgart. @@ -32,20 +32,20 @@ Assumption for integration: docker-compose or a new docker version with integrat Test it without building anything e.g. with Moodle 4.3 using the provided docker-compose.yaml. With this compose file, after Moodle spinup -- install the dta plugin -- configure Moodle to open the necessary ports and hosts under Site Administration/Security/HTTP Security -- configure moodle dta plugin backend url to e.g. backendcomposedtt:8080 when using the example dockerfile -- ensure read/write access to the host temp dir for the dta plugin, e.g. with the example dockerfile for the group 'docker' to /tmp/dta-tests -- create a new course -- create a new assignment - - configure the assignment as Dockerized Test Agent - - provide the example repo in the teacher-dta-dir.txt example file -- add a submission to the new assignment - - provide the example repo in the student-dir.txt example file -- see the result! +- Install the dta plugin +- Configure Moodle to open the necessary ports and hosts under Site Administration/Security/HTTP Security +- Configure moodle dta plugin backend url to e.g. backend:8080 when using the example dockerfile +- Ensure read/write access to the host temp dir for the dta plugin, e.g. with the example dockerfile for the group 'docker' to /tmp/dta-tests +- Create a new course +- Create a new assignment + - Configure the assignment as Dockerized Test Agent + - Provide the example repo in the teacher-dta-dir.txt example file +- Add a submission to the new assignment + - Provide the example repo in the student-dir.txt example file +- See the result! ## Usage -See plugin docs at the Moodle HQ or the readme at https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/moodledta. +See plugin docs at the Moodle HQ or the readme at [Moodle Assign Submission DTA repo](https://transfer.hft-stuttgart.de/gitlab/cota/moodle-assignsubmission_dta) ## Support Issue tracker in this Portal. @@ -53,7 +53,7 @@ Issue tracker in this Portal. ## Roadmap See issues: -HIGH: Include agent recommendation functionality, support for Subversion version control system and kubernetes infrastructure alternatively to docker(-compose). +HIGH: Include SSH+SVN support (SVN currently under https) MEDIUM: Enhance security by building all images to run as non-root. @@ -67,6 +67,7 @@ Lineage: - Master student project Moodle JUnit Exercise Corrector (MoJEC, 2017), - Bachelor student project Moodle Dockerized Code Testing (MoDoCoT, 2020), - Master thesis project Moodle Dockerized Test Tool (Moodle DTT, 2021). +- AVILAB2 project (CoTA, 2024) ## License See LICENSE in the root directory. -- GitLab