[bitbake-devel] [[selftest][PATCH] 1/2] bitbake: tests: create unit tests for event module
Jair Gonzalez
jair.de.jesus.gonzalez.plascencia at linux.intel.com
Wed Jan 25 02:35:21 UTC 2017
Hi Anibal,
Thank you for your comments. Mine are also below.
Regards,
Jair
> -----Original Message-----
> From: Aníbal Limón [mailto:anibal.limon at linux.intel.com]
> Sent: Tuesday, January 24, 2017 11:08 AM
> To: Jair Gonzalez <jair.de.jesus.gonzalez.plascencia at linux.intel.com>;
> bitbake-devel at lists.openembedded.org
> Cc: richard.purdie at linuxfoundation.org
> Subject: Re: [[selftest][PATCH] 1/2] bitbake: tests: create unit tests for
event
> module
>
> Hi Jair,
>
> At first glance your tests are good, there are some comments below,
>
> Cheers,
> alimon
>
> On 01/23/2017 05:25 PM, Jair Gonzalez wrote:
> > This change adds a new unit test module (bb.tests.event) for bitbake
> > event.
> > It includes the following items:
> >
> > - Client and server stubs setup
> > - Testing the module's main functions including:
> > - get_class_handlers
> > - set_class_handlers
> > - clean_class_handlers
> > - enable_threadlock
> > - disable_threadlock
> > - get_handlers
> > - set_handlers
> > - execute_handler
> > - fire_class_handlers
> > - print_ui_queue
> > - fire_ui_handlers
> > - fire
> > - fire_from_worker
> > - register
> > - remove
> > - register_UIHhandler
> > - unregister_UIHhandler
> > - Testing event handling using:
> > - class Event(object)
> > - class OperationStarted(Event)
> > - class OperationCompleted(Event)
> > - class OperationProgress(Event)
> > - class ConfigParsed(Event)
> >
> > [YOCTO #10368]
> >
> > Signed-off-by: Jair Gonzalez
> > <jair.de.jesus.gonzalez.plascencia at linux.intel.com>
> > ---
> > bitbake/lib/bb/tests/event.py | 324
> > ++++++++++++++++++++++++++++++++++++++++++
> > 1 file changed, 324 insertions(+)
> > create mode 100644 bitbake/lib/bb/tests/event.py
> >
> > diff --git a/bitbake/lib/bb/tests/event.py
> > b/bitbake/lib/bb/tests/event.py new file mode 100644 index
> > 0000000..58846ee
> > --- /dev/null
> > +++ b/bitbake/lib/bb/tests/event.py
> > @@ -0,0 +1,324 @@
> > +# ex:ts=4:sw=4:sts=4:et
> > +# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- # #
> > +BitBake Tests for the Event implementation (event.py) # # Copyright
> > +(C) 2017 Intel
>
> Here is missing the Corporation.
>
> Copyright (C) 2017 Intel Corporation
Agreed, I'll change it.
>
> > +#
> > +# This program is free software; you can redistribute it and/or
> > +modify # it under the terms of the GNU General Public License version
> > +2 as # published by the Free Software Foundation.
> > +#
> > +# This program is distributed in the hope that it will be useful, #
> > +but WITHOUT ANY WARRANTY; without even the implied warranty of #
> > +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
> GNU
> > +General Public License for more details.
> > +#
> > +# You should have received a copy of the GNU General Public License
> > +along # with this program; if not, write to the Free Software
> > +Foundation, Inc., # 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301
> USA.
> > +#
> > +
> > +import unittest
> > +import bb
> > +import logging
> > +import bb.compat
> > +import bb.event
> > +import importlib
> > +import threading
> > +import time
> > +from unittest.mock import Mock
> > +
> > +
> > +class EventQueueStub():
> > + """ Class used as specification for UI event handler queue stub
objects
> """
> > + def __init__(self):
> > + return
> > +
> > + def send(self, event):
> > + return
> > +
> > +
> > +class PickleEventQueueStub():
> > + """ Class used as specification for UI event handler queue stub
objects
> > + with sendpickle method """
> > + def __init__(self):
> > + return
> > +
> > + def sendpickle(self, pickled_event):
> > + return
> > +
> > +
> > +class UIClientStub():
> > + """ Class used as specification for UI event handler stub objects
"""
> > + def __init__(self):
> > + self.event = None
> > +
> > +
> > +class EventHandlingTest(unittest.TestCase):
> > + """ Event handling test class """
> > + _threadlock_test_calls = []
> > +
> > + def setUp(self):
> > + self._test_process = Mock()
> > + ui_client1 = UIClientStub()
> > + ui_client2 = UIClientStub()
> > + self._test_ui1 = Mock(wraps=ui_client1)
> > + self._test_ui2 = Mock(wraps=ui_client2)
> > + importlib.reload(bb.event)
> > +
> > + def _create_test_handlers(self):
> > + """ Method used to create a test handler ordered dictionary """
> > + test_handlers = bb.compat.OrderedDict()
> > + test_handlers["handler1"] = self._test_process.handler1
> > + test_handlers["handler2"] = self._test_process.handler2
> > + return test_handlers
> > +
> > + def test_class_handlers(self):
> > + """ Test set_class_handlers and get_class_handlers methods """
> > + test_handlers = self._create_test_handlers()
> > + bb.event.set_class_handlers(test_handlers)
> > + self.assertEqual(test_handlers,
> > + bb.event.get_class_handlers())
>
> Since the bb.event set_class_handlers and clean_handlers are simple, i
don't
> know if there needs of a test case. The same in the related code below.
I tend to agree with you here, however, the reason I added these tests
is to ensure all public methods are covered.
Because they are really simple, I at least grouped together the tests for
the setter
and getter for each of class_handlers and handlers accessors (which in this
case,
for some reason, both make reference to the same internal attribute
_handlers).
In any case, the main benefit would be to ensure that they are not left out
in a
future class refactoring.
>
>
> > +
> > + def test_handlers(self):
> > + """ Test set_handlers and get_handlers """
> > + test_handlers = self._create_test_handlers()
> > + bb.event.set_handlers(test_handlers)
> > + self.assertEqual(test_handlers,
> > + bb.event.get_handlers())
> > +
> > + def test_clean_class_handlers(self):
> > + """ Test clean_class_handlers method """
> > + cleanDict = bb.compat.OrderedDict()
> > + self.assertEqual(cleanDict,
> > + bb.event.clean_class_handlers())
> > +
> > + def test_register(self):
> > + """ Test register method for class handlers """
> > + result = bb.event.register("handler",
self._test_process.handler)
> > + self.assertEqual(result, bb.event.Registered)
> > + handlers_dict = bb.event.get_class_handlers()
> > + self.assertIn("handler", handlers_dict)
> > +
> > + def test_already_registered(self):
> > + """ Test detection of an already registed class handler """
> > + bb.event.register("handler", self._test_process.handler)
> > + handlers_dict = bb.event.get_class_handlers()
> > + self.assertIn("handler", handlers_dict)
> > + result = bb.event.register("handler",
self._test_process.handler)
> > + self.assertEqual(result, bb.event.AlreadyRegistered)
> > +
> > + def test_register_from_string(self):
> > + """ Test register method receiving code in string """
> > + result = bb.event.register("string_handler", " return True")
> > + self.assertEqual(result, bb.event.Registered)
> > + handlers_dict = bb.event.get_class_handlers()
> > + self.assertIn("string_handler", handlers_dict)
> > +
> > + def test_register_with_mask(self):
> > + """ Test register method with event masking """
> > + mask = ["bb.event.OperationStarted",
> > + "bb.event.OperationCompleted"]
> > + result = bb.event.register("event_handler",
> > + self._test_process.event_handler,
> > + mask)
> > + self.assertEqual(result, bb.event.Registered)
> > + handlers_dict = bb.event.get_class_handlers()
> > + self.assertIn("event_handler", handlers_dict)
> > +
> > + def test_remove(self):
> > + """ Test remove method for class handlers """
> > + test_handlers = self._create_test_handlers()
> > + bb.event.set_class_handlers(test_handlers)
> > + count = len(test_handlers)
> > + bb.event.remove("handler1", None)
> > + self.assertEqual(len(test_handlers), count - 1)
> > + with self.assertRaises(KeyError):
> > + bb.event.remove("handler1", None)
> > +
> > + def test_execute_handler(self):
> > + """ Test execute_handler method for class handlers """
> > + mask = ["bb.event.OperationProgress"]
> > + result = bb.event.register("event_handler",
> > + self._test_process.event_handler,
> > + mask)
> > + self.assertEqual(result, bb.event.Registered)
> > + event = bb.event.OperationProgress(current=10, total=100)
> > + bb.event.execute_handler("event_handler",
> > + self._test_process.event_handler,
> > + event,
> > + None)
> > +
> > + self._test_process.event_handler.assert_called_once_with(event)
> > +
> > + def test_fire_class_handlers(self):
> > + """ Test fire_class_handlers method """
> > + mask = ["bb.event.OperationStarted"]
> > + result = bb.event.register("event_handler1",
> > + self._test_process.event_handler1,
> > + mask)
> > + self.assertEqual(result, bb.event.Registered)
> > + result = bb.event.register("event_handler2",
> > + self._test_process.event_handler2,
> > + "*")
> > + event1 = bb.event.OperationStarted()
> > + event2 = bb.event.OperationCompleted(total=123)
> > + bb.event.fire_class_handlers(event1, None)
> > + bb.event.fire_class_handlers(event2, None)
> > + bb.event.fire_class_handlers(event2, None)
> > + self.assertEqual(self._test_process.event_handler1.call_count,
1)
> > +
> > + self.assertEqual(self._test_process.event_handler2.call_count, 3)
>
> You count for number of events arrived, will be good if you can test about
> what type of event arrived. The same in the related code below.
Agreed. I'll add assertions for the event types too.
>
> > +
> > + def test_change_handler_event_mapping(self):
> > + """ Test changing the event mapping for class handlers """
> > + # register handler for all events
> > + result = bb.event.register("event_handler1",
> > + self._test_process.event_handler1,
> > + "*")
> > + self.assertEqual(result, bb.event.Registered)
> > + event1 = bb.event.OperationStarted()
> > + event2 = bb.event.OperationCompleted(total=123)
> > + bb.event.fire_class_handlers(event1, None)
> > + bb.event.fire_class_handlers(event2, None)
> > +
> > + self.assertEqual(self._test_process.event_handler1.call_count, 2)
> > +
> > + # unregister handler and register it only for OperationStarted
> > + result = bb.event.remove("event_handler1",
> > + self._test_process.event_handler1)
> > + mask = ["bb.event.OperationStarted"]
> > + result = bb.event.register("event_handler1",
> > + self._test_process.event_handler1,
> > + mask)
> > + self.assertEqual(result, bb.event.Registered)
> > + bb.event.fire_class_handlers(event1, None)
> > + bb.event.fire_class_handlers(event2, None)
> > +
> > + self.assertEqual(self._test_process.event_handler1.call_count, 3)
> > +
> > + def test_register_UIHhandler(self):
> > + """ Test register_UIHhandler method """
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > +
> > + def test_UIHhandler_already_registered(self):
> > + """ Test registering an UIHhandler already existing """
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 2)
> > +
> > + def test_unregister_UIHhandler(self):
> > + """ Test unregister_UIHhandler method """
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > + result = bb.event.unregister_UIHhandler(1)
> > + self.assertIs(result, None)
> > +
> > + def test_fire_ui_handlers(self):
> > + """ Test fire_ui_handlers method """
> > + self._test_ui1.event = Mock(spec_set=EventQueueStub)
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > + self._test_ui2.event = Mock(spec_set=PickleEventQueueStub)
> > + result = bb.event.register_UIHhandler(self._test_ui2,
mainui=True)
> > + self.assertEqual(result, 2)
> > + bb.event.fire_ui_handlers(bb.event.OperationStarted(), None)
> > + self.assertEqual(self._test_ui1.event.send.call_count, 1)
> > + self.assertEqual(self._test_ui2.event.sendpickle.call_count,
> > + 1)
> > +
> > + def test_fire(self):
> > + """ Test fire method used to trigger class and ui event
handlers """
> > + mask = ["bb.event.ConfigParsed"]
> > + result = bb.event.register("event_handler1",
> > + self._test_process.event_handler1,
> > + mask)
> > +
> > + self._test_ui1.event = Mock(spec_set=EventQueueStub)
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > +
> > + event1 = bb.event.ConfigParsed()
> > + bb.event.fire(event1, None)
> > + self.assertEqual(self._test_process.event_handler1.call_count,
1)
> > + self.assertEqual(self._test_ui1.event.send.call_count, 1)
> > +
> > + def test_fire_from_worker(self):
> > + """ Test fire_from_worker method """
> > + self._test_ui1.event = Mock(spec_set=EventQueueStub)
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > + bb.event.fire_from_worker(bb.event.ConfigParsed(), None)
> > + self.assertEqual(self._test_ui1.event.send.call_count, 1)
> > +
> > + def test_print_ui_queue(self):
> > + """ Test print_ui_queue method """
> > + event1 = bb.event.OperationStarted()
> > + event2 = bb.event.OperationCompleted(total=123)
> > + bb.event.fire(event1, None)
> > + bb.event.fire(event2, None)
> > + logger = logging.getLogger("BitBake")
> > + logger.addHandler(bb.event.LogHandler())
> > + logger.info("Test info LogRecord")
> > + logger.warning("Test warning LogRecord")
> > + with self.assertLogs("BitBake", level="INFO") as cm:
> > + bb.event.print_ui_queue()
> > + self.assertEqual(cm.output,
> > + ["INFO:BitBake:Test info LogRecord",
> > + "WARNING:BitBake:Test warning LogRecord"])
> > +
> > + def _set_threadlock_test_mockups(self):
> > + """ Create test mockups used in enable and disable threadlock
> > + tests """
> > + def ui1_event_send(event):
> > + self._threadlock_test_calls.append(1)
> > + time.sleep(0.2)
> > +
> > + def ui2_event_send(event):
> > + self._threadlock_test_calls.append(2)
> > + time.sleep(0.2)
> > +
> > + self._threadlock_test_calls = []
> > + self._test_ui1.event = EventQueueStub()
> > + self._test_ui1.event.send = ui1_event_send
> > + result = bb.event.register_UIHhandler(self._test_ui1,
mainui=True)
> > + self.assertEqual(result, 1)
> > + self._test_ui2.event = EventQueueStub()
> > + self._test_ui2.event.send = ui2_event_send
> > + result = bb.event.register_UIHhandler(self._test_ui2,
mainui=True)
> > + self.assertEqual(result, 2)
> > +
> > + def _set_and_run_threadlock_test_workers(self):
> > + """ Create and run workers used in enable and disable
threadlock
> > + tests """
> > + worker1 =
threading.Thread(target=self._thread_lock_test_worker)
> > + worker2 =
threading.Thread(target=self._thread_lock_test_worker)
> > + worker1.start()
> > + time.sleep(0.01)
> > + worker2.start()
> > + time.sleep(0.2)
> > + worker1.join()
> > + worker2.join()
> > +
> > + def _thread_lock_test_worker(self):
> > + """ Worker used to create race conditions for enable and
disable
> > + threadlocks tests """
> > + bb.event.fire(bb.event.ConfigParsed(), None)
> > + time.sleep(0.02)
> > + bb.event.fire(bb.event.OperationStarted(), None)
> > +
> > + def test_enable_threadlock(self):
> > + """ Test enable_threadlock method """
> > + self._set_threadlock_test_mockups()
> > + bb.event.enable_threadlock()
> > + self._set_and_run_threadlock_test_workers()
> > + # Calls to UI Handlers should be in order
> > + self.assertEqual(self._threadlock_test_calls,
> > + [1, 2, 1, 2, 1, 2, 1, 2])
>
> This kind of test of inputs given by certain threads don't guarantee the
order
> it depends on Python thread scheduler so i suggest to test for a number of
> thread1 of inputs and thread2 inputs. Same below.
The problem is the test's purpose is to validate that the event handling
order
changes with the threadlock enabled or disabled.
With threadlock enabled, the events coming from the second thread won't be
handled until the event handling from the first thread is completed (hence,
the ordered event 1, then 2 from the first thread, and then 1 and 2 from the
second thread, and the same again on a second succession of events).
Because of the sleep times set, the event handling from both threads will be
intertwined together when threadlock is disabled (1, 1, 2, 2, 1, 1, 2, 2).
I used sleep calls in the order of tens of miliseconds to avoid an overlap
offset
because of a thread scheduler's delay, while not increasing the test
execution
time to the order of seconds. However, I'm open to suggestions for a better
approach.
>
> > +
> > + def test_disable_threadlock(self):
> > + """ Test disable_threadlock method """
> > + self._set_threadlock_test_mockups()
> > + bb.event.disable_threadlock()
> > + self._set_and_run_threadlock_test_workers()
> > + # Calls to UI Handlers should be interwined together
> > + self.assertEqual(self._threadlock_test_calls,
> > + [1, 1, 2, 2, 1, 1, 2, 2])
> >
More information about the bitbake-devel
mailing list