Refactor test cases for improved readability and consistency

- Adjusted function signatures in various test files to enhance clarity by aligning parameters.
- Updated patching syntax for better readability across test cases.
- Improved formatting and spacing in test assertions and mock setups.
- Ensured consistent use of async/await patterns in async test functions.
- Enhanced comments for better understanding of test intentions.

tests/services/test_vlc_player.py

@@ -80,6 +80,7 @@ class TestVLCPlayerService:
 
         # Mock Path to return True for the first absolute path
         with patch("app.services.vlc_player.Path") as mock_path:
+
             def path_side_effect(path_str):
                 mock_instance = Mock()
                 mock_instance.exists.return_value = str(path_str) == "/usr/bin/vlc"
@@ -105,11 +106,13 @@ class TestVLCPlayerService:
         service = VLCPlayerService()
         assert service.vlc_executable == "vlc"
 
-
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
     async def test_play_sound_success(
-        self, mock_subprocess, vlc_service, sample_sound,
+        self,
+        mock_subprocess,
+        vlc_service,
+        sample_sound,
     ) -> None:
         """Test successful sound playback."""
         # Mock subprocess
@@ -142,7 +145,9 @@ class TestVLCPlayerService:
 
     @pytest.mark.asyncio
     async def test_play_sound_file_not_found(
-        self, vlc_service, sample_sound,
+        self,
+        vlc_service,
+        sample_sound,
     ) -> None:
         """Test sound playback when file doesn't exist."""
         # Mock the file path utility to return a non-existent path
@@ -158,7 +163,10 @@ class TestVLCPlayerService:
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
     async def test_play_sound_subprocess_error(
-        self, mock_subprocess, vlc_service, sample_sound,
+        self,
+        mock_subprocess,
+        vlc_service,
+        sample_sound,
     ) -> None:
         """Test sound playback when subprocess fails."""
         # Mock the file path utility to return an existing path
@@ -176,7 +184,9 @@ class TestVLCPlayerService:
 
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
-    async def test_stop_all_vlc_instances_success(self, mock_subprocess, vlc_service) -> None:
+    async def test_stop_all_vlc_instances_success(
+        self, mock_subprocess, vlc_service,
+    ) -> None:
         """Test successful stopping of all VLC instances."""
         # Mock pgrep process (find VLC processes)
         mock_find_process = Mock()
@@ -212,7 +222,9 @@ class TestVLCPlayerService:
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
     async def test_stop_all_vlc_instances_no_processes(
-        self, mock_subprocess, vlc_service,
+        self,
+        mock_subprocess,
+        vlc_service,
     ) -> None:
         """Test stopping VLC instances when none are running."""
         # Mock pgrep process (no VLC processes found)
@@ -232,7 +244,9 @@ class TestVLCPlayerService:
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
     async def test_stop_all_vlc_instances_partial_kill(
-        self, mock_subprocess, vlc_service,
+        self,
+        mock_subprocess,
+        vlc_service,
     ) -> None:
         """Test stopping VLC instances when some processes remain."""
         # Mock pgrep process (find VLC processes)
@@ -266,7 +280,9 @@ class TestVLCPlayerService:
 
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
-    async def test_stop_all_vlc_instances_error(self, mock_subprocess, vlc_service) -> None:
+    async def test_stop_all_vlc_instances_error(
+        self, mock_subprocess, vlc_service,
+    ) -> None:
         """Test stopping VLC instances when an error occurs."""
         # Mock subprocess exception
         mock_subprocess.side_effect = Exception("Command failed")
@@ -287,6 +303,7 @@ class TestVLCPlayerService:
 
             # Clear the global instance
             import app.services.vlc_player
+
             app.services.vlc_player.vlc_player_service = None
 
             # First call should create new instance
@@ -304,7 +321,10 @@ class TestVLCPlayerService:
     @pytest.mark.asyncio
     @patch("app.services.vlc_player.asyncio.create_subprocess_exec")
     async def test_play_sound_with_play_count_tracking(
-        self, mock_subprocess, vlc_service_with_db, sample_sound,
+        self,
+        mock_subprocess,
+        vlc_service_with_db,
+        sample_sound,
     ) -> None:
         """Test sound playback with play count tracking."""
         # Mock subprocess
@@ -320,11 +340,17 @@ class TestVLCPlayerService:
         mock_sound_repo = AsyncMock()
         mock_user_repo = AsyncMock()
 
