2 # Copyright (C) 2019 EfficiOS Inc.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; only version 2
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 class _MyIter(bt2
._UserMessageIterator
):
24 def __init__(self
, config
, self_output_port
):
28 def _build_meta(self
):
29 self
._tc
= self
._component
._create
_trace
_class
()
31 self
._sc
= self
._tc
.create_stream_class(supports_packets
=True)
32 self
._ec
= self
._sc
.create_event_class(name
='salut')
33 self
._my
_int
_ft
= self
._tc
.create_signed_integer_field_class(32)
34 payload_ft
= self
._tc
.create_structure_field_class()
35 payload_ft
+= [('my_int', self
._my
_int
_ft
)]
36 self
._ec
.payload_field_type
= payload_ft
37 self
._stream
= self
._t
.create_stream(self
._sc
)
38 self
._packet
= self
._stream
.create_packet()
40 def _create_event(self
, value
):
42 ev
.payload_field
['my_int'] = value
43 ev
.packet
= self
._packet
47 class GraphTestCase(unittest
.TestCase
):
49 self
._graph
= bt2
.Graph()
54 def test_create_default(self
):
57 def test_create_known_mip_version(self
):
60 def test_create_invalid_mip_version_type(self
):
61 with self
.assertRaises(TypeError):
64 def test_create_unknown_mip_version(self
):
65 with self
.assertRaisesRegex(ValueError, 'unknown MIP version'):
68 def test_default_interrupter(self
):
69 interrupter
= self
._graph
.default_interrupter
70 self
.assertIs(type(interrupter
), bt2
.Interrupter
)
72 def test_add_component_user_cls(self
):
73 class MySink(bt2
._UserSinkComponent
):
74 def _user_consume(self
):
77 comp
= self
._graph
.add_component(MySink
, 'salut')
78 self
.assertEqual(comp
.name
, 'salut')
80 def test_add_component_gen_cls(self
):
81 class MySink(bt2
._UserSinkComponent
):
82 def _user_consume(self
):
85 comp
= self
._graph
.add_component(MySink
, 'salut')
87 comp2
= self
._graph
.add_component(comp
.cls
, 'salut2')
88 self
.assertEqual(comp2
.name
, 'salut2')
90 def test_add_component_params(self
):
93 class MySink(bt2
._UserSinkComponent
):
94 def __init__(self
, config
, params
, obj
):
98 def _user_consume(self
):
101 params
= {'hello': 23, 'path': '/path/to/stuff'}
102 self
._graph
.add_component(MySink
, 'salut', params
)
103 self
.assertEqual(params
, comp_params
)
106 def test_add_component_obj_python_comp_cls(self
):
109 class MySink(bt2
._UserSinkComponent
):
110 def __init__(self
, config
, params
, obj
):
114 def _user_consume(self
):
118 self
._graph
.add_component(MySink
, 'salut', obj
=obj
)
119 self
.assertIs(comp_obj
, obj
)
122 def test_add_component_obj_none_python_comp_cls(self
):
125 class MySink(bt2
._UserSinkComponent
):
126 def __init__(self
, config
, params
, obj
):
130 def _user_consume(self
):
133 self
._graph
.add_component(MySink
, 'salut')
134 self
.assertIsNone(comp_obj
)
137 def test_add_component_obj_non_python_comp_cls(self
):
138 plugin
= bt2
.find_plugin('text', find_in_user_dir
=False, find_in_sys_dir
=False)
139 assert plugin
is not None
140 cc
= plugin
.source_component_classes
['dmesg']
141 assert cc
is not None
143 with self
.assertRaises(ValueError):
144 self
._graph
.add_component(cc
, 'salut', obj
=57)
146 def test_add_component_invalid_cls_type(self
):
147 with self
.assertRaises(TypeError):
148 self
._graph
.add_component(int, 'salut')
150 def test_add_component_invalid_logging_level_type(self
):
151 class MySink(bt2
._UserSinkComponent
):
152 def _user_consume(self
):
155 with self
.assertRaises(TypeError):
156 self
._graph
.add_component(MySink
, 'salut', logging_level
='yo')
158 def test_add_component_invalid_logging_level_value(self
):
159 class MySink(bt2
._UserSinkComponent
):
160 def _user_consume(self
):
163 with self
.assertRaises(ValueError):
164 self
._graph
.add_component(MySink
, 'salut', logging_level
=12345)
166 def test_add_component_invalid_params_type(self
):
167 class MySink(bt2
._UserSinkComponent
):
168 def _user_consume(self
):
171 with self
.assertRaises(TypeError):
172 self
._graph
.add_component(MySink
, 'salut', params
=12)
174 def test_add_component_params_dict(self
):
177 class MySink(bt2
._UserSinkComponent
):
178 def __init__(self
, config
, params
, obj
):
182 def _user_consume(self
):
185 params
= {'plage': 12312}
186 self
._graph
.add_component(MySink
, 'salut', params
=params
)
188 # Check equality and not identity because `add_component()` method
189 # converts the Python `dict` to a `bt2.MapValue`.
190 self
.assertEqual(params
, params_obj
)
192 def test_add_component_params_mapvalue(self
):
195 class MySink(bt2
._UserSinkComponent
):
196 def __init__(self
, config
, params
, obj
):
200 def _user_consume(self
):
203 params
= bt2
.MapValue({'beachclub': '121'})
204 self
._graph
.add_component(MySink
, 'salut', params
=params
)
206 self
.assertEqual(params
, params_obj
)
208 def test_add_component_logging_level(self
):
209 class MySink(bt2
._UserSinkComponent
):
210 def _user_consume(self
):
213 comp
= self
._graph
.add_component(
214 MySink
, 'salut', logging_level
=bt2
.LoggingLevel
.DEBUG
216 self
.assertEqual(comp
.logging_level
, bt2
.LoggingLevel
.DEBUG
)
218 def test_connect_ports(self
):
220 bt2
._UserSourceComponent
, message_iterator_class
=bt2
._UserMessageIterator
222 def __init__(self
, config
, params
, obj
):
223 self
._add
_output
_port
('out')
225 class MySink(bt2
._UserSinkComponent
):
226 def __init__(self
, config
, params
, obj
):
227 self
._add
_input
_port
('in')
229 def _user_consume(self
):
232 src
= self
._graph
.add_component(MySource
, 'src')
233 sink
= self
._graph
.add_component(MySink
, 'sink')
235 conn
= self
._graph
.connect_ports(
236 src
.output_ports
['out'], sink
.input_ports
['in']
238 self
.assertTrue(src
.output_ports
['out'].is_connected
)
239 self
.assertTrue(sink
.input_ports
['in'].is_connected
)
240 self
.assertEqual(src
.output_ports
['out'].connection
.addr
, conn
.addr
)
241 self
.assertEqual(sink
.input_ports
['in'].connection
.addr
, conn
.addr
)
243 def test_connect_ports_invalid_direction(self
):
245 bt2
._UserSourceComponent
, message_iterator_class
=bt2
._UserMessageIterator
247 def __init__(self
, config
, params
, obj
):
248 self
._add
_output
_port
('out')
250 class MySink(bt2
._UserSinkComponent
):
251 def __init__(self
, config
, params
, obj
):
252 self
._add
_input
_port
('in')
254 def _user_consume(self
):
257 src
= self
._graph
.add_component(MySource
, 'src')
258 sink
= self
._graph
.add_component(MySink
, 'sink')
260 with self
.assertRaises(TypeError):
261 self
._graph
.connect_ports(sink
.input_ports
['in'], src
.output_ports
['out'])
263 def test_add_interrupter(self
):
264 class MyIter(bt2
._UserMessageIterator
):
268 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
269 def __init__(self
, config
, params
, obj
):
270 self
._add
_output
_port
('out')
272 class MySink(bt2
._UserSinkComponent
):
273 def __init__(self
, config
, params
, obj
):
274 self
._add
_input
_port
('in')
276 def _user_consume(self
):
279 def _user_graph_is_configured(self
):
280 self
._msg
_iter
= self
._create
_input
_port
_message
_iterator
(
281 self
._input
_ports
['in']
284 # add two interrupters, set one of them
285 interrupter1
= bt2
.Interrupter()
286 interrupter2
= bt2
.Interrupter()
287 self
._graph
.add_interrupter(interrupter1
)
288 src
= self
._graph
.add_component(MySource
, 'src')
289 sink
= self
._graph
.add_component(MySink
, 'sink')
290 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
291 self
._graph
.add_interrupter(interrupter2
)
293 with self
.assertRaises(bt2
._Error
):
298 with self
.assertRaises(bt2
.TryAgain
):
303 with self
.assertRaises(bt2
._Error
):
306 # Test that Graph.run() raises bt2.Interrupted if the graph gets
307 # interrupted during execution.
308 def test_interrupt_while_running(self
):
309 class MyIter(_MyIter
):
311 return self
._create
_stream
_beginning
_message
(self
._stream
)
313 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
314 def __init__(self
, config
, params
, obj
):
315 self
._add
_output
_port
('out')
317 class MySink(bt2
._UserSinkComponent
):
318 def __init__(self
, config
, params
, obj
):
319 self
._add
_input
_port
('in')
321 def _user_consume(self
):
322 # Pretend that somebody asynchronously interrupted the graph.
324 graph
.default_interrupter
.set()
325 return next(self
._msg
_iter
)
327 def _user_graph_is_configured(self
):
328 self
._msg
_iter
= self
._create
_input
_port
_message
_iterator
(
329 self
._input
_ports
['in']
333 up
= self
._graph
.add_component(MySource
, 'down')
334 down
= self
._graph
.add_component(MySink
, 'up')
335 self
._graph
.connect_ports(up
.output_ports
['out'], down
.input_ports
['in'])
337 with self
.assertRaises(bt2
.TryAgain
):
341 class MyIter(_MyIter
):
347 msg
= self
._create
_stream
_beginning
_message
(self
._stream
)
349 msg
= self
._create
_packet
_beginning
_message
(self
._packet
)
351 msg
= self
._create
_packet
_end
_message
(self
._packet
)
353 msg
= self
._create
_stream
_end
_message
(self
._stream
)
355 msg
= self
._create
_event
_message
(self
._ec
, self
._packet
)
360 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
361 def __init__(self
, config
, params
, obj
):
362 self
._add
_output
_port
('out')
364 class MySink(bt2
._UserSinkComponent
):
365 def __init__(self
, config
, params
, obj
):
366 self
._input
_port
= self
._add
_input
_port
('in')
369 def _user_consume(comp_self
):
370 msg
= next(comp_self
._msg
_iter
)
372 if comp_self
._at
== 0:
373 self
.assertIs(type(msg
), bt2
._StreamBeginningMessageConst
)
374 elif comp_self
._at
== 1:
375 self
.assertIs(type(msg
), bt2
._PacketBeginningMessageConst
)
376 elif comp_self
._at
>= 2 and comp_self
._at
<= 6:
377 self
.assertIs(type(msg
), bt2
._EventMessageConst
)
378 self
.assertEqual(msg
.event
.cls
.name
, 'salut')
379 elif comp_self
._at
== 7:
380 self
.assertIs(type(msg
), bt2
._PacketEndMessageConst
)
381 elif comp_self
._at
== 8:
382 self
.assertIs(type(msg
), bt2
._StreamEndMessageConst
)
386 def _user_graph_is_configured(self
):
387 self
._msg
_iter
= self
._create
_input
_port
_message
_iterator
(
391 src
= self
._graph
.add_component(MySource
, 'src')
392 sink
= self
._graph
.add_component(MySink
, 'sink')
393 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
396 def test_run_once(self
):
397 class MyIter(_MyIter
):
400 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
401 def __init__(self
, config
, params
, obj
):
402 self
._add
_output
_port
('out')
404 class MySink(bt2
._UserSinkComponent
):
405 def __init__(self
, config
, params
, obj
):
406 self
._input
_port
= self
._add
_input
_port
('in')
408 def _user_consume(comp_self
):
414 src
= self
._graph
.add_component(MySource
, 'src')
415 sink
= self
._graph
.add_component(MySink
, 'sink')
416 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
418 with self
.assertRaises(bt2
.TryAgain
):
419 self
._graph
.run_once()
421 self
.assertEqual(run_count
, 1)
423 def test_run_once_stops(self
):
424 class MyIter(_MyIter
):
427 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
428 def __init__(self
, config
, params
, obj
):
429 self
._add
_output
_port
('out')
431 class MySink(bt2
._UserSinkComponent
):
432 def __init__(self
, config
, params
, obj
):
433 self
._input
_port
= self
._add
_input
_port
('in')
435 def _user_consume(comp_self
):
438 src
= self
._graph
.add_component(MySource
, 'src')
439 sink
= self
._graph
.add_component(MySink
, 'sink')
440 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
442 with self
.assertRaises(bt2
.Stop
):
443 self
._graph
.run_once()
445 def test_run_again(self
):
446 class MyIter(_MyIter
):
452 msg
= self
._create
_stream
_beginning
_message
(self
._stream
)
454 msg
= self
._create
_packet
_beginning
_message
(self
._packet
)
456 msg
= self
._create
_event
_message
(self
._ec
, self
._packet
)
461 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
462 def __init__(self
, config
, params
, obj
):
463 self
._add
_output
_port
('out')
465 class MySink(bt2
._UserSinkComponent
):
466 def __init__(self
, config
, params
, obj
):
467 self
._input
_port
= self
._add
_input
_port
('in')
470 def _user_consume(comp_self
):
471 msg
= next(comp_self
._msg
_iter
)
472 if comp_self
._at
== 0:
473 self
.assertIs(type(msg
), bt2
._StreamBeginningMessageConst
)
474 elif comp_self
._at
== 1:
475 self
.assertIs(type(msg
), bt2
._PacketBeginningMessageConst
)
476 elif comp_self
._at
== 2:
477 self
.assertIs(type(msg
), bt2
._EventMessageConst
)
484 def _user_graph_is_configured(self
):
485 self
._msg
_iter
= self
._create
_input
_port
_message
_iterator
(
489 src
= self
._graph
.add_component(MySource
, 'src')
490 sink
= self
._graph
.add_component(MySink
, 'sink')
491 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
493 with self
.assertRaises(bt2
.TryAgain
):
496 def test_run_error(self
):
497 raised_in_sink
= False
499 class MyIter(_MyIter
):
501 # If this gets called after the sink raised an exception, it is
503 nonlocal raised_in_sink
504 assert raised_in_sink
is False
507 msg
= self
._create
_stream
_beginning
_message
(self
._stream
)
509 msg
= self
._create
_packet
_beginning
_message
(self
._packet
)
510 elif self
._at
== 2 or self
._at
== 3:
511 msg
= self
._create
_event
_message
(self
._ec
, self
._packet
)
517 class MySource(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
518 def __init__(self
, config
, params
, obj
):
519 self
._add
_output
_port
('out')
521 class MySink(bt2
._UserSinkComponent
):
522 def __init__(self
, config
, params
, obj
):
523 self
._input
_port
= self
._add
_input
_port
('in')
526 def _user_consume(comp_self
):
527 msg
= next(comp_self
._msg
_iter
)
528 if comp_self
._at
== 0:
529 self
.assertIs(type(msg
), bt2
._StreamBeginningMessageConst
)
530 elif comp_self
._at
== 1:
531 self
.assertIs(type(msg
), bt2
._PacketBeginningMessageConst
)
532 elif comp_self
._at
== 2:
533 self
.assertIs(type(msg
), bt2
._EventMessageConst
)
534 elif comp_self
._at
== 3:
535 nonlocal raised_in_sink
536 raised_in_sink
= True
537 raise RuntimeError('error!')
541 def _user_graph_is_configured(self
):
542 self
._msg
_iter
= self
._create
_input
_port
_message
_iterator
(
546 src
= self
._graph
.add_component(MySource
, 'src')
547 sink
= self
._graph
.add_component(MySink
, 'sink')
548 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
550 with self
.assertRaises(bt2
._Error
):
553 def test_listeners(self
):
555 bt2
._UserSourceComponent
, message_iterator_class
=bt2
._UserMessageIterator
557 def __init__(self
, config
, params
, obj
):
558 self
._add
_output
_port
('out')
559 self
._add
_output
_port
('zero')
561 class MySink(bt2
._UserSinkComponent
):
562 def __init__(self
, config
, params
, obj
):
563 self
._add
_input
_port
('in')
565 def _user_consume(self
):
568 def _user_port_connected(self
, port
, other_port
):
569 self
._add
_input
_port
('taste')
571 def port_added_listener(component
, port
):
573 calls
.append((port_added_listener
, component
, port
))
576 self
._graph
.add_port_added_listener(port_added_listener
)
577 src
= self
._graph
.add_component(MySource
, 'src')
578 sink
= self
._graph
.add_component(MySink
, 'sink')
579 self
._graph
.connect_ports(src
.output_ports
['out'], sink
.input_ports
['in'])
581 self
.assertEqual(len(calls
), 4)
583 self
.assertIs(calls
[0][0], port_added_listener
)
584 self
.assertEqual(calls
[0][1].name
, 'src')
585 self
.assertEqual(calls
[0][2].name
, 'out')
587 self
.assertIs(calls
[1][0], port_added_listener
)
588 self
.assertEqual(calls
[1][1].name
, 'src')
589 self
.assertEqual(calls
[1][2].name
, 'zero')
591 self
.assertIs(calls
[2][0], port_added_listener
)
592 self
.assertEqual(calls
[2][1].name
, 'sink')
593 self
.assertEqual(calls
[2][2].name
, 'in')
595 self
.assertIs(calls
[3][0], port_added_listener
)
596 self
.assertEqual(calls
[3][1].name
, 'sink')
597 self
.assertEqual(calls
[3][2].name
, 'taste')
599 def test_invalid_listeners(self
):
601 bt2
._UserSourceComponent
, message_iterator_class
=bt2
._UserMessageIterator
603 def __init__(self
, config
, params
, obj
):
604 self
._add
_output
_port
('out')
605 self
._add
_output
_port
('zero')
607 class MySink(bt2
._UserSinkComponent
):
608 def __init__(self
, config
, params
, obj
):
609 self
._add
_input
_port
('in')
611 def _user_consume(self
):
614 def _user_port_connected(self
, port
, other_port
):
615 self
._add
_input
_port
('taste')
617 with self
.assertRaises(TypeError):
618 self
._graph
.add_port_added_listener(1234)
620 def test_raise_in_component_init(self
):
621 class MySink(bt2
._UserSinkComponent
):
622 def __init__(self
, config
, params
, obj
):
623 raise ValueError('oops!')
625 def _user_consume(self
):
630 with self
.assertRaises(bt2
._Error
):
631 graph
.add_component(MySink
, 'comp')
633 def test_raise_in_port_added_listener(self
):
634 class MySink(bt2
._UserSinkComponent
):
635 def __init__(self
, config
, params
, obj
):
636 self
._add
_input
_port
('in')
638 def _user_consume(self
):
641 def port_added_listener(component
, port
):
642 raise ValueError('oh noes!')
645 graph
.add_port_added_listener(port_added_listener
)
647 with self
.assertRaises(bt2
._Error
):
648 graph
.add_component(MySink
, 'comp')
651 if __name__
== '__main__':