Commit 039ac813 authored by Vayhinger's avatar Vayhinger
Browse files

Update README.md

parent fb83f5b6
# Moodle JUnit Excercise Corrector (MoDoCoT) - Backend # Moodle Dockerized Code Testing (MoDoCoT) - Backend
## Usage ## Usage
### Conventions ### Conventions
...@@ -8,19 +8,23 @@ ...@@ -8,19 +8,23 @@
### Build ### Build
This is a maven project. It can be build with `mvn package`. This is a maven project. It can be build with `mvn package`.
There is also ready to go docker image available. It can be found [on Docker Hub](https://hub.docker.com/r/hftstuttgart/modocot-backend/) There is also a ready-to-go docker image available. It can be found [on Docker Hub](https://hub.docker.com/r/hftstuttgart/modocot-backend/)
### Local application configuration ### Server application configuration
We're using the **application.properties** file to configure our application. We're using the **application-server.properties** file to configure the application.
The file can be found under _/src/main/resources/_
To configure your local configuration create a file called _application-local.properties_ in _/src/main/resources/_ and override the properties. You need to configure following entries:
Afterwards configure the application to use the local profile using the run configuration or adding _spring.profiles.active=local_ to the global _application.properties_ file. docker.hostIp= "Your docker host ip"
jenkins.api.token= "Your jenkins api token" [See Jenkins Doc](https://www.jenkins.io/doc/book/using/remote-access-api/)
### Integration tests ### Local application configuration
Modocot-Backend has some rudimentary API tests using [Spring Boot Testing](https://spring.io/blog/2016/04/15/testing-improvements-in-spring-boot-1-4). This tests assure that there won't be any regressions in the API when changing the backend code. We're using the **application.properties** file to configure the application.
The file can be found under _/src/main/resources/_
To be able to run the integration tests the system where the tests are executed needs to be a *nix System because a `/tmp/` folder must exist. Also the needed libraries [JUnit](http://central.maven.org/maven2/junit/junit/4.12/junit-4.12.jar) and [Hamcrest](http://central.maven.org/maven2/org/hamcrest/hamcrest-core/1.3/hamcrest-core-1.3.jar) need to be downloaded into `/opt/modocot/junit/`. You need to configure following entries:
This is the reason why the tests are disabled by default. They can be enabled by setting `-DskipTests=false` docker.hostIp= "Your docker host ip"
jenkins.api.token= "Your jenkins api token" [See Jenkins Doc](https://www.jenkins.io/doc/book/using/remote-access-api/)
## Interfaces ## Interfaces
##### POST /v1/unittest ##### POST /v1/unittest
......
Supports Markdown
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