test: add more backend testing

Author: FlysonBot

src/mastermind/client/languages/localization.py

@@ -2,13 +2,30 @@
 from pathlib import Path
 from typing import Any, Dict
 
+from mastermind.libs.logs import ClientLogger
 from mastermind.libs.utils import CallableDotDict
 
 JSON = list[Any] | dict[str, Any]
+logger = ClientLogger("Localization")
 
 
 class Localization:
-    """Localization class for printing messages in different languages."""
+    """Localization class for printing messages in different languages.
+
+    Examples:
+        >>> localization = Localization(language="en")
+        >>> localization.language
+        'en'
+        >>> localization.menu.main_menu.menu_title
+        'Main Menu'
+        >>> localization.language = "zh"
+        >>> localization.menu.main_menu.menu_title
+        '主菜单'
+        >>> localization.language = "unsupported_language"
+        Traceback (most recent call last):
+        ...
+        FileNotFoundError: Language pack for 'unsupported_language' not found.
+    """
 
     _language_pack: Dict[str, CallableDotDict] = {}
 
@@ -22,6 +39,7 @@ def language(self) -> str:
     @language.setter
     def language(self, language: str) -> None:
         """Set and load new language."""
+        logger.debug(f"Setting language to: {language}")
         self.messages: CallableDotDict = self.load_language_pack(language)
         self._language: str = language
 
@@ -32,6 +50,7 @@ def load_language_pack(self, language: str) -> CallableDotDict:
 
         file_path = Path(f"{Path(__file__).parent}/{language}.json")
         if not file_path.is_file():
+            logger.error(f"Language pack for '{language}' not found.")
             raise FileNotFoundError(f"Language pack for '{language}' not found.")
 
         with open(file_path, "r", encoding="utf-8") as f:
@@ -41,6 +60,7 @@ def print_message(message: str, **kwargs: Any) -> str:
 
             data: JSON = json.load(f)
             self._language_pack[language] = CallableDotDict(data, func=print_message)
+            logger.info(f"Language pack for '{language}' loaded successfully")
             return self._language_pack[language]
 
     def __getattr__(self, item: str) -> CallableDotDict:

src/mastermind/server/api/__init__.py

@@ -0,0 +1,3 @@
+from .app import app
+
+__all__ = ["app"]

src/mastermind/server/database/io/cattrs_multifiles_handler.py

@@ -142,9 +142,6 @@ def delete(self, key: str) -> None:
         try:
             os.remove(os.path.join(self.path, f"{key}.json"))
 
-        except FileNotFoundError as e:
-            _log_exception(f"File {key}.json does not exist in {self.path}", e)
-
         except Exception as e:
             _log_exception(f"Error deleting {key}.json", e)
 

src/tests/conftest.py

@@ -0,0 +1,40 @@
+from tempfile import TemporaryDirectory
+from typing import Any, Generator
+
+import pytest
+
+from mastermind.server.database.enum import GameMode
+from mastermind.server.database.models import Game, GameConfiguration
+from mastermind.server.database.repository import GameRepository
+from mastermind.server.services import GameboardService, GameService
+
+
+@pytest.fixture
+def game_configuration() -> GameConfiguration:
+    return GameConfiguration(
+        NUMBER_OF_COLORS=3,
+        NUMBER_OF_DOTS=4,
+        ATTEMPTS_ALLOWED=5,
+        GAME_MODE=GameMode.PVP,
+    )
+
+
+@pytest.fixture
+def game(game_configuration: GameConfiguration) -> Game:
+    return Game(game_configuration=game_configuration)
+
+
+@pytest.fixture
+def gameboard_service(game: Game) -> GameboardService:
+    return GameboardService(game.game_board)
+
+
+@pytest.fixture
+def game_service(game: Game, gameboard_service: GameboardService) -> GameService:
+    return GameService(game, gameboard_service)
+
+
+@pytest.fixture
+def game_repository() -> Generator[GameRepository, Any, None]:
+    with TemporaryDirectory() as temp_dir:
+        yield GameRepository(temp_dir)

src/tests/libs/__init__.py

