X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Fbindings%2Fpython%2Fbt2%2Ftest_message_iterator.py;h=40adfa60d847fc16e652540b9811114d23d3f833;hb=dda659b36bc8a3a9f477d6bbc57cb7eb10c614a6;hp=08be7d008dd908306dcc5581486618a516e80b88;hpb=6a91742b3a25285222551341c8a134b4b2b5aba9;p=babeltrace.git diff --git a/tests/bindings/python/bt2/test_message_iterator.py b/tests/bindings/python/bt2/test_message_iterator.py index 08be7d00..40adfa60 100644 --- a/tests/bindings/python/bt2/test_message_iterator.py +++ b/tests/bindings/python/bt2/test_message_iterator.py @@ -16,18 +16,17 @@ # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # -from bt2 import value -import collections import unittest -import copy import bt2 +import sys +from utils import TestOutputPortMessageIterator class UserMessageIteratorTestCase(unittest.TestCase): @staticmethod def _create_graph(src_comp_cls, flt_comp_cls=None): class MySink(bt2._UserSinkComponent): - def __init__(self, params): + def __init__(self, params, obj): self._add_input_port('in') def _user_consume(self): @@ -70,7 +69,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): the_output_port_from_iter = self_port_output class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): + def __init__(self, params, obj): nonlocal the_output_port_from_source the_output_port_from_source = self._add_output_port('out', 'user data') @@ -90,7 +89,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): src_iter_initialized = True class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): - def __init__(self, params): + def __init__(self, params, obj): self._add_output_port('out') class MyFilterIter(bt2._UserMessageIterator): @@ -105,7 +104,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): return next(self._up_iter) class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): - def __init__(self, params): + def __init__(self, params, obj): self._add_input_port('in') self._add_output_port('out') @@ -116,6 +115,45 @@ class UserMessageIteratorTestCase(unittest.TestCase): self.assertTrue(src_iter_initialized) self.assertTrue(flt_iter_initialized) + def test_create_user_error(self): + # This tests both error handling by + # _UserSinkComponent._create_input_port_message_iterator + # and _UserMessageIterator._create_input_port_message_iterator, as they + # are both used in the graph. + class MySourceIter(bt2._UserMessageIterator): + def __init__(self, self_port_output): + raise ValueError('Very bad error') + + class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): + def __init__(self, params, obj): + self._add_output_port('out') + + class MyFilterIter(bt2._UserMessageIterator): + def __init__(self, self_port_output): + # This is expected to raise because of the error in + # MySourceIter.__init__. + self._create_input_port_message_iterator( + self._component._input_ports['in'] + ) + + class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): + def __init__(self, params, obj): + self._add_input_port('in') + self._add_output_port('out') + + graph = self._create_graph(MySource, MyFilter) + + with self.assertRaises(bt2._Error) as ctx: + graph.run() + + exc = ctx.exception + cause = exc[0] + + self.assertIsInstance(cause, bt2._MessageIteratorErrorCause) + self.assertEqual(cause.component_name, 'src') + self.assertEqual(cause.component_output_port_name, 'out') + self.assertIn('ValueError: Very bad error', cause.message) + def test_finalize(self): class MyIter(bt2._UserMessageIterator): def _user_finalize(self): @@ -123,7 +161,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): finalized = True class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): + def __init__(self, params, obj): self._add_output_port('out') finalized = False @@ -139,7 +177,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): salut = self._component._salut class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): + def __init__(self, params, obj): self._add_output_port('out') self._salut = 23 @@ -155,7 +193,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): addr = self.addr class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): + def __init__(self, params, obj): self._add_output_port('out') addr = None @@ -188,7 +226,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): return self._msgs.pop(0) class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): + def __init__(self, params, obj): tc = self._create_trace_class() sc = tc.create_stream_class(supports_packets=True) ec = sc.create_event_class() @@ -196,23 +234,23 @@ class UserMessageIteratorTestCase(unittest.TestCase): graph = bt2.Graph() src = graph.add_component(MySource, 'src') - it = graph.create_output_port_message_iterator(src.output_ports['out']) + it = TestOutputPortMessageIterator(graph, src.output_ports['out']) # Skip beginning messages. msg = next(it) - self.assertIsInstance(msg, bt2._StreamBeginningMessage) + self.assertIs(type(msg), bt2._StreamBeginningMessageConst) msg = next(it) - self.assertIsInstance(msg, bt2._PacketBeginningMessage) + self.assertIs(type(msg), bt2._PacketBeginningMessageConst) msg_ev1 = next(it) msg_ev2 = next(it) - self.assertIsInstance(msg_ev1, bt2._EventMessage) - self.assertIsInstance(msg_ev2, bt2._EventMessage) + self.assertIs(type(msg_ev1), bt2._EventMessageConst) + self.assertIs(type(msg_ev2), bt2._EventMessageConst) self.assertEqual(msg_ev1.addr, msg_ev2.addr) @staticmethod - def _setup_seek_beginning_test(): + def _setup_seek_beginning_test(sink_cls): # Use a source, a filter and an output port iterator. This allows us # to test calling `seek_beginning` on both a _OutputPortMessageIterator # and a _UserComponentInputPortMessageIterator, on top of checking that @@ -247,7 +285,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): raise StopIteration class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): - def __init__(self, params): + def __init__(self, params, obj): tc = self._create_trace_class() sc = tc.create_stream_class(supports_packets=True) ec = sc.create_event_class() @@ -272,32 +310,49 @@ class UserMessageIteratorTestCase(unittest.TestCase): return self._upstream_iter.can_seek_beginning class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): - def __init__(self, params): + def __init__(self, params, obj): input_port = self._add_input_port('in') self._add_output_port('out', input_port) graph = bt2.Graph() src = graph.add_component(MySource, 'src') flt = graph.add_component(MyFilter, 'flt') + sink = graph.add_component(sink_cls, 'sink') graph.connect_ports(src.output_ports['out'], flt.input_ports['in']) - it = graph.create_output_port_message_iterator(flt.output_ports['out']) - - return it, MySourceIter + graph.connect_ports(flt.output_ports['out'], sink.input_ports['in']) + return MySourceIter, graph def test_can_seek_beginning(self): - it, MySourceIter = self._setup_seek_beginning_test() + class MySink(bt2._UserSinkComponent): + def __init__(self, params, obj): + self._add_input_port('in') + + def _user_graph_is_configured(self): + self._msg_iter = self._create_input_port_message_iterator( + self._input_ports['in'] + ) + + def _user_consume(self): + nonlocal can_seek_beginning + can_seek_beginning = self._msg_iter.can_seek_beginning + + MySourceIter, graph = self._setup_seek_beginning_test(MySink) def _user_can_seek_beginning(self): - nonlocal can_seek_beginning - return can_seek_beginning + nonlocal input_port_iter_can_seek_beginning + return input_port_iter_can_seek_beginning MySourceIter._user_can_seek_beginning = property(_user_can_seek_beginning) - can_seek_beginning = True - self.assertTrue(it.can_seek_beginning) + input_port_iter_can_seek_beginning = True + can_seek_beginning = None + graph.run_once() + self.assertTrue(can_seek_beginning) - can_seek_beginning = False - self.assertFalse(it.can_seek_beginning) + input_port_iter_can_seek_beginning = False + can_seek_beginning = None + graph.run_once() + self.assertFalse(can_seek_beginning) # Once can_seek_beginning returns an error, verify that it raises when # _can_seek_beginning has/returns the wrong type. @@ -306,42 +361,62 @@ class UserMessageIteratorTestCase(unittest.TestCase): # a _seek_beginning method to know whether the iterator can seek to # beginning or not. del MySourceIter._user_can_seek_beginning - self.assertTrue(it.can_seek_beginning) + can_seek_beginning = None + graph.run_once() + self.assertTrue(can_seek_beginning) del MySourceIter._user_seek_beginning - self.assertFalse(it.can_seek_beginning) + can_seek_beginning = None + graph.run_once() + self.assertFalse(can_seek_beginning) def test_seek_beginning(self): - it, MySourceIter = self._setup_seek_beginning_test() - - msg = next(it) - self.assertIsInstance(msg, bt2._StreamBeginningMessage) - msg = next(it) - self.assertIsInstance(msg, bt2._PacketBeginningMessage) + class MySink(bt2._UserSinkComponent): + def __init__(self, params, obj): + self._add_input_port('in') - it.seek_beginning() + def _user_graph_is_configured(self): + self._msg_iter = self._create_input_port_message_iterator( + self._input_ports['in'] + ) - msg = next(it) - self.assertIsInstance(msg, bt2._StreamBeginningMessage) - - # Verify that we can seek beginning after having reached the end. - # - # It currently does not work to seek an output port message iterator - # once it's ended, but we should eventually make it work and uncomment - # the following snippet. - # - # try: - # while True: - # next(it) - # except bt2.Stop: - # pass - # - # it.seek_beginning() - # msg = next(it) - # self.assertIsInstance(msg, bt2._StreamBeginningMessage) + def _user_consume(self): + nonlocal do_seek_beginning + nonlocal msg + + if do_seek_beginning: + self._msg_iter.seek_beginning() + return + + msg = next(self._msg_iter) + + do_seek_beginning = False + msg = None + MySourceIter, graph = self._setup_seek_beginning_test(MySink) + graph.run_once() + self.assertIs(type(msg), bt2._StreamBeginningMessageConst) + graph.run_once() + self.assertIs(type(msg), bt2._PacketBeginningMessageConst) + do_seek_beginning = True + graph.run_once() + do_seek_beginning = False + graph.run_once() + self.assertIs(type(msg), bt2._StreamBeginningMessageConst) def test_seek_beginning_user_error(self): - it, MySourceIter = self._setup_seek_beginning_test() + class MySink(bt2._UserSinkComponent): + def __init__(self, params, obj): + self._add_input_port('in') + + def _user_graph_is_configured(self): + self._msg_iter = self._create_input_port_message_iterator( + self._input_ports['in'] + ) + + def _user_consume(self): + self._msg_iter.seek_beginning() + + MySourceIter, graph = self._setup_seek_beginning_test(MySink) def _user_seek_beginning_error(self): raise ValueError('ouch') @@ -349,7 +424,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): MySourceIter._user_seek_beginning = _user_seek_beginning_error with self.assertRaises(bt2._Error): - it.seek_beginning() + graph.run_once() # Try consuming many times from an iterator that always returns TryAgain. # This verifies that we are not missing an incref of Py_None, making the @@ -360,92 +435,22 @@ class UserMessageIteratorTestCase(unittest.TestCase): raise bt2.TryAgain class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): + def __init__(self, params, obj): self._add_output_port('out') graph = bt2.Graph() src = graph.add_component(MySource, 'src') - it = graph.create_output_port_message_iterator(src.output_ports['out']) + it = TestOutputPortMessageIterator(graph, src.output_ports['out']) - # The initial refcount of Py_None was in the 7000, so 100000 iterations - # should be enough to catch the bug even if there are small differences + # Three times the initial ref count of `None` iterations should + # be enough to catch the bug even if there are small differences # between configurations. - for i in range(100000): + none_ref_count = sys.getrefcount(None) * 3 + + for i in range(none_ref_count): with self.assertRaises(bt2.TryAgain): next(it) -class OutputPortMessageIteratorTestCase(unittest.TestCase): - def test_component(self): - class MyIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): - self._at = 0 - - def __next__(self): - if self._at == 7: - raise bt2.Stop - - if self._at == 0: - msg = self._create_stream_beginning_message(test_obj._stream) - elif self._at == 1: - msg = self._create_packet_beginning_message(test_obj._packet) - elif self._at == 5: - msg = self._create_packet_end_message(test_obj._packet) - elif self._at == 6: - msg = self._create_stream_end_message(test_obj._stream) - else: - msg = self._create_event_message( - test_obj._event_class, test_obj._packet - ) - msg.event.payload_field['my_int'] = self._at * 3 - - self._at += 1 - return msg - - class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params): - self._add_output_port('out') - - trace_class = self._create_trace_class() - stream_class = trace_class.create_stream_class(supports_packets=True) - - # Create payload field class - my_int_ft = trace_class.create_signed_integer_field_class(32) - payload_ft = trace_class.create_structure_field_class() - payload_ft += [('my_int', my_int_ft)] - - event_class = stream_class.create_event_class( - name='salut', payload_field_class=payload_ft - ) - - trace = trace_class() - stream = trace.create_stream(stream_class) - packet = stream.create_packet() - - test_obj._event_class = event_class - test_obj._stream = stream - test_obj._packet = packet - - test_obj = self - graph = bt2.Graph() - src = graph.add_component(MySource, 'src') - msg_iter = graph.create_output_port_message_iterator(src.output_ports['out']) - - for at, msg in enumerate(msg_iter): - if at == 0: - self.assertIsInstance(msg, bt2._StreamBeginningMessage) - elif at == 1: - self.assertIsInstance(msg, bt2._PacketBeginningMessage) - elif at == 5: - self.assertIsInstance(msg, bt2._PacketEndMessage) - elif at == 6: - self.assertIsInstance(msg, bt2._StreamEndMessage) - else: - self.assertIsInstance(msg, bt2._EventMessage) - self.assertEqual(msg.event.cls.name, 'salut') - field = msg.event.payload_field['my_int'] - self.assertEqual(field, at * 3) - - if __name__ == '__main__': unittest.main()