class TestMessageTemplate(TestCase):
def setUp(self):
self._protocol = Protocol('TestProtocol')
self._protocol.add(UInt(2, 'msgId', 5))
self._protocol.add(UInt(2, 'length', None))
self._protocol.add(PDU('length-4'))
self.tmp = MessageTemplate('FooRequest', self._protocol, {})
self.tmp.add(UInt(2, 'field_1', 1))
self.tmp.add(UInt(2, 'field_2', 2))
def test_create_template(self):
self.assertEquals(len(self.tmp._fields), 2)
def test_encode_template(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg.field_1.int, 1)
self.assertEquals(msg.field_2.int, 2)
def test_message_field_type_conversions(self):
msg = self.tmp.encode({'field_1': 1024}, {})
self.assertEquals(msg.field_1.int, 1024)
self.assertEquals(msg.field_1.hex, '0x0400')
self.assertEquals(msg.field_1.bytes, '\x04\x00')
def test_encode_template_with_params(self):
msg = self.tmp.encode({'field_1': 111, 'field_2': 222}, {})
self.assertEquals(msg.field_1.int, 111)
self.assertEquals(msg.field_2.int, 222)
def test_encode_template_header(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg._header.msgId.int, 5)
self.assertEquals(msg._header.length.int, 8)
def test_encode_to_bytes(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg._header.msgId.int, 5)
self.assertEquals(msg._raw, to_bin_of_length(8,
'0x0005 0008 0001 0002'))
def test_pretty_print(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg._header.msgId.int, 5)
self.assertEquals(str(msg), 'Message FooRequest')
self.assertEquals(
repr(msg), """Message FooRequest
Header TestProtocol
msgId = 5 (0x0005)
length = 8 (0x0008)
field_1 = 1 (0x0001)
field_2 = 2 (0x0002)
""")
def test_unknown_params_cause_exception(self):
self.assertRaises(AssertionError, self.tmp.encode, {'unknown': 111},
{})
def test_decode_message(self):
msg = self.tmp.decode(to_bin('0xcafebabe'))
self.assertEquals(msg.field_1.hex, '0xcafe')
class TestMessageTemplate(TestCase):
def setUp(self):
self._protocol = Protocol('TestProtocol')
self._protocol.add(UInt(2, 'msgId', 5))
self._protocol.add(UInt(2, 'length', None))
self._protocol.add(PDU('length-4'))
self.tmp = MessageTemplate('FooRequest', self._protocol, {})
self.tmp.add(UInt(2, 'field_1', 1))
self.tmp.add(UInt(2, 'field_2', 2))
def test_create_template(self):
self.assertEquals(len(self.tmp._fields), 2)
def test_encode_template(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg.field_1.int, 1)
self.assertEquals(msg.field_2.int, 2)
def test_message_field_type_conversions(self):
msg = self.tmp.encode({'field_1': 1024}, {})
self.assertEquals(msg.field_1.int, 1024)
self.assertEquals(msg.field_1.hex, '0x0400')
self.assertEquals(msg.field_1.bytes, '\x04\x00')
def test_encode_template_with_params(self):
msg = self.tmp.encode({'field_1': 111, 'field_2': 222}, {})
self.assertEquals(msg.field_1.int, 111)
self.assertEquals(msg.field_2.int, 222)
def test_encode_template_header(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg._header.msgId.int, 5)
self.assertEquals(msg._header.length.int, 8)
def test_encode_to_bytes(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg._header.msgId.int, 5)
self.assertEquals(msg._raw, to_bin_of_length(8, '0x0005 0008 0001 0002'))
def test_pretty_print(self):
msg = self.tmp.encode({}, {})
self.assertEquals(msg._header.msgId.int, 5)
self.assertEquals(str(msg), 'Message FooRequest')
self.assertEquals(repr(msg),
"""Message FooRequest
Header TestProtocol
msgId = 5 (0x0005)
length = 8 (0x0008)
field_1 = 1 (0x0001)
field_2 = 2 (0x0002)
""")
def test_unknown_params_cause_exception(self):
self.assertRaises(AssertionError, self.tmp.encode, {'unknown': 111}, {})
def test_decode_message(self):
msg = self.tmp.decode(to_bin('0xcafebabe'))
self.assertEquals(msg.field_1.hex, '0xcafe')
class TestMessageTemplateValidation(TestCase):
def setUp(self):
self._protocol = Protocol('TestProtocol')
self._protocol.add(UInt(2, 'msgId', 5))
self._protocol.add(UInt(2, 'length', None))
self._protocol.add(PDU('length-4'))
self.tmp = MessageTemplate('FooRequest', self._protocol, {})
self.tmp.add(UInt(2, 'field_1', '0xcafe'))
self.tmp.add(UInt(2, 'field_2', '0xbabe'))
self.example = self.tmp.encode({}, {})
def test_validate_passing_hex(self):
msg = self._decode_and_set_fake_header('0xcafebabe')
errors = self.tmp.validate(msg, {}, {})
self.assertEquals(errors, [])
def test_validate_error_default_value(self):
msg = self._decode_and_set_fake_header('0xcafedead')
errors = self.tmp.validate(msg, {}, {})
self.assertEquals(
errors, ['Value of field field_2 does not match 0xdead!=0xbabe'])
def test_validate_error_override(self):
msg = self._decode_and_set_fake_header('0xcafebabe')
errors = self.tmp.validate(msg, {'field_2': '0xdead'}, {})
self.assertEquals(
errors, ['Value of field field_2 does not match 0xbabe!=0xdead'])
def test_validate_two_errors(self):
msg = self._decode_and_set_fake_header('0xbeefbabe')
errors = self.tmp.validate(msg, {'field_2': '0xdead'}, {})
self.assertEquals(len(errors), 2)
def test_validate_pattern_pass(self):
msg = self._decode_and_set_fake_header('0xcafe0002')
errors = self.tmp.validate(msg, {'field_2': '(0|2)'}, {})
self.assertEquals(len(errors), 0)
def test_validate_pattern_failure(self):
msg = self._decode_and_set_fake_header('0xcafe0002')
errors = self.tmp.validate(msg, {'field_2': '(0|3)'}, {})
self.assertEquals(len(errors), 1)
def test_validate_passing_int(self):
msg = self._decode_and_set_fake_header('0xcafe0200')
errors = self.tmp.validate(msg, {'field_2': '512'}, {})
self.assertEquals(errors, [])
def _decode_and_set_fake_header(self, bin_value):
msg = self.tmp.decode(to_bin(bin_value))
msg['_header'] = self.example._header
return msg
def test_failing_passing_int(self):
msg = self._decode_and_set_fake_header('0xcafe0200')
errors = self.tmp.validate(msg, {'field_2': '513'}, {})
self.assertEquals(len(errors), 1)
def test_decode_dynamic_list(self):
tmp = MessageTemplate('Dymagic', self._protocol, {})
tmp.add(UInt(2, 'len', None))
lst = ListTemplate('len', 'foo', parent=None)
lst.add(UInt(1, 'bar', None))
tmp.add(lst)
decoded = tmp.decode(to_bin('0x 00 04 6162 6364'))
self.assertEquals(decoded.len.int, 4)
self.assertEquals(decoded.foo[0].hex, '0x61')
def test_decode_dynamic_list(self):
tmp = MessageTemplate('Dymagic', self._protocol, {})
tmp.add(UInt(2, 'len', None))
lst = ListTemplate('len', 'foo', parent=None)
lst.add(UInt(1, 'bar', None))
tmp.add(lst)
decoded = tmp.decode(to_bin('0x 00 04 6162 6364'))
self.assertEqual(decoded.len.int, 4)
self.assertEqual(decoded.foo[0].hex, '0x61')
class TestMessageTemplateValidation(TestCase):
def setUp(self):
self._protocol = Protocol('TestProtocol')
self._protocol.add(UInt(2, 'msgId', 5))
self._protocol.add(UInt(2, 'length', None))
self._protocol.add(PDU('length-4'))
self.tmp = MessageTemplate('FooRequest', self._protocol, {})
self.tmp.add(UInt(2, 'field_1', '0xcafe'))
self.tmp.add(UInt(2, 'field_2', '0xbabe'))
self.example = self.tmp.encode({}, {})
def test_validate_passing_hex(self):
msg = self._decode_and_set_fake_header('0xcafebabe')
errors = self.tmp.validate(msg, {}, {})
self.assertEquals(errors, [])
def test_validate_error_default_value(self):
msg = self._decode_and_set_fake_header('0xcafedead')
errors = self.tmp.validate(msg, {}, {})
self.assertEquals(errors, ['Value of field field_2 does not match 0xdead!=0xbabe'])
def test_validate_error_override(self):
msg = self._decode_and_set_fake_header('0xcafebabe')
errors = self.tmp.validate(msg, {'field_2': '0xdead'}, {})
self.assertEquals(errors, ['Value of field field_2 does not match 0xbabe!=0xdead'])
def test_validate_two_errors(self):
msg = self._decode_and_set_fake_header('0xbeefbabe')
errors = self.tmp.validate(msg, {'field_2': '0xdead'}, {})
self.assertEquals(len(errors), 2)
def test_validate_pattern_pass(self):
msg = self._decode_and_set_fake_header('0xcafe0002')
errors = self.tmp.validate(msg, {'field_2': '(0|2)'}, {})
self.assertEquals(len(errors), 0)
def test_validate_pattern_failure(self):
msg = self._decode_and_set_fake_header('0xcafe0002')
errors = self.tmp.validate(msg, {'field_2': '(0|3)'}, {})
self.assertEquals(len(errors), 1)
def test_validate_passing_int(self):
msg = self._decode_and_set_fake_header('0xcafe0200')
errors = self.tmp.validate(msg, {'field_2': '512'}, {})
self.assertEquals(errors, [])
def _decode_and_set_fake_header(self, bin_value):
msg = self.tmp.decode(to_bin(bin_value))
msg['_header'] = self.example._header
return msg
def test_failing_passing_int(self):
msg = self._decode_and_set_fake_header('0xcafe0200')
errors = self.tmp.validate(msg, {'field_2': '513'}, {})
self.assertEquals(len(errors), 1)
def test_decode_dynamic_primitive(self):
tmp = MessageTemplate('Dymagic', self._protocol, {})
tmp.add(UInt(1, 'len', None))
tmp.add(Char('len', 'chars', None))
tmp.add(UInt(1, 'len2', None))
tmp.add(Char('len2', 'chars2', None))
decoded = tmp.decode(to_bin('0x 04 6162 6364 02 6566'))
self.assertEquals(decoded.len.int, 4)
self.assertEquals(decoded.chars.ascii, 'abcd')
self.assertEquals(decoded.chars2.ascii, 'ef')
def test_decode_dynamic_primitive(self):
tmp = MessageTemplate('Dymagic', self._protocol, {})
tmp.add(UInt(1, 'len', None))
tmp.add(Char('len', 'chars', None))
tmp.add(UInt(1, 'len2', None))
tmp.add(Char('len2', 'chars2', None))
decoded = tmp.decode(to_bin('0x 04 6162 6364 02 6566'))
self.assertEqual(decoded.len.int, 4)
self.assertEqual(decoded.chars.ascii, 'abcd')
self.assertEqual(decoded.chars2.ascii, 'ef')
