SDK-2525: Refactor errors

tests/test_achievements.py

@@ -1,7 +1,8 @@
 import asyncio
 import json
 
-from galaxy.api.types import Achievement, GetAchievementsError
+from galaxy.api.types import Achievement
+from galaxy.api.errors import UnknownError
 
 def test_success(plugin, readline, write):
     request = {
@@ -49,7 +50,7 @@ def test_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_unlocked_achievements.side_effect = GetAchievementsError("reason")
+    plugin.get_unlocked_achievements.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_unlocked_achievements.assert_called()
     response = json.loads(write.call_args[0][0])
@@ -58,11 +59,8 @@ def test_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error"
         }
     }
 

tests/test_authenticate.py

@@ -1,7 +1,14 @@
 import asyncio
 import json
 
-from galaxy.api.types import Authentication, LoginError
+import pytest
+
+from galaxy.api.types import Authentication
+from galaxy.api.errors import (
+    UnknownError, InvalidCredentials, NetworkError, LoggedInElsewhere, ProtocolError,
+    BackendNotAvailable, BackendTimeout, BackendError, TemporaryBlocked, Banned, AccessDenied,
+    ParentalControlBlock, DeviceBlocked, RegionBlocked
+)
 
 def test_success(plugin, readline, write):
     request = {
@@ -25,7 +32,23 @@ def test_success(plugin, readline, write):
         }
     }
 
-def test_failure(plugin, readline, write):
+@pytest.mark.parametrize("error,code,message", [
+    pytest.param(UnknownError, 0, "Unknown error", id="unknown_error"),
+    pytest.param(InvalidCredentials, 100, "Invalid credentials", id="invalid_credentials"),
+    pytest.param(NetworkError, 101, "Network error", id="network_error"),
+    pytest.param(LoggedInElsewhere, 102, "Logged in elsewhere", id="logged_elsewhere"),
+    pytest.param(ProtocolError, 103, "Protocol error", id="protocol_error"),
+    pytest.param(BackendNotAvailable, 104, "Backend not available", id="backend_not_available"),
+    pytest.param(BackendTimeout, 105, "Backend timed out", id="backend_timeout"),
+    pytest.param(BackendError, 106, "Backend error", id="backend_error"),
+    pytest.param(TemporaryBlocked, 107, "Temporary blocked", id="temporary_blocked"),
+    pytest.param(Banned, 108, "Banned", id="banned"),
+    pytest.param(AccessDenied, 109, "Access denied", id="access_denied"),
+    pytest.param(ParentalControlBlock, 110, "Parental control block", id="parental_control_clock"),
+    pytest.param(DeviceBlocked, 111, "Device blocked", id="device_blocked"),
+    pytest.param(RegionBlocked, 112, "Region blocked", id="region_blocked")
+])
+def test_failure(plugin, readline, write, error, code, message):
     request = {
         "jsonrpc": "2.0",
         "id": "3",
@@ -33,7 +56,7 @@ def test_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.authenticate.side_effect = LoginError("step", "reason")
+    plugin.authenticate.side_effect = error()
     asyncio.run(plugin.run())
     plugin.authenticate.assert_called_with()
     response = json.loads(write.call_args[0][0])
@@ -42,12 +65,8 @@ def test_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "current_step": "step",
-                "reason": "reason"
-            }
+            "code": code,
+            "message": message
         }
     }
 

tests/test_chat.py

@@ -1,9 +1,10 @@
 import asyncio
 import json
 
-from galaxy.api.types import (
-    SendMessageError, MarkAsReadError, Room, GetRoomsError, Message, GetRoomHistoryError
-)
+import pytest
+
+from galaxy.api.types import Room, Message
+from galaxy.api.errors import UnknownError, TooManyMessagesSent, IncoherentLastMessage, MessageNotFound
 
 def test_send_message_success(plugin, readline, write):
     request = {
@@ -28,7 +29,11 @@ def test_send_message_success(plugin, readline, write):
         "result": None
     }
 
