X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=tests%2Fbindings%2Fpython%2Fbt2%2Ftest_message_iterator.py;h=54fd232907dadc4c7a51f122844b1d31bb54bbe7;hp=ce968ea851cae8f643aab9bc38f446125b983cd7;hb=0235b0db7de5bcacdb3650c92461f2ce5eb2143d;hpb=7f0c21bb99a20d28739bee293fa4066989b2f3d6 diff --git a/tests/bindings/python/bt2/test_message_iterator.py b/tests/bindings/python/bt2/test_message_iterator.py index ce968ea8..54fd2329 100644 --- a/tests/bindings/python/bt2/test_message_iterator.py +++ b/tests/bindings/python/bt2/test_message_iterator.py @@ -1,42 +1,28 @@ +# SPDX-License-Identifier: GPL-2.0-only # # Copyright (C) 2019 EfficiOS Inc. # -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License -# as published by the Free Software Foundation; only version 2 -# of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -# 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 SimpleSink(bt2._UserSinkComponent): # Straightforward sink that creates one input port (`in`) and consumes from # it. - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') def _user_consume(self): next(self._msg_iter) def _user_graph_is_configured(self): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _create_graph(src_comp_cls, sink_comp_cls, flt_comp_cls=None): @@ -61,14 +47,14 @@ class UserMessageIteratorTestCase(unittest.TestCase): 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') @@ -83,19 +69,19 @@ 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( + self._up_iter = self._create_message_iterator( self._component._input_ports['in'] ) @@ -103,7 +89,7 @@ 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') @@ -116,27 +102,25 @@ class UserMessageIteratorTestCase(unittest.TestCase): 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 + # _UserSinkComponent._create_message_iterator + # and _UserMessageIterator._create_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( - self._component._input_ports['in'] - ) + self._create_message_iterator(self._component._input_ports['in']) 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') @@ -160,7 +144,7 @@ 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 @@ -169,14 +153,77 @@ class UserMessageIteratorTestCase(unittest.TestCase): 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_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 @@ -187,7 +234,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): def test_port(self): class MyIter(bt2._UserMessageIterator): - def __init__(self_iter, self_port_output): + def __init__(self_iter, config, self_port_output): nonlocal called called = True port = self_iter._port @@ -196,7 +243,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): self.assertEqual(self_port_output.addr, port.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') called = False @@ -206,12 +253,12 @@ class UserMessageIteratorTestCase(unittest.TestCase): 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 @@ -224,7 +271,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) @@ -244,7 +291,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() @@ -276,15 +323,13 @@ class UserMessageIteratorTestCase(unittest.TestCase): raise bt2.TryAgain class MySource(bt2._UserSourceComponent, message_iterator_class=MyIter): - def __init__(self, params, obj): + def __init__(self, config, params, obj): self._add_output_port('out') class MyFilterIter(bt2._UserMessageIterator): def __init__(self, port): input_port = port.user_data - self._upstream_iter = self._create_input_port_message_iterator( - input_port - ) + self._upstream_iter = self._create_message_iterator(input_port) def __next__(self): return next(self._upstream_iter) @@ -296,7 +341,7 @@ class UserMessageIteratorTestCase(unittest.TestCase): 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) @@ -313,10 +358,72 @@ class UserMessageIteratorTestCase(unittest.TestCase): with self.assertRaises(bt2.TryAgain): next(it) + def test_error_in_iterator_with_cycle_after_having_created_upstream_iterator(self): + # Test a failure that triggered an abort in libbabeltrace2, in this situation: + # + # - The filter iterator creates an upstream iterator. + # - The filter iterator creates a reference cycle, including itself. + # - An exception is raised, causing the filter iterator's + # initialization method to fail. + class MySourceIter(bt2._UserMessageIterator): + pass + + class MySource(bt2._UserSourceComponent, message_iterator_class=MySourceIter): + def __init__(self, config, params, obj): + self._add_output_port('out') + + class MyFilterIter(bt2._UserMessageIterator): + def __init__(self, config, port): + # First, create an upstream iterator. + self._upstream_iter = self._create_message_iterator( + self._component._input_ports['in'] + ) + + # Then, voluntarily make a reference cycle that will keep this + # Python object alive, which will keep the upstream iterator + # Babeltrace object alive. + self._self = self -def _setup_seek_test(sink_cls, user_seek_beginning=None, user_can_seek_beginning=None): + # Finally, raise an exception to make __init__ fail. + raise ValueError('woops') + + class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyFilterIter): + def __init__(self, config, params, obj): + self._in = self._add_input_port('in') + self._out = self._add_output_port('out') + + class MySink(bt2._UserSinkComponent): + def __init__(self, config, params, obj): + self._input_port = self._add_input_port('in') + + def _user_graph_is_configured(self): + self._upstream_iter = self._create_message_iterator(self._input_port) + + def _user_consume(self): + # We should not reach this. + assert False + + g = bt2.Graph() + src = g.add_component(MySource, 'src') + flt = g.add_component(MyFilter, 'flt') + snk = g.add_component(MySink, 'snk') + g.connect_ports(src.output_ports['out'], flt.input_ports['in']) + g.connect_ports(flt.output_ports['out'], snk.input_ports['in']) + + with self.assertRaisesRegex(bt2._Error, 'ValueError: woops'): + g.run() + + +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, port): + def __init__(self, config, port): tc, sc, ec = port.user_data trace = tc() stream = trace.create_stream(sc) @@ -331,6 +438,7 @@ def _setup_seek_test(sink_cls, user_seek_beginning=None, user_can_seek_beginning 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): @@ -346,8 +454,14 @@ def _setup_seek_test(sink_cls, user_seek_beginning=None, user_can_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, 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() @@ -355,10 +469,11 @@ def _setup_seek_test(sink_cls, user_seek_beginning=None, user_can_seek_beginning self._add_output_port('out', (tc, sc, ec)) class MyFilterIter(bt2._UserMessageIterator): - def __init__(self, port): - self._upstream_iter = self._create_input_port_message_iterator( + def __init__(self, config, port): + self._upstream_iter = self._create_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) @@ -369,8 +484,14 @@ def _setup_seek_test(sink_cls, user_seek_beginning=None, user_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, params, obj): + def __init__(self, config, params, obj): self._add_input_port('in') self._add_output_port('out') @@ -378,15 +499,20 @@ def _setup_seek_test(sink_cls, user_seek_beginning=None, user_can_seek_beginning class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): + def test_can_seek_beginning_without_seek_beginning(self): + with self.assertRaisesRegex( + bt2._IncompleteUserClass, + "cannot create component class 'MySource': message iterator class implements _user_can_seek_beginning but not _user_seek_beginning", + ): + _setup_seek_test(SimpleSink, user_can_seek_beginning=lambda: None) + 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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): nonlocal can_seek_beginning @@ -397,7 +523,9 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): return input_port_iter_can_seek_beginning graph = _setup_seek_test( - MySink, user_can_seek_beginning=_user_can_seek_beginning + MySink, + user_can_seek_beginning=_user_can_seek_beginning, + user_seek_beginning=lambda: None, ) input_port_iter_can_seek_beginning = True @@ -414,13 +542,11 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): # Test an iterator without a _user_can_seek_beginning method, but with # a _user_seek_beginning method. 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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): nonlocal can_seek_beginning @@ -438,13 +564,11 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): # Test an iterator without a _user_can_seek_beginning method, without # a _user_seek_beginning method. 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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): nonlocal can_seek_beginning @@ -457,13 +581,11 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): def test_can_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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): # This is expected to raise. @@ -473,7 +595,9 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): raise ValueError('moustiquaire') graph = _setup_seek_test( - MySink, user_can_seek_beginning=_user_can_seek_beginning + MySink, + user_can_seek_beginning=_user_can_seek_beginning, + user_seek_beginning=lambda: None, ) with self.assertRaises(bt2._Error) as ctx: @@ -484,13 +608,11 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): def test_can_seek_beginning_wrong_return_value(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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): # This is expected to raise. @@ -500,7 +622,9 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): return 'Amqui' graph = _setup_seek_test( - MySink, user_can_seek_beginning=_user_can_seek_beginning + MySink, + user_can_seek_beginning=_user_can_seek_beginning, + user_seek_beginning=lambda: None, ) with self.assertRaises(bt2._Error) as ctx: @@ -511,13 +635,11 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): 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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): nonlocal do_seek_beginning @@ -555,13 +677,11 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): 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): - self._msg_iter = self._create_input_port_message_iterator( - self._input_ports['in'] - ) + self._msg_iter = self._create_message_iterator(self._input_ports['in']) def _user_consume(self): self._msg_iter.seek_beginning() @@ -575,5 +695,361 @@ class UserMessageIteratorSeekBeginningTestCase(unittest.TestCase): graph.run_once() +class UserMessageIteratorSeekNsFromOriginTestCase(unittest.TestCase): + def test_can_seek_ns_from_origin_without_seek_ns_from_origin(self): + # Test the case where: + # + # - can_seek_ns_from_origin: Returns True (don't really care, as long + # as it's provided) + # - seek_ns_from_origin provided: No + # - can the iterator seek beginning: Don't care + # - can the iterator seek forward: Don't care + for can_seek_ns_from_origin in (False, True): + for iter_can_seek_beginning in (False, True): + for iter_can_seek_forward in (False, True): + with self.assertRaisesRegex( + bt2._IncompleteUserClass, + "cannot create component class 'MySource': message iterator class implements _user_can_seek_ns_from_origin but not _user_seek_ns_from_origin", + ): + self._can_seek_ns_from_origin_test( + None, + user_can_seek_ns_from_origin_ret_val=True, + user_seek_ns_from_origin_provided=False, + iter_can_seek_beginning=iter_can_seek_beginning, + iter_can_seek_forward=iter_can_seek_forward, + ) + + 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: 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=True, + 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_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: Yes + # - 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=False, + user_seek_ns_from_origin_provided=True, + iter_can_seek_beginning=True, + iter_can_seek_forward=True, + ) + + 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: Yes + # - 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=False, + user_seek_ns_from_origin_provided=True, + iter_can_seek_beginning=True, + iter_can_seek_forward=False, + ) + + 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: Yes + # - 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=False, + user_seek_ns_from_origin_provided=True, + iter_can_seek_beginning=False, + iter_can_seek_forward=True, + ) + + 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: Yes + # - 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=False, + user_seek_ns_from_origin_provided=True, + 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_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_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, + user_seek_ns_from_origin=lambda: None, + ) + + 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_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, + user_seek_ns_from_origin=lambda: None, + ) + + 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_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__': unittest.main()