X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Fbindings%2Fpython%2Fbt2%2Ftest_message_iterator.py;h=37f6dc87798dcda7b32b4ef72b8e36b40b56b0f5;hb=c49bf79b7d7e87cc21d065a7d208bcc238fb0800;hp=c317ae432f7764a7bfdea06f329d422341c163d2;hpb=ab8b2b1ba138ce05c6eb7f1e16c0bc7784d6edfa;p=babeltrace.git diff --git a/tests/bindings/python/bt2/test_message_iterator.py b/tests/bindings/python/bt2/test_message_iterator.py index c317ae43..37f6dc87 100644 --- a/tests/bindings/python/bt2/test_message_iterator.py +++ b/tests/bindings/python/bt2/test_message_iterator.py @@ -20,61 +20,61 @@ import unittest import bt2 import sys from utils import TestOutputPortMessageIterator +from bt2 import port as bt2_port +from bt2 import message_iterator as bt2_message_iterator -class UserMessageIteratorTestCase(unittest.TestCase): - @staticmethod - def _create_graph(src_comp_cls, flt_comp_cls=None): - class MySink(bt2._UserSinkComponent): - def __init__(self, params, obj): - self._add_input_port('in') +class SimpleSink(bt2._UserSinkComponent): + # Straightforward sink that creates one input port (`in`) and consumes from + # it. - def _user_consume(self): - next(self._msg_iter) + def __init__(self, config, 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): + next(self._msg_iter) - graph = bt2.Graph() - src_comp = graph.add_component(src_comp_cls, 'src') + def _user_graph_is_configured(self): + self._msg_iter = self._create_input_port_message_iterator( + self._input_ports['in'] + ) - if flt_comp_cls is not None: - flt_comp = graph.add_component(flt_comp_cls, 'flt') - sink_comp = graph.add_component(MySink, 'sink') +def _create_graph(src_comp_cls, sink_comp_cls, flt_comp_cls=None): + graph = bt2.Graph() - if flt_comp_cls is not None: - assert flt_comp is not None - graph.connect_ports( - src_comp.output_ports['out'], flt_comp.input_ports['in'] - ) - out_port = flt_comp.output_ports['out'] - else: - out_port = src_comp.output_ports['out'] + src_comp = graph.add_component(src_comp_cls, 'src') + sink_comp = graph.add_component(sink_comp_cls, 'sink') + + if flt_comp_cls is not None: + flt_comp = graph.add_component(flt_comp_cls, 'flt') + graph.connect_ports(src_comp.output_ports['out'], flt_comp.input_ports['in']) + graph.connect_ports(flt_comp.output_ports['out'], sink_comp.input_ports['in']) + else: + graph.connect_ports(src_comp.output_ports['out'], sink_comp.input_ports['in']) + + return graph - graph.connect_ports(out_port, sink_comp.input_ports['in']) - return graph +class UserMessageIteratorTestCase(unittest.TestCase): def test_init(self): the_output_port_from_source = None the_output_port_from_iter = None class MyIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): + def __init__(self, config, self_port_output): nonlocal initialized nonlocal the_output_port_from_iter initialized = True the_output_port_from_iter = self_port_output class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): nonlocal the_output_port_from_source the_output_port_from_source = self._add_output_port('out', 'user data') initialized = False - graph = self._create_graph(MySource) + graph = _create_graph(MySource, SimpleSink) graph.run() self.assertTrue(initialized) self.assertEqual( @@ -84,16 +84,16 @@ class UserMessageIteratorTestCase(unittest.TestCase): def test_create_from_message_iterator(self): class MySourceIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): + def __init__(self, config, self_port_output): nonlocal src_iter_initialized src_iter_initialized = True class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_output_port('out') class MyFilterIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): + def __init__(self, config, self_port_output): nonlocal flt_iter_initialized flt_iter_initialized = True self._up_iter = self._create_input_port_message_iterator( @@ -104,13 +104,13 @@ class UserMessageIteratorTestCase(unittest.TestCase): return next(self._up_iter) class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') self._add_output_port('out') src_iter_initialized = False flt_iter_initialized = False - graph = self._create_graph(MySource, MyFilter) + graph = _create_graph(MySource, SimpleSink, MyFilter) graph.run() self.assertTrue(src_iter_initialized) self.assertTrue(flt_iter_initialized) @@ -121,15 +121,15 @@ class UserMessageIteratorTestCase(unittest.TestCase): # 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): + def __init__(self, config, self_port_output): raise ValueError('Very bad error') class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_output_port('out') class MyFilterIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): + def __init__(self, config, self_port_output): # This is expected to raise because of the error in # MySourceIter.__init__. self._create_input_port_message_iterator( @@ -137,11 +137,11 @@ class UserMessageIteratorTestCase(unittest.TestCase): ) class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') self._add_output_port('out') - graph = self._create_graph(MySource, MyFilter) + graph = _create_graph(MySource, SimpleSink, MyFilter) with self.assertRaises(bt2._Error) as ctx: graph.run() @@ -161,43 +161,127 @@ class UserMessageIteratorTestCase(unittest.TestCase): finalized = True class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_output_port('out') finalized = False - graph = self._create_graph(MySource) + graph = _create_graph(MySource, SimpleSink) graph.run() del graph self.assertTrue(finalized) + def test_config_parameter(self): + class MyIter(bt2._UserMessageIterator): + def __init__(self, config, port): + nonlocal config_type + config_type = type(config) + + class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + def __init__(self, config, params, obj): + self._add_output_port('out') + + config_type = None + graph = _create_graph(MySource, SimpleSink) + graph.run() + self.assertIs(config_type, bt2_message_iterator._MessageIteratorConfiguration) + + def _test_config_can_seek_forward(self, set_can_seek_forward): + class MyIter(bt2._UserMessageIterator): + def __init__(self, config, port): + if set_can_seek_forward: + config.can_seek_forward = True + + class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + def __init__(self, config, params, obj): + self._add_output_port('out') + + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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_forward + can_seek_forward = self._msg_iter.can_seek_forward + + can_seek_forward = None + graph = _create_graph(MySource, MySink) + graph.run_once() + self.assertIs(can_seek_forward, set_can_seek_forward) + + def test_config_can_seek_forward_default(self): + self._test_config_can_seek_forward(False) + + def test_config_can_seek_forward(self): + self._test_config_can_seek_forward(True) + + def test_config_can_seek_forward_wrong_type(self): + class MyIter(bt2._UserMessageIterator): + def __init__(self, config, port): + config.can_seek_forward = 1 + + class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + def __init__(self, config, params, obj): + self._add_output_port('out') + + graph = _create_graph(MySource, SimpleSink) + with self.assertRaises(bt2._Error) as ctx: + graph.run() + + root_cause = ctx.exception[0] + self.assertIn("TypeError: 'int' is not a 'bool' object", root_cause.message) + def test_component(self): class MyIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): + def __init__(self, config, self_port_output): nonlocal salut salut = self._component._salut class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_output_port('out') self._salut = 23 salut = None - graph = self._create_graph(MySource) + graph = _create_graph(MySource, SimpleSink) graph.run() self.assertEqual(salut, 23) + def test_port(self): + class MyIter(bt2._UserMessageIterator): + def __init__(self_iter, config, self_port_output): + nonlocal called + called = True + port = self_iter._port + self.assertIs(type(self_port_output), bt2_port._UserComponentOutputPort) + self.assertIs(type(port), bt2_port._UserComponentOutputPort) + self.assertEqual(self_port_output.addr, port.addr) + + class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + def __init__(self, config, params, obj): + self._add_output_port('out') + + called = False + graph = _create_graph(MySource, SimpleSink) + graph.run() + self.assertTrue(called) + def test_addr(self): class MyIter(bt2._UserMessageIterator): - def __init__(self, self_port_output): + def __init__(self, config, self_port_output): nonlocal addr addr = self.addr class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_output_port('out') addr = None - graph = self._create_graph(MySource) + graph = _create_graph(MySource, SimpleSink) graph.run() self.assertIsNotNone(addr) self.assertNotEqual(addr, 0) @@ -206,7 +290,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): # and can be re-used. def test_reuse_message(self): class MyIter(bt2._UserMessageIterator): - def __init__(self, port): + def __init__(self, config, port): tc, sc, ec = port.user_data trace = tc() stream = trace.create_stream(sc) @@ -226,7 +310,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): return self._msgs.pop(0) class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): tc = self._create_trace_class() sc = tc.create_stream_class(supports_packets=True) ec = sc.create_event_class() @@ -238,59 +322,28 @@ class UserMessageIteratorTestCase(unittest.TestCase): # 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(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 - # _UserMessageIterator._seek_beginning is properly called. - - class MySourceIter(bt2._UserMessageIterator): - def __init__(self, port): - tc, sc, ec = port.user_data - trace = tc() - stream = trace.create_stream(sc) - packet = stream.create_packet() - - self._msgs = [ - self._create_stream_beginning_message(stream), - self._create_packet_beginning_message(packet), - self._create_event_message(ec, packet), - self._create_event_message(ec, packet), - self._create_packet_end_message(packet), - self._create_stream_end_message(stream), - ] - self._at = 0 - - def _user_seek_beginning(self): - self._at = 0 - + # 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 + # refcount of Py_None reach 0. + def test_try_again_many_times(self): + class MyIter(bt2._UserMessageIterator): def __next__(self): - if self._at < len(self._msgs): - msg = self._msgs[self._at] - self._at += 1 - return msg - else: - raise StopIteration - - class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): - def __init__(self, params, obj): - tc = self._create_trace_class() - sc = tc.create_stream_class(supports_packets=True) - ec = sc.create_event_class() + raise bt2.TryAgain - self._add_output_port('out', (tc, sc, ec)) + class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): + def __init__(self, config, params, obj): + self._add_output_port('out') class MyFilterIter(bt2._UserMessageIterator): def __init__(self, port): @@ -305,26 +358,116 @@ class UserMessageIteratorTestCase(unittest.TestCase): def _user_seek_beginning(self): self._upstream_iter.seek_beginning() - @property def _user_can_seek_beginning(self): - return self._upstream_iter.can_seek_beginning + return self._upstream_iter.can_seek_beginning() class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): - def __init__(self, params, obj): + def __init__(self, config, 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']) - graph.connect_ports(flt.output_ports['out'], sink.input_ports['in']) - return MySourceIter, graph + it = TestOutputPortMessageIterator(graph, src.output_ports['out']) + + # Three times the initial ref count of `None` iterations should + # be enough to catch the bug even if there are small differences + # between configurations. + none_ref_count = sys.getrefcount(None) * 3 + + for i in range(none_ref_count): + with self.assertRaises(bt2.TryAgain): + next(it) + + +def _setup_seek_test( + sink_cls, + user_seek_beginning=None, + user_can_seek_beginning=None, + user_seek_ns_from_origin=None, + user_can_seek_ns_from_origin=None, + can_seek_forward=False, +): + class MySourceIter(bt2._UserMessageIterator): + def __init__(self, config, port): + tc, sc, ec = port.user_data + trace = tc() + stream = trace.create_stream(sc) + packet = stream.create_packet() + + self._msgs = [ + self._create_stream_beginning_message(stream), + self._create_packet_beginning_message(packet), + self._create_event_message(ec, packet), + self._create_event_message(ec, packet), + self._create_packet_end_message(packet), + self._create_stream_end_message(stream), + ] + self._at = 0 + config.can_seek_forward = can_seek_forward + + def __next__(self): + if self._at < len(self._msgs): + msg = self._msgs[self._at] + self._at += 1 + return msg + else: + raise StopIteration + + if user_seek_beginning is not None: + MySourceIter._user_seek_beginning = user_seek_beginning + + if user_can_seek_beginning is not None: + MySourceIter._user_can_seek_beginning = user_can_seek_beginning + + if user_seek_ns_from_origin is not None: + MySourceIter._user_seek_ns_from_origin = user_seek_ns_from_origin + + if user_can_seek_ns_from_origin is not None: + MySourceIter._user_can_seek_ns_from_origin = user_can_seek_ns_from_origin + + class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): + def __init__(self, config, params, obj): + tc = self._create_trace_class() + sc = tc.create_stream_class(supports_packets=True) + ec = sc.create_event_class() + + self._add_output_port('out', (tc, sc, ec)) + + class MyFilterIter(bt2._UserMessageIterator): + def __init__(self, config, port): + self._upstream_iter = self._create_input_port_message_iterator( + self._component._input_ports['in'] + ) + config.can_seek_forward = self._upstream_iter.can_seek_forward + + def __next__(self): + return next(self._upstream_iter) + + def _user_can_seek_beginning(self): + return self._upstream_iter.can_seek_beginning() + + def _user_seek_beginning(self): + self._upstream_iter.seek_beginning() + + def _user_can_seek_ns_from_origin(self, ns_from_origin): + return self._upstream_iter.can_seek_ns_from_origin(ns_from_origin) + + def _user_seek_ns_from_origin(self, ns_from_origin): + self._upstream_iter.seek_ns_from_origin(ns_from_origin) + + class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): + def __init__(self, config, params, obj): + self._add_input_port('in') + self._add_output_port('out') + + return _create_graph(MySource, sink_cls, flt_comp_cls=MyFilter) + +class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): def test_can_seek_beginning(self): class MySink(bt2._UserSinkComponent): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') def _user_graph_is_configured(self): @@ -334,45 +477,128 @@ class UserMessageIteratorTestCase(unittest.TestCase): 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) + can_seek_beginning = self._msg_iter.can_seek_beginning() def _user_can_seek_beginning(self): nonlocal input_port_iter_can_seek_beginning return input_port_iter_can_seek_beginning - MySourceIter._user_can_seek_beginning = property(_user_can_seek_beginning) + graph = _setup_seek_test( + MySink, user_can_seek_beginning=_user_can_seek_beginning + ) input_port_iter_can_seek_beginning = True can_seek_beginning = None graph.run_once() - self.assertTrue(can_seek_beginning) + self.assertIs(can_seek_beginning, True) input_port_iter_can_seek_beginning = False can_seek_beginning = None graph.run_once() - self.assertFalse(can_seek_beginning) + self.assertIs(can_seek_beginning, False) + + def test_no_can_seek_beginning_with_seek_beginning(self): + # Test an iterator without a _user_can_seek_beginning method, but with + # a _user_seek_beginning method. + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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() - # Once can_seek_beginning returns an error, verify that it raises when - # _can_seek_beginning has/returns the wrong type. + def _user_seek_beginning(self): + pass - # Remove the _can_seek_beginning method, we now rely on the presence of - # a _seek_beginning method to know whether the iterator can seek to - # beginning or not. - del MySourceIter._user_can_seek_beginning + graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning) can_seek_beginning = None graph.run_once() - self.assertTrue(can_seek_beginning) + self.assertIs(can_seek_beginning, True) - del MySourceIter._user_seek_beginning + def test_no_can_seek_beginning(self): + # Test an iterator without a _user_can_seek_beginning method, without + # a _user_seek_beginning method. + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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() + + graph = _setup_seek_test(MySink) can_seek_beginning = None graph.run_once() - self.assertFalse(can_seek_beginning) + self.assertIs(can_seek_beginning, False) + + def test_can_seek_beginning_user_error(self): + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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): + # This is expected to raise. + self._msg_iter.can_seek_beginning() + + def _user_can_seek_beginning(self): + raise ValueError('moustiquaire') + + graph = _setup_seek_test( + MySink, user_can_seek_beginning=_user_can_seek_beginning + ) + + with self.assertRaises(bt2._Error) as ctx: + graph.run_once() + + cause = ctx.exception[0] + self.assertIn('ValueError: moustiquaire', cause.message) + + def test_can_seek_beginning_wrong_return_value(self): + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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): + # This is expected to raise. + self._msg_iter.can_seek_beginning() + + def _user_can_seek_beginning(self): + return 'Amqui' + + graph = _setup_seek_test( + MySink, user_can_seek_beginning=_user_can_seek_beginning + ) + + with self.assertRaises(bt2._Error) as ctx: + graph.run_once() + + cause = ctx.exception[0] + self.assertIn("TypeError: 'str' is not a 'bool' object", cause.message) def test_seek_beginning(self): class MySink(bt2._UserSinkComponent): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') def _user_graph_is_configured(self): @@ -390,22 +616,33 @@ class UserMessageIteratorTestCase(unittest.TestCase): msg = next(self._msg_iter) - do_seek_beginning = False + def _user_seek_beginning(self): + self._at = 0 + msg = None - MySourceIter, graph = self._setup_seek_beginning_test(MySink) + graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning) + + # Consume message. + do_seek_beginning = False graph.run_once() - self.assertIsInstance(msg, bt2._StreamBeginningMessage) + self.assertIs(type(msg), bt2._StreamBeginningMessageConst) + + # Consume message. graph.run_once() - self.assertIsInstance(msg, bt2._PacketBeginningMessage) + self.assertIs(type(msg), bt2._PacketBeginningMessageConst) + + # Seek beginning. do_seek_beginning = True graph.run_once() + + # Consume message. do_seek_beginning = False graph.run_once() - self.assertIsInstance(msg, bt2._StreamBeginningMessage) + self.assertIs(type(msg), bt2._StreamBeginningMessageConst) def test_seek_beginning_user_error(self): class MySink(bt2._UserSinkComponent): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') def _user_graph_is_configured(self): @@ -416,40 +653,355 @@ class UserMessageIteratorTestCase(unittest.TestCase): def _user_consume(self): self._msg_iter.seek_beginning() - MySourceIter, graph = self._setup_seek_beginning_test(MySink) - - def _user_seek_beginning_error(self): + def _user_seek_beginning(self): raise ValueError('ouch') - MySourceIter._user_seek_beginning = _user_seek_beginning_error + graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning) with self.assertRaises(bt2._Error): 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 - # refcount of Py_None reach 0. - def test_try_again_many_times(self): - class MyIter(bt2._UserMessageIterator): - def __next__(self): - raise bt2.TryAgain - class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): - self._add_output_port('out') +class UserMessageIteratorSeekNsFromOriginTestCase(unittest.TestCase): + def test_can_seek_ns_from_origin_returns_true(self): + # Test the case where: + # + # - can_seek_ns_from_origin: returns True + # - seek_ns_from_origin provided: Don't care + # - can the iterator seek beginning: Don't care + # - can the iterator seek forward: Don't care + # + # We expect iter.can_seek_ns_from_origin to return True. + for user_seek_ns_from_origin_provided in (False, True): + for iter_can_seek_beginning in (False, True): + for iter_can_seek_forward in (False, True): + self._can_seek_ns_from_origin_test( + expected_outcome=True, + user_can_seek_ns_from_origin_ret_val=True, + user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided, + iter_can_seek_beginning=iter_can_seek_beginning, + iter_can_seek_forward=iter_can_seek_forward, + ) + + def test_can_seek_ns_from_origin_returns_false_can_seek_beginning_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: returns False + # - seek_ns_from_origin provided: Don't care + # - can the iterator seek beginning: Yes + # - can the iterator seek forward: Yes + # + # We expect iter.can_seek_ns_from_origin to return True. + for user_seek_ns_from_origin_provided in (False, True): + self._can_seek_ns_from_origin_test( + expected_outcome=True, + user_can_seek_ns_from_origin_ret_val=False, + user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided, + iter_can_seek_beginning=True, + iter_can_seek_forward=True, + ) - graph = bt2.Graph() - src = graph.add_component(MySource, 'src') - it = TestOutputPortMessageIterator(graph, src.output_ports['out']) + def test_can_seek_ns_from_origin_returns_false_can_seek_beginning_not_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: returns False + # - seek_ns_from_origin provided: Don't care + # - can the iterator seek beginning: Yes + # - can the iterator seek forward: No + # + # We expect iter.can_seek_ns_from_origin to return False. + for user_seek_ns_from_origin_provided in (False, True): + self._can_seek_ns_from_origin_test( + expected_outcome=False, + user_can_seek_ns_from_origin_ret_val=False, + user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided, + iter_can_seek_beginning=True, + iter_can_seek_forward=False, + ) - # Three times the initial ref count of `None` iterations should - # be enough to catch the bug even if there are small differences - # between configurations. - none_ref_count = sys.getrefcount(None) * 3 + def test_can_seek_ns_from_origin_returns_false_cant_seek_beginning_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: returns False + # - seek_ns_from_origin provided: Don't care + # - can the iterator seek beginning: No + # - can the iterator seek forward: Yes + # + # We expect iter.can_seek_ns_from_origin to return False. + # for user_seek_ns_from_origin_provided in (False, True): + self._can_seek_ns_from_origin_test( + expected_outcome=False, + user_can_seek_ns_from_origin_ret_val=False, + user_seek_ns_from_origin_provided=False, + iter_can_seek_beginning=False, + iter_can_seek_forward=True, + ) - for i in range(none_ref_count): - with self.assertRaises(bt2.TryAgain): - next(it) + def test_can_seek_ns_from_origin_returns_false_cant_seek_beginning_not_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: returns False + # - seek_ns_from_origin provided: Don't care + # - can the iterator seek beginning: No + # - can the iterator seek forward: No + # + # We expect iter.can_seek_ns_from_origin to return False. + for user_seek_ns_from_origin_provided in (False, True): + self._can_seek_ns_from_origin_test( + expected_outcome=False, + user_can_seek_ns_from_origin_ret_val=False, + user_seek_ns_from_origin_provided=user_seek_ns_from_origin_provided, + iter_can_seek_beginning=False, + iter_can_seek_forward=False, + ) + + def test_no_can_seek_ns_from_origin_seek_ns_from_origin(self): + # Test the case where: + # + # - can_seek_ns_from_origin: Not provided + # - seek_ns_from_origin provided: Yes + # - can the iterator seek beginning: Don't care + # - can the iterator seek forward: Don't care + # + # We expect iter.can_seek_ns_from_origin to return True. + for iter_can_seek_beginning in (False, True): + for iter_can_seek_forward in (False, True): + self._can_seek_ns_from_origin_test( + expected_outcome=True, + user_can_seek_ns_from_origin_ret_val=None, + user_seek_ns_from_origin_provided=True, + iter_can_seek_beginning=iter_can_seek_beginning, + iter_can_seek_forward=iter_can_seek_forward, + ) + + def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_can_seek_beginning_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: Not provided + # - seek_ns_from_origin provided: Not provided + # - can the iterator seek beginning: Yes + # - can the iterator seek forward: Yes + # + # We expect iter.can_seek_ns_from_origin to return True. + self._can_seek_ns_from_origin_test( + expected_outcome=True, + user_can_seek_ns_from_origin_ret_val=None, + user_seek_ns_from_origin_provided=False, + iter_can_seek_beginning=True, + iter_can_seek_forward=True, + ) + + def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_can_seek_beginning_not_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: Not provided + # - seek_ns_from_origin provided: Not provided + # - can the iterator seek beginning: Yes + # - can the iterator seek forward: No + # + # We expect iter.can_seek_ns_from_origin to return False. + self._can_seek_ns_from_origin_test( + expected_outcome=False, + user_can_seek_ns_from_origin_ret_val=None, + user_seek_ns_from_origin_provided=False, + iter_can_seek_beginning=True, + iter_can_seek_forward=False, + ) + + def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_cant_seek_beginning_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: Not provided + # - seek_ns_from_origin provided: Not provided + # - can the iterator seek beginning: No + # - can the iterator seek forward: Yes + # + # We expect iter.can_seek_ns_from_origin to return False. + self._can_seek_ns_from_origin_test( + expected_outcome=False, + user_can_seek_ns_from_origin_ret_val=None, + user_seek_ns_from_origin_provided=False, + iter_can_seek_beginning=False, + iter_can_seek_forward=True, + ) + + def test_no_can_seek_ns_from_origin_no_seek_ns_from_origin_cant_seek_beginning_not_forward_seekable( + self + ): + # Test the case where: + # + # - can_seek_ns_from_origin: Not provided + # - seek_ns_from_origin provided: Not provided + # - can the iterator seek beginning: No + # - can the iterator seek forward: No + # + # We expect iter.can_seek_ns_from_origin to return False. + self._can_seek_ns_from_origin_test( + expected_outcome=False, + user_can_seek_ns_from_origin_ret_val=None, + user_seek_ns_from_origin_provided=False, + iter_can_seek_beginning=False, + iter_can_seek_forward=False, + ) + + def _can_seek_ns_from_origin_test( + self, + expected_outcome, + user_can_seek_ns_from_origin_ret_val, + user_seek_ns_from_origin_provided, + iter_can_seek_beginning, + iter_can_seek_forward, + ): + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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_ns_from_origin + can_seek_ns_from_origin = self._msg_iter.can_seek_ns_from_origin( + passed_ns_from_origin + ) + + if user_can_seek_ns_from_origin_ret_val is not None: + + def user_can_seek_ns_from_origin(self, ns_from_origin): + nonlocal received_ns_from_origin + received_ns_from_origin = ns_from_origin + return user_can_seek_ns_from_origin_ret_val + + else: + user_can_seek_ns_from_origin = None + + if user_seek_ns_from_origin_provided: + + def user_seek_ns_from_origin(self, ns_from_origin): + pass + + else: + user_seek_ns_from_origin = None + + if iter_can_seek_beginning: + + def user_seek_beginning(self): + pass + + else: + user_seek_beginning = None + + graph = _setup_seek_test( + MySink, + user_can_seek_ns_from_origin=user_can_seek_ns_from_origin, + user_seek_ns_from_origin=user_seek_ns_from_origin, + user_seek_beginning=user_seek_beginning, + can_seek_forward=iter_can_seek_forward, + ) + + passed_ns_from_origin = 77 + received_ns_from_origin = None + can_seek_ns_from_origin = None + graph.run_once() + self.assertIs(can_seek_ns_from_origin, expected_outcome) + + if user_can_seek_ns_from_origin_ret_val is not None: + self.assertEqual(received_ns_from_origin, passed_ns_from_origin) + + def test_can_seek_ns_from_origin_user_error(self): + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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): + # This is expected to raise. + self._msg_iter.can_seek_ns_from_origin(2) + + def _user_can_seek_ns_from_origin(self, ns_from_origin): + raise ValueError('Joutel') + + graph = _setup_seek_test( + MySink, user_can_seek_ns_from_origin=_user_can_seek_ns_from_origin + ) + + with self.assertRaises(bt2._Error) as ctx: + graph.run_once() + + cause = ctx.exception[0] + self.assertIn('ValueError: Joutel', cause.message) + + def test_can_seek_ns_from_origin_wrong_return_value(self): + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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): + # This is expected to raise. + self._msg_iter.can_seek_ns_from_origin(2) + + def _user_can_seek_ns_from_origin(self, ns_from_origin): + return 'Nitchequon' + + graph = _setup_seek_test( + MySink, user_can_seek_ns_from_origin=_user_can_seek_ns_from_origin + ) + + with self.assertRaises(bt2._Error) as ctx: + graph.run_once() + + cause = ctx.exception[0] + self.assertIn("TypeError: 'str' is not a 'bool' object", cause.message) + + def test_seek_ns_from_origin(self): + class MySink(bt2._UserSinkComponent): + def __init__(self, config, 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_ns_from_origin(17) + + def _user_seek_ns_from_origin(self, ns_from_origin): + nonlocal actual_ns_from_origin + actual_ns_from_origin = ns_from_origin + + graph = _setup_seek_test( + MySink, user_seek_ns_from_origin=_user_seek_ns_from_origin + ) + + actual_ns_from_origin = None + graph.run_once() + self.assertEqual(actual_ns_from_origin, 17) if __name__ == '__main__':