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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
|
import sys
import unittest
from struct import pack
import six
import txdbus.marshal as m
# dbus_types = [ ('BYTE', 'y', 1),
# ('BOOLEAN', 'b', 4),
# ('INT16', 'n', 2),
# ('UINT16', 'q', 2),
# ('INT32', 'i', 4),
# ('UINT32', 'u', 4),
# ('INT64', 'x', 8),
# ('UINT64', 't', 8),
# ('DOUBLE', 'd', 8),
# ('STRING', 's', 4), # (4-byte align for length)
# ('OBJECT_PATH', '4', 4), # (4-byte align for length)
# ('SIGNATURE', 'g', 1),
# ('ARRAY', 'a', 4), # (4-byte align for length)
# ('STRUCT', '(', 8),
# ('VARIANT', 'v', 1), # (1-byte align for signature)
# ('DICT_ENTRY', '{', 8),
# ('UNIX_FD', 'h', 4)
# ]
class SigFromPyTests(unittest.TestCase):
def t(self, p, s):
self.assertEqual(m.sigFromPy(p), s)
def test_int(self):
self.t(1, 'i')
def test_bool(self):
self.t(True, 'b')
@unittest.skipIf(six.PY3, 'Python 3 uses unified integers: no long type.')
def test_long(self):
self.t(long(1), 'x') # noqa: This test is python2-only
def test_float(self):
self.t(1.0, 'd')
def test_string(self):
self.t('foo', 's')
def test_list(self):
self.t([1], 'ai')
def test_bytearray(self):
self.t(bytearray(six.b('\xAA\xAA')), 'ay')
def test_list_multiple_elements_same_type(self):
self.t([1, 2], 'ai')
def test_list_of_variants(self):
self.t([1, '2'], 'av')
def test_tuple(self):
self.t(('foo', 1), '(si)')
def test_dict(self):
self.t({'foo': 1}, 'a{si}')
def test_dict_multiple_elements_same_type(self):
self.t({'foo': 1, 'bar': 2}, 'a{si}')
def test_dict_of_variants(self):
self.t({'foo': 1, 'bar': '2'}, 'a{sv}')
def test_fail(self):
class I(object):
pass
self.assertRaises(m.MarshallingError, m.sigFromPy, I())
def test_class(self):
class V(object):
dbusSignature = 'ii'
self.t(V(), 'ii')
class AlignmentTests(unittest.TestCase):
def test_no_padding(self):
self.assertEqual(m.pad['y'](1), b'')
def test_2align(self):
self.assertEqual(m.pad['n'](1), b'\0')
def test_8align(self):
self.assertEqual(m.pad['t'](1), b'\0' * 7)
def test_0align(self):
self.assertEqual(m.pad['t'](8), b'')
def test_mid_align(self):
self.assertEqual(m.pad['t'](4), b'\0' * 4)
class SignatureIteratorTests(unittest.TestCase):
def ae(self, sig, expected):
self.assertEqual(list(m.genCompleteTypes(sig)), expected)
def test_one(self):
self.ae('i', ['i'])
def test_two(self):
self.ae('ii', ['i', 'i'])
def test_multi(self):
self.ae('isydnq', ['i', 's', 'y', 'd', 'n', 'q'])
def test_struct(self):
self.ae('i(ii)i', ['i', '(ii)', 'i'])
def test_embedded_struct(self):
self.ae('i(i(ss)i)i', ['i', '(i(ss)i)', 'i'])
def test_embedded_array(self):
self.ae('i(iaii)i', ['i', '(iaii)', 'i'])
def test_array_of_struct(self):
self.ae('ia(iii)i', ['i', 'a(iii)', 'i'])
def test_array_of_dict(self):
self.ae('ia{s(ii)}i', ['i', 'a{s(ii)}', 'i'])
class TestMarshal(unittest.TestCase):
def check(self, sig, var_list, expected_encoding, little_endian = sys.byteorder == 'little'):
if not isinstance(var_list, list):
var_list = [var_list]
nbytes, chunks = m.marshal(sig, var_list, 0, little_endian)
bin_str = b''.join(chunks)
self.assertEqual(
nbytes,
len(expected_encoding),
"Byte length mismatch. Expected %d. Got %d" % (
len(expected_encoding),
nbytes,
),
)
self.assertEqual(
bin_str,
expected_encoding,
"Binary encoding differs from expected value",
)
class TestSimpleMarshal(TestMarshal):
def test_byte(self):
self.check('y', 1, b'\x01')
def test_int16(self):
self.check('n', -1024, pack('h', -1024))
def test_uint16(self):
self.check('q', 1024, pack('H', 1024))
def test_int32(self):
self.check('i', -70000, pack('i', -70000))
def test_uint32(self):
self.check('u', 70000, pack('I', 70000))
def test_int64(self):
self.check('x', -70000, pack('q', -70000))
def test_uint64(self):
self.check('t', 70000, pack('Q', 70000))
def test_double(self):
self.check('d', 3.14, pack('d', 3.14))
def test_boolean(self):
self.check('b', True, pack('i', 1))
def test_string(self):
self.check('s', 'Hello World', pack('i12s', 11, b'Hello World'))
def test_string_wrong_type(self):
self.assertRaises(m.MarshallingError, self.check, 's', 1, '')
def test_string_embedded_null(self):
self.assertRaises(
m.MarshallingError,
self.check,
's',
b'Hello\0World',
'')
def test_signature1(self):
self.check('g', 'i', pack('BcB', 1, b'i', 0))
def test_signature2(self):
self.check('g', '(ii)', pack('B4sB', 4, b'(ii)', 0))
def test_endian(self):
self.check('x', 70000, pack('>q', 70000), False)
class TestStructMarshal(TestMarshal):
def test_one(self):
self.check('(i)', [[1]], pack('i', 1))
def test_two(self):
self.check('(ii)', [[2, 3]], pack('ii', 2, 3))
def test_pad(self):
self.check('(yx)', [[1, 70000]], pack('Bxxxxxxxq', 1, 70000))
def test_string(self):
self.check('(ysy)', [[1, 'foo', 2]], pack(
'Bxxxi3sxB', 1, 3, b'foo', 2))
def test_substruct(self):
self.check('(y(ii)y)', [[1, [3, 4], 2]],
pack('BxxxxxxxiiB', 1, 3, 4, 2))
def test_substruct_endian(self):
self.check('(y(ii)y)', [[1, [3, 4], 2]], pack(
'>BxxxxxxxiiB', 1, 3, 4, 2), False)
def test_custom(self):
class S:
dbusOrder = 'a b'.split()
def __init__(self):
self.a = 1
self.b = 2
self.check('(ii)', [S()], pack('ii', 1, 2))
class TestArrayMarshal(TestMarshal):
def test_byte(self):
self.check('ay', [[1, 2, 3, 4]], pack('iBBBB', 4, 1, 2, 3, 4))
def test_byte_bytearray(self):
self.check(
'ay',
bytearray(six.b('\xaa\xaa')),
pack('iBB', 2, 170, 170),
)
def test_string(self):
self.check('as', [['x', 'foo']], pack(
'ii2sxxi4s', 16, 1, b'x', 3, b'foo'))
def test_struct(self):
self.check('a(ii)', [[[1, 2], [3, 4]]],
pack('ixxxxiiii', 16, 1, 2, 3, 4))
def test_struct_padding(self):
self.check('a(yy)', [[[1, 2], [3, 4]]], pack(
'ixxxxBBxxxxxxBB', 10, 1, 2, 3, 4))
def test_dict(self):
self.check('a{yy}', [{1: 2, 3: 4}], pack(
'ixxxxBBxxxxxxBB', 10, 1, 2, 3, 4))
def test_dict_strings(self):
self.check(
'a{ss}',
[[('foo', 'bar'), ('x', 'y')]],
pack(
'ixxxxi4si4si2sxxi2s',
30,
3,
b'foo',
3,
b'bar',
1,
b'x',
1,
b'y'
)
)
def test_invalid_array(self):
self.assertRaises(m.MarshallingError, self.check, 'a{yy}', 1, '')
class TestVariantMarshal(TestMarshal):
def test_byte(self):
self.check('v', [1], pack('B2si', 1, b'i', 1))
def test_struct(self):
class S:
dbusSignature = '(ii)'
dbusOrder = 'a b'.split()
def __init__(self):
self.a = 1
self.b = 2
self.check('v', [S()], pack('B5sxxii', 4, b'(ii)', 1, 2))
def test_bytearray(self):
self.check(
'v', bytearray(
six.b('\xAA\xAA')), pack(
'B2siBB', 2, six.b('ay'), 2, 170, 170))
# ------------------------------------------------------------------------
# Unmarshalling
# ------------------------------------------------------------------------
def check_equal(a, b):
try:
if isinstance(a, list):
check_list(a, b)
elif isinstance(a, dict):
check_dict(a, b)
elif not a == b:
raise Exception()
except BaseException:
return False
return True
def check_list(a, b):
if not isinstance(b, list):
raise Exception()
if len(a) != len(b):
raise Exception()
for x, y in zip(a, b):
check_equal(x, y)
def check_dict(a, b):
if not isinstance(b, dict):
raise Exception()
if not len(a.keys()) == len(b.keys()):
raise Exception()
aset = set(a.keys())
bset = set(b.keys())
if aset - bset:
raise Exception()
for x in a.keys():
check_equal(a[x], b[x])
class TestUnmarshal(unittest.TestCase):
def check(self, sig, expected_value, encoding):
nbytes, value = m.unmarshal(sig, encoding, 0, sys.byteorder == 'little')
self.assertEqual(
nbytes,
len(encoding),
(
"Unmarshalling length mismatch. Expected %d bytes consumed. "
"Got %d"
) % (len(encoding), nbytes),
)
self.assertTrue(
check_equal(
[expected_value],
value),
'Value mismatch. Expected: "%s". Got: "%s"' %
(repr(expected_value),
repr(value)))
class TestSimpleUnmarshal(TestUnmarshal):
def test_byte(self):
self.check('y', 1, b'\1')
def test_int16(self):
self.check('n', -1024, pack('h', -1024))
def test_uint16(self):
self.check('q', 1024, pack('H', 1024))
def test_int32(self):
self.check('i', -70000, pack('i', -70000))
def test_uint32(self):
self.check('u', 70000, pack('I', 70000))
def test_int64(self):
self.check('x', -70000, pack('q', -70000))
def test_uint64(self):
self.check('t', 70000, pack('Q', 70000))
def test_double(self):
self.check('d', 3.14, pack('d', 3.14))
def test_boolean(self):
self.check('b', True, pack('i', 1))
def test_string(self):
self.check('s', 'Hello World', pack('i12s', 11, b'Hello World'))
def test_signature1(self):
self.check('g', 'i', pack('BcB', 1, b'i', 0))
def test_signature2(self):
self.check('g', '(ii)', pack('B4sB', 4, b'(ii)', 0))
class TestStructUnmarshal(TestUnmarshal):
def test_one(self):
self.check('(i)', [[1]], pack('i', 1))
def test_two(self):
self.check('(ii)', [[2, 3]], pack('ii', 2, 3))
def test_pad(self):
self.check('(yx)', [[1, 70000]], pack('Bxxxxxxxq', 1, 70000))
def test_string(self):
self.check(
'(ysy)',
[[1, 'foo', 2]],
pack('Bxxxi3sxB', 1, 3, b'foo', 2),
)
def test_substruct(self):
self.check(
'(y(ii)y)',
[[1, [3, 4], 2]],
pack('BxxxxxxxiiB', 1, 3, 4, 2),
)
class TestArrayUnmarshal(TestUnmarshal):
def test_byte(self):
self.check('ay', [[1, 2, 3, 4]], pack('iBBBB', 4, 1, 2, 3, 4))
def test_string(self):
self.check(
'as',
[['x', 'foo']],
pack('ii2sxxi4s', 16, 1, b'x', 3, b'foo')
)
def test_struct(self):
self.check(
'a(ii)',
[[[1, 2], [3, 4]]],
pack('ixxxxiiii', 16, 1, 2, 3, 4)
)
def test_struct_padding(self):
self.check(
'a(yy)',
[[[1, 2], [3, 4]]],
pack('ixxxxBBxxxxxxBB', 10, 1, 2, 3, 4)
)
def test_dict(self):
self.check(
'a{yy}',
[{1: 2, 3: 4}],
pack('ixxxxBBxxxxxxBB', 10, 1, 2, 3, 4),
)
def test_dict_strings(self):
self.check(
'a{ss}',
[{'foo': 'bar', 'x': 'y'}],
pack(
'ixxxxi4si4si2sxxi2s',
30,
3,
b'foo',
3,
b'bar',
1,
b'x',
1,
b'y'
)
)
def test_bad_length(self):
self.assertRaises(
m.MarshallingError,
self.check,
'a(ii)',
[[[1, 2], [3, 4]]],
pack('ixxxxiiii', 15, 1, 2, 3, 4)
)
class TestVariantUnmarshal(TestUnmarshal):
def test_byte(self):
self.check('v', [1], pack('B2si', 1, b'i', 1))
def test_struct(self):
self.check('v', [[1, 2]], pack('B5sxxii', 4, b'(ii)', 1, 2))
if __name__ == '__main__':
unittest.main()
|