File: test_protocol.py

package info (click to toggle)
pyro5 5.16-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,124 kB
  • sloc: python: 14,328; makefile: 161; sh: 66; javascript: 62
file content (171 lines) | stat: -rw-r--r-- 8,115 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
import zlib
import pytest
import Pyro5.protocol
import Pyro5.errors
import Pyro5.protocol
import Pyro5.serializers
import Pyro5.errors
from Pyro5.protocol import SendingMessage, ReceivingMessage
from support import ConnectionMock


class TestSendingMessage:
    def test_create(self):
        msg = Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg")
        assert len(msg.data) > 1

    def test_annotations_errors(self):
        with pytest.raises(Pyro5.errors.ProtocolError):
            Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg", annotations={"zxcv": "no_bytes"})
        with pytest.raises(Pyro5.errors.ProtocolError):
            Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg", annotations={"err": b"bytes"})

    def test_annotations(self):
        msg = Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg", annotations={"zxcv": b"bytes"})
        assert len(msg.data) > 1

    def test_compression(self):
        compr_orig = Pyro5.config.COMPRESSION
        try:
            Pyro5.config.COMPRESSION = False
            msg_uncompressed = Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg"*100)
            Pyro5.config.COMPRESSION = True
            msg_compressed = Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg"*100)
            msg_notcompressed = Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 42, 99, b"abcdefg")
            assert not (msg_uncompressed.flags & Pyro5.protocol.FLAGS_COMPRESSED)
            assert not (msg_notcompressed.flags & Pyro5.protocol.FLAGS_COMPRESSED)
            assert msg_compressed.flags & Pyro5.protocol.FLAGS_COMPRESSED
            assert len(msg_uncompressed.data) > len(msg_compressed.data)
        finally:
            Pyro5.config.COMPRESSION = compr_orig


class TestReceivingMessage:
    def createmessage(self, compression=False):
        compr_orig = Pyro5.config.COMPRESSION
        Pyro5.config.COMPRESSION = compression
        annotations = {
            "TEST": b"0123456789qwertyu",
            "UNIT": b"aaaaaaa"
        }
        msg = Pyro5.protocol.SendingMessage(Pyro5.protocol.MSG_INVOKE, 255, 42, 99, b"abcdefg"*100, annotations)
        Pyro5.config.COMPRESSION = compr_orig
        return msg

    def test_validate(self):
        with pytest.raises(ValueError):
            Pyro5.protocol.ReceivingMessage.validate(b"abc")
        with pytest.raises(Pyro5.errors.ProtocolError):
            Pyro5.protocol.ReceivingMessage.validate(b"ZXCV")
        Pyro5.protocol.ReceivingMessage.validate(b"PYRO")
        with pytest.raises(Pyro5.errors.ProtocolError):
            Pyro5.protocol.ReceivingMessage.validate(b"PYRO__")
        msg = self.createmessage()
        msg.data = bytearray(msg.data)
        Pyro5.protocol.ReceivingMessage.validate(msg.data)
        orig_magic = msg.data[38]
        msg.data[38] = 0xff   # kill the magic number
        with pytest.raises(Pyro5.errors.ProtocolError) as x:
            Pyro5.protocol.ReceivingMessage.validate(msg.data)
        assert "magic number" in str(x.value)
        msg.data[38] = orig_magic   # repair the magic number
        msg.data[5] = 0xff   # invalid protocol version
        with pytest.raises(Pyro5.errors.ProtocolError) as x:
            Pyro5.protocol.ReceivingMessage.validate(msg.data)
        assert "protocol version" in str(x.value)

    def test_create_nopayload(self):
        send_msg = self.createmessage(compression=True)
        header = send_msg.data[:Pyro5.protocol._header_size]
        msg = Pyro5.protocol.ReceivingMessage(header)
        assert msg.data is None
        assert msg.type == Pyro5.protocol.MSG_INVOKE
        assert msg.flags == 255
        assert msg.seq == 42
        assert msg.serializer_id == 99
        assert len(msg.annotations) == 0

    def test_create_payload(self):
        send_msg = self.createmessage(compression=True)
        header = send_msg.data[:Pyro5.protocol._header_size]
        payload = send_msg.data[Pyro5.protocol._header_size:]
        msg = Pyro5.protocol.ReceivingMessage(header, payload)
        assert len(msg.data) == 700
        assert msg.flags == 255 & ~Pyro5.protocol.FLAGS_COMPRESSED
        assert len(msg.annotations) == 2
        assert msg.annotations["TEST"] == b"0123456789qwertyu"
        assert msg.annotations["UNIT"] == b"aaaaaaa"
        assert type(msg.data) is bytes

    def test_create_payload_memview(self):
        send_msg = self.createmessage(compression=False)
        header = send_msg.data[:Pyro5.protocol._header_size]
        payload = send_msg.data[Pyro5.protocol._header_size:]
        msg = Pyro5.protocol.ReceivingMessage(header, payload)
        assert type(msg.data) is memoryview