@@ -0,0 +1,43 @@
+from dataclasses import dataclass
+
+import pytest
+
+from mastermind.server.database.repository import GameRepository
+
+
+@pytest.fixture
+def unexpected_object() -> object:
+    class UnexpectedObject:
+        some_field: str = "Hello, World!"
+
+    return UnexpectedObject()
+
+
+@pytest.fixture
+def unexpected_serializable() -> object:
+    @dataclass
+    class UnexpectedSerializable:
+        some_field: str = "Hello, World!"
+
+    return UnexpectedSerializable()
+
+
+def test_delete_nonexistent_file(game_repository: GameRepository) -> None:
+    with pytest.raises(FileNotFoundError):
+        game_repository.io_handler.delete("nonexistent_file")
+
+
+def test_repository_unexpected_object(
+    game_repository: GameRepository, unexpected_object: object
+) -> None:
+    with pytest.raises(TypeError):
+        game_repository.add(unexpected_object)  # type: ignore
+
+
+def test_io_handling_unexpected_serializable(
+    game_repository: GameRepository, unexpected_serializable: object
+) -> None:
+    game_repository.io_handler.add("unexpected_serializable", unexpected_serializable)  # type: ignore
+
+    with pytest.raises(Exception):
+        game_repository["unexpected_serializable"]  # type: ignore

src/tests/test_cattrs_multifiles_handler.py

@@ -1,31 +1,10 @@
-from tempfile import TemporaryDirectory
-from typing import Any, Generator
-
 import pytest
 
 from mastermind.server.database.enum import GameMode
 from mastermind.server.database.models import Game, GameConfiguration
 from mastermind.server.database.repository import GameRepository
 
 
-@pytest.fixture
-def game_repository() -> Generator[GameRepository, Any, None]:
-    with TemporaryDirectory() as temp_dir:
-        yield GameRepository(temp_dir)
-
-
-@pytest.fixture
-def game() -> Game:
-    return Game(
-        game_configuration=GameConfiguration(
-            NUMBER_OF_COLORS=3,
-            NUMBER_OF_DOTS=4,
-            ATTEMPTS_ALLOWED=5,
-            GAME_MODE=GameMode.PVP,
-        )
-    )
-
-
 def test_add(game_repository: GameRepository, game: Game) -> None:
     uuid = game_repository.add(game)
     assert uuid in game_repository
@@ -36,6 +15,12 @@ def test_getitem(game_repository: GameRepository, game: Game) -> None:
     assert game_repository[uuid] == game
 
 
+def test_retrieve_uncached_file(game_repository: GameRepository, game: Game) -> None:
+    game_repository.io_handler.add("some_uuid", game)
+    retrieved_game = game_repository["some_uuid"]
+    assert retrieved_game == game
+
+
 def test_update_item(game_repository: GameRepository, game: Game) -> None:
     uuid = game_repository.add(game)
     new_game = Game(
@@ -50,13 +35,23 @@ def test_update_item(game_repository: GameRepository, game: Game) -> None:
     assert game_repository[uuid] == new_game
 
 
+def test_update_item_nonexistent(game_repository: GameRepository, game: Game) -> None:
+    with pytest.raises(KeyError):
+        game_repository["nonexistent_uuid"] = game
+
+
 def test_delitem(game_repository: GameRepository, game: Game) -> None:
     uuid = game_repository.add(game)
     assert uuid in game_repository
     del game_repository[uuid]
     assert uuid not in game_repository
 
 
+def test_delitem_nonexistent(game_repository: GameRepository) -> None:
+    with pytest.raises(KeyError):
+        del game_repository["nonexistent_uuid"]
+
+
 def test_len(game_repository: GameRepository, game: Game) -> None:
     assert len(game_repository) == 0
     game_repository.add(game)
@@ -68,5 +63,7 @@ def test_len(game_repository: GameRepository, game: Game) -> None:
 def test_iter(game_repository: GameRepository, game: Game) -> None:
     game_repository.add(game)
     game_repository.add(game)
-    assert all(_game == game_repository[uuid] for uuid, _game in game_repository)
     assert len(list(game_repository)) == 2
+
+    for uuid, _game in game_repository:
+        assert _game == game_repository[uuid]

src/tests/libs/test_game_repository.py src/tests/test_game_repository.pysrc/tests/libs/test_game_repository.py renamed to src/tests/test_game_repository.py

@@ -2,34 +2,16 @@
 
 import pytest
 
-from mastermind.server.database.enum import GameMode, PlayerRole
-from mastermind.server.database.models import Game, GameConfiguration, GameRound
+from mastermind.server.database.enum import PlayerRole
+from mastermind.server.database.models import Game, GameRound
 from mastermind.server.services import (
-    GameboardService,
     GameEndedException,
     GameNotStartedException,
     GameService,
     NoRedoAvailableException,
 )
 
 
-@pytest.fixture
-def game() -> 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) -> GameService:
-    return GameService(game, GameboardService(game.game_board))
-
-
 def test_add_round(game_service: GameService, game: Game) -> None:
     game_service.add_round((1, 2, 3, 4), (1, 0))
     assert game.game_board.game_rounds == deque(