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.
22 from utils
import TestOutputPortMessageIterator
24 from bt2
import field
as bt2_field
25 from bt2
import stream
as bt2_stream
26 from bt2
import event_class
as bt2_event_class
27 from bt2
import clock_snapshot
as bt2_clock_snapshot
30 class EventTestCase(unittest
.TestCase
):
31 def _create_test_const_event_message(
33 packet_fields_config
=None,
34 event_fields_config
=None,
35 with_clockclass
=False,
41 class MyIter(bt2
._UserMessageIterator
):
42 def __init__(self
, self_output_port
):
44 self
._msgs
= [self
._create
_stream
_beginning
_message
(test_obj
.stream
)]
47 assert test_obj
.packet
49 self
._create
_packet
_beginning
_message
(test_obj
.packet
)
52 default_clock_snapshot
= 789 if with_clockclass
else None
55 assert test_obj
.packet
56 ev_parent
= test_obj
.packet
58 assert test_obj
.stream
59 ev_parent
= test_obj
.stream
61 msg
= self
._create
_event
_message
(
62 test_obj
.event_class
, ev_parent
, default_clock_snapshot
65 if event_fields_config
is not None:
66 event_fields_config(msg
.event
)
68 self
._msgs
.append(msg
)
71 self
._msgs
.append(self
._create
_packet
_end
_message
(test_obj
.packet
))
73 self
._msgs
.append(self
._create
_stream
_end
_message
(test_obj
.stream
))
76 if self
._at
== len(self
._msgs
):
79 msg
= self
._msgs
[self
._at
]
83 class MySrc(bt2
._UserSourceComponent
, message_iterator_class
=MyIter
):
84 def __init__(self
, config
, params
, obj
):
85 self
._add
_output
_port
('out')
86 tc
= self
._create
_trace
_class
()
90 clock_class
= self
._create
_clock
_class
(frequency
=1000)
92 # event common context (stream-class-defined)
95 cc
= tc
.create_structure_field_class()
97 ('cpu_id', tc
.create_signed_integer_field_class(8)),
98 ('stuff', tc
.create_real_field_class()),
101 # packet context (stream-class-defined)
105 pc
= tc
.create_structure_field_class()
107 ('something', tc
.create_unsigned_integer_field_class(8)),
108 ('something_else', tc
.create_real_field_class()),
111 stream_class
= tc
.create_stream_class(
112 default_clock_class
=clock_class
,
113 event_common_context_field_class
=cc
,
114 packet_context_field_class
=pc
,
115 supports_packets
=with_packet
,
118 # specific context (event-class-defined)
121 sc
= tc
.create_structure_field_class()
123 ('ant', tc
.create_signed_integer_field_class(16)),
124 ('msg', tc
.create_string_field_class()),
130 ep
= tc
.create_structure_field_class()
132 ('giraffe', tc
.create_signed_integer_field_class(32)),
133 ('gnu', tc
.create_signed_integer_field_class(8)),
134 ('mosquito', tc
.create_signed_integer_field_class(8)),
137 event_class
= stream_class
.create_event_class(
139 specific_context_field_class
=sc
,
140 payload_field_class
=ep
,
144 stream
= trace
.create_stream(stream_class
)
147 packet
= stream
.create_packet()
149 if packet_fields_config
is not None:
151 packet_fields_config(packet
)
154 test_obj
.packet
= packet
156 test_obj
.stream
= stream
157 test_obj
.event_class
= event_class
160 self
._graph
= bt2
.Graph()
161 self
._src
_comp
= self
._graph
.add_component(MySrc
, 'my_source')
162 self
._msg
_iter
= TestOutputPortMessageIterator(
163 self
._graph
, self
._src
_comp
.output_ports
['out']
166 for msg
in self
._msg
_iter
:
167 if type(msg
) is bt2
._EventMessageConst
:
168 self
._event
_msg
= msg
171 def test_const_attr_event_class(self
):
172 msg
= self
._create
_test
_const
_event
_message
()
173 self
.assertEqual(msg
.event
.cls
.addr
, self
.event_class
.addr
)
174 self
.assertIs(type(msg
.event
.cls
), bt2_event_class
._EventClassConst
)
176 def test_attr_event_class(self
):
177 msg
= utils
.get_event_message()
178 self
.assertIs(type(msg
.event
.cls
), bt2_event_class
._EventClass
)
180 def test_const_attr_name(self
):
181 msg
= self
._create
_test
_const
_event
_message
()
182 self
.assertEqual(msg
.event
.name
, self
.event_class
.name
)
184 def test_const_attr_id(self
):
185 msg
= self
._create
_test
_const
_event
_message
()
186 self
.assertEqual(msg
.event
.id, self
.event_class
.id)
188 def test_const_get_common_context_field(self
):
189 def event_fields_config(event
):
190 event
.common_context_field
['cpu_id'] = 1
191 event
.common_context_field
['stuff'] = 13.194
193 msg
= self
._create
_test
_const
_event
_message
(
194 event_fields_config
=event_fields_config
, with_cc
=True
197 self
.assertEqual(msg
.event
.common_context_field
['cpu_id'], 1)
198 self
.assertEqual(msg
.event
.common_context_field
['stuff'], 13.194)
200 type(msg
.event
.common_context_field
), bt2_field
._StructureFieldConst
203 def test_attr_common_context_field(self
):
204 msg
= utils
.get_event_message()
205 self
.assertIs(type(msg
.event
.common_context_field
), bt2_field
._StructureField
)
207 def test_const_no_common_context_field(self
):
208 msg
= self
._create
_test
_const
_event
_message
(with_cc
=False)
209 self
.assertIsNone(msg
.event
.common_context_field
)
211 def test_const_get_specific_context_field(self
):
212 def event_fields_config(event
):
213 event
.specific_context_field
['ant'] = -1
214 event
.specific_context_field
['msg'] = 'hellooo'
216 msg
= self
._create
_test
_const
_event
_message
(
217 event_fields_config
=event_fields_config
, with_sc
=True
220 self
.assertEqual(msg
.event
.specific_context_field
['ant'], -1)
221 self
.assertEqual(msg
.event
.specific_context_field
['msg'], 'hellooo')
223 type(msg
.event
.specific_context_field
), bt2_field
._StructureFieldConst
226 def test_attr_specific_context_field(self
):
227 msg
= utils
.get_event_message()
228 self
.assertIs(type(msg
.event
.specific_context_field
), bt2_field
._StructureField
)
230 def test_const_no_specific_context_field(self
):
231 msg
= self
._create
_test
_const
_event
_message
(with_sc
=False)
232 self
.assertIsNone(msg
.event
.specific_context_field
)
234 def test_const_get_event_payload_field(self
):
235 def event_fields_config(event
):
236 event
.payload_field
['giraffe'] = 1
237 event
.payload_field
['gnu'] = 23
238 event
.payload_field
['mosquito'] = 42
240 msg
= self
._create
_test
_const
_event
_message
(
241 event_fields_config
=event_fields_config
, with_ep
=True
244 self
.assertEqual(msg
.event
.payload_field
['giraffe'], 1)
245 self
.assertEqual(msg
.event
.payload_field
['gnu'], 23)
246 self
.assertEqual(msg
.event
.payload_field
['mosquito'], 42)
247 self
.assertIs(type(msg
.event
.payload_field
), bt2_field
._StructureFieldConst
)
249 def test_attr_payload_field(self
):
250 msg
= utils
.get_event_message()
251 self
.assertIs(type(msg
.event
.payload_field
), bt2_field
._StructureField
)
253 def test_const_no_payload_field(self
):
254 msg
= self
._create
_test
_const
_event
_message
(with_ep
=False)
255 self
.assertIsNone(msg
.event
.payload_field
)
257 def test_const_clock_value(self
):
258 msg
= self
._create
_test
_const
_event
_message
(with_clockclass
=True)
259 self
.assertEqual(msg
.default_clock_snapshot
.value
, 789)
261 type(msg
.default_clock_snapshot
), bt2_clock_snapshot
._ClockSnapshotConst
264 def test_clock_value(self
):
265 msg
= utils
.get_event_message()
266 self
.assertEqual(msg
.default_clock_snapshot
.value
, 789)
268 type(msg
.default_clock_snapshot
), bt2_clock_snapshot
._ClockSnapshotConst
271 def test_const_no_clock_value(self
):
272 msg
= self
._create
_test
_const
_event
_message
(with_clockclass
=False)
273 with self
.assertRaisesRegex(
274 ValueError, 'stream class has no default clock class'
276 msg
.default_clock_snapshot
278 def test_const_stream(self
):
279 msg
= self
._create
_test
_const
_event
_message
()
280 self
.assertEqual(msg
.event
.stream
.addr
, self
.stream
.addr
)
281 self
.assertIs(type(msg
.event
.stream
), bt2_stream
._StreamConst
)
283 def test_stream(self
):
284 msg
= utils
.get_event_message()
285 self
.assertIs(type(msg
.event
.stream
), bt2_stream
._Stream
)
287 def test_const_getitem(self
):
288 def event_fields_config(event
):
289 event
.payload_field
['giraffe'] = 1
290 event
.payload_field
['gnu'] = 23
291 event
.payload_field
['mosquito'] = 42
292 event
.specific_context_field
['ant'] = -1
293 event
.specific_context_field
['msg'] = 'hellooo'
294 event
.common_context_field
['cpu_id'] = 1
295 event
.common_context_field
['stuff'] = 13.194
297 def packet_fields_config(packet
):
298 packet
.context_field
['something'] = 154
299 packet
.context_field
['something_else'] = 17.2
301 msg
= self
._create
_test
_const
_event
_message
(
302 packet_fields_config
=packet_fields_config
,
303 event_fields_config
=event_fields_config
,
312 self
.assertEqual(ev
['giraffe'], 1)
313 self
.assertIs(type(ev
['giraffe']), bt2_field
._SignedIntegerFieldConst
)
314 self
.assertEqual(ev
['gnu'], 23)
315 self
.assertEqual(ev
['mosquito'], 42)
316 self
.assertEqual(ev
['ant'], -1)
317 self
.assertIs(type(ev
['ant']), bt2_field
._SignedIntegerFieldConst
)
318 self
.assertEqual(ev
['msg'], 'hellooo')
319 self
.assertEqual(ev
['cpu_id'], 1)
320 self
.assertIs(type(ev
['cpu_id']), bt2_field
._SignedIntegerFieldConst
)
321 self
.assertEqual(ev
['stuff'], 13.194)
324 self
.assertEqual(ev
['something'], 154)
325 self
.assertIs(type(ev
['something']), bt2_field
._UnsignedIntegerFieldConst
)
326 self
.assertEqual(ev
['something_else'], 17.2)
328 with self
.assertRaises(KeyError):
331 def test_getitem(self
):
332 msg
= utils
.get_event_message()
334 self
.assertEqual(ev
['giraffe'], 1)
335 self
.assertIs(type(ev
['giraffe']), bt2_field
._SignedIntegerField
)
336 self
.assertEqual(ev
['ant'], -1)
337 self
.assertIs(type(ev
['ant']), bt2_field
._SignedIntegerField
)
338 self
.assertEqual(ev
['cpu_id'], 1)
339 self
.assertIs(type(ev
['cpu_id']), bt2_field
._SignedIntegerField
)
340 self
.assertEqual(ev
['something'], 154)
341 self
.assertIs(type(ev
['something']), bt2_field
._UnsignedIntegerField
)
344 if __name__
== "__main__":