Merge remote-tracking branch 'origin/main'

src/test/java/ch/zhaw/pm2/racetrack/CarTest.java

@@ -33,6 +33,9 @@ class CarTest {
         car = new Car(DEFAULT_ID, new PositionVector(DEFAULT_X, DEFAULT_Y));
     }
 
+    /**
+     * Checks getID
+     */
     @Test
     void getID() {
         assertEquals(DEFAULT_ID, car.getID());

src/test/java/ch/zhaw/pm2/racetrack/GameTest.java

@@ -45,6 +45,9 @@ class GameTest {
 
         }
 
+        /**
+         * Tests if Carindex is correct
+         */
         @Test
         void getCurrentCarIndex() {
             Assertions.assertEquals(CAR_INDEX_ONE, game.getCurrentCarIndex());
@@ -52,34 +55,52 @@ class GameTest {
             Assertions.assertEquals(CAR_INDEX_TWO, game.getCurrentCarIndex());
         }
 
+        /**
+         * Checks if CarId matches char given in trackfile
+         */
         @Test
         void getCarId() {
             Assertions.assertEquals('a', game.getCarId(0));
             Assertions.assertEquals('b', game.getCarId(1));
         }
 
+        /**
+         * Checks initial carposition
+         */
         @Test
         void getCarPosition() {
             Assertions.assertEquals(new PositionVector(24, 22), game.getCarPosition(0));
             Assertions.assertEquals(new PositionVector(24, 24), game.getCarPosition(1));
         }
 
+        /**
+         * Checks if initial carvelocity is 0,0
+         */
         @Test
         void getCarVelocity() {
             Assertions.assertEquals(new PositionVector(0, 0), game.getCarVelocity(0));
             Assertions.assertEquals(new PositionVector(0, 0), game.getCarVelocity(1));
         }
 
+        /**
+         * Checks initial winner
+         */
         @Test
         void getWinner() {
             Assertions.assertEquals(NO_WINNER, game.getWinner());
         }
 
+        /**
+         * Checks correct inital state
+         */
         @Test
         void onlyOneCarLeft() {
             Assertions.assertFalse(game.onlyOneCarLeft());
         }
 
+        /**
+         * Checks if cars are able to move
+         */
         @Test
         void carsMoving() {
             Assertions.assertTrue(game.carsMoving());
@@ -109,6 +130,9 @@ class GameTest {
 
         }
 
+        /**
+         * Checks if car does change velocity specified by direction input
+         */
         @Test
         void carTurnCorrect() {
             game.doCarTurn(RIGHT);
@@ -131,6 +155,9 @@ class GameTest {
     class Play {
         private Game game;
 
+        /**
+         * This method will start a game instance on the challenge track. Car a uses MoveListStrategy. Car b uses DoNotMoveStrategy
+         */
         @Test
         void winner() {
             game = new Game(new interFace("Test",new Integer[]{0,2,0},new PositionVector.Direction[]{RIGHT,
@@ -176,6 +203,9 @@ class GameTest {
             Assertions.assertEquals("a",game.gamePhase());
         }
 
+        /**
+         * Will start a game instance where car a does crash.
+         */
         @Test
         void crashA() {
             game = new Game(new interFace("Test",new Integer[]{0,1,0},new PositionVector.Direction[]{UP}), new Config());
@@ -183,6 +213,9 @@ class GameTest {
             Assertions.assertEquals("b",game.gamePhase());
         }
 
+        /**
+         * Checks that a car cant win before finishing a complete round around the track.
+         */
         @Test
         void passFinishLineInWrongDirection() {
             game = new Game(new interFace("Test",new Integer[]{1,0,1},new PositionVector.Direction[]{LEFT,NONE,NONE,RIGHT,RIGHT}), new Config());
@@ -190,6 +223,9 @@ class GameTest {
             Assertions.assertEquals("a",game.gamePhase());
         }
 
+        /**
+         * Does wait 10 seconds before closing the textio.
+         */
         @AfterEach
         void cleanUp() {
             try {