-def test_send_message_failure(plugin, readline, write):
+@pytest.mark.parametrize("error,code,message", [
+    pytest.param(UnknownError, 0, "Unknown error", id="unknown_error"),
+    pytest.param(TooManyMessagesSent, 300, "Too many messages sent", id="too_many_messages")
+])
+def test_send_message_failure(plugin, readline, write, error, code, message):
     request = {
         "jsonrpc": "2.0",
         "id": "6",
@@ -40,7 +45,7 @@ def test_send_message_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.send_message.side_effect = SendMessageError("reason")
+    plugin.send_message.side_effect = error()
     asyncio.run(plugin.run())
     plugin.send_message.assert_called_with(room_id="15", message="Bye")
     response = json.loads(write.call_args[0][0])
@@ -49,11 +54,8 @@ def test_send_message_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "6",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": code,
+            "message": message
         }
     }
 
@@ -80,7 +82,16 @@ def test_mark_as_read_success(plugin, readline, write):
         "result": None
     }
 
-def test_mark_as_read_failure(plugin, readline, write):
+@pytest.mark.parametrize("error,code,message", [
+    pytest.param(UnknownError, 0, "Unknown error", id="unknown_error"),
+    pytest.param(
+        IncoherentLastMessage,
+        400,
+        "Different last message id on backend",
+        id="incoherent_last_message"
+    )
+])
+def test_mark_as_read_failure(plugin, readline, write, error, code, message):
     request = {
         "jsonrpc": "2.0",
         "id": "4",
@@ -92,7 +103,7 @@ def test_mark_as_read_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.mark_as_read.side_effect = MarkAsReadError("reason")
+    plugin.mark_as_read.side_effect = error()
     asyncio.run(plugin.run())
     plugin.mark_as_read.assert_called_with(room_id="18", last_message_id="7")
     response = json.loads(write.call_args[0][0])
@@ -101,11 +112,8 @@ def test_mark_as_read_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "4",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": code,
+            "message": message
         }
     }
 
@@ -151,7 +159,7 @@ def test_get_rooms_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_rooms.side_effect = GetRoomsError("reason")
+    plugin.get_rooms.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_rooms.assert_called_with()
     response = json.loads(write.call_args[0][0])
@@ -160,11 +168,8 @@ def test_get_rooms_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "9",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error"
         }
     }
 
@@ -209,7 +214,11 @@ def test_get_room_history_from_message_success(plugin, readline, write):
         }
     }
 
-def test_get_room_history_from_message_failure(plugin, readline, write):
+@pytest.mark.parametrize("error,code,message", [
+    pytest.param(UnknownError, 0, "Unknown error", id="unknown_error"),
+    pytest.param(MessageNotFound, 500, "Message not found", id="message_not_found")
+])
+def test_get_room_history_from_message_failure(plugin, readline, write, error, code, message):
     request = {
         "jsonrpc": "2.0",
         "id": "7",
@@ -221,7 +230,7 @@ def test_get_room_history_from_message_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_room_history_from_message.side_effect = GetRoomHistoryError("reason")
+    plugin.get_room_history_from_message.side_effect = error()
     asyncio.run(plugin.run())
     plugin.get_room_history_from_message.assert_called_with(room_id="33", message_id="88")
     response = json.loads(write.call_args[0][0])
@@ -230,11 +239,8 @@ def test_get_room_history_from_message_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "7",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": code,
+            "message": message
         }
     }
 
@@ -287,7 +293,7 @@ def test_get_room_history_from_timestamp_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_room_history_from_timestamp.side_effect = GetRoomHistoryError("reason")
+    plugin.get_room_history_from_timestamp.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_room_history_from_timestamp.assert_called_with(
         room_id="10",
@@ -299,11 +305,8 @@ def test_get_room_history_from_timestamp_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error"
         }
     }
 

tests/test_game_times.py

@@ -1,7 +1,8 @@
 import asyncio
 import json
 