-        with patch("app.services.vlc_player.SoundRepository", return_value=mock_sound_repo):
-            with patch("app.services.vlc_player.UserRepository", return_value=mock_user_repo):
+        with patch(
+            "app.services.vlc_player.SoundRepository", return_value=mock_sound_repo,
+        ):
+            with patch(
+                "app.services.vlc_player.UserRepository", return_value=mock_user_repo,
+            ):
                 with patch("app.services.vlc_player.socket_manager") as mock_socket:
                     # Mock the file path utility
-                    with patch("app.services.vlc_player.get_sound_file_path") as mock_get_path:
+                    with patch(
+                        "app.services.vlc_player.get_sound_file_path",
+                    ) as mock_get_path:
                         mock_path = Mock()
                         mock_path.exists.return_value = True
                         mock_get_path.return_value = mock_path
@@ -397,8 +423,12 @@ class TestVLCPlayerService:
             role="admin",
         )
 
-        with patch("app.services.vlc_player.SoundRepository", return_value=mock_sound_repo):
-            with patch("app.services.vlc_player.UserRepository", return_value=mock_user_repo):
+        with patch(
+            "app.services.vlc_player.SoundRepository", return_value=mock_sound_repo,
+        ):
+            with patch(
+                "app.services.vlc_player.UserRepository", return_value=mock_user_repo,
+            ):
                 with patch("app.services.vlc_player.socket_manager") as mock_socket:
                     # Setup mocks
                     mock_sound_repo.get_by_id.return_value = test_sound
@@ -412,7 +442,8 @@ class TestVLCPlayerService:
                     # Verify sound repository calls
                     mock_sound_repo.get_by_id.assert_called_once_with(1)
                     mock_sound_repo.update.assert_called_once_with(
-                        test_sound, {"play_count": 1},
+                        test_sound,
+                        {"play_count": 1},
                     )
 
                     # Verify user repository calls
@@ -442,7 +473,9 @@ class TestVLCPlayerService:
         # The method should return early without doing anything
 
     @pytest.mark.asyncio
-    async def test_record_play_count_always_creates_record(self, vlc_service_with_db) -> None:
+    async def test_record_play_count_always_creates_record(
+        self, vlc_service_with_db,
+    ) -> None:
         """Test play count recording always creates a new SoundPlayed record."""
         # Mock session and repositories
         mock_session = AsyncMock()
@@ -469,28 +502,33 @@ class TestVLCPlayerService:
             role="admin",
         )
 
-        with patch("app.services.vlc_player.SoundRepository", return_value=mock_sound_repo):
-            with patch("app.services.vlc_player.UserRepository", return_value=mock_user_repo):
+        with patch(
+            "app.services.vlc_player.SoundRepository", return_value=mock_sound_repo,
+        ):
+            with patch(
+                "app.services.vlc_player.UserRepository", return_value=mock_user_repo,
+            ):
                 with patch("app.services.vlc_player.socket_manager") as mock_socket:
-                        # Setup mocks
-                        mock_sound_repo.get_by_id.return_value = test_sound
-                        mock_user_repo.get_by_id.return_value = admin_user
+                    # Setup mocks
+                    mock_sound_repo.get_by_id.return_value = test_sound
+                    mock_user_repo.get_by_id.return_value = admin_user
 
-                        # Mock socket broadcast
-                        mock_socket.broadcast_to_all = AsyncMock()
+                    # Mock socket broadcast
+                    mock_socket.broadcast_to_all = AsyncMock()
 
-                        await vlc_service_with_db._record_play_count(1, "Test Sound")
+                    await vlc_service_with_db._record_play_count(1, "Test Sound")
 
-                        # Verify sound play count was updated
-                        mock_sound_repo.update.assert_called_once_with(
-                            test_sound, {"play_count": 6},
-                        )
+                    # Verify sound play count was updated
+                    mock_sound_repo.update.assert_called_once_with(
+                        test_sound,
+                        {"play_count": 6},
+                    )
 
-                        # Verify new SoundPlayed record was always added
-                        mock_session.add.assert_called_once()
+                    # Verify new SoundPlayed record was always added
+                    mock_session.add.assert_called_once()
 
-                        # Verify commit happened
-                        mock_session.commit.assert_called_once()
+                    # Verify commit happened
+                    mock_session.commit.assert_called_once()
 
     def test_uses_shared_sound_path_utility(self, vlc_service, sample_sound) -> None:
         """Test that VLC service uses the shared sound path utility."""