mirror of
https://github.com/ammaraskar/pyCraft.git
synced 2024-11-29 13:45:11 +01:00
969419da3f
After 1.16.3, Mojang started publishing snapshot, pre-release and release
candidate versions of Minecraft with protocol version numbers of the form
`(1 << 30) | n' where 'n' is a small non-negative integer increasing with each
such version; the release versions continued to use the old format. For
example, these are the last 8 published Minecraft versions as of this commit:
release 1.16.3 uses protocol version 753
pre-release 1.16.4-pre1 uses protocol version 1073741825 == (1 << 30) | 1
pre-release 1.16.4-pre2 uses protocol version 1073741826 == (1 << 30) | 2
release candidate 1.16.4-rc1 uses protocol version 1073741827 == (1 << 30) | 3
release 1.16.4 uses protocol version 754
snapshot 20w45a uses protocol version 1073741829 == (1 << 30) | 5
snapshot 20w46a uses protocol version 1073741830 == (1 << 30) | 6
snapshot 20w48a uses protocol version 1073741831 == (1 << 30) | 7
This means that protocol versions no longer increase monotonically with respect
to publication history, a property that was assumed to hold in much of
pyCraft's code relating to support of multiple protocol versions. This commit
rectifies the issue by replacing any comparison of protocol versions by their
numerical value with a comparison based on their publication time.
Newly defined is the dictionary `minecraft.PROTOCOL_VERSION_INDICES', which
maps each known protocol version to its index in the protocol chronology. As
such, the bound method `minecraft.PROTOCOL_VERSION_INDICES.get` can be used as
a key function for the built-in `sorted`, `min` and `max` functions to collate
protocol versions chronologically.
Two utility functions are provided for direct comparison of protocol versions:
`minecraft.utility.protocol_earlier` and
`minecraft.utility.protocol_earlier_eq`.
Additionally, four methods are added to the `ConnectionContext` type to ease
the most common cases where the protocol of a given context must be compared to
a given version number:
`minecraft.connection.ConnectionContext.protocol_earlier`,
`minecraft.connection.ConnectionContext.protocol_earlier_eq`,
`minecraft.connection.ConnectionContext.protocol_later` and
`minecraft.connection.ConnectionContext.protocol_later_eq`.
111 lines
3.7 KiB
Python
111 lines
3.7 KiB
Python
import unittest
|
|
try:
|
|
from unittest import mock
|
|
except ImportError:
|
|
import mock
|
|
|
|
from minecraft import SUPPORTED_PROTOCOL_VERSIONS
|
|
from minecraft.networking.connection import (
|
|
LoginReactor, PlayingReactor, ConnectionContext
|
|
)
|
|
from minecraft.networking.packets import clientbound
|
|
|
|
|
|
latest_proto = SUPPORTED_PROTOCOL_VERSIONS[-1]
|
|
|
|
|
|
class LoginReactorTest(unittest.TestCase):
|
|
|
|
@mock.patch('minecraft.networking.connection.encryption')
|
|
def test_encryption_online_server(self, encrypt):
|
|
connection = mock.MagicMock()
|
|
connection.context = ConnectionContext(protocol_version=latest_proto)
|
|
reactor = LoginReactor(connection)
|
|
|
|
packet = clientbound.login.EncryptionRequestPacket()
|
|
packet.server_id = "123"
|
|
packet.public_key = b"asdf"
|
|
packet.verify_token = b"23"
|
|
|
|
secret = b"secret"
|
|
encrypt.generate_shared_secret.return_value = secret
|
|
encrypt.encrypt_token_and_secret.return_value = (b"a", b"b")
|
|
encrypt.generate_verification_hash.return_value = b"hash"
|
|
|
|
reactor.react(packet)
|
|
|
|
encrypt.encrypt_token_and_secret.assert_called_once_with(
|
|
packet.public_key, packet.verify_token, secret
|
|
)
|
|
connection.auth_token.join.assert_called_once_with(b"hash")
|
|
self.assertEqual(connection.write_packet.call_count, 1)
|
|
|
|
@mock.patch('minecraft.networking.connection.encryption')
|
|
def test_encryption_offline_server(self, encrypt):
|
|
connection = mock.MagicMock()
|
|
connection.context = ConnectionContext(protocol_version=latest_proto)
|
|
reactor = LoginReactor(connection)
|
|
|
|
packet = clientbound.login.EncryptionRequestPacket()
|
|
packet.server_id = "-"
|
|
packet.public_key = b"asdf"
|
|
packet.verify_token = b"23"
|
|
|
|
secret = b"secret"
|
|
encrypt.generate_shared_secret.return_value = secret
|
|
encrypt.encrypt_token_and_secret.return_value = (b"a", b"b")
|
|
|
|
reactor.react(packet)
|
|
|
|
encrypt.encrypt_token_and_secret.assert_called_once_with(
|
|
packet.public_key, packet.verify_token, secret
|
|
)
|
|
self.assertEqual(connection.auth_token.join.call_count, 0)
|
|
self.assertEqual(connection.write_packet.call_count, 1)
|
|
|
|
|
|
class PlayingReactorTest(unittest.TestCase):
|
|
|
|
def get_position_packet(self):
|
|
packet = clientbound.play.PlayerPositionAndLookPacket()
|
|
packet.x = 1.0
|
|
packet.y = 2.0
|
|
packet.z = 3.0
|
|
packet.yaw = 4.0
|
|
packet.pitch = 5.0
|
|
|
|
packet.teleport_id = 42
|
|
|
|
return packet
|
|
|
|
def test_teleport_confirmation_old(self):
|
|
connection = mock.MagicMock()
|
|
connection.context = ConnectionContext(protocol_version=106)
|
|
reactor = PlayingReactor(connection)
|
|
|
|
packet = self.get_position_packet()
|
|
reactor.react(packet)
|
|
|
|
self.assertEqual(connection.write_packet.call_count, 1)
|
|
response_packet = connection.write_packet.call_args[0][0]
|
|
|
|
self.assertEqual(response_packet.x, 1.0)
|
|
self.assertEqual(response_packet.feet_y, 2.0)
|
|
self.assertEqual(response_packet.z, 3.0)
|
|
self.assertEqual(response_packet.yaw, 4.0)
|
|
self.assertEqual(response_packet.pitch, 5.0)
|
|
self.assertTrue(response_packet.on_ground)
|
|
|
|
def test_teleport_confirmation_new(self):
|
|
connection = mock.MagicMock()
|
|
connection.context = ConnectionContext(protocol_version=107)
|
|
reactor = PlayingReactor(connection)
|
|
|
|
packet = self.get_position_packet()
|
|
reactor.react(packet)
|
|
|
|
self.assertEqual(connection.write_packet.call_count, 1)
|
|
|
|
response_packet = connection.write_packet.call_args[0][0]
|
|
self.assertEqual(response_packet.teleport_id, 42)
|