Skip to content

Commit 1a69abe

Browse files
benoit-pierrebenoit-pierre
committed
test: add struct tests
1 parent 2b54483 commit 1a69abe

1 file changed

Lines changed: 174 additions & 0 deletions

File tree

‎test/test_struct.py‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
2+
from collections import OrderedDict
3+
from functools import partial
4+
import struct
5+
import types
6+
import re
7+
8+
from six import binary_type
9+
10+
from Xlib.protocol import rq
11+
from . import DummyDisplay, TestCase
12+
13+
14+
dummy_display = DummyDisplay()
15+
16+
def pack(format, *args):
17+
return struct.pack('=' + format, *args)
18+
19+
def packstr(s, padding=0):
20+
return s.encode() + (b'\0' * padding)
21+
22+
23+
class StructTest(object):
24+
""" Test class helper for rq.Struct packing/unpacking support. """
25+
26+
struct = None
27+
values = None
28+
binary = None
29+
30+
def test_pack_value_dict(self):
31+
self.assertBinaryEqual(self.struct.pack_value(dict(self.values)), self.binary)
32+
33+
def test_pack_value_tuple(self):
34+
self.assertBinaryEqual(self.struct.pack_value(tuple(self.values.values())), self.binary)
35+
36+
def test_to_binary_args(self):
37+
self.assertBinaryEqual(self.struct.to_binary(*self.values.values()), self.binary)
38+
39+
def test_to_binary_kwargs(self):
40+
self.assertBinaryEqual(self.struct.to_binary(**dict(self.values)), self.binary)
41+
42+
def test_parse_binary(self):
43+
values, remain = self.struct.parse_binary(self.binary, dummy_display)
44+
self.assertEqual(values, rq.DictWrapper(dict(self.values)))
45+
self.assertBinaryEmpty(remain)
46+
47+
48+
def _struct_test(name, fields):
49+
""" Generate a new Struct packing/unpacking test.
50+
51+
<fields> is a list of (field_name, field_type, field_value, field_binary):
52+
- field_name:
53+
name of the field, None if it's not a named field (e.g. LengthOf)
54+
- field_type:
55+
factory for the field type, taking one parameter only, the name of
56+
the field and returning a rq.Field subclass instance
57+
- field_value:
58+
the raw value passed in when packing and expected output on unpacking
59+
- field_binary:
60+
the binary representation of the field value or a function to
61+
convert it to binary for creating the expected result of packing
62+
the struct
63+
"""
64+
65+
class_name = ''.join([part.capitalize() for part in re.sub(r'[^\w]+', ' ', name).split()])
66+
class_name += 'StructTest'
67+
struct_layout = []
68+
values = OrderedDict()
69+
binary = b''
70+
for field_name, field_type, field_value, field_binary in fields:
71+
struct_layout.append(field_type(field_name))
72+
if field_name is not None and field_value is not None:
73+
values[field_name] = field_value
74+
if isinstance(field_binary, binary_type):
75+
binary += field_binary
76+
elif isinstance(field_binary, (types.FunctionType, types.LambdaType, partial)):
77+
binary += field_binary(field_value)
78+
else:
79+
raise ValueError('unsupported type for binary: {data} [{type}]'.format(
80+
data=str(field_binary), type=type(field_binary))
81+
)
82+
class_dict = {
83+
'struct': rq.Struct(*struct_layout),
84+
'values': values,
85+
'binary': binary,
86+
}
87+
globals()[class_name] = type(class_name, (StructTest, TestCase), class_dict)
88+
89+
90+
_struct_test('card', (
91+
('c8' , rq.Card8 , 0x42 , partial(pack, 'B')),
92+
('c16', rq.Card16, 0x666 , partial(pack, 'H')),
93+
('c32', rq.Card32, 0xdeadbeef, partial(pack, 'L')),
94+
))
95+
96+
_struct_test('int', (
97+
('i8' , rq.Int8 , -42 , partial(pack, 'b')),
98+
('i16', rq.Int16, -666 , partial(pack, 'h')),
99+
('i32', rq.Int32, -2147483648, partial(pack, 'l')),
100+
))
101+
102+
_struct_test('list', (
103+
(None , lambda name: rq.LengthOf('lc8', 1) , None , pack('B', 2) ),
104+
(None , lambda name: rq.LengthOf('lc16', 2) , None , pack('H', 3) ),
105+
(None , lambda name: rq.LengthOf('lc32', 4) , None , pack('L', 5) ),
106+
('lc8' , lambda name: rq.List(name, rq.Card8 , pad=0), [0x42, 0xc3] , lambda v: pack('2B' , *v)),
107+
('lc16' , lambda name: rq.List(name, rq.Card16, pad=0), [666, 1, 60143] , lambda v: pack('3H' , *v)),
108+
('lc32' , lambda name: rq.List(name, rq.Card32, pad=0), [0xf02facb, 666, 1, 0x1043, 0xdeadbeef], lambda v: pack('5L' , *v)),
109+
))
110+
111+
_struct_test('list pad', (
112+
(None , lambda name: rq.LengthOf('lc8', 1) , None , pack('B', 2) ),
113+
(None , lambda name: rq.LengthOf('lc16', 2) , None , pack('H', 3) ),
114+
(None , lambda name: rq.LengthOf('lc32', 4) , None , pack('L', 5) ),
115+
('lc8' , lambda name: rq.List(name, rq.Card8 , pad=1), [0x42, 0xc3] , lambda v: pack('2B2x', *v)),
116+
('lc16' , lambda name: rq.List(name, rq.Card16, pad=1), [666, 1, 60143] , lambda v: pack('3H2x', *v)),
117+
('lc32' , lambda name: rq.List(name, rq.Card32, pad=1), [0xf02facb, 666, 1, 0x1043, 0xdeadbeef], lambda v: pack('5L' , *v)),
118+
))
119+
120+
_struct_test('fixed list', (
121+
('lc8' , lambda name: rq.FixedList(name, 2, rq.Card8 , pad=0), [0x42, 0xc3] , lambda v: pack('2B' , *v)),
122+
('lc16' , lambda name: rq.FixedList(name, 3, rq.Card16, pad=0), [666, 1, 60143] , lambda v: pack('3H' , *v)),
123+
('lc32' , lambda name: rq.FixedList(name, 5, rq.Card32, pad=0), [0xf02facb, 666, 1, 0x1043, 0xdeadbeef], lambda v: pack('5L' , *v)),
124+
))
125+
126+
_struct_test('fixed list pad', (
127+
('lc8p' , lambda name: rq.FixedList(name, 2, rq.Card8 , pad=1), [0x42, 0xc3] , lambda v: pack('2B2x', *v)),
128+
('lc16p', lambda name: rq.FixedList(name, 3, rq.Card16, pad=1), [666, 1, 60143] , lambda v: pack('3H2x', *v)),
129+
('lc32p', lambda name: rq.FixedList(name, 5, rq.Card32, pad=1), [0xf02facb, 666, 1, 0x1043, 0xdeadbeef], lambda v: pack('5L' , *v)),
130+
))
131+
132+
_struct_test('string8', (
133+
(None, lambda name: rq.LengthOf('s1', 1) , None , pack('B', 7) ),
134+
(None, lambda name: rq.LengthOf('s2', 2) , None , pack('H', 13)),
135+
(None, lambda name: rq.LengthOf('s3', 4) , None , pack('L', 34)),
136+
('s1', lambda name: rq.String8(name, pad=0), "testing" , packstr ),
137+
('s2', lambda name: rq.String8(name, pad=0), "one two three" , packstr ),
138+
('s3', lambda name: rq.String8(name, pad=0), "supercalifragilisticexpialidocious", packstr ),
139+
))
140+
141+
_struct_test('string8 pad', (
142+
(None, lambda name: rq.LengthOf('s1', 1) , None , pack('B', 7) ),
143+
(None, lambda name: rq.LengthOf('s2', 2) , None , pack('H', 13) ),
144+
(None, lambda name: rq.LengthOf('s3', 4) , None , pack('L', 34) ),
145+
('s1', lambda name: rq.String8(name, pad=1), "testing" , partial(packstr, padding=1)),
146+
('s2', lambda name: rq.String8(name, pad=1), "one two three" , partial(packstr, padding=3)),
147+
('s3', lambda name: rq.String8(name, pad=1), "supercalifragilisticexpialidocious", partial(packstr, padding=2)),
148+
))
149+
150+
_struct_test('binary', (
151+
(None, lambda name: rq.LengthOf('s1', 1) , None , pack('B', 7) ),
152+
(None, lambda name: rq.LengthOf('s2', 2) , None , pack('H', 13)),
153+
(None, lambda name: rq.LengthOf('s3', 4) , None , pack('L', 34)),
154+
('s1', lambda name: rq.Binary(name, pad=0), b"testing" , lambda v: v),
155+
('s2', lambda name: rq.Binary(name, pad=0), b"one two three" , lambda v: v),
156+
('s3', lambda name: rq.Binary(name, pad=0), b"supercalifragilisticexpialidocious", lambda v: v),
157+
))
158+
159+
_struct_test('binary pad', (
160+
(None, lambda name: rq.LengthOf('s1', 1) , None , pack('B', 7) ),
161+
(None, lambda name: rq.LengthOf('s2', 2) , None , pack('H', 13)),
162+
(None, lambda name: rq.LengthOf('s3', 4) , None , pack('L', 34)),
163+
('s1', lambda name: rq.Binary(name, pad=1), b"testing" , lambda v: v + b'\0' * 1),
164+
('s2', lambda name: rq.Binary(name, pad=1), b"one two three" , lambda v: v + b'\0' * 3),
165+
('s3', lambda name: rq.Binary(name, pad=1), b"supercalifragilisticexpialidocious", lambda v: v + b'\0' * 2),
166+
))
167+
168+
_struct_test('fixed binary', (
169+
('s1', lambda name: rq.FixedBinary(name, 7 ), b"testing" , lambda v: v),
170+
('s2', lambda name: rq.FixedBinary(name, 13), b"one two three" , lambda v: v),
171+
('s3', lambda name: rq.FixedBinary(name, 34), b"supercalifragilisticexpialidocious", lambda v: v),
172+
# Make sure fixed binary fields are handled as static fields.
173+
('c8', rq.Card8, 0x42, partial(pack, 'B')),
174+
))

0 commit comments

Comments
 (0)