Commit 50e6400c authored by Vayhinger's avatar Vayhinger
Browse files

Update README.md

parent 70fd3d1a
......@@ -7,15 +7,20 @@ a set of JUnit tests (that have been priorly provided by the teacher) and receiv
on the test results.
For this to work, the plugin communicates with an external webservice providing essentially the following services on the given paths:
* POST **/v1/unittest**: Expects the assignment id and a zip file containing the unit test files as http post parameters.
* POST **/v1/tasks**: Expects the assignment id and a zip file containing the java files that should be tested as http post parameters. Extracts the zip file, compiles the java files and runs the tests (provided via /v1/unittest). Returns the results in form of JSON.
* POST **/v1/unittest**: Expects the assignment id and a zip file containing a repo.txt with the repository-link and an optional line for credentials when using a private repository.
You need to add the credentials like this: username:passwort or username:auth-token.
* POST **/v1/tasks**: Expects the assignment id and a zip file containing a repo.txt with the repository-link and an optional line for credentials when using a private repository.
You need to add the credentials like this: username:passwort or username:auth-token.
Returns the results as JSON.
* DELETE **/v1/unittest?assignmentId={id}**: Triggers the deletion of the test files.
See here for an implementation of the webservice: [MoDoCoT Backend](!!!!!!!!!!!!!!!!https://github.com/HFTSoftwareProject/MoJEC-Backend)
See here for an implementation of the webservice: [MoDoCoT Backend](https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/MoDoCoT-Backend.git)
## Installation/Configuration
* Install this plugin by using the Moodle web installer, or by extracting the plugin archive to {Moodle_Root}/mod/assign/submission/modocot and visting the admins notifications page.
* Visit the plugin's settings and configure the base URL of the web service to use. (You need a running webservice to use, see [MoDoCoT Backend](!!!!!!!!!!!!!!!!https://github.com/HFTSoftwareProject/MoJEC-Backend) for a working solution)
* Visit the plugin's settings and configure the base URL of the web service to use. (You need a running webservice to use, see [MoDoCoT Backend](https://transfer.hft-stuttgart.de/gitlab/HFTSoftwareProject/MoDoCoT-Backend.git) for a working solution)
* Done!
## Usage (Teacher)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment