test(service): move game service's examples to pytest and added more

Author: FlysonBot

src/mastermind/core/models/game_state.py

@@ -41,7 +41,7 @@ def get_winner(
     max_attempts: int,
     last_feedback: tuple[int, int],
     number_of_dots: int,
-) -> Optional[PlayerRole]:
+) -> PlayerRole:
     """Determines the winner of the game based on the number of attempts and the last feedback.
 
     Args:

src/mastermind/core/services/game_service.py

@@ -35,15 +35,6 @@ def add_round(self, guess: tuple[int, ...], feedback: tuple[int, int]) -> None:
             guess (tuple[int, ...]): A tuple representing the player's current guess.
             feedback (tuple[int, int]): A tuple containing the number of correct and misplaced pegs.
 
-        Examples:
-            >>> from mastermind.core.models.game_configuration import GameConfiguration
-            >>> from mastermind.core.models.game_mode import GameMode
-            >>> game = Game(game_configuration=GameConfiguration(NUMBER_OF_COLORS=3, NUMBER_OF_DOTS=4, ATTEMPTS_ALLOWED=5, GAME_MODE=GameMode.PVP))
-            >>> service = GameService(game)
-            >>> service.add_round((1, 2, 3, 4), (1, 0))
-            >>> game.game_board.game_rounds
-            deque([GameRound(GUESS=(1, 2, 3, 4), FEEDBACK=(1, 0))])
-
         Raises:
             GameEndedException: When trying to add a round to a game that has ended.
         """
@@ -63,18 +54,6 @@ def add_round(self, guess: tuple[int, ...], feedback: tuple[int, int]) -> None:
     def undo(self) -> None:
         """Undo the most recent game round.
 
-        Examples:
-            >>> from mastermind.core.models.game_configuration import GameConfiguration
-            >>> from mastermind.core.models.game_mode import GameMode
-            >>> game = Game(game_configuration=GameConfiguration(NUMBER_OF_COLORS=3, NUMBER_OF_DOTS=4, ATTEMPTS_ALLOWED=5, GAME_MODE=GameMode.PVP))
-            >>> service = GameService(game)
-            >>> service.add_round((1, 2, 3, 4), (1, 0))
-            >>> game.game_board.game_rounds
-            deque([GameRound(GUESS=(1, 2, 3, 4), FEEDBACK=(1, 0))])
-            >>> service.undo()
-            >>> game.game_board.game_rounds
-            deque([])
-
         Raises:
             GameNotStartedException: When trying to undo game rounds before the game has started.
             GameEndedException: When trying to undo game rounds after the game has ended.
@@ -93,17 +72,6 @@ def undo(self) -> None:
     def redo(self) -> None:
         """Restores the most recently undone game round.
 
-        Examples:
-            >>> from mastermind.core.models.game_configuration import GameConfiguration
-            >>> from mastermind.core.models.game_mode import GameMode
-            >>> game = Game(game_configuration=GameConfiguration(NUMBER_OF_COLORS=3, NUMBER_OF_DOTS=4, ATTEMPTS_ALLOWED=5, GAME_MODE=GameMode.PVP))
-            >>> service = GameService(game)
-            >>> service.add_round((1, 2, 3, 4), (1, 0))
-            >>> service.undo()
-            >>> service.redo()
-            >>> game.game_board.game_rounds
-            deque([GameRound(GUESS=(1, 2, 3, 4), FEEDBACK=(1, 0))])
-
         Raises:
             GameNotStartedException: When trying to redo game rounds before the game has started.
         """

src/mastermind/core/services/gameboard_service.py

@@ -5,6 +5,10 @@
 from mastermind.core.models.gameboard import GameBoard
 
 
+class NoRedoAvailableException(Exception):
+    pass
+
+
 class GameboardService:
     """This class manages the game board and provides methods for adding and undoing game rounds.
 
@@ -60,7 +64,11 @@ def redo(self) -> None:
             [GameRound(GUESS=(1, 2, 3, 4), FEEDBACK=(1, 0)), GameRound(GUESS=(3, 4, 5, 6), FEEDBACK=(2, 1))]
         """
 
-        self.game_rounds.append(self.undo_stack.pop())
+        try:
+            self.game_rounds.append(self.undo_stack.pop())
+
+        except IndexError as e:
+            raise NoRedoAvailableException("No redo available.") from e
 
     def add_round(self, guess: tuple[int, ...], feedback: tuple[int, int]) -> None:
         """Adds a new game round with the player's guess and corresponding feedback.

src/tests/libs/test_game_service.py

@@ -0,0 +1,84 @@
+from collections import deque
+
+import pytest
+
+from mastermind.core.controllers.players import PlayerRole
+from mastermind.core.models.game import Game
+from mastermind.core.models.game_configuration import GameConfiguration
+from mastermind.core.models.game_mode import GameMode
+from mastermind.core.models.game_round import GameRound
+from mastermind.core.services.game_service import (
+    GameEndedException,
+    GameNotStartedException,
+    GameService,
+)
+from mastermind.core.services.gameboard_service import NoRedoAvailableException
+
+
+@pytest.fixture
+def game():
+    return Game(
+        game_configuration=GameConfiguration(
+            NUMBER_OF_COLORS=3,
+            NUMBER_OF_DOTS=4,
+            ATTEMPTS_ALLOWED=5,
+            GAME_MODE=GameMode.PVP,
+        )
+    )
+
+
+@pytest.fixture
+def game_service(game: Game):
+    return GameService(game)
+
+
+def test_add_round(game_service: GameService, game: Game):
+    game_service.add_round((1, 2, 3, 4), (1, 0))
+    assert game.game_board.game_rounds == deque(
+        [GameRound(GUESS=(1, 2, 3, 4), FEEDBACK=(1, 0))]
+    )
+
+
+def test_undo(game_service: GameService, game: Game):
+    game_service.add_round((1, 2, 3, 4), (1, 0))
+    game_service.undo()
+    assert game.game_board.game_rounds == deque([])
+
+
+def test_add_round_with_redo(game_service: GameService, game: Game):
+    game_service.add_round((1, 2, 3, 4), (1, 0))
+    game_service.undo()
+    game_service.redo()
+    assert game.game_board.game_rounds == deque(
+        [GameRound(GUESS=(1, 2, 3, 4), FEEDBACK=(1, 0))]
+    )
+
+
+def test_add_round_after_end(game_service: GameService, game: Game):
+    game.game_state.game_started = True
+    game.game_state.winner = PlayerRole.CODE_SETTER
+    with pytest.raises(GameEndedException):
+        game_service.add_round((1, 2, 3, 4), (1, 0))
+
+
+def test_undo_after_end(game_service: GameService, game: Game):
+    game.game_state.game_started = True
+    game.game_state.winner = PlayerRole.CODE_SETTER
+    with pytest.raises(GameEndedException):
+        game_service.undo()
+
+
+def test_undo_before_start(game_service: GameService, game: Game):
+    with pytest.raises(GameNotStartedException):
+        game_service.undo()
+
+
+def test_redo_before_start(game_service: GameService, game: Game):
+    with pytest.raises(GameNotStartedException):
+        game_service.redo()
+
+
+def test_redo_without_undo(game_service: GameService, game: Game):
+    game_service.add_round((1, 2, 3, 4), (1, 0))
+    with pytest.raises(NoRedoAvailableException):
+        game_service.redo()