tests/bindings/python/bt2/test_component_class.py

   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
  19 from bt2 import value
  20 import unittest
  21 import bt2
  22
  23
  24 class UserComponentClassTestCase(unittest.TestCase):
  25     def _test_no_init(self, cls):
  26         with self.assertRaises(bt2.Error):
  27             cls()
  28
  29     def test_no_init_source(self):
  30         class MyIter(bt2._UserMessageIterator):
  31             def __next__(self):
  32                 raise bt2.Stop
  33
  34         class MySource(bt2._UserSourceComponent,
  35                        message_iterator_class=MyIter):
  36             pass
  37
  38         self._test_no_init(MySource)
  39
  40     def test_no_init_filter(self):
  41         class MyIter(bt2._UserMessageIterator):
  42             def __next__(self):
  43                 raise bt2.Stop
  44
  45         class MyFilter(bt2._UserFilterComponent,
  46                        message_iterator_class=MyIter):
  47             pass
  48
  49         self._test_no_init(MyFilter)
  50
  51     def test_no_init_sink(self):
  52         class MySink(bt2._UserSinkComponent):
  53             def _consume(self):
  54                 pass
  55
  56         self._test_no_init(MySink)
  57
  58     def test_incomplete_source_no_msg_iter_cls(self):
  59         class MyIter(bt2._UserMessageIterator):
  60             pass
  61
  62         with self.assertRaises(bt2.IncompleteUserClass):
  63             class MySource(bt2._UserSourceComponent):
  64                 pass
  65
  66     def test_incomplete_source_wrong_msg_iter_cls_type(self):
  67         class MyIter(bt2._UserMessageIterator):
  68             pass
  69
  70         with self.assertRaises(bt2.IncompleteUserClass):
  71             class MySource(bt2._UserSourceComponent,
  72                            message_iterator_class=int):
  73                 pass
  74
  75     def test_incomplete_filter_no_msg_iter_cls(self):
  76         class MyIter(bt2._UserMessageIterator):
  77             pass
  78
  79         with self.assertRaises(bt2.IncompleteUserClass):
  80             class MyFilter(bt2._UserFilterComponent):
  81                 pass
  82
  83     def test_incomplete_sink_no_consume_method(self):
  84         class MyIter(bt2._UserMessageIterator):
  85             pass
  86
  87         with self.assertRaises(bt2.IncompleteUserClass):
  88             class MySink(bt2._UserSinkComponent):
  89                 pass
  90
  91     def test_minimal_source(self):
  92         class MyIter(bt2._UserMessageIterator):
  93             pass
  94
  95         class MySource(bt2._UserSourceComponent,
  96                        message_iterator_class=MyIter):
  97             pass
  98
  99     def test_minimal_filter(self):
 100         class MyIter(bt2._UserMessageIterator):
 101             pass
 102
 103         class MyFilter(bt2._UserFilterComponent,
 104                        message_iterator_class=MyIter):
 105             pass
 106
 107     def test_minimal_sink(self):
 108         class MySink(bt2._UserSinkComponent):
 109             def _consume(self):
 110                 pass
 111
 112     def test_default_name(self):
 113         class MySink(bt2._UserSinkComponent):
 114             def _consume(self):
 115                 pass
 116
 117         self.assertEqual(MySink.name, 'MySink')
 118
 119     def test_custom_name(self):
 120         class MySink(bt2._UserSinkComponent, name='salut'):
 121             def _consume(self):
 122                 pass
 123
 124         self.assertEqual(MySink.name, 'salut')
 125
 126     def test_invalid_custom_name(self):
 127         with self.assertRaises(TypeError):
 128             class MySink(bt2._UserSinkComponent, name=23):
 129                 def _consume(self):
 130                     pass
 131
 132     def test_description(self):
 133         class MySink(bt2._UserSinkComponent):
 134             """
 135             The description.
 136
 137             Bacon ipsum dolor amet ribeye t-bone corned beef, beef jerky
 138             porchetta burgdoggen prosciutto chicken frankfurter boudin
 139             hamburger doner bacon turducken. Sirloin shank sausage,
 140             boudin meatloaf alcatra meatball t-bone tongue pastrami
 141             cupim flank tenderloin.
 142             """
 143
 144             def _consume(self):
 145                 pass
 146
 147         self.assertEqual(MySink.description, 'The description.')
 148
 149     def test_empty_description(self):
 150         class MySink(bt2._UserSinkComponent):
 151             """
 152             """
 153
 154             def _consume(self):
 155                 pass
 156
 157         self.assertIsNone(MySink.description)
 158
 159     def test_help(self):
 160         class MySink(bt2._UserSinkComponent):
 161             """
 162             The description.
 163
 164             The help
 165             text is
 166             here.
 167             """
 168
 169             def _consume(self):
 170                 pass
 171
 172         self.assertEqual(MySink.help, 'The help\ntext is\nhere.')
 173
 174     def test_addr(self):
 175         class MySink(bt2._UserSinkComponent):
 176             def _consume(self):
 177                 pass
 178
 179         self.assertIsInstance(MySink.addr, int)
 180         self.assertNotEqual(MySink.addr, 0)
 181
 182     def test_query_not_implemented(self):
 183         class MySink(bt2._UserSinkComponent):
 184             def _consume(self):
 185                 pass
 186
 187         with self.assertRaises(bt2.Error):
 188             bt2.QueryExecutor().query(MySink, 'obj', 23)
 189
 190     def test_query_raises(self):
 191         class MySink(bt2._UserSinkComponent):
 192             def _consume(self):
 193                 pass
 194
 195             @classmethod
 196             def _query(cls, query_exec, obj, params, log_level):
 197                 raise ValueError
 198
 199         with self.assertRaises(bt2.Error):
 200             bt2.QueryExecutor().query(MySink, 'obj', 23)
 201
 202     def test_query_wrong_return_type(self):
 203         class MySink(bt2._UserSinkComponent):
 204             def _consume(self):
 205                 pass
 206
 207             @classmethod
 208             def _query(cls, query_exec, obj, params, log_level):
 209                 return ...
 210
 211         with self.assertRaises(bt2.Error):
 212             bt2.QueryExecutor().query(MySink, 'obj', 23)
 213
 214     def test_query_params_none(self):
 215         class MySink(bt2._UserSinkComponent):
 216             def _consume(self):
 217                 pass
 218
 219             @classmethod
 220             def _query(cls, query_exec, obj, params, log_level):
 221                 nonlocal query_params
 222                 query_params = params
 223                 return None
 224
 225         query_params = None
 226         params = None
 227         res = bt2.QueryExecutor().query(MySink, 'obj', params)
 228         self.assertEqual(query_params, params)
 229         self.assertIsNone(res)
 230         del query_params
 231
 232     def test_query_logging_level(self):
 233         class MySink(bt2._UserSinkComponent):
 234             def _consume(self):
 235                 pass
 236
 237             @classmethod
 238             def _query(cls, query_exec, obj, params, log_level):
 239                 nonlocal query_log_level
 240                 query_log_level = log_level
 241
 242         query_log_level = None
 243         res = bt2.QueryExecutor().query(MySink, 'obj', None,
 244                                         bt2.LoggingLevel.WARN)
 245         self.assertEqual(query_log_level, bt2.LoggingLevel.WARN)
 246         del query_log_level
 247
 248     def test_query_simple(self):
 249         class MySink(bt2._UserSinkComponent):
 250             def _consume(self):
 251                 pass
 252
 253             @classmethod
 254             def _query(cls, query_exec, obj, params, log_level):
 255                 nonlocal query_params
 256                 query_params = params
 257                 return 17.5
 258
 259         query_params = None
 260         params = ['coucou', 23, None]
 261         res = bt2.QueryExecutor().query(MySink, 'obj', params)
 262         self.assertEqual(query_params, params)
 263         self.assertEqual(res, 17.5)
 264         del query_params
 265
 266     def test_query_complex(self):
 267         class MySink(bt2._UserSinkComponent):
 268             def _consume(self):
 269                 pass
 270
 271             @classmethod
 272             def _query(cls, query_exec, obj, params, log_level):
 273                 nonlocal query_params
 274                 query_params = params
 275                 return {
 276                     'null': None,
 277                     'bt2': 'BT2',
 278                 }
 279
 280         query_params = None
 281         params = {
 282             'array': ['coucou', 23, None],
 283             'other_map': {
 284                 'yes': 'yeah',
 285                 '19': 19,
 286                 'minus 1.5': -1.5,
 287             },
 288             'null': None,
 289         }
 290
 291         res = bt2.QueryExecutor().query(MySink, 'obj', params)
 292         self.assertEqual(query_params, params)
 293         self.assertEqual(res, {
 294             'null': None,
 295             'bt2': 'BT2',
 296         })
 297         del query_params
 298
 299     def test_eq(self):
 300         class MySink(bt2._UserSinkComponent):
 301             def _consume(self):
 302                 pass
 303
 304         self.assertEqual(MySink, MySink)
 305
 306
 307 class GenericComponentClassTestCase(unittest.TestCase):
 308     def setUp(self):
 309         class MySink(bt2._UserSinkComponent):
 310             '''
 311             The description.
 312
 313             The help.
 314             '''
 315             def _consume(self):
 316                 pass
 317
 318             @classmethod
 319             def _query(cls, query_exec, obj, params, log_level):
 320                 return [obj, params, 23]
 321
 322         self._py_comp_cls = MySink
 323         graph = bt2.Graph()
 324         comp = graph.add_component(MySink, 'salut')
 325         self._comp_cls = comp.cls
 326         self.assertTrue(issubclass(type(self._comp_cls),
 327                                    bt2.component._GenericComponentClass))
 328
 329     def tearDown(self):
 330         del self._py_comp_cls
 331         del self._comp_cls
 332
 333     def test_description(self):
 334         self.assertEqual(self._comp_cls.description, 'The description.')
 335
 336     def test_help(self):
 337         self.assertEqual(self._comp_cls.help, 'The help.')
 338
 339     def test_name(self):
 340         self.assertEqual(self._comp_cls.name, 'MySink')
 341
 342     def test_addr(self):
 343         self.assertIsInstance(self._comp_cls.addr, int)
 344         self.assertNotEqual(self._comp_cls.addr, 0)
 345
 346     def test_eq_invalid(self):
 347         self.assertFalse(self._comp_cls == 23)
 348
 349     def test_eq(self):
 350         self.assertEqual(self._comp_cls, self._comp_cls)
 351         self.assertEqual(self._py_comp_cls, self._comp_cls)
 352
 353     def test_query(self):
 354         res = bt2.QueryExecutor().query(self._comp_cls, 'an object',
 355                                         {'yes': 'no', 'book': -17})
 356         expected = ['an object', {'yes': 'no', 'book': -17}, 23]
 357         self.assertEqual(res, expected)