refactor(tests): use helper function to assert error responses

Author: S1M0N38

tests/conftest.py

@@ -9,7 +9,7 @@
 # Connection settings
 HOST = "127.0.0.1"
 PORT: int = 12346  # default port for BalatroBot UDP API
-TIMEOUT: float = 30.0  # timeout for socket operations in seconds
+TIMEOUT: float = 10.0  # timeout for socket operations in seconds
 BUFFER_SIZE: int = 65536  # 64KB buffer for UDP messages
 
 
@@ -68,3 +68,15 @@ def send_and_receive_api_message(
     send_api_message(sock, name, arguments)
     game_state = receive_api_message(sock)
     return game_state
+
+
+def assert_error_response(response, expected_error_text, expected_context_keys=None):
+    """Helper function to assert error response format and content."""
+    assert isinstance(response, dict)
+    assert "error" in response
+    assert "state" in response
+    assert expected_error_text in response["error"]
+    if expected_context_keys:
+        assert "context" in response
+        for key in expected_context_keys:
+            assert key in response["context"]

tests/test_api_functions.py

@@ -4,7 +4,7 @@
 from typing import Generator
 
 import pytest
-from conftest import send_and_receive_api_message
+from conftest import send_and_receive_api_message, assert_error_response
 
 from balatrobot.enums import State
 
@@ -127,9 +127,7 @@ def test_start_run_missing_required_args(self, udp_client: socket.socket) -> Non
         response = send_and_receive_api_message(
             udp_client, "start_run", incomplete_args
         )
-        assert isinstance(response, dict)
-        assert "error" in response
-        assert "Invalid deck arg" in response["error"]
+        assert_error_response(response, "Invalid deck arg for start_run")
 
     def test_start_run_invalid_deck(self, udp_client: socket.socket) -> None:
         """Test start_run with invalid deck name."""
@@ -141,9 +139,7 @@ def test_start_run_invalid_deck(self, udp_client: socket.socket) -> None:
         }
         # Should receive error response
         response = send_and_receive_api_message(udp_client, "start_run", invalid_args)
-        assert isinstance(response, dict)
-        assert "error" in response
-        assert "Invalid deck arg" in response["error"]
+        assert_error_response(response, "Invalid deck arg for start_run", ["deck"])
 
 
 class TestGoToMenu:
@@ -231,9 +227,9 @@ def test_invalid_blind_action(self, udp_client: socket.socket) -> None:
         )
 
         # Verify error response
-        assert isinstance(error_response, dict)
-        assert "error" in error_response
-        assert "Invalid action arg" in error_response["error"]
+        assert_error_response(
+            error_response, "Invalid action arg for skip_or_select_blind", ["action"]
+        )
 
 
 class TestPlayHandOrDiscard:
@@ -327,9 +323,9 @@ def test_play_hand_or_discard_invalid_cards(
         )
 
         # Should receive error response for invalid card index
-        assert isinstance(response, dict)
-        assert "error" in response
-        assert "Invalid card index" in response["error"]
+        assert_error_response(
+            response, "Invalid card index", ["card_index", "hand_size"]
+        )
 
     def test_play_hand_invalid_action(self, udp_client: socket.socket) -> None:
         """Test playing a hand with invalid action returns error."""
@@ -339,9 +335,9 @@ def test_play_hand_invalid_action(self, udp_client: socket.socket) -> None:
         )
 
         # Should receive error response for invalid action
-        assert isinstance(response, dict)
-        assert "error" in response
-        assert "Invalid action arg" in response["error"]
+        assert_error_response(
+            response, "Invalid action arg for play_hand_or_discard", ["action"]
+        )
 
     @pytest.mark.parametrize(
         "cards,expected_new_cards",
@@ -407,9 +403,9 @@ def test_try_to_discard_when_no_discards_left(
         )
 
         # Should receive error response for no discards left
-        assert isinstance(response, dict)
-        assert "error" in response
-        assert "No discards left" in response["error"]
+        assert_error_response(
+            response, "No discards left to perform discard", ["discards_left"]
+        )
 
 
 class TestCashOut:
@@ -461,7 +457,6 @@ def test_cash_out_invalid_state_error(self, udp_client: socket.socket) -> None:
         response = send_and_receive_api_message(udp_client, "cash_out", {})
 
         # Verify error response
-        assert isinstance(response, dict)
-        assert "error" in response
-        assert "Cannot cash out when not in shop" in response["error"]
-        assert "state" in response
+        assert_error_response(
+            response, "Cannot cash out when not in shop", ["current_state"]
+        )

tests/test_connection.py

@@ -4,7 +4,7 @@
 import socket
 
 import pytest
-from conftest import BUFFER_SIZE, HOST, PORT, send_api_message
+from conftest import BUFFER_SIZE, HOST, PORT, send_api_message, assert_error_response
 
 
 def test_basic_connection(udp_client: socket.socket) -> None:
@@ -54,9 +54,7 @@ def test_invalid_json_message(udp_client: socket.socket) -> None:
     data, _ = udp_client.recvfrom(BUFFER_SIZE)
     response = data.decode().strip()
     error_response = json.loads(response)
-    assert isinstance(error_response, dict)
-    assert "error" in error_response
-    assert "Invalid JSON" in error_response["error"]
+    assert_error_response(error_response, "Invalid JSON")
 
     # Verify server is still responsive
     send_api_message(udp_client, "get_game_state", {})
@@ -77,9 +75,7 @@ def test_missing_name_field(udp_client: socket.socket) -> None:
     data, _ = udp_client.recvfrom(BUFFER_SIZE)
     response = data.decode().strip()
     error_response = json.loads(response)
-    assert isinstance(error_response, dict)
-    assert "error" in error_response
-    assert "Message must contain a name" in error_response["error"]
+    assert_error_response(error_response, "Message must contain a name")
 
     # Verify server is still responsive
     send_api_message(udp_client, "get_game_state", {})
@@ -100,9 +96,7 @@ def test_missing_arguments_field(udp_client: socket.socket) -> None:
     data, _ = udp_client.recvfrom(BUFFER_SIZE)
     response = data.decode().strip()
     error_response = json.loads(response)
-    assert isinstance(error_response, dict)
-    assert "error" in error_response
-    assert "Message must contain arguments" in error_response["error"]
+    assert_error_response(error_response, "Message must contain arguments")
 
     # Verify server is still responsive
     send_api_message(udp_client, "get_game_state", {})
@@ -123,9 +117,7 @@ def test_unknown_message(udp_client: socket.socket) -> None:
     data, _ = udp_client.recvfrom(BUFFER_SIZE)
     response = data.decode().strip()
     error_response = json.loads(response)
-    assert isinstance(error_response, dict)
-    assert "error" in error_response
-    assert "Unknown function name" in error_response["error"]
+    assert_error_response(error_response, "Unknown function name", ["function_name"])
 
     # Verify server is still responsive
     send_api_message(udp_client, "get_game_state", {})