From 591bbc423d06d770c9af4b3eb25af0d53cb8f9a7 Mon Sep 17 00:00:00 2001
From: Andrin Fassbind <fassband@students.zhaw.ch>
Date: Fri, 25 Mar 2022 23:44:56 +0100
Subject: [PATCH] javadoc

---
 .../java/ch/zhaw/pm2/racetrack/TrackTest.java | 38 ++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java b/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java
index 807a832..164b0a7 100644
--- a/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java
+++ b/src/test/java/ch/zhaw/pm2/racetrack/TrackTest.java
@@ -29,12 +29,18 @@ public class TrackTest {
 
         }
 
+        /**
+         * Checks if correct amount of cars has been instantiated
+         */
         @Test
         @DisplayName("Create correct amount of Car instance")
         void checkCars() {
             Assertions.assertEquals(2, trackObj.getCarCount());
         }
 
+        /**
+         * Checks if car id matches track file symbol
+         */
         @Test
         @DisplayName("Create Car instance with correct Symbols / Id")
         void checkCarId() {
@@ -42,13 +48,18 @@ public class TrackTest {
             Assertions.assertEquals('b', trackObj.getCarId(1));
         }
 
-
+        /**
+         * checks if track reads space typ from track file correctly
+         */
         @Test
         @DisplayName("Check getSpaceTyp")
         void getSpaceTyp() {
             Assertions.assertEquals(ConfigSpecification.SpaceType.FINISH_RIGHT, trackObj.getSpaceType(new PositionVector(22, 24)));
         }
 
+        /**
+         * checks if track finds the finish line at the correct positions
+         */
         @Test
         @DisplayName("Find FinishLine")
         void findFinish() {
@@ -59,6 +70,9 @@ public class TrackTest {
             Assertions.assertEquals(expected, trackObj.getFinishLine());
         }
 
+        /**
+         * Checks if track does read in track file correctly
+         */
         @Test
         @DisplayName("Converts track file correctly to List<String>")
         void checkTrack() {
@@ -86,6 +100,9 @@ public class TrackTest {
             }
         }
 
+        /**
+         * checks if track does process car move correctly
+         */
         @Test
         @DisplayName("Make Car move down on track")
         void makeCarMoveDown() {
@@ -97,6 +114,9 @@ public class TrackTest {
             Assertions.assertEquals(beforeMove.getX(), afterMove.getX());
         }
 
+        /**
+         * Checks if car does not move if there is no acceleartion
+         */
         @Test
         @DisplayName("Make Car move with (0,0) acceleration on track")
         void makeCarStay() {
@@ -107,6 +127,9 @@ public class TrackTest {
             Assertions.assertEquals(beforeMove.getX(), afterMove.getX());
         }
 
+        /**
+         * Checks if car does crash
+         */
         @Test
         @DisplayName("Will Car Crash")
         void willCarCrash() {
@@ -119,6 +142,9 @@ public class TrackTest {
 
         }
 
+        /**
+         * checks if track is updated after car crash
+         */
         @Test
         @DisplayName("Make Car Crash")
         void makeCarCrash() {
@@ -128,10 +154,14 @@ public class TrackTest {
         }
     }
 
+    /**
+     * This testcase does check for negative test cases
+     */
     @Nested
     @DisplayName("Negative TestCase")
     class negativeClass {
         File file;
+
         @BeforeEach
         void setup() {
             file = new File(".\\tracks\\challenge.txt");
@@ -143,6 +173,9 @@ public class TrackTest {
             }
         }
 
+        /**
+         * Tries to read not valid file
+         */
         @Test
         @DisplayName("Throw error if File not found")
         void canReadFile() {
@@ -150,6 +183,9 @@ public class TrackTest {
             Assertions.assertThrows(FileNotFoundException.class, () -> new Track(file));
         }
 
+        /**
+         * Tries to read not valid file with 2 cars with same symbol
+         */
         @Test
         @DisplayName("Throw error if File is invalid")
         void invalidTrackFile() {