Commit | Line | Data |
---|---|---|
d2d857a8 MJ |
1 | # |
2 | # Copyright (C) 2019 EfficiOS Inc. | |
3 | # | |
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 | |
7 | # of the License. | |
8 | # | |
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. | |
13 | # | |
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. | |
17 | # | |
18 | ||
811644b8 PP |
19 | import collections |
20 | import unittest | |
811644b8 | 21 | import bt2 |
6c373cc9 | 22 | from utils import TestOutputPortMessageIterator |
811644b8 PP |
23 | |
24 | ||
9ec609ec | 25 | class AllMessagesTestCase(unittest.TestCase): |
811644b8 | 26 | def setUp(self): |
5602ef81 | 27 | class MyIter(bt2._UserMessageIterator): |
c5f330cd | 28 | def __init__(self, self_port_output): |
9ec609ec | 29 | self._at = 0 |
cfbd7cf3 FD |
30 | self._with_stream_msgs_clock_snapshots = self_port_output.user_data.get( |
31 | 'with_stream_msgs_clock_snapshots', False | |
32 | ) | |
811644b8 PP |
33 | |
34 | def __next__(self): | |
9ec609ec SM |
35 | if test_obj._clock_class: |
36 | if self._at == 0: | |
188edac1 | 37 | if self._with_stream_msgs_clock_snapshots: |
cfbd7cf3 FD |
38 | msg = self._create_stream_beginning_message( |
39 | test_obj._stream, default_clock_snapshot=self._at | |
40 | ) | |
188edac1 | 41 | else: |
cfbd7cf3 FD |
42 | msg = self._create_stream_beginning_message( |
43 | test_obj._stream | |
44 | ) | |
9ec609ec | 45 | elif self._at == 1: |
cfbd7cf3 FD |
46 | msg = self._create_packet_beginning_message( |
47 | test_obj._packet, self._at | |
48 | ) | |
188edac1 | 49 | elif self._at == 2: |
cfbd7cf3 FD |
50 | msg = self._create_event_message( |
51 | test_obj._event_class, test_obj._packet, self._at | |
52 | ) | |
188edac1 | 53 | elif self._at == 3: |
cfbd7cf3 FD |
54 | msg = self._create_message_iterator_inactivity_message( |
55 | test_obj._clock_class, self._at | |
56 | ) | |
188edac1 | 57 | elif self._at == 4: |
cfbd7cf3 FD |
58 | msg = self._create_discarded_events_message( |
59 | test_obj._stream, 890, self._at, self._at | |
60 | ) | |
188edac1 | 61 | elif self._at == 5: |
cfbd7cf3 FD |
62 | msg = self._create_packet_end_message( |
63 | test_obj._packet, self._at | |
64 | ) | |
188edac1 | 65 | elif self._at == 6: |
cfbd7cf3 FD |
66 | msg = self._create_discarded_packets_message( |
67 | test_obj._stream, 678, self._at, self._at | |
68 | ) | |
188edac1 SM |
69 | elif self._at == 7: |
70 | if self._with_stream_msgs_clock_snapshots: | |
cfbd7cf3 FD |
71 | msg = self._create_stream_end_message( |
72 | test_obj._stream, default_clock_snapshot=self._at | |
73 | ) | |
188edac1 SM |
74 | else: |
75 | msg = self._create_stream_end_message(test_obj._stream) | |
76 | elif self._at >= 8: | |
9ec609ec | 77 | raise bt2.Stop |
811644b8 | 78 | else: |
9ec609ec SM |
79 | if self._at == 0: |
80 | msg = self._create_stream_beginning_message(test_obj._stream) | |
81 | elif self._at == 1: | |
9ec609ec | 82 | msg = self._create_packet_beginning_message(test_obj._packet) |
188edac1 | 83 | elif self._at == 2: |
cfbd7cf3 FD |
84 | msg = self._create_event_message( |
85 | test_obj._event_class, test_obj._packet | |
86 | ) | |
188edac1 | 87 | elif self._at == 3: |
cfbd7cf3 FD |
88 | msg = self._create_discarded_events_message( |
89 | test_obj._stream, 890 | |
90 | ) | |
188edac1 | 91 | elif self._at == 4: |
9ec609ec | 92 | msg = self._create_packet_end_message(test_obj._packet) |
188edac1 | 93 | elif self._at == 5: |
cfbd7cf3 FD |
94 | msg = self._create_discarded_packets_message( |
95 | test_obj._stream, 678 | |
96 | ) | |
188edac1 | 97 | elif self._at == 6: |
9ec609ec | 98 | msg = self._create_stream_end_message(test_obj._stream) |
188edac1 | 99 | elif self._at >= 7: |
9ec609ec | 100 | raise bt2.Stop |
811644b8 PP |
101 | |
102 | self._at += 1 | |
5602ef81 | 103 | return msg |
811644b8 | 104 | |
9ec609ec | 105 | class MySrc(bt2._UserSourceComponent, message_iterator_class=MyIter): |
66964f3f | 106 | def __init__(self, params, obj): |
188edac1 | 107 | self._add_output_port('out', params) |
811644b8 | 108 | |
2e90378a | 109 | with_cc = bool(params['with_cc']) |
9ec609ec SM |
110 | tc = self._create_trace_class() |
111 | if with_cc: | |
112 | cc = self._create_clock_class() | |
811644b8 | 113 | else: |
9ec609ec | 114 | cc = None |
9ec609ec | 115 | |
cfbd7cf3 FD |
116 | sc = tc.create_stream_class( |
117 | default_clock_class=cc, | |
118 | supports_packets=True, | |
119 | packets_have_beginning_default_clock_snapshot=with_cc, | |
120 | packets_have_end_default_clock_snapshot=with_cc, | |
121 | supports_discarded_events=True, | |
122 | discarded_events_have_default_clock_snapshots=with_cc, | |
123 | supports_discarded_packets=True, | |
124 | discarded_packets_have_default_clock_snapshots=with_cc, | |
125 | ) | |
9ec609ec SM |
126 | |
127 | # Create payload field class | |
128 | my_int_fc = tc.create_signed_integer_field_class(32) | |
129 | payload_fc = tc.create_structure_field_class() | |
cfbd7cf3 | 130 | payload_fc += [('my_int', my_int_fc)] |
9ec609ec SM |
131 | |
132 | ec = sc.create_event_class(name='salut', payload_field_class=payload_fc) | |
133 | ||
134 | trace = tc() | |
135 | stream = trace.create_stream(sc) | |
136 | packet = stream.create_packet() | |
137 | ||
138 | test_obj._trace = trace | |
139 | test_obj._stream = stream | |
140 | test_obj._packet = packet | |
141 | test_obj._event_class = ec | |
142 | test_obj._clock_class = cc | |
143 | ||
144 | test_obj = self | |
145 | self._graph = bt2.Graph() | |
146 | self._src = MySrc | |
147 | self._iter = MyIter | |
148 | ||
149 | def test_all_msg_with_cc(self): | |
150 | params = {'with_cc': True} | |
151 | self._src_comp = self._graph.add_component(self._src, 'my_source', params) | |
6c373cc9 PP |
152 | self._msg_iter = TestOutputPortMessageIterator( |
153 | self._graph, self._src_comp.output_ports['out'] | |
cfbd7cf3 | 154 | ) |
9ec609ec SM |
155 | |
156 | for i, msg in enumerate(self._msg_iter): | |
157 | if i == 0: | |
3fb99a22 | 158 | self.assertIsInstance(msg, bt2._StreamBeginningMessage) |
9ec609ec | 159 | self.assertEqual(msg.stream.addr, self._stream.addr) |
cfbd7cf3 | 160 | self.assertIsInstance( |
3fb99a22 | 161 | msg.default_clock_snapshot, bt2._UnknownClockSnapshot |
cfbd7cf3 | 162 | ) |
9ec609ec | 163 | elif i == 1: |
3fb99a22 | 164 | self.assertIsInstance(msg, bt2._PacketBeginningMessage) |
9ec609ec SM |
165 | self.assertEqual(msg.packet.addr, self._packet.addr) |
166 | self.assertEqual(msg.default_clock_snapshot.value, i) | |
188edac1 | 167 | elif i == 2: |
3fb99a22 | 168 | self.assertIsInstance(msg, bt2._EventMessage) |
e8ac1aae | 169 | self.assertEqual(msg.event.cls.addr, self._event_class.addr) |
9ec609ec | 170 | self.assertEqual(msg.default_clock_snapshot.value, i) |
188edac1 | 171 | elif i == 3: |
3fb99a22 | 172 | self.assertIsInstance(msg, bt2._MessageIteratorInactivityMessage) |
9ec609ec | 173 | self.assertEqual(msg.default_clock_snapshot.value, i) |
188edac1 | 174 | elif i == 4: |
3fb99a22 | 175 | self.assertIsInstance(msg, bt2._DiscardedEventsMessage) |
9ec609ec SM |
176 | self.assertEqual(msg.stream.addr, self._stream.addr) |
177 | self.assertEqual(msg.count, 890) | |
cfbd7cf3 FD |
178 | self.assertEqual( |
179 | msg.stream.cls.default_clock_class.addr, self._clock_class.addr | |
180 | ) | |
9ec609ec SM |
181 | self.assertEqual(msg.beginning_default_clock_snapshot.value, i) |
182 | self.assertEqual(msg.end_default_clock_snapshot.value, i) | |
188edac1 | 183 | elif i == 5: |
3fb99a22 | 184 | self.assertIsInstance(msg, bt2._PacketEndMessage) |
9ec609ec SM |
185 | self.assertEqual(msg.packet.addr, self._packet.addr) |
186 | self.assertEqual(msg.default_clock_snapshot.value, i) | |
188edac1 | 187 | elif i == 6: |
3fb99a22 | 188 | self.assertIsInstance(msg, bt2._DiscardedPacketsMessage) |
9ec609ec SM |
189 | self.assertEqual(msg.stream.addr, self._stream.addr) |
190 | self.assertEqual(msg.count, 678) | |
cfbd7cf3 FD |
191 | self.assertEqual( |
192 | msg.stream.cls.default_clock_class.addr, self._clock_class.addr | |
193 | ) | |
9ec609ec SM |
194 | self.assertEqual(msg.beginning_default_clock_snapshot.value, i) |
195 | self.assertEqual(msg.end_default_clock_snapshot.value, i) | |
188edac1 | 196 | elif i == 7: |
3fb99a22 | 197 | self.assertIsInstance(msg, bt2._StreamEndMessage) |
9ec609ec | 198 | self.assertEqual(msg.stream.addr, self._stream.addr) |
cfbd7cf3 | 199 | self.assertIsInstance( |
3fb99a22 | 200 | msg.default_clock_snapshot, bt2._UnknownClockSnapshot |
cfbd7cf3 | 201 | ) |
9ec609ec SM |
202 | else: |
203 | raise Exception | |
204 | ||
205 | def test_all_msg_without_cc(self): | |
206 | params = {'with_cc': False} | |
207 | self._src_comp = self._graph.add_component(self._src, 'my_source', params) | |
6c373cc9 PP |
208 | self._msg_iter = TestOutputPortMessageIterator( |
209 | self._graph, self._src_comp.output_ports['out'] | |
cfbd7cf3 | 210 | ) |
9ec609ec SM |
211 | |
212 | for i, msg in enumerate(self._msg_iter): | |
213 | if i == 0: | |
3fb99a22 | 214 | self.assertIsInstance(msg, bt2._StreamBeginningMessage) |
9ec609ec | 215 | self.assertEqual(msg.stream.addr, self._stream.addr) |
1153eccb SM |
216 | with self.assertRaisesRegex( |
217 | ValueError, 'stream class has no default clock class' | |
218 | ): | |
188edac1 | 219 | msg.default_clock_snapshot |
9ec609ec | 220 | elif i == 1: |
3fb99a22 | 221 | self.assertIsInstance(msg, bt2._PacketBeginningMessage) |
9ec609ec | 222 | self.assertEqual(msg.packet.addr, self._packet.addr) |
188edac1 | 223 | elif i == 2: |
3fb99a22 | 224 | self.assertIsInstance(msg, bt2._EventMessage) |
e8ac1aae | 225 | self.assertEqual(msg.event.cls.addr, self._event_class.addr) |
1153eccb SM |
226 | with self.assertRaisesRegex( |
227 | ValueError, 'stream class has no default clock class' | |
228 | ): | |
9ec609ec | 229 | msg.default_clock_snapshot |
188edac1 | 230 | elif i == 3: |
3fb99a22 | 231 | self.assertIsInstance(msg, bt2._DiscardedEventsMessage) |
9ec609ec SM |
232 | self.assertEqual(msg.stream.addr, self._stream.addr) |
233 | self.assertEqual(msg.count, 890) | |
e8ac1aae | 234 | self.assertIsNone(msg.stream.cls.default_clock_class) |
1153eccb SM |
235 | with self.assertRaisesRegex( |
236 | ValueError, | |
237 | 'such a message has no clock snapshots for this stream class', | |
238 | ): | |
9ec609ec | 239 | msg.beginning_default_clock_snapshot |
1153eccb SM |
240 | with self.assertRaisesRegex( |
241 | ValueError, | |
242 | 'such a message has no clock snapshots for this stream class', | |
243 | ): | |
9ec609ec | 244 | msg.end_default_clock_snapshot |
188edac1 | 245 | elif i == 4: |
3fb99a22 | 246 | self.assertIsInstance(msg, bt2._PacketEndMessage) |
9ec609ec | 247 | self.assertEqual(msg.packet.addr, self._packet.addr) |
188edac1 | 248 | elif i == 5: |
3fb99a22 | 249 | self.assertIsInstance(msg, bt2._DiscardedPacketsMessage) |
9ec609ec SM |
250 | self.assertEqual(msg.stream.addr, self._stream.addr) |
251 | self.assertEqual(msg.count, 678) | |
e8ac1aae | 252 | self.assertIsNone(msg.stream.cls.default_clock_class) |
1153eccb SM |
253 | with self.assertRaisesRegex( |
254 | ValueError, | |
255 | 'such a message has no clock snapshots for this stream class', | |
256 | ): | |
9ec609ec | 257 | msg.beginning_default_clock_snapshot |
1153eccb SM |
258 | with self.assertRaisesRegex( |
259 | ValueError, | |
260 | 'such a message has no clock snapshots for this stream class', | |
261 | ): | |
9ec609ec | 262 | msg.end_default_clock_snapshot |
188edac1 | 263 | elif i == 6: |
3fb99a22 | 264 | self.assertIsInstance(msg, bt2._StreamEndMessage) |
9ec609ec | 265 | self.assertEqual(msg.stream.addr, self._stream.addr) |
1153eccb SM |
266 | with self.assertRaisesRegex( |
267 | ValueError, 'stream class has no default clock class' | |
268 | ): | |
188edac1 | 269 | msg.default_clock_snapshot |
9ec609ec SM |
270 | else: |
271 | raise Exception | |
811644b8 | 272 | |
188edac1 | 273 | def test_msg_stream_with_clock_snapshots(self): |
cfbd7cf3 | 274 | params = {'with_cc': True, 'with_stream_msgs_clock_snapshots': True} |
c6af194f | 275 | |
188edac1 | 276 | self._src_comp = self._graph.add_component(self._src, 'my_source', params) |
6c373cc9 PP |
277 | self._msg_iter = TestOutputPortMessageIterator( |
278 | self._graph, self._src_comp.output_ports['out'] | |
cfbd7cf3 | 279 | ) |
188edac1 | 280 | msgs = list(self._msg_iter) |
c6af194f | 281 | |
188edac1 | 282 | msg_stream_beg = msgs[0] |
3fb99a22 | 283 | self.assertIsInstance(msg_stream_beg, bt2._StreamBeginningMessage) |
188edac1 | 284 | self.assertEqual(msg_stream_beg.default_clock_snapshot.value, 0) |
c6af194f | 285 | |
188edac1 | 286 | msg_stream_end = msgs[7] |
3fb99a22 | 287 | self.assertIsInstance(msg_stream_end, bt2._StreamEndMessage) |
188edac1 | 288 | self.assertEqual(msg_stream_end.default_clock_snapshot.value, 7) |