Add admin port support with other major refactorations

tests/test_protocol.py

@@ -126,3 +126,169 @@ async def test_protocol_is_closing_failure():
     
     with pytest.raises(SocketClosed):
         await proto.send_packet(b"\x02\x00")
+
+def test_admin_protocol_static_receives():
+    from openttd.protocol import OpenTTDAdminProtocol
+    import struct
+
+    # 1. receive_ServerProtocol
+    data = memoryview(struct.pack("<B B H H B", 3, 1, 10, 100, 0))
+    res = OpenTTDAdminProtocol.receive_ServerProtocol(None, data)
+    assert res == {"version": 3, "updates": {10: 100}}
+
+    # 2. receive_ServerWelcome
+    data = memoryview(b"srv_name\x00" + b"1.0\x00" + struct.pack("<B", 1) + b"map_name\x00" + struct.pack("<I B I H H", 1234, 2, 5678, 100, 200))
+    res = OpenTTDAdminProtocol.receive_ServerWelcome(None, data)
+    assert res["server_name"] == "srv_name"
+    assert res["openttd_version"] == "1.0"
+    assert res["dedicated"] is True
+    assert res["map_name"] == "map_name"
+    assert res["generation_seed"] == 1234
+    assert res["landscape"] == 2
+    assert res["start_date"] == 5678
+    assert res["map_width"] == 100
+    assert res["map_height"] == 200
+
+    # 3. receive_ServerDate
+    data = memoryview(struct.pack("<I", 12345))
+    res = OpenTTDAdminProtocol.receive_ServerDate(None, data)
+    assert res == {"date": 12345}
+
+    # 4. receive_ServerChat
+    data = memoryview(struct.pack("<B B I", 1, 2, 3) + b"msg\x00" + struct.pack("<Q", 100))
+    res = OpenTTDAdminProtocol.receive_ServerChat(None, data)
+    assert res["action"] == 1
+    assert res["dest_type"] == 2
+    assert res["client_id"] == 3
+    assert res["message"] == "msg"
+    assert res["money"] == 100
+
+    # 5. receive_ServerConsole
+    data = memoryview(b"origin\x00" + b"text\x00")
+    res = OpenTTDAdminProtocol.receive_ServerConsole(None, data)
+    assert res == {"origin": "origin", "text": "text"}
+
+    # 6. receive_ServerRcon
+    data = memoryview(struct.pack("<H", 7) + b"rcon_text\x00")
+    res = OpenTTDAdminProtocol.receive_ServerRcon(None, data)
+    assert res == {"color": 7, "text": "rcon_text"}
+
+    # 7. receive_ServerRconEnd
+    data = memoryview(b"cmd\x00")
+    res = OpenTTDAdminProtocol.receive_ServerRconEnd(None, data)
+    assert res == {"command": "cmd"}
+
+    # 8. receive_ServerAuthRequest
+    data = memoryview(struct.pack("<B", 1) + b"auth_data")
+    res = OpenTTDAdminProtocol.receive_ServerAuthRequest(None, data)
+    assert res == {"auth_type": 1, "data": b"auth_data"}
+
+    # 9. receive_ServerEnableEncryption
+    res = OpenTTDAdminProtocol.receive_ServerEnableEncryption(None, memoryview(b"enc_nonce"))
+    assert res == {"data": b"enc_nonce"}
+
+    # 10. receive_ServerError
+    data = memoryview(struct.pack("<B", 10))
+    res = OpenTTDAdminProtocol.receive_ServerError(None, data)
+    assert res == {"error_code": 10}
+
+    # 11. receive_ServerFull, receive_ServerBanned, receive_ServerShutdown, receive_ServerNewGame
+    assert OpenTTDAdminProtocol.receive_ServerFull(None, memoryview(b"")) == {}
+    assert OpenTTDAdminProtocol.receive_ServerBanned(None, memoryview(b"")) == {}
+    assert OpenTTDAdminProtocol.receive_ServerShutdown(None, memoryview(b"")) == {}
+    assert OpenTTDAdminProtocol.receive_ServerNewGame(None, memoryview(b"")) == {}
+
+    # 12. receive_ServerClientJoin
+    data = memoryview(struct.pack("<I", 12))
+    res = OpenTTDAdminProtocol.receive_ServerClientJoin(None, data)
+    assert res == {"client_id": 12}
+
+    # 13. receive_ServerClientInfo
+    data = memoryview(struct.pack("<I", 1) + b"127.0.0.1\x00" + b"clientname\x00" + struct.pack("<B I B", 2, 3456, 3))
+    res = OpenTTDAdminProtocol.receive_ServerClientInfo(None, data)
+    assert res["client_id"] == 1
+    assert res["network_address"] == "127.0.0.1"
+    assert res["name"] == "clientname"
+    assert res["language"] == 2
+    assert res["join_date"] == 3456
+    assert res["play_as"] == 3
+
+    # 14. receive_ServerClientUpdate
+    data = memoryview(struct.pack("<I", 1) + b"newname\x00" + struct.pack("<B", 2))
+    res = OpenTTDAdminProtocol.receive_ServerClientUpdate(None, data)
+    assert res == {"client_id": 1, "name": "newname", "play_as": 2}
+
+    # 15. receive_ServerClientQuit
+    data = memoryview(struct.pack("<I", 1))
+    res = OpenTTDAdminProtocol.receive_ServerClientQuit(None, data)
+    assert res == {"client_id": 1}
+
+    # 16. receive_ServerClientError
+    data = memoryview(struct.pack("<I B", 1, 2))
+    res = OpenTTDAdminProtocol.receive_ServerClientError(None, data)
+    assert res == {"client_id": 1, "error_code": 2}
+
+    # 17. receive_ServerCompanyNew
+    data = memoryview(struct.pack("<B", 1))
+    res = OpenTTDAdminProtocol.receive_ServerCompanyNew(None, data)
+    assert res == {"company_id": 1}
+
+    # 18. receive_ServerCompanyInfo
+    data = memoryview(struct.pack("<B", 1) + b"companyname\x00" + b"managername\x00" + struct.pack("<B B I B", 2, 1, 1990, 0))
+    res = OpenTTDAdminProtocol.receive_ServerCompanyInfo(None, data)
+    assert res["company_id"] == 1
+    assert res["name"] == "companyname"
+    assert res["manager_name"] == "managername"
+    assert res["color"] == 2
+    assert res["password_protected"] is True
+    assert res["inaugurated_year"] == 1990
+    assert res["is_ai"] is False
+
+    # 19. receive_ServerCompanyUpdate
+    data = memoryview(struct.pack("<B", 1) + b"companyname\x00" + b"managername\x00" + struct.pack("<B B B B B B B", 2, 1, 0, 255, 255, 255, 255))
+    res = OpenTTDAdminProtocol.receive_ServerCompanyUpdate(None, data)
+    assert res["company_id"] == 1
+    assert res["name"] == "companyname"
+    assert res["manager_name"] == "managername"
+    assert res["color"] == 2
+    assert res["password_protected"] is True
+    assert res["quarters_of_bankruptcy"] == 0
+    assert res["share_owners"] == [255, 255, 255, 255]
+
+    # 20. receive_ServerCompanyRemove
+    data = memoryview(struct.pack("<B B", 1, 2))
+    res = OpenTTDAdminProtocol.receive_ServerCompanyRemove(None, data)
+    assert res == {"company_id": 1, "reason": 2}
+
+    # 21. receive_ServerCompanyEconomy
+    data = memoryview(struct.pack("<B Q Q q H Q H H Q H H", 1, 1000, 200, -50, 10, 1200, 8, 9, 1100, 7, 8))
+    res = OpenTTDAdminProtocol.receive_ServerCompanyEconomy(None, data)
+    assert res["company_id"] == 1
+    assert res["money"] == 1000
+    assert res["loan"] == 200
+    assert res["income"] == -50
+    assert res["delivered_cargo"] == 10
+    assert res["value_last_quarter"] == 1200
+    assert res["performance_last_quarter"] == 8
+    assert res["delivered_cargo_last_quarter"] == 9
+    assert res["value_previous_quarter"] == 1100
+    assert res["performance_previous_quarter"] == 7
+    assert res["delivered_cargo_previous_quarter"] == 8
+
+    # 22. receive_ServerCompanyStats
+    data = memoryview(struct.pack("<B H H H H H H H H H H", 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11))
+    res = OpenTTDAdminProtocol.receive_ServerCompanyStats(None, data)
+    assert res["company_id"] == 1
+    assert res["vehicles"] == {"trains": 2, "lorries": 3, "buses": 4, "planes": 5, "ships": 6}
+    assert res["stations"] == {"train": 7, "lorry": 8, "bus": 9, "airport": 10, "harbour": 11}
+
+    # 23. receive_ServerGamescript (valid and invalid JSON)
+    res = OpenTTDAdminProtocol.receive_ServerGamescript(None, memoryview(b'{"a": 1}\x00'))
+    assert res == {"data": {"a": 1}}
+    res = OpenTTDAdminProtocol.receive_ServerGamescript(None, memoryview(b'invalid_json\x00'))
+    assert res == {"raw_data": "invalid_json"}
+
+    # 24. receive_ServerPong
+    data = memoryview(struct.pack("<I", 999))
+    res = OpenTTDAdminProtocol.receive_ServerPong(None, data)
+    assert res == {"payload": 999}