event.py 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966
  1. #
  2. # BitBake Tests for the Event implementation (event.py)
  3. #
  4. # Copyright (C) 2017 Intel Corporation
  5. #
  6. # SPDX-License-Identifier: GPL-2.0-only
  7. #
  8. import collections
  9. import importlib
  10. import logging
  11. import pickle
  12. import threading
  13. import time
  14. import unittest
  15. from unittest.mock import Mock
  16. from unittest.mock import call
  17. import bb
  18. import bb.event
  19. from bb.msg import BBLogFormatter
  20. class EventQueueStubBase(object):
  21. """ Base class for EventQueueStub classes """
  22. def __init__(self):
  23. self.event_calls = []
  24. return
  25. def _store_event_data_string(self, event):
  26. if isinstance(event, logging.LogRecord):
  27. formatter = BBLogFormatter("%(levelname)s: %(message)s")
  28. self.event_calls.append(formatter.format(event))
  29. else:
  30. self.event_calls.append(bb.event.getName(event))
  31. return
  32. class EventQueueStub(EventQueueStubBase):
  33. """ Class used as specification for UI event handler queue stub objects """
  34. def __init__(self):
  35. super(EventQueueStub, self).__init__()
  36. def send(self, event):
  37. super(EventQueueStub, self)._store_event_data_string(event)
  38. class PickleEventQueueStub(EventQueueStubBase):
  39. """ Class used as specification for UI event handler queue stub objects
  40. with sendpickle method """
  41. def __init__(self):
  42. super(PickleEventQueueStub, self).__init__()
  43. def sendpickle(self, pickled_event):
  44. event = pickle.loads(pickled_event)
  45. super(PickleEventQueueStub, self)._store_event_data_string(event)
  46. class UIClientStub(object):
  47. """ Class used as specification for UI event handler stub objects """
  48. def __init__(self):
  49. self.event = None
  50. class EventHandlingTest(unittest.TestCase):
  51. """ Event handling test class """
  52. def setUp(self):
  53. self._test_process = Mock()
  54. ui_client1 = UIClientStub()
  55. ui_client2 = UIClientStub()
  56. self._test_ui1 = Mock(wraps=ui_client1)
  57. self._test_ui2 = Mock(wraps=ui_client2)
  58. importlib.reload(bb.event)
  59. def _create_test_handlers(self):
  60. """ Method used to create a test handler ordered dictionary """
  61. test_handlers = collections.OrderedDict()
  62. test_handlers["handler1"] = self._test_process.handler1
  63. test_handlers["handler2"] = self._test_process.handler2
  64. return test_handlers
  65. def test_class_handlers(self):
  66. """ Test set_class_handlers and get_class_handlers methods """
  67. test_handlers = self._create_test_handlers()
  68. bb.event.set_class_handlers(test_handlers)
  69. self.assertEqual(test_handlers,
  70. bb.event.get_class_handlers())
  71. def test_handlers(self):
  72. """ Test set_handlers and get_handlers """
  73. test_handlers = self._create_test_handlers()
  74. bb.event.set_handlers(test_handlers)
  75. self.assertEqual(test_handlers,
  76. bb.event.get_handlers())
  77. def test_clean_class_handlers(self):
  78. """ Test clean_class_handlers method """
  79. cleanDict = collections.OrderedDict()
  80. self.assertEqual(cleanDict,
  81. bb.event.clean_class_handlers())
  82. def test_register(self):
  83. """ Test register method for class handlers """
  84. result = bb.event.register("handler", self._test_process.handler)
  85. self.assertEqual(result, bb.event.Registered)
  86. handlers_dict = bb.event.get_class_handlers()
  87. self.assertIn("handler", handlers_dict)
  88. def test_already_registered(self):
  89. """ Test detection of an already registed class handler """
  90. bb.event.register("handler", self._test_process.handler)
  91. handlers_dict = bb.event.get_class_handlers()
  92. self.assertIn("handler", handlers_dict)
  93. result = bb.event.register("handler", self._test_process.handler)
  94. self.assertEqual(result, bb.event.AlreadyRegistered)
  95. def test_register_from_string(self):
  96. """ Test register method receiving code in string """
  97. result = bb.event.register("string_handler", " return True")
  98. self.assertEqual(result, bb.event.Registered)
  99. handlers_dict = bb.event.get_class_handlers()
  100. self.assertIn("string_handler", handlers_dict)
  101. def test_register_with_mask(self):
  102. """ Test register method with event masking """
  103. mask = ["bb.event.OperationStarted",
  104. "bb.event.OperationCompleted"]
  105. result = bb.event.register("event_handler",
  106. self._test_process.event_handler,
  107. mask)
  108. self.assertEqual(result, bb.event.Registered)
  109. handlers_dict = bb.event.get_class_handlers()
  110. self.assertIn("event_handler", handlers_dict)
  111. def test_remove(self):
  112. """ Test remove method for class handlers """
  113. test_handlers = self._create_test_handlers()
  114. bb.event.set_class_handlers(test_handlers)
  115. count = len(test_handlers)
  116. bb.event.remove("handler1", None)
  117. test_handlers = bb.event.get_class_handlers()
  118. self.assertEqual(len(test_handlers), count - 1)
  119. with self.assertRaises(KeyError):
  120. bb.event.remove("handler1", None)
  121. def test_execute_handler(self):
  122. """ Test execute_handler method for class handlers """
  123. mask = ["bb.event.OperationProgress"]
  124. result = bb.event.register("event_handler",
  125. self._test_process.event_handler,
  126. mask)
  127. self.assertEqual(result, bb.event.Registered)
  128. event = bb.event.OperationProgress(current=10, total=100)
  129. bb.event.execute_handler("event_handler",
  130. self._test_process.event_handler,
  131. event,
  132. None)
  133. self._test_process.event_handler.assert_called_once_with(event)
  134. def test_fire_class_handlers(self):
  135. """ Test fire_class_handlers method """
  136. mask = ["bb.event.OperationStarted"]
  137. result = bb.event.register("event_handler1",
  138. self._test_process.event_handler1,
  139. mask)
  140. self.assertEqual(result, bb.event.Registered)
  141. result = bb.event.register("event_handler2",
  142. self._test_process.event_handler2,
  143. "*")
  144. self.assertEqual(result, bb.event.Registered)
  145. event1 = bb.event.OperationStarted()
  146. event2 = bb.event.OperationCompleted(total=123)
  147. bb.event.fire_class_handlers(event1, None)
  148. bb.event.fire_class_handlers(event2, None)
  149. bb.event.fire_class_handlers(event2, None)
  150. expected_event_handler1 = [call(event1)]
  151. expected_event_handler2 = [call(event1),
  152. call(event2),
  153. call(event2)]
  154. self.assertEqual(self._test_process.event_handler1.call_args_list,
  155. expected_event_handler1)
  156. self.assertEqual(self._test_process.event_handler2.call_args_list,
  157. expected_event_handler2)
  158. def test_class_handler_filters(self):
  159. """ Test filters for class handlers """
  160. mask = ["bb.event.OperationStarted"]
  161. result = bb.event.register("event_handler1",
  162. self._test_process.event_handler1,
  163. mask)
  164. self.assertEqual(result, bb.event.Registered)
  165. result = bb.event.register("event_handler2",
  166. self._test_process.event_handler2,
  167. "*")
  168. self.assertEqual(result, bb.event.Registered)
  169. bb.event.set_eventfilter(
  170. lambda name, handler, event, d :
  171. name == 'event_handler2' and
  172. bb.event.getName(event) == "OperationStarted")
  173. event1 = bb.event.OperationStarted()
  174. event2 = bb.event.OperationCompleted(total=123)
  175. bb.event.fire_class_handlers(event1, None)
  176. bb.event.fire_class_handlers(event2, None)
  177. bb.event.fire_class_handlers(event2, None)
  178. expected_event_handler1 = []
  179. expected_event_handler2 = [call(event1)]
  180. self.assertEqual(self._test_process.event_handler1.call_args_list,
  181. expected_event_handler1)
  182. self.assertEqual(self._test_process.event_handler2.call_args_list,
  183. expected_event_handler2)
  184. def test_change_handler_event_mapping(self):
  185. """ Test changing the event mapping for class handlers """
  186. event1 = bb.event.OperationStarted()
  187. event2 = bb.event.OperationCompleted(total=123)
  188. # register handler for all events
  189. result = bb.event.register("event_handler1",
  190. self._test_process.event_handler1,
  191. "*")
  192. self.assertEqual(result, bb.event.Registered)
  193. bb.event.fire_class_handlers(event1, None)
  194. bb.event.fire_class_handlers(event2, None)
  195. expected = [call(event1), call(event2)]
  196. self.assertEqual(self._test_process.event_handler1.call_args_list,
  197. expected)
  198. # unregister handler and register it only for OperationStarted
  199. bb.event.remove("event_handler1",
  200. self._test_process.event_handler1)
  201. mask = ["bb.event.OperationStarted"]
  202. result = bb.event.register("event_handler1",
  203. self._test_process.event_handler1,
  204. mask)
  205. self.assertEqual(result, bb.event.Registered)
  206. bb.event.fire_class_handlers(event1, None)
  207. bb.event.fire_class_handlers(event2, None)
  208. expected = [call(event1), call(event2), call(event1)]
  209. self.assertEqual(self._test_process.event_handler1.call_args_list,
  210. expected)
  211. # unregister handler and register it only for OperationCompleted
  212. bb.event.remove("event_handler1",
  213. self._test_process.event_handler1)
  214. mask = ["bb.event.OperationCompleted"]
  215. result = bb.event.register("event_handler1",
  216. self._test_process.event_handler1,
  217. mask)
  218. self.assertEqual(result, bb.event.Registered)
  219. bb.event.fire_class_handlers(event1, None)
  220. bb.event.fire_class_handlers(event2, None)
  221. expected = [call(event1), call(event2), call(event1), call(event2)]
  222. self.assertEqual(self._test_process.event_handler1.call_args_list,
  223. expected)
  224. def test_register_UIHhandler(self):
  225. """ Test register_UIHhandler method """
  226. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  227. self.assertEqual(result, 1)
  228. def test_UIHhandler_already_registered(self):
  229. """ Test registering an UIHhandler already existing """
  230. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  231. self.assertEqual(result, 1)
  232. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  233. self.assertEqual(result, 2)
  234. def test_unregister_UIHhandler(self):
  235. """ Test unregister_UIHhandler method """
  236. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  237. self.assertEqual(result, 1)
  238. result = bb.event.unregister_UIHhandler(1)
  239. self.assertIs(result, None)
  240. def test_fire_ui_handlers(self):
  241. """ Test fire_ui_handlers method """
  242. self._test_ui1.event = Mock(spec_set=EventQueueStub)
  243. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  244. self.assertEqual(result, 1)
  245. self._test_ui2.event = Mock(spec_set=PickleEventQueueStub)
  246. result = bb.event.register_UIHhandler(self._test_ui2, mainui=True)
  247. self.assertEqual(result, 2)
  248. event1 = bb.event.OperationStarted()
  249. bb.event.fire_ui_handlers(event1, None)
  250. expected = [call(event1)]
  251. self.assertEqual(self._test_ui1.event.send.call_args_list,
  252. expected)
  253. expected = [call(pickle.dumps(event1))]
  254. self.assertEqual(self._test_ui2.event.sendpickle.call_args_list,
  255. expected)
  256. def test_ui_handler_mask_filter(self):
  257. """ Test filters for UI handlers """
  258. mask = ["bb.event.OperationStarted"]
  259. debug_domains = {}
  260. self._test_ui1.event = Mock(spec_set=EventQueueStub)
  261. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  262. bb.event.set_UIHmask(result, logging.INFO, debug_domains, mask)
  263. self._test_ui2.event = Mock(spec_set=PickleEventQueueStub)
  264. result = bb.event.register_UIHhandler(self._test_ui2, mainui=True)
  265. bb.event.set_UIHmask(result, logging.INFO, debug_domains, mask)
  266. event1 = bb.event.OperationStarted()
  267. event2 = bb.event.OperationCompleted(total=1)
  268. bb.event.fire_ui_handlers(event1, None)
  269. bb.event.fire_ui_handlers(event2, None)
  270. expected = [call(event1)]
  271. self.assertEqual(self._test_ui1.event.send.call_args_list,
  272. expected)
  273. expected = [call(pickle.dumps(event1))]
  274. self.assertEqual(self._test_ui2.event.sendpickle.call_args_list,
  275. expected)
  276. def test_ui_handler_log_filter(self):
  277. """ Test log filters for UI handlers """
  278. mask = ["*"]
  279. debug_domains = {'BitBake.Foo': logging.WARNING}
  280. self._test_ui1.event = EventQueueStub()
  281. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  282. bb.event.set_UIHmask(result, logging.ERROR, debug_domains, mask)
  283. self._test_ui2.event = PickleEventQueueStub()
  284. result = bb.event.register_UIHhandler(self._test_ui2, mainui=True)
  285. bb.event.set_UIHmask(result, logging.ERROR, debug_domains, mask)
  286. event1 = bb.event.OperationStarted()
  287. bb.event.fire_ui_handlers(event1, None) # All events match
  288. event_log_handler = bb.event.LogHandler()
  289. logger = logging.getLogger("BitBake")
  290. logger.addHandler(event_log_handler)
  291. logger1 = logging.getLogger("BitBake.Foo")
  292. logger1.warning("Test warning LogRecord1") # Matches debug_domains level
  293. logger1.info("Test info LogRecord") # Filtered out
  294. logger2 = logging.getLogger("BitBake.Bar")
  295. logger2.error("Test error LogRecord") # Matches filter base level
  296. logger2.warning("Test warning LogRecord2") # Filtered out
  297. logger.removeHandler(event_log_handler)
  298. expected = ['OperationStarted',
  299. 'WARNING: Test warning LogRecord1',
  300. 'ERROR: Test error LogRecord']
  301. self.assertEqual(self._test_ui1.event.event_calls, expected)
  302. self.assertEqual(self._test_ui2.event.event_calls, expected)
  303. def test_fire(self):
  304. """ Test fire method used to trigger class and ui event handlers """
  305. mask = ["bb.event.ConfigParsed"]
  306. result = bb.event.register("event_handler1",
  307. self._test_process.event_handler1,
  308. mask)
  309. self._test_ui1.event = Mock(spec_set=EventQueueStub)
  310. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  311. self.assertEqual(result, 1)
  312. event1 = bb.event.ConfigParsed()
  313. bb.event.fire(event1, None)
  314. expected = [call(event1)]
  315. self.assertEqual(self._test_process.event_handler1.call_args_list,
  316. expected)
  317. self.assertEqual(self._test_ui1.event.send.call_args_list,
  318. expected)
  319. def test_fire_from_worker(self):
  320. """ Test fire_from_worker method """
  321. self._test_ui1.event = Mock(spec_set=EventQueueStub)
  322. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  323. self.assertEqual(result, 1)
  324. event1 = bb.event.ConfigParsed()
  325. bb.event.fire_from_worker(event1, None)
  326. expected = [call(event1)]
  327. self.assertEqual(self._test_ui1.event.send.call_args_list,
  328. expected)
  329. def test_worker_fire(self):
  330. """ Test the triggering of bb.event.worker_fire callback """
  331. bb.event.worker_fire = Mock()
  332. event = bb.event.Event()
  333. bb.event.fire(event, None)
  334. expected = [call(event, None)]
  335. self.assertEqual(bb.event.worker_fire.call_args_list, expected)
  336. def test_print_ui_queue(self):
  337. """ Test print_ui_queue method """
  338. event1 = bb.event.OperationStarted()
  339. event2 = bb.event.OperationCompleted(total=123)
  340. bb.event.fire(event1, None)
  341. bb.event.fire(event2, None)
  342. event_log_handler = bb.event.LogHandler()
  343. logger = logging.getLogger("BitBake")
  344. logger.addHandler(event_log_handler)
  345. logger.info("Test info LogRecord")
  346. logger.warning("Test warning LogRecord")
  347. with self.assertLogs("BitBake", level="INFO") as cm:
  348. bb.event.print_ui_queue()
  349. logger.removeHandler(event_log_handler)
  350. self.assertEqual(cm.output,
  351. ["INFO:BitBake:Test info LogRecord",
  352. "WARNING:BitBake:Test warning LogRecord"])
  353. def _set_threadlock_test_mockups(self):
  354. """ Create UI event handler mockups used in enable and disable
  355. threadlock tests """
  356. def ui1_event_send(event):
  357. if type(event) is bb.event.ConfigParsed:
  358. self._threadlock_test_calls.append("w1_ui1")
  359. if type(event) is bb.event.OperationStarted:
  360. self._threadlock_test_calls.append("w2_ui1")
  361. time.sleep(2)
  362. def ui2_event_send(event):
  363. if type(event) is bb.event.ConfigParsed:
  364. self._threadlock_test_calls.append("w1_ui2")
  365. if type(event) is bb.event.OperationStarted:
  366. self._threadlock_test_calls.append("w2_ui2")
  367. time.sleep(2)
  368. self._threadlock_test_calls = []
  369. self._test_ui1.event = EventQueueStub()
  370. self._test_ui1.event.send = ui1_event_send
  371. result = bb.event.register_UIHhandler(self._test_ui1, mainui=True)
  372. self.assertEqual(result, 1)
  373. self._test_ui2.event = EventQueueStub()
  374. self._test_ui2.event.send = ui2_event_send
  375. result = bb.event.register_UIHhandler(self._test_ui2, mainui=True)
  376. self.assertEqual(result, 2)
  377. def _set_and_run_threadlock_test_workers(self):
  378. """ Create and run the workers used to trigger events in enable and
  379. disable threadlock tests """
  380. worker1 = threading.Thread(target=self._thread_lock_test_worker1)
  381. worker2 = threading.Thread(target=self._thread_lock_test_worker2)
  382. worker1.start()
  383. time.sleep(1)
  384. worker2.start()
  385. worker1.join()
  386. worker2.join()
  387. def _thread_lock_test_worker1(self):
  388. """ First worker used to fire the ConfigParsed event for enable and
  389. disable threadlocks tests """
  390. bb.event.fire(bb.event.ConfigParsed(), None)
  391. def _thread_lock_test_worker2(self):
  392. """ Second worker used to fire the OperationStarted event for enable
  393. and disable threadlocks tests """
  394. bb.event.fire(bb.event.OperationStarted(), None)
  395. def test_enable_threadlock(self):
  396. """ Test enable_threadlock method """
  397. self._set_threadlock_test_mockups()
  398. bb.event.enable_threadlock()
  399. self._set_and_run_threadlock_test_workers()
  400. # Calls to UI handlers should be in order as all the registered
  401. # handlers for the event coming from the first worker should be
  402. # called before processing the event from the second worker.
  403. self.assertEqual(self._threadlock_test_calls,
  404. ["w1_ui1", "w1_ui2", "w2_ui1", "w2_ui2"])
  405. def test_disable_threadlock(self):
  406. """ Test disable_threadlock method """
  407. self._set_threadlock_test_mockups()
  408. bb.event.disable_threadlock()
  409. self._set_and_run_threadlock_test_workers()
  410. # Calls to UI handlers should be intertwined together. Thanks to the
  411. # delay in the registered handlers for the event coming from the first
  412. # worker, the event coming from the second worker starts being
  413. # processed before finishing handling the first worker event.
  414. self.assertEqual(self._threadlock_test_calls,
  415. ["w1_ui1", "w2_ui1", "w1_ui2", "w2_ui2"])
  416. class EventClassesTest(unittest.TestCase):
  417. """ Event classes test class """
  418. _worker_pid = 54321
  419. def setUp(self):
  420. bb.event.worker_pid = EventClassesTest._worker_pid
  421. def test_Event(self):
  422. """ Test the Event base class """
  423. event = bb.event.Event()
  424. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  425. def test_HeartbeatEvent(self):
  426. """ Test the HeartbeatEvent class """
  427. time = 10
  428. event = bb.event.HeartbeatEvent(time)
  429. self.assertEqual(event.time, time)
  430. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  431. def test_OperationStarted(self):
  432. """ Test OperationStarted event class """
  433. msg = "Foo Bar"
  434. event = bb.event.OperationStarted(msg)
  435. self.assertEqual(event.msg, msg)
  436. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  437. def test_OperationCompleted(self):
  438. """ Test OperationCompleted event class """
  439. msg = "Foo Bar"
  440. total = 123
  441. event = bb.event.OperationCompleted(total, msg)
  442. self.assertEqual(event.msg, msg)
  443. self.assertEqual(event.total, total)
  444. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  445. def test_OperationProgress(self):
  446. """ Test OperationProgress event class """
  447. msg = "Foo Bar"
  448. total = 123
  449. current = 111
  450. event = bb.event.OperationProgress(current, total, msg)
  451. self.assertEqual(event.msg, msg + ": %s/%s" % (current, total))
  452. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  453. def test_ConfigParsed(self):
  454. """ Test the ConfigParsed class """
  455. event = bb.event.ConfigParsed()
  456. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  457. def test_MultiConfigParsed(self):
  458. """ Test MultiConfigParsed event class """
  459. mcdata = {"foobar": "Foo Bar"}
  460. event = bb.event.MultiConfigParsed(mcdata)
  461. self.assertEqual(event.mcdata, mcdata)
  462. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  463. def test_RecipeEvent(self):
  464. """ Test RecipeEvent event base class """
  465. callback = lambda a: 2 * a
  466. event = bb.event.RecipeEvent(callback)
  467. self.assertEqual(event.fn(1), callback(1))
  468. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  469. def test_RecipePreFinalise(self):
  470. """ Test RecipePreFinalise event class """
  471. callback = lambda a: 2 * a
  472. event = bb.event.RecipePreFinalise(callback)
  473. self.assertEqual(event.fn(1), callback(1))
  474. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  475. def test_RecipeTaskPreProcess(self):
  476. """ Test RecipeTaskPreProcess event class """
  477. callback = lambda a: 2 * a
  478. tasklist = [("foobar", callback)]
  479. event = bb.event.RecipeTaskPreProcess(callback, tasklist)
  480. self.assertEqual(event.fn(1), callback(1))
  481. self.assertEqual(event.tasklist, tasklist)
  482. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  483. def test_RecipeParsed(self):
  484. """ Test RecipeParsed event base class """
  485. callback = lambda a: 2 * a
  486. event = bb.event.RecipeParsed(callback)
  487. self.assertEqual(event.fn(1), callback(1))
  488. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  489. def test_BuildBase(self):
  490. """ Test base class for bitbake build events """
  491. name = "foo"
  492. pkgs = ["bar"]
  493. failures = 123
  494. event = bb.event.BuildBase(name, pkgs, failures)
  495. self.assertEqual(event.name, name)
  496. self.assertEqual(event.pkgs, pkgs)
  497. self.assertEqual(event.getFailures(), failures)
  498. name = event.name = "bar"
  499. pkgs = event.pkgs = ["foo"]
  500. self.assertEqual(event.name, name)
  501. self.assertEqual(event.pkgs, pkgs)
  502. self.assertEqual(event.getFailures(), failures)
  503. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  504. def test_BuildInit(self):
  505. """ Test class for bitbake build invocation events """
  506. event = bb.event.BuildInit()
  507. self.assertEqual(event.name, None)
  508. self.assertEqual(event.pkgs, [])
  509. self.assertEqual(event.getFailures(), 0)
  510. name = event.name = "bar"
  511. pkgs = event.pkgs = ["foo"]
  512. self.assertEqual(event.name, name)
  513. self.assertEqual(event.pkgs, pkgs)
  514. self.assertEqual(event.getFailures(), 0)
  515. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  516. def test_BuildStarted(self):
  517. """ Test class for build started events """
  518. name = "foo"
  519. pkgs = ["bar"]
  520. failures = 123
  521. event = bb.event.BuildStarted(name, pkgs, failures)
  522. self.assertEqual(event.name, name)
  523. self.assertEqual(event.pkgs, pkgs)
  524. self.assertEqual(event.getFailures(), failures)
  525. self.assertEqual(event.msg, "Building Started")
  526. name = event.name = "bar"
  527. pkgs = event.pkgs = ["foo"]
  528. msg = event.msg = "foobar"
  529. self.assertEqual(event.name, name)
  530. self.assertEqual(event.pkgs, pkgs)
  531. self.assertEqual(event.getFailures(), failures)
  532. self.assertEqual(event.msg, msg)
  533. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  534. def test_BuildCompleted(self):
  535. """ Test class for build completed events """
  536. total = 1000
  537. name = "foo"
  538. pkgs = ["bar"]
  539. failures = 123
  540. interrupted = 1
  541. event = bb.event.BuildCompleted(total, name, pkgs, failures,
  542. interrupted)
  543. self.assertEqual(event.name, name)
  544. self.assertEqual(event.pkgs, pkgs)
  545. self.assertEqual(event.getFailures(), failures)
  546. self.assertEqual(event.msg, "Building Failed")
  547. event2 = bb.event.BuildCompleted(total, name, pkgs)
  548. self.assertEqual(event2.name, name)
  549. self.assertEqual(event2.pkgs, pkgs)
  550. self.assertEqual(event2.getFailures(), 0)
  551. self.assertEqual(event2.msg, "Building Succeeded")
  552. self.assertEqual(event2.pid, EventClassesTest._worker_pid)
  553. def test_DiskFull(self):
  554. """ Test DiskFull event class """
  555. dev = "/dev/foo"
  556. type = "ext4"
  557. freespace = "104M"
  558. mountpoint = "/"
  559. event = bb.event.DiskFull(dev, type, freespace, mountpoint)
  560. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  561. def test_MonitorDiskEvent(self):
  562. """ Test MonitorDiskEvent class """
  563. available_bytes = 10000000
  564. free_bytes = 90000000
  565. total_bytes = 1000000000
  566. du = bb.event.DiskUsageSample(available_bytes, free_bytes,
  567. total_bytes)
  568. event = bb.event.MonitorDiskEvent(du)
  569. self.assertEqual(event.disk_usage.available_bytes, available_bytes)
  570. self.assertEqual(event.disk_usage.free_bytes, free_bytes)
  571. self.assertEqual(event.disk_usage.total_bytes, total_bytes)
  572. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  573. def test_NoProvider(self):
  574. """ Test NoProvider event class """
  575. item = "foobar"
  576. event1 = bb.event.NoProvider(item)
  577. self.assertEqual(event1.getItem(), item)
  578. self.assertEqual(event1.isRuntime(), False)
  579. self.assertEqual(str(event1), "Nothing PROVIDES 'foobar'")
  580. runtime = True
  581. dependees = ["foo", "bar"]
  582. reasons = None
  583. close_matches = ["foibar", "footbar"]
  584. event2 = bb.event.NoProvider(item, runtime, dependees, reasons,
  585. close_matches)
  586. self.assertEqual(event2.isRuntime(), True)
  587. expected = ("Nothing RPROVIDES 'foobar' (but foo, bar RDEPENDS"
  588. " on or otherwise requires it). Close matches:\n"
  589. " foibar\n"
  590. " footbar")
  591. self.assertEqual(str(event2), expected)
  592. reasons = ["Item does not exist on database"]
  593. close_matches = ["foibar", "footbar"]
  594. event3 = bb.event.NoProvider(item, runtime, dependees, reasons,
  595. close_matches)
  596. expected = ("Nothing RPROVIDES 'foobar' (but foo, bar RDEPENDS"
  597. " on or otherwise requires it)\n"
  598. "Item does not exist on database")
  599. self.assertEqual(str(event3), expected)
  600. self.assertEqual(event3.pid, EventClassesTest._worker_pid)
  601. def test_MultipleProviders(self):
  602. """ Test MultipleProviders event class """
  603. item = "foobar"
  604. candidates = ["foobarv1", "foobars"]
  605. event1 = bb.event.MultipleProviders(item, candidates)
  606. self.assertEqual(event1.isRuntime(), False)
  607. self.assertEqual(event1.getItem(), item)
  608. self.assertEqual(event1.getCandidates(), candidates)
  609. expected = ("Multiple providers are available for foobar (foobarv1,"
  610. " foobars)\n"
  611. "Consider defining a PREFERRED_PROVIDER entry to match "
  612. "foobar")
  613. self.assertEqual(str(event1), expected)
  614. runtime = True
  615. event2 = bb.event.MultipleProviders(item, candidates, runtime)
  616. self.assertEqual(event2.isRuntime(), runtime)
  617. expected = ("Multiple providers are available for runtime foobar "
  618. "(foobarv1, foobars)\n"
  619. "Consider defining a PREFERRED_RPROVIDER entry to match "
  620. "foobar")
  621. self.assertEqual(str(event2), expected)
  622. self.assertEqual(event2.pid, EventClassesTest._worker_pid)
  623. def test_ParseStarted(self):
  624. """ Test ParseStarted event class """
  625. total = 123
  626. event = bb.event.ParseStarted(total)
  627. self.assertEqual(event.msg, "Recipe parsing Started")
  628. self.assertEqual(event.total, total)
  629. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  630. def test_ParseCompleted(self):
  631. """ Test ParseCompleted event class """
  632. cached = 10
  633. parsed = 13
  634. skipped = 7
  635. virtuals = 2
  636. masked = 1
  637. errors = 0
  638. total = 23
  639. event = bb.event.ParseCompleted(cached, parsed, skipped, masked,
  640. virtuals, errors, total)
  641. self.assertEqual(event.msg, "Recipe parsing Completed")
  642. expected = [cached, parsed, skipped, virtuals, masked, errors,
  643. cached + parsed, total]
  644. actual = [event.cached, event.parsed, event.skipped, event.virtuals,
  645. event.masked, event.errors, event.sofar, event.total]
  646. self.assertEqual(str(actual), str(expected))
  647. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  648. def test_ParseProgress(self):
  649. """ Test ParseProgress event class """
  650. current = 10
  651. total = 100
  652. event = bb.event.ParseProgress(current, total)
  653. self.assertEqual(event.msg,
  654. "Recipe parsing" + ": %s/%s" % (current, total))
  655. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  656. def test_CacheLoadStarted(self):
  657. """ Test CacheLoadStarted event class """
  658. total = 123
  659. event = bb.event.CacheLoadStarted(total)
  660. self.assertEqual(event.msg, "Loading cache Started")
  661. self.assertEqual(event.total, total)
  662. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  663. def test_CacheLoadProgress(self):
  664. """ Test CacheLoadProgress event class """
  665. current = 10
  666. total = 100
  667. event = bb.event.CacheLoadProgress(current, total)
  668. self.assertEqual(event.msg,
  669. "Loading cache" + ": %s/%s" % (current, total))
  670. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  671. def test_CacheLoadCompleted(self):
  672. """ Test CacheLoadCompleted event class """
  673. total = 23
  674. num_entries = 12
  675. event = bb.event.CacheLoadCompleted(total, num_entries)
  676. self.assertEqual(event.msg, "Loading cache Completed")
  677. expected = [total, num_entries]
  678. actual = [event.total, event.num_entries]
  679. self.assertEqual(str(actual), str(expected))
  680. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  681. def test_TreeDataPreparationStarted(self):
  682. """ Test TreeDataPreparationStarted event class """
  683. event = bb.event.TreeDataPreparationStarted()
  684. self.assertEqual(event.msg, "Preparing tree data Started")
  685. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  686. def test_TreeDataPreparationProgress(self):
  687. """ Test TreeDataPreparationProgress event class """
  688. current = 10
  689. total = 100
  690. event = bb.event.TreeDataPreparationProgress(current, total)
  691. self.assertEqual(event.msg,
  692. "Preparing tree data" + ": %s/%s" % (current, total))
  693. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  694. def test_TreeDataPreparationCompleted(self):
  695. """ Test TreeDataPreparationCompleted event class """
  696. total = 23
  697. event = bb.event.TreeDataPreparationCompleted(total)
  698. self.assertEqual(event.msg, "Preparing tree data Completed")
  699. self.assertEqual(event.total, total)
  700. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  701. def test_DepTreeGenerated(self):
  702. """ Test DepTreeGenerated event class """
  703. depgraph = Mock()
  704. event = bb.event.DepTreeGenerated(depgraph)
  705. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  706. def test_TargetsTreeGenerated(self):
  707. """ Test TargetsTreeGenerated event class """
  708. model = Mock()
  709. event = bb.event.TargetsTreeGenerated(model)
  710. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  711. def test_ReachableStamps(self):
  712. """ Test ReachableStamps event class """
  713. stamps = [Mock(), Mock()]
  714. event = bb.event.ReachableStamps(stamps)
  715. self.assertEqual(event.stamps, stamps)
  716. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  717. def test_FilesMatchingFound(self):
  718. """ Test FilesMatchingFound event class """
  719. pattern = "foo.*bar"
  720. matches = ["foobar"]
  721. event = bb.event.FilesMatchingFound(pattern, matches)
  722. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  723. def test_ConfigFilesFound(self):
  724. """ Test ConfigFilesFound event class """
  725. variable = "FOO_BAR"
  726. values = ["foo", "bar"]
  727. event = bb.event.ConfigFilesFound(variable, values)
  728. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  729. def test_ConfigFilePathFound(self):
  730. """ Test ConfigFilePathFound event class """
  731. path = "/foo/bar"
  732. event = bb.event.ConfigFilePathFound(path)
  733. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  734. def test_message_classes(self):
  735. """ Test message event classes """
  736. msg = "foobar foo bar"
  737. event = bb.event.MsgBase(msg)
  738. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  739. event = bb.event.MsgDebug(msg)
  740. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  741. event = bb.event.MsgNote(msg)
  742. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  743. event = bb.event.MsgWarn(msg)
  744. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  745. event = bb.event.MsgError(msg)
  746. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  747. event = bb.event.MsgFatal(msg)
  748. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  749. event = bb.event.MsgPlain(msg)
  750. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  751. def test_LogExecTTY(self):
  752. """ Test LogExecTTY event class """
  753. msg = "foo bar"
  754. prog = "foo.sh"
  755. sleep_delay = 10
  756. retries = 3
  757. event = bb.event.LogExecTTY(msg, prog, sleep_delay, retries)
  758. self.assertEqual(event.msg, msg)
  759. self.assertEqual(event.prog, prog)
  760. self.assertEqual(event.sleep_delay, sleep_delay)
  761. self.assertEqual(event.retries, retries)
  762. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  763. def _throw_zero_division_exception(self):
  764. a = 1 / 0
  765. return
  766. def _worker_handler(self, event, d):
  767. self._returned_event = event
  768. return
  769. def test_LogHandler(self):
  770. """ Test LogHandler class """
  771. logger = logging.getLogger("TestEventClasses")
  772. logger.propagate = False
  773. handler = bb.event.LogHandler(logging.INFO)
  774. logger.addHandler(handler)
  775. bb.event.worker_fire = self._worker_handler
  776. try:
  777. self._throw_zero_division_exception()
  778. except ZeroDivisionError as ex:
  779. logger.exception(ex)
  780. event = self._returned_event
  781. try:
  782. pe = pickle.dumps(event)
  783. newevent = pickle.loads(pe)
  784. except:
  785. self.fail('Logged event is not serializable')
  786. self.assertEqual(event.taskpid, EventClassesTest._worker_pid)
  787. def test_MetadataEvent(self):
  788. """ Test MetadataEvent class """
  789. eventtype = "footype"
  790. eventdata = {"foo": "bar"}
  791. event = bb.event.MetadataEvent(eventtype, eventdata)
  792. self.assertEqual(event.type, eventtype)
  793. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  794. def test_ProcessStarted(self):
  795. """ Test ProcessStarted class """
  796. processname = "foo"
  797. total = 9783128974
  798. event = bb.event.ProcessStarted(processname, total)
  799. self.assertEqual(event.processname, processname)
  800. self.assertEqual(event.total, total)
  801. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  802. def test_ProcessProgress(self):
  803. """ Test ProcessProgress class """
  804. processname = "foo"
  805. progress = 243224
  806. event = bb.event.ProcessProgress(processname, progress)
  807. self.assertEqual(event.processname, processname)
  808. self.assertEqual(event.progress, progress)
  809. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  810. def test_ProcessFinished(self):
  811. """ Test ProcessFinished class """
  812. processname = "foo"
  813. total = 1242342344
  814. event = bb.event.ProcessFinished(processname)
  815. self.assertEqual(event.processname, processname)
  816. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  817. def test_SanityCheck(self):
  818. """ Test SanityCheck class """
  819. event1 = bb.event.SanityCheck()
  820. self.assertEqual(event1.generateevents, True)
  821. self.assertEqual(event1.pid, EventClassesTest._worker_pid)
  822. generateevents = False
  823. event2 = bb.event.SanityCheck(generateevents)
  824. self.assertEqual(event2.generateevents, generateevents)
  825. self.assertEqual(event2.pid, EventClassesTest._worker_pid)
  826. def test_SanityCheckPassed(self):
  827. """ Test SanityCheckPassed class """
  828. event = bb.event.SanityCheckPassed()
  829. self.assertEqual(event.pid, EventClassesTest._worker_pid)
  830. def test_SanityCheckFailed(self):
  831. """ Test SanityCheckFailed class """
  832. msg = "The sanity test failed."
  833. event1 = bb.event.SanityCheckFailed(msg)
  834. self.assertEqual(event1.pid, EventClassesTest._worker_pid)
  835. network_error = True
  836. event2 = bb.event.SanityCheckFailed(msg, network_error)
  837. self.assertEqual(event2.pid, EventClassesTest._worker_pid)
  838. def test_network_event_classes(self):
  839. """ Test network event classes """
  840. event1 = bb.event.NetworkTest()
  841. generateevents = False
  842. self.assertEqual(event1.pid, EventClassesTest._worker_pid)
  843. event2 = bb.event.NetworkTest(generateevents)
  844. self.assertEqual(event2.pid, EventClassesTest._worker_pid)
  845. event3 = bb.event.NetworkTestPassed()
  846. self.assertEqual(event3.pid, EventClassesTest._worker_pid)
  847. event4 = bb.event.NetworkTestFailed()
  848. self.assertEqual(event4.pid, EventClassesTest._worker_pid)
  849. def test_FindSigInfoResult(self):
  850. """ Test FindSigInfoResult event class """
  851. result = [Mock()]
  852. event = bb.event.FindSigInfoResult(result)
  853. self.assertEqual(event.result, result)
  854. self.assertEqual(event.pid, EventClassesTest._worker_pid)