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(RuntimeError):
  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, message_iterator_class=MyIter):
  35             pass
  36
  37         self._test_no_init(MySource)
  38
  39     def test_no_init_filter(self):
  40         class MyIter(bt2._UserMessageIterator):
  41             def __next__(self):
  42                 raise bt2.Stop
  43
  44         class MyFilter(bt2._UserFilterComponent, message_iterator_class=MyIter):
  45             pass
  46
  47         self._test_no_init(MyFilter)
  48
  49     def test_no_init_sink(self):
  50         class MySink(bt2._UserSinkComponent):
  51             def _user_consume(self):
  52                 pass
  53
  54         self._test_no_init(MySink)
  55
  56     def test_incomplete_source_no_msg_iter_cls(self):
  57         class MyIter(bt2._UserMessageIterator):
  58             pass
  59
  60         with self.assertRaises(bt2._IncompleteUserClass):
  61
  62             class MySource(bt2._UserSourceComponent):
  63                 pass
  64
  65     def test_incomplete_source_wrong_msg_iter_cls_type(self):
  66         class MyIter(bt2._UserMessageIterator):
  67             pass
  68
  69         with self.assertRaises(bt2._IncompleteUserClass):
  70
  71             class MySource(bt2._UserSourceComponent, message_iterator_class=int):
  72                 pass
  73
  74     def test_incomplete_filter_no_msg_iter_cls(self):
  75         class MyIter(bt2._UserMessageIterator):
  76             pass
  77
  78         with self.assertRaises(bt2._IncompleteUserClass):
  79
  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
  89             class MySink(bt2._UserSinkComponent):
  90                 pass
  91
  92     def test_minimal_source(self):
  93         class MyIter(bt2._UserMessageIterator):
  94             pass
  95
  96         class MySource(bt2._UserSourceComponent, 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, message_iterator_class=MyIter):
 104             pass
 105
 106     def test_minimal_sink(self):
 107         class MySink(bt2._UserSinkComponent):
 108             def _user_consume(self):
 109                 pass
 110
 111     def test_default_name(self):
 112         class MySink(bt2._UserSinkComponent):
 113             def _user_consume(self):
 114                 pass
 115
 116         self.assertEqual(MySink.name, 'MySink')
 117
 118     def test_custom_name(self):
 119         class MySink(bt2._UserSinkComponent, name='salut'):
 120             def _user_consume(self):
 121                 pass
 122
 123         self.assertEqual(MySink.name, 'salut')
 124
 125     def test_invalid_custom_name(self):
 126         with self.assertRaises(TypeError):
 127
 128             class MySink(bt2._UserSinkComponent, name=23):
 129                 def _user_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 _user_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 _user_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 _user_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 _user_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 _user_consume(self):
 185                 pass
 186
 187         with self.assertRaises(bt2.UnknownObject):
 188             bt2.QueryExecutor(MySink, 'obj', 23).query()
 189
 190     def test_query_raises(self):
 191         class MySink(bt2._UserSinkComponent):
 192             def _user_consume(self):
 193                 pass
 194
 195             @classmethod
 196             def _user_query(cls, priv_query_exec, obj, params):
 197                 raise ValueError
 198
 199         with self.assertRaises(bt2._Error):
 200             bt2.QueryExecutor(MySink, 'obj', 23).query()
 201
 202     def test_query_wrong_return_type(self):
 203         class MySink(bt2._UserSinkComponent):
 204             def _user_consume(self):
 205                 pass
 206
 207             @classmethod
 208             def _user_query(cls, priv_query_exec, obj, params, method_obj):
 209                 return ...
 210
 211         with self.assertRaises(bt2._Error):
 212             bt2.QueryExecutor(MySink, 'obj', 23).query()
 213
 214     def test_query_params_none(self):
 215         class MySink(bt2._UserSinkComponent):
 216             def _user_consume(self):
 217                 pass
 218
 219             @classmethod
 220             def _user_query(cls, priv_query_exec, obj, params, method_obj):
 221                 nonlocal query_params
 222                 query_params = params
 223                 return None
 224
 225         query_params = None
 226         params = None
 227         res = bt2.QueryExecutor(MySink, 'obj', params).query()
 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 _user_consume(self):
 235                 pass
 236
 237             @classmethod
 238             def _user_query(cls, priv_query_exec, obj, params, method_obj):
 239                 nonlocal query_log_level
 240                 query_log_level = priv_query_exec.logging_level
 241
 242         query_log_level = None
 243         query_exec = bt2.QueryExecutor(MySink, 'obj', None)
 244         query_exec.logging_level = bt2.LoggingLevel.WARNING
 245         query_exec.query()
 246         self.assertEqual(query_log_level, bt2.LoggingLevel.WARNING)
 247         del query_log_level
 248
 249     def test_query_returns_none(self):
 250         class MySink(bt2._UserSinkComponent):
 251             def _user_consume(self):
 252                 pass
 253
 254             @staticmethod
 255             def _user_query(priv_query_exec, obj, params, method_obj):
 256                 return
 257
 258         res = bt2.QueryExecutor(MySink, 'obj', None).query()
 259         self.assertIsNone(res)
 260
 261     def test_query_simple(self):
 262         class MySink(bt2._UserSinkComponent):
 263             def _user_consume(self):
 264                 pass
 265
 266             @classmethod
 267             def _user_query(cls, priv_query_exec, obj, params, method_obj):
 268                 nonlocal query_params
 269                 query_params = params
 270                 return 17.5
 271
 272         query_params = None
 273         params = ['coucou', 23, None]
 274         res = bt2.QueryExecutor(MySink, 'obj', params).query()
 275         self.assertEqual(query_params, params)
 276         self.assertEqual(res, 17.5)
 277         del query_params
 278
 279     def test_query_complex(self):
 280         class MySink(bt2._UserSinkComponent):
 281             def _user_consume(self):
 282                 pass
 283
 284             @classmethod
 285             def _user_query(cls, priv_query_exec, obj, params, method_obj):
 286                 nonlocal query_params
 287                 query_params = params
 288                 return {'null': None, 'bt2': 'BT2'}
 289
 290         query_params = None
 291         params = {
 292             'array': ['coucou', 23, None],
 293             'other_map': {'yes': 'yeah', '19': 19, 'minus 1.5': -1.5},
 294             'null': None,
 295         }
 296
 297         res = bt2.QueryExecutor(MySink, 'obj', params).query()
 298         self.assertEqual(query_params, params)
 299         self.assertEqual(res, {'null': None, 'bt2': 'BT2'})
 300         del query_params
 301
 302     def test_eq(self):
 303         class MySink(bt2._UserSinkComponent):
 304             def _user_consume(self):
 305                 pass
 306
 307         self.assertEqual(MySink, MySink)
 308
 309
 310 class ComponentClassTestCase(unittest.TestCase):
 311     def setUp(self):
 312         class MySink(bt2._UserSinkComponent):
 313             '''
 314             The description.
 315
 316             The help.
 317             '''
 318
 319             def _user_consume(self):
 320                 pass
 321
 322             @classmethod
 323             def _user_query(cls, priv_query_exec, obj, params, method_obj):
 324                 return [obj, params, 23]
 325
 326         self._py_comp_cls = MySink
 327         graph = bt2.Graph()
 328         comp = graph.add_component(MySink, 'salut')
 329         self._comp_cls = comp.cls
 330         self.assertTrue(issubclass(type(self._comp_cls), bt2._SinkComponentClass))
 331
 332     def tearDown(self):
 333         del self._py_comp_cls
 334         del self._comp_cls
 335
 336     def test_description(self):
 337         self.assertEqual(self._comp_cls.description, 'The description.')
 338
 339     def test_help(self):
 340         self.assertEqual(self._comp_cls.help, 'The help.')
 341
 342     def test_name(self):
 343         self.assertEqual(self._comp_cls.name, 'MySink')
 344
 345     def test_addr(self):
 346         self.assertIsInstance(self._comp_cls.addr, int)
 347         self.assertNotEqual(self._comp_cls.addr, 0)
 348
 349     def test_eq_invalid(self):
 350         self.assertFalse(self._comp_cls == 23)
 351
 352     def test_eq(self):
 353         self.assertEqual(self._comp_cls, self._comp_cls)
 354         self.assertEqual(self._py_comp_cls, self._comp_cls)
 355
 356     def test_query(self):
 357         res = bt2.QueryExecutor(
 358             self._comp_cls, 'an object', {'yes': 'no', 'book': -17}
 359         ).query()
 360         expected = ['an object', {'yes': 'no', 'book': -17}, 23]
 361         self.assertEqual(res, expected)