Javadoc in PathFollowerMoveStrategy.java

GameTest startet

build.gradle

@@ -44,7 +44,7 @@ version = '2022.1'
 
 application {
     // Define the main class for the application.
-    mainClass = 'ch.zhaw.pm2.racetrack.ConsoleApp'
+    mainClass = 'ch.zhaw.pm2.racetrack.Main'
 }
 
 run {

follower/challenge_points.txt

@@ -0,0 +1,19 @@
+(X:40, Y:22)
+(X:43, Y:22)
+(X:46, Y:21)
+(X:48, Y:19)
+(X:48, Y:17)
+(X:46, Y:15)
+(X:41, Y:13)
+(X:41, Y:10)
+(X:46, Y:9)
+(X:49, Y:4)
+(X:40, Y:2)
+(X:30, Y:2)
+(X:21, Y:3)
+(X:16, Y:7)
+(X:13, Y:10)
+(X:14, Y:14)
+(X:11, Y:19)
+(X:13, Y:22)
+(X:24, Y:22)

src/main/java/ch/zhaw/pm2/racetrack/Game.java

@@ -1,10 +1,7 @@
 package ch.zhaw.pm2.racetrack;
 
 import ch.zhaw.pm2.racetrack.given.GameSpecification;
-import ch.zhaw.pm2.racetrack.strategy.DoNotMoveStrategy;
-import ch.zhaw.pm2.racetrack.strategy.MoveListStrategy;
-import ch.zhaw.pm2.racetrack.strategy.PathFollowerMoveStrategy;
-import ch.zhaw.pm2.racetrack.strategy.UserMoveStrategy;
+import ch.zhaw.pm2.racetrack.strategy.*;
 
 import java.io.File;
 import java.io.FileNotFoundException;
@@ -21,7 +18,7 @@ import static ch.zhaw.pm2.racetrack.PositionVector.Direction;
 public class Game implements GameSpecification {
     public static final int NO_WINNER = -1;
     private Track track;
-    int currentCarIndex;
+    private int currentCarIndex;
 
     UserInterface userInterface;
 
@@ -30,7 +27,7 @@ public class Game implements GameSpecification {
     }
 
 
-    public boolean initPhase() throws InvalidTrackFormatException, FileNotFoundException {
+    public boolean initPhase() throws InvalidTrackFormatException {
         File folder = new File("tracks");
         File[] listOfFiles = folder.listFiles();
         if (listOfFiles.length > 0) {
@@ -39,33 +36,46 @@ public class Game implements GameSpecification {
                 tracks.add(file.getName());
             }
             File selectedTrack = listOfFiles[userInterface.selectOption("Select Track file", tracks)];
-            try {
-                track = new Track(selectedTrack);
-            } catch (FileNotFoundException | PositionVectorNotValid e) {
-                e.printStackTrace();
-            }
+            selectTrack(selectedTrack);
             List<String> moveStrategies = new ArrayList<>();
             moveStrategies.add("Do not move Strategy");
             moveStrategies.add("User Move Strategy");
             moveStrategies.add("Move List Strategy");
             moveStrategies.add("Path Follow Move Strategy");
             for (int i = 0; i < track.getCarCount(); i++) {
-                int moveStrategie = userInterface.selectOption(
-                    "Select Strategy for Car " + i + " (" + track.getCarId(i) + ")", moveStrategies);
-                switch (moveStrategie + 1) {
-                    case 1:
-                        track.getCar(i).setMoveStrategy(new DoNotMoveStrategy());
-                        break;
-                    case 2:
-                        track.getCar(i).setMoveStrategy(new UserMoveStrategy(userInterface, i, track.getCarId(i)));
-                        break;
-                    case 3:
-                        track.getCar(i).setMoveStrategy(new MoveListStrategy()); //TODO: add Arguments
-                        break;
-                    case 4:
-                        track.getCar(i).setMoveStrategy(new PathFollowerMoveStrategy()); //TODO: add Arguments
-                        break;
+                Car car = track.getCar(i);
+                MoveStrategy moveStrategy = null;
+                while (moveStrategy == null) {
+                    String filePath;
+                    int moveStrategie = userInterface.selectOption(
+                        "Select Strategy for Car " + i + " (" + track.getCarId(i) + ")", moveStrategies);
+                    switch (moveStrategie + 1) {
+                        case 1:
+                            moveStrategy = new DoNotMoveStrategy();
+                            break;
+                        case 2:
+                            moveStrategy = new UserMoveStrategy(userInterface, i, track.getCarId(i));
+                            break;
+                        case 3:
+                            filePath = ".\\moves\\" + selectedTrack.getName().split("\\.")[0] + "-car-" + track.getCar(i).getID() + ".txt";
+                            try {
+                                moveStrategy = new MoveListStrategy(filePath);
+                            } catch (FileNotFoundException e) {
+                                userInterface.printInformation("There is no Move-List implemented. Choose another Strategy!");
+                            }
+                            //TODO: Backslash kompatibel für Linux
+                            break;
+                        case 4:
+                            filePath = ".\\follower\\" + selectedTrack.getName().split("\\.")[0] + "_points.txt";
+                            try {
+                                moveStrategy = new PathFollowerMoveStrategy(filePath, track.getCarPos(i));
+                            } catch (FileNotFoundException e) {
+                                userInterface.printInformation("There is no Point-List implemented. Choose another Strategy!");
+                            }
+                            break;
+                    }
                 }
+                selectMoveStrategy(car, moveStrategy);
             }
             return true;
         } else {
@@ -74,6 +84,31 @@ public class Game implements GameSpecification {
         }
     }
 
+    /**
+     * The functionality was taken out of init to automate testing
+     *
+     * @param selectedTrack
+     */
+    Track selectTrack(File selectedTrack) {
+        try {
+            track = new Track(selectedTrack);
+            return track;
+        } catch (FileNotFoundException | PositionVectorNotValid | InvalidTrackFormatException e) {
+            e.printStackTrace();
+        }
+        return null;
+    }
+
+    /**
+     * The functionality was taken out of init to automate testing
+     *
+     * @param car      to set the MoveStrategy
+     * @param strategy The movestrategy to set
+     */
+    void selectMoveStrategy(Car car, MoveStrategy strategy) {
+        car.setMoveStrategy(strategy);
+    }
+
     /**
      * Return the index of the current active car.
      * Car indexes are zero-based, so the first car is 0, and the last car is getCarCount() - 1.
@@ -175,6 +210,7 @@ public class Game implements GameSpecification {
                 } else {
                     crashPosition = positionList.get(i - 1);
                 }
+                break;
             }
         }
         if (crashPosition != null) {
@@ -185,20 +221,25 @@ public class Game implements GameSpecification {
         }
     }
 
-    public int gamePhase() throws PositionVectorNotValid {
-        while (CarsMoving() && getWinner() == NO_WINNER) {
+    public String gamePhase() throws PositionVectorNotValid {
+        while (carsMoving() && getWinner() == NO_WINNER) {
             userInterface.printTrack(track);
-            Direction direction = null;
-            direction= track.getCar(currentCarIndex).getMoveStrategy().nextMove();
-            if(direction == null) {
+            Direction direction;
+            direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove();
+            if (direction == null) {
                 track.getCar(currentCarIndex).setMoveStrategy(new DoNotMoveStrategy());
-                direction= track.getCar(currentCarIndex).getMoveStrategy().nextMove();
+                direction = track.getCar(currentCarIndex).getMoveStrategy().nextMove(); //TODO: Entfernen?
+            }else {
+                doCarTurn(direction);
             }
-            doCarTurn(direction);
             switchToNextActiveCar();
         }
         userInterface.printTrack(track);
-        return getWinner();
+        int indexWinner = getWinner();
+        if (indexWinner == NO_WINNER) {
+            return null;
+        }
+        return String.valueOf(track.getCar(indexWinner).getID());
     }
 
     /**
@@ -292,8 +333,7 @@ public class Game implements GameSpecification {
     private void calculateWinner(PositionVector start, PositionVector finish, int carIndex) {
         List<PositionVector> path = calculatePath(start, finish);
         for (PositionVector point : path) {
-            if (track.getSpaceType(point) != null)
-                {
+            if (track.getSpaceType(point) != null) {
                 switch (track.getSpaceType(point)) {
                     case FINISH_UP:
                         if (start.getY() < finish.getY()) {
@@ -323,15 +363,16 @@ public class Game implements GameSpecification {
                             track.getCar(carIndex).increaseWinPoints();
                         }
                         break;
-                    }
-
                 }
+
+            }
         }
     }
 
 
     /**
      * Does indicate if a car would have a crash with a WALL space or another car at the given position.
+     *
      * @param carIndex The zero-based carIndex number
      * @param position A PositionVector of the possible crash position
      * @return A boolean indicator if the car would crash with a WALL or another car.
@@ -343,17 +384,17 @@ public class Game implements GameSpecification {
 
     public boolean onlyOneCarLeft() {
         int carsLeft = 0;
-        for(int carIndex = 0; carIndex < track.getCarCount(); carIndex ++) {
-            if(! track.getCar(carIndex).isCrashed()) {
+        for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) {
+            if (!track.getCar(carIndex).isCrashed()) {
                 carsLeft++;
             }
         }
         return !(carsLeft > 1);
     }
 
-    public boolean CarsMoving() {
-        for(int carIndex = 0; carIndex < track.getCarCount(); carIndex ++) {
-            if(! (track.getCar(carIndex).isCrashed() || track.getCar(carIndex).getMoveStrategy().getClass() == DoNotMoveStrategy.class)) {
+    public boolean carsMoving() {
+        for (int carIndex = 0; carIndex < track.getCarCount(); carIndex++) {
+            if (!(track.getCar(carIndex).isCrashed() || track.getCar(carIndex).getMoveStrategy().getClass() == DoNotMoveStrategy.class)) {
                 return true;
             }
         }

src/main/java/ch/zhaw/pm2/racetrack/Main.java

@@ -6,24 +6,35 @@ import java.util.List;
 
 public class Main {
 
-    public static void main(String[] args) throws InvalidTrackFormatException, FileNotFoundException, PositionVectorNotValid {
-        boolean exit = false;
-        UserInterface userInterface = new UserInterface("Hello and Welcome");
-        while (!exit) {
+    public static void main(String[] args) throws InvalidTrackFormatException, PositionVectorNotValid {
+        UserInterface userInterface = new UserInterface("Hello and Welcome to Racetrack by Team02-\"AngryNerds\"");
+        while (true) {
             Game game = new Game(userInterface);
-            int winner = 0;
+            String winner;
             if (game.initPhase()) {
                 winner = game.gamePhase();
+                List<String> optionsNewGame = new ArrayList<>();
+                optionsNewGame.add("exit");
+                optionsNewGame.add("new game");
+                String winnerText;
+                if(winner == null){
+                    winnerText = "There was no winner.";
+                }
+                else {
+                    winnerText = "The Winner was Car " + winner;
+                }
+                int selectedOption = userInterface.selectOption(winnerText + "\nStart new Game?", optionsNewGame);
+                if(selectedOption == 0) {
+                    userInterface.quit("Thank you and goodbye\npress enter to close the application.");
+                    break;
+                }
             }
-            List<String> optionsNewGame = new ArrayList<>();
-            optionsNewGame.add("exit");
-            optionsNewGame.add("new game");
-            int selectedOption = userInterface.selectOption("The Winner was Car : " + winner + "\nStart new Game?", optionsNewGame);
-            if(selectedOption == 0) {
-                exit = true;
+            else {
+                userInterface.quit("The initialisation of the game failed. Press enter to close the application.");
+                break;
             }
         }
-        userInterface.printInformation("Thank you and goodbye");
+
     }
 
 }

src/main/java/ch/zhaw/pm2/racetrack/UserInterface.java

@@ -97,6 +97,15 @@ public class UserInterface {
             textTerminal.println(track.toString());
     }
 
+    /**
+     * Method to dispose the Textterminal
+     * @param text OUtput Text
+     */
+    public void quit(String text){
+        textIO.newStringInputReader().withMinLength(0).read(text);
+        textTerminal.dispose();
+    }
+
 
 
 }

src/main/java/ch/zhaw/pm2/racetrack/strategy/MoveListStrategy.java

@@ -2,11 +2,44 @@ package ch.zhaw.pm2.racetrack.strategy;
 
 import ch.zhaw.pm2.racetrack.PositionVector.Direction;
 
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Scanner;
+
 public class MoveListStrategy implements MoveStrategy {
 
+    private List<Direction> moveList;
+    private int pointer;
+
+    public MoveListStrategy(String path) throws FileNotFoundException{
+        moveList = new ArrayList<>();
+        pointer = -1;
+        readFile(new File(path));
+    }
+
+    private void readFile(File trackFile) throws FileNotFoundException {
+        Scanner scanner = new Scanner(new FileInputStream(trackFile), "UTF-8");
+        Direction[] directions = Direction.values();
+        while (scanner.hasNextLine()) {
+            String line = scanner.nextLine();
+            for (Direction direction : directions) {
+                if (direction.toString().equals(line)) {
+                    moveList.add(direction);
+                    break;
+                }
+            }
+        }
+    }
+
     @Override
     public Direction nextMove() {
-        // TODO: implementation
-        throw new UnsupportedOperationException();
+        pointer += 1;
+        if (pointer < moveList.size()) {
+            return moveList.get(pointer);
+        }
+        return null;
     }
 }

src/main/java/ch/zhaw/pm2/racetrack/strategy/PathFollowerMoveStrategy.java

@@ -1,15 +1,126 @@
 package ch.zhaw.pm2.racetrack.strategy;
 
+import ch.zhaw.pm2.racetrack.PositionVector;
 import ch.zhaw.pm2.racetrack.PositionVector.Direction;
 
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.util.ArrayList;
+import java.util.Scanner;
+
 /**
  * The PathFollowerMoveStrategy class determines the next move based on a file containing points on a path.
  */
 public class PathFollowerMoveStrategy implements MoveStrategy {
 
+    /**
+     * The current Position of the car.
+     */
+    private PositionVector currentPosition;
+    /**
+     * The current Velocity of the car.
+     */
+    private PositionVector currentVelocity;
+    /**
+     * List of all points on the path.
+     */
+    private ArrayList<PositionVector> pointList;
+    /**
+     * The index of the next point on the path.
+     */
+    private int pointer;
+
+    /**
+     * Constructor to create a new PathFollowerMoveStrategy for a car.
+     * @param path The location where the file is saved
+     * @param startPosition The start position of the car
+     * @throws FileNotFoundException If the file with the given path does not exist.
+     */
+    public PathFollowerMoveStrategy(String path, PositionVector startPosition) throws FileNotFoundException {
+        pointList = new ArrayList<>();
+        pointer = 0;
+        readFile(new File(path));
+        currentPosition = startPosition;
+        currentVelocity = new PositionVector(0, 0);
+    }
+
+    /**
+     * Method to read the given File and add the points to the pointList
+     * @param trackFile the File Object which should be read
+     * @throws FileNotFoundException If the file with the given path does not exist.
+     */
+    public void readFile(File trackFile) throws FileNotFoundException {
+        Scanner scanner = new Scanner(new FileInputStream(trackFile), "UTF-8");
+        while (scanner.hasNextLine()) {
+            String line = scanner.nextLine();
+            String[] coordinates = line.split("(\\(X:|, Y:|\\))");
+            pointList.add(new PositionVector(Integer.parseInt(coordinates[1]), Integer.parseInt(coordinates[2])));
+        }
+    }
+
+    /**
+     * Method to select the direction for the next move.
+     * @return The direction for the next move. null if there are no points left in the list.
+     */
     @Override
     public Direction nextMove() {
-        // TODO: implementation
-        throw new UnsupportedOperationException();
+        // if no more points in the list --> return null
+        if (pointer >= pointList.size()) {
+            return null;
+        }
+
+        // increase pointer variable if the next point is reached.
+        if (pointList.get(pointer).equals(currentPosition)) {
+            pointer ++;
+        }
+
+        // calculate Vector from current Position to next Point
+        PositionVector movementVector = new PositionVector(pointList.get(pointer).getX() - currentPosition.getX(), pointList.get(pointer).getY() - currentPosition.getY());
+
+        // select acceleration for X
+        int accelerationX;
+        if((movementVector.getX() == 0 && currentVelocity.getX() > 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getX() > 0 && movementVector.getX()/2.0 <= currentVelocity.getX()) || //increase velocity
+            (movementVector.getX() < 0 && movementVector.getX()/2.0 < currentVelocity.getX())){ //reduce velocity
+                accelerationX = -1;
+        } else if((movementVector.getX() == 0 && currentVelocity.getX() < 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getX() > 0 && movementVector.getX()/2.0 > currentVelocity.getX()) || //increase velocity
+            (movementVector.getX() < 0 && movementVector.getX()/2.0 >= currentVelocity.getX())) { //reduce velocity
+                accelerationX = 1;
+        }
+        else { //no acceleration
+            accelerationX = 0;
+        }
+
+        // select acceleration for Y
+        int accelerationY;
+        if((movementVector.getY() == 0 && currentVelocity.getY() > 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getY() > 0 && movementVector.getY()/2.0 <= currentVelocity.getY()) || //increase velocity
+            (movementVector.getY() < 0 && movementVector.getY()/2.0 < currentVelocity.getY())){ //reduce velocity
+                accelerationY = -1;
+        } else if((movementVector.getY() == 0 && currentVelocity.getY() < 0) || //reduce velocity to 0 if the destination coordinate is reached
+            (movementVector.getY() > 0 && movementVector.getY()/2.0 > currentVelocity.getY()) || //increase velocity
+            (movementVector.getY() < 0 && movementVector.getY()/2.0 >= currentVelocity.getY())) { //reduce velocity
+                accelerationY = 1;
+        }
+        else { //no acceleration
+            accelerationY = 0;
+        }
+
+        //update current Velocity and current Position with the selected acceleration
+        currentVelocity = new PositionVector(currentVelocity.getX() + accelerationX, currentVelocity.getY() + accelerationY);
+        currentPosition = new PositionVector(currentPosition.getX() + currentVelocity.getX(), currentPosition.getY() + currentVelocity.getY());
+
+        //Find Direction for acceleration
+        PositionVector acceleration = new PositionVector(accelerationX, accelerationY);
+        Direction[] directions = Direction.values();
+        for (Direction direction : directions) {
+            if (direction.vector.equals(acceleration)) {
+                return direction;
+            }
+        }
+    return null;
+
     }
 }

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

@@ -0,0 +1,104 @@
+package ch.zhaw.pm2.racetrack;
+
+import ch.zhaw.pm2.racetrack.strategy.UserMoveStrategy;
+import org.junit.jupiter.api.*;
+
+import java.io.File;
+
+import static ch.zhaw.pm2.racetrack.Game.NO_WINNER;
+
+class GameTest {
+    private UserInterface userInterface;
+    private Game game;
+    private Track track;
+
+    @Nested
+    @DisplayName("Test correct Setup")
+    class Setup {
+        @BeforeEach
+        void setup() {
+            userInterface = new UserInterface("Test");
+            game = new Game(userInterface);
+            track = game.selectTrack(new File(".\\tracks\\challenge.txt"));
+            game.selectMoveStrategy(track.getCar(0),new UserMoveStrategy(new UserInterface("Testing"),0, track.getCarId(0)));
+            game.selectMoveStrategy(track.getCar(1),new UserMoveStrategy(new UserInterface("Testing"),1, track.getCarId(1)));
+
+        }
+
+
+        @Test
+        void getCurrentCarIndex() {
+            Assertions.assertEquals(0,game.getCurrentCarIndex());
+            game.switchToNextActiveCar();
+            Assertions.assertEquals(1,game.getCurrentCarIndex());
+        }
+
+        @Test
+        void getCarId() {
+            Assertions.assertEquals('a',game.getCarId(0));
+            Assertions.assertEquals('b',game.getCarId(1));
+        }
+
+        @Test
+        void getCarPosition() {
+            Assertions.assertEquals(new PositionVector(24,22),game.getCarPosition(0));
+            Assertions.assertEquals(new PositionVector(24,24),game.getCarPosition(1));
+        }
+
+        @Test
+        void getCarVelocity() {
+            Assertions.assertEquals(new PositionVector(0,0),game.getCarVelocity(0));
+            Assertions.assertEquals(new PositionVector(0,0),game.getCarVelocity(1));
+        }
+
+        @Test
+        void getWinner() {
+            Assertions.assertEquals(NO_WINNER,game.getWinner());
+        }
+
+        @Test
+        void onlyOneCarLeft() {
+            Assertions.assertFalse(game.onlyOneCarLeft());
+        }
+
+        @Test
+        void carsMoving() {
+            Assertions.assertTrue(game.carsMoving());
+        }
+    }
+
+    @Nested
+    @DisplayName("Basic manipulation")
+    class manipulation {
+        @BeforeEach
+        void setup() {
+            userInterface = new UserInterface("Test");
+            game = new Game(userInterface);
+            track = game.selectTrack(new File(".\\tracks\\challenge.txt"));
+            game.selectMoveStrategy(track.getCar(0),new UserMoveStrategy(new UserInterface("Testing"),0, track.getCarId(0)));
+            game.selectMoveStrategy(track.getCar(1),new UserMoveStrategy(new UserInterface("Testing"),1, track.getCarId(1)));
+
+        }
+
+        @Test
+        void carTurnCorrect() {
+            try {
+                game.doCarTurn(PositionVector.Direction.RIGHT);
+                Assertions.assertEquals(new PositionVector(1,0),game.getCarVelocity(0));
+            } catch (PositionVectorNotValid positionVectorNotValid) {
+                positionVectorNotValid.printStackTrace();
+            }
+        }
+
+        @Test
+        void carCrash() {
+            try {
+                game.doCarTurn(PositionVector.Direction.UP);
+                Assertions.assertTrue(game.onlyOneCarLeft());
+            } catch (PositionVectorNotValid positionVectorNotValid) {
+                positionVectorNotValid.printStackTrace();
+            }
+        }
+
+    }
+}

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

@@ -0,0 +1,40 @@
+package ch.zhaw.pm2.racetrack;
+
+import ch.zhaw.pm2.racetrack.strategy.MoveListStrategy;
+import ch.zhaw.pm2.racetrack.strategy.MoveStrategy;
+import org.junit.jupiter.api.*;
+
+import java.io.FileNotFoundException;
+
+public class MoveStrategyTest {
+
+    private MoveStrategy moveList;
+
+    @Nested
+    @DisplayName("MoveListStrategy")
+    class MoveList {
+
+
+        @BeforeEach
+        void setup() {
+            try {
+                moveList = new MoveListStrategy(".\\moves\\challenge-car-a.txt");
+            }catch (FileNotFoundException e) {
+                e.printStackTrace();
+            }
+        }
+
+        @Test
+        void checkMove() {
+            Assertions.assertEquals(PositionVector.Direction.RIGHT,moveList.nextMove());
+            for (int i = 0; i < 3; i++) {
+                moveList.nextMove();
+            }
+            Assertions.assertEquals(PositionVector.Direction.NONE,moveList.nextMove());
+            for (int i = 0; i < 40; i++) {
+                moveList.nextMove();
+            }
+            Assertions.assertNull(moveList.nextMove());
+        }
+    }
+}