-from galaxy.api.types import GameTime, GetGameTimeError
+from galaxy.api.types import GameTime
+from galaxy.api.errors import UnknownError
 
 def test_success(plugin, readline, write):
     request = {
@@ -46,7 +47,7 @@ def test_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_game_times.side_effect = GetGameTimeError("reason")
+    plugin.get_game_times.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_game_times.assert_called_with()
     response = json.loads(write.call_args[0][0])
@@ -55,11 +56,8 @@ def test_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error",
         }
     }
 

tests/test_local_games.py

@@ -1,8 +1,11 @@
 import asyncio
 import json
 
-from galaxy.api.types import GetLocalGamesError, LocalGame
+import pytest
+
+from galaxy.api.types import LocalGame
 from galaxy.api.consts import LocalGameState
+from galaxy.api.errors import UnknownError, FailedParsingManifest
 
 def test_success(plugin, readline, write):
     request = {
@@ -38,7 +41,14 @@ def test_success(plugin, readline, write):
         }
     }
 
-def test_failure(plugin, readline, write):
+@pytest.mark.parametrize(
+    "error,code,message",
+    [
+        pytest.param(UnknownError, 0, "Unknown error", id="unknown_error"),
+        pytest.param(FailedParsingManifest, 200, "Failed parsing manifest", id="failed_parsing")
+    ],
+)
+def test_failure(plugin, readline, write, error, code, message):
     request = {
         "jsonrpc": "2.0",
         "id": "3",
@@ -46,7 +56,7 @@ def test_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_local_games.side_effect = GetLocalGamesError("reason")
+    plugin.get_local_games.side_effect = error()
     asyncio.run(plugin.run())
     plugin.get_local_games.assert_called_with()
     response = json.loads(write.call_args[0][0])
@@ -55,11 +65,8 @@ def test_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": code,
+            "message": message
         }
     }
 

tests/test_owned_games.py

@@ -1,7 +1,8 @@
 import asyncio
 import json
 
-from galaxy.api.types import Game, Dlc, LicenseInfo, GetGamesError
+from galaxy.api.types import Game, Dlc, LicenseInfo
+from galaxy.api.errors import UnknownError
 
 def test_success(plugin, readline, write):
     request = {
@@ -73,7 +74,7 @@ def test_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_owned_games.side_effect = GetGamesError("reason")
+    plugin.get_owned_games.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_owned_games.assert_called_with()
     response = json.loads(write.call_args[0][0])
@@ -82,11 +83,8 @@ def test_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error"
         }
     }
 

tests/test_users.py

@@ -1,7 +1,8 @@
 import asyncio
 import json
 
-from galaxy.api.types import UserInfo, Presence, GetFriendsError, GetUsersError
+from galaxy.api.types import UserInfo, Presence
+from galaxy.api.errors import UnknownError
 from galaxy.api.consts import PresenceState
 
 def test_get_friends_success(plugin, readline, write):
@@ -73,7 +74,7 @@ def test_get_friends_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_friends.side_effect = GetFriendsError("reason")
+    plugin.get_friends.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_friends.assert_called_with()
     response = json.loads(write.call_args[0][0])
@@ -82,11 +83,8 @@ def test_get_friends_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "3",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error",
         }
     }
 
@@ -202,7 +200,7 @@ def test_get_users_failure(plugin, readline, write):
     }
 
     readline.side_effect = [json.dumps(request), ""]
-    plugin.get_users.side_effect = GetUsersError("reason")
+    plugin.get_users.side_effect = UnknownError()
     asyncio.run(plugin.run())
     plugin.get_users.assert_called_with(user_id_list=["10", "11", "12"])
     response = json.loads(write.call_args[0][0])
@@ -211,10 +209,7 @@ def test_get_users_failure(plugin, readline, write):
         "jsonrpc": "2.0",
         "id": "12",
         "error": {
-            "code": -32003,
-            "message": "Custom error",
-            "data": {
-                "reason": "reason"
-            }
+            "code": 0,
+            "message": "Unknown error"
         }
     }