+ 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_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, 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()
+
+ def _user_can_seek_beginning(self):
+ nonlocal input_port_iter_can_seek_beginning
+ return input_port_iter_can_seek_beginning
+
+ graph = _setup_seek_test(
+ MySink,
+ user_can_seek_beginning=_user_can_seek_beginning,
+ user_seek_beginning=lambda: None,
+ )
+
+ input_port_iter_can_seek_beginning = True
+ can_seek_beginning = None
+ graph.run_once()
+ self.assertIs(can_seek_beginning, True)
+
+ input_port_iter_can_seek_beginning = False
+ can_seek_beginning = None
+ graph.run_once()
+ 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()
+
+ def _user_seek_beginning(self):
+ pass
+
+ graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning)
+ can_seek_beginning = None
+ graph.run_once()
+ self.assertIs(can_seek_beginning, True)
+
+ 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.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,
+ user_seek_beginning=lambda: None,
+ )
+
+ 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,
+ user_seek_beginning=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_beginning(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):
+ nonlocal do_seek_beginning
+ nonlocal msg
+
+ if do_seek_beginning:
+ self._msg_iter.seek_beginning()
+ return
+
+ msg = next(self._msg_iter)
+
+ def _user_seek_beginning(self):
+ self._at = 0
+
+ msg = None
+ graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning)
+
+ # Consume message.
+ do_seek_beginning = False
+ graph.run_once()
+ self.assertIs(type(msg), bt2._StreamBeginningMessageConst)
+
+ # Consume message.
+ graph.run_once()
+ 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.assertIs(type(msg), bt2._StreamBeginningMessageConst)
+
+ def test_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):
+ self._msg_iter.seek_beginning()
+
+ def _user_seek_beginning(self):
+ raise ValueError('ouch')
+
+ graph = _setup_seek_test(MySink, user_seek_beginning=_user_seek_beginning)
+
+ with self.assertRaises(bt2._Error):
+ 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_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,
+ 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_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,
+ 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_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__':
+ unittest.main()