class TestProtocolMessages:
    def testMessage(self):
        SendingMessage(99, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, b"")  # doesn't check msg type here
        with pytest.raises(TypeError):
            ReceivingMessage("FOOBAR")
        with pytest.raises(Pyro5.errors.ProtocolError):
            ReceivingMessage(b"FOOBARFOOBARFOOBARFOOBARFOOBARFOOBAR1234")
        msg = SendingMessage(Pyro5.protocol.MSG_CONNECT, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, b"hello")
        assert msg.type == Pyro5.protocol.MSG_CONNECT
        assert len(msg.data) == Pyro5.protocol._header_size + 5
        msg = ReceivingMessage(msg.data[:Pyro5.protocol._header_size], msg.data[Pyro5.protocol._header_size:])
        assert msg.type == Pyro5.protocol.MSG_CONNECT
        assert msg.data == b"hello"

        msg = SendingMessage(Pyro5.protocol.MSG_RESULT, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, b"")
        msg = ReceivingMessage(msg.data[:Pyro5.protocol._header_size], msg.data[Pyro5.protocol._header_size:])
        assert msg.type == Pyro5.protocol.MSG_RESULT
        assert len(msg.data) == 0

        msg = SendingMessage(255, 0, 255, Pyro5.serializers.SerpentSerializer.serializer_id, b"").data
        assert len(msg) == 40
        msg = SendingMessage(1, 0, 255, Pyro5.serializers.SerpentSerializer.serializer_id, b"").data
        assert len(msg) == 40

        data = b"x" * 1000
        Pyro5.config.COMPRESSION = True
        msg = SendingMessage(Pyro5.protocol.MSG_INVOKE, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, data).data
        assert len(msg) < len(data)
        Pyro5.config.COMPRESSION = False

    def testAnnotationsIdLength4(self):
        with pytest.raises(Pyro5.errors.ProtocolError):
            SendingMessage(Pyro5.protocol.MSG_CONNECT, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, b"hello", {"TOOLONG": b"abcde"})
        with pytest.raises(Pyro5.errors.ProtocolError):
            SendingMessage(Pyro5.protocol.MSG_CONNECT, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, b"hello", {"QQ": b"abcde"})

    def testRecvAnnotations(self):
        annotations = {"TEST": b"abcde"}
        msg = SendingMessage(Pyro5.protocol.MSG_CONNECT, 0, 0, Pyro5.serializers.SerpentSerializer.serializer_id, b"hello", annotations)
        c = ConnectionMock()
        c.send(msg.data)
        msg = Pyro5.protocol.recv_stub(c)
        assert len(c.received) == 0
        assert msg.data == b"hello"
        assert msg.annotations["TEST"] == b"abcde"

    def testCompression(self):
        data = b"The quick brown fox jumps over the lazy dog."*10
        compressed_data = zlib.compress(data)
        flags = Pyro5.protocol.FLAGS_COMPRESSED
        msg = SendingMessage(Pyro5.protocol.MSG_INVOKE, 42, flags, 1, compressed_data)
        assert msg.data != data
        assert len(msg.data) < len(data)

    def testRecvNoAnnotations(self):
        msg = SendingMessage(Pyro5.protocol.MSG_CONNECT, 42, 0, 0, b"hello")
        c = ConnectionMock()
        c.send(msg.data)
        msg = Pyro5.protocol.recv_stub(c)
        assert len(c.received) == 0
        assert msg.data_size == 5
        assert msg.data == b"hello"
        assert msg.annotations_size == 0
        assert len(msg.annotations) == 0