From a5af54940b8cbf9e610e504b4c628a7b62d034f6 Mon Sep 17 00:00:00 2001 From: Olivia <johain@stud.ntnu.no> Date: Sat, 22 Apr 2023 15:38:14 +0200 Subject: [PATCH] Expand readme to include tests, remove gdx dependencies from model Model is meant to have little to no dependencies --- README.md | 8 ++++++++ build.gradle | 3 --- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b6ef509..b4f0539 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,14 @@ Additionally, the following important files and folders exist: Building components can be done from the command line or your favorite IDE. This will not be demonstrated in detail, as this is fairly straight-forward for the components involved. +### Optional: running tests + +There are several tests, though particularly of the server and model, attempting to validate core parts of the logic. + +These can be run from the terminal using `./gradlew test`, or by right-clicking each "test" folder in each module, and clicking "Run tests". While there are facilities to run all tests in an entire project in Android Studio, for reasons we don't understand, it complains about not finding the "COMPILE_JAVA" target, in spite of everything else working fine. + +It's also worth noting that certain tests may fail on the first try, particularly among the server tests. This is a consequence of the somewhat non-deterministic behavior of a few of the tests. Attempts have been made to reduce this as much as possible, but it can occasionally happen regardless. + ### Server #### Alternative 1: Official server diff --git a/build.gradle b/build.gradle index 61b6983..2333d35 100644 --- a/build.gradle +++ b/build.gradle @@ -146,8 +146,5 @@ project(":model") { testImplementation 'org.jetbrains.kotlin:kotlin-test' testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.2' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.2' - implementation "com.badlogicgames.gdx:gdx:1.10.0" - implementation "com.badlogicgames.gdx:gdx-backend-headless:1.10.0" - } } -- GitLab