test_notifier.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947
  1. # Copyright 2021-2025 Avaiga Private Limited
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  4. # the License. You may obtain a copy of the License at
  5. #
  6. # http://www.apache.org/licenses/LICENSE-2.0
  7. #
  8. # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
  9. # an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
  10. # specific language governing permissions and limitations under the License.
  11. from queue import SimpleQueue
  12. from taipy.common.config import Config, Frequency
  13. from taipy.core import taipy as tp
  14. from taipy.core._version._version_manager_factory import _VersionManagerFactory
  15. from taipy.core.notification import EventEntityType, EventOperation, _Registration
  16. from taipy.core.notification._topic import _Topic
  17. from taipy.core.notification.event import Event
  18. from taipy.core.notification.notifier import Notifier
  19. from taipy.core.scenario._scenario_manager_factory import _ScenarioManagerFactory
  20. from taipy.core.submission.submission_status import SubmissionStatus
  21. def test_register_unregister():
  22. def find_registration_and_topic(registration_id):
  23. for topic, registrations in Notifier._topics_registrations_list.items():
  24. for registration in registrations:
  25. if registration.registration_id == registration_id:
  26. return topic, registration
  27. assert len(Notifier._topics_registrations_list) == 0
  28. registration_id_0, register_queue_0 = Notifier.register()
  29. topic_0, registration_0 = find_registration_and_topic(registration_id_0)
  30. assert isinstance(registration_id_0, str) and registration_id_0 == registration_0.registration_id
  31. assert isinstance(register_queue_0, SimpleQueue)
  32. assert len(Notifier._topics_registrations_list.keys()) == 1
  33. assert len(Notifier._topics_registrations_list[topic_0]) == 1
  34. assert registration_0.queue == register_queue_0
  35. assert register_queue_0 in [registration.queue for registration in Notifier._topics_registrations_list[topic_0]]
  36. registration_id_1, register_queue_1 = Notifier.register()
  37. topic_1, registration_1 = find_registration_and_topic(registration_id_1)
  38. assert isinstance(registration_id_1, str) and registration_id_1 == registration_1.registration_id
  39. assert isinstance(register_queue_1, SimpleQueue)
  40. assert len(Notifier._topics_registrations_list.keys()) == 1
  41. assert len(Notifier._topics_registrations_list[topic_1]) == 2
  42. assert registration_1.queue == register_queue_1
  43. assert register_queue_1 in [registration.queue for registration in Notifier._topics_registrations_list[topic_1]]
  44. registration_id_2, register_queue_2 = Notifier.register(EventEntityType.SCENARIO)
  45. topic_2, registration_2 = find_registration_and_topic(registration_id_2)
  46. assert isinstance(registration_id_2, str) and registration_id_2 == registration_2.registration_id
  47. assert isinstance(register_queue_2, SimpleQueue)
  48. assert len(Notifier._topics_registrations_list.keys()) == 2
  49. assert len(Notifier._topics_registrations_list[topic_2]) == 1
  50. assert registration_2.queue == register_queue_2
  51. assert register_queue_2 in [registration.queue for registration in Notifier._topics_registrations_list[topic_2]]
  52. registration_id_3, register_queue_3 = Notifier.register(EventEntityType.SCENARIO, "scenario_id")
  53. topic_3, registration_3 = find_registration_and_topic(registration_id_3)
  54. assert isinstance(registration_id_3, str) and registration_id_3 == registration_3.registration_id
  55. assert isinstance(register_queue_3, SimpleQueue)
  56. assert len(Notifier._topics_registrations_list.keys()) == 3
  57. assert len(Notifier._topics_registrations_list[topic_3]) == 1
  58. assert registration_3.queue == register_queue_3
  59. assert register_queue_3 in [registration.queue for registration in Notifier._topics_registrations_list[topic_3]]
  60. registration_id_4, register_queue_4 = Notifier.register(
  61. EventEntityType.SEQUENCE, "sequence_id", EventOperation.UPDATE, "tasks"
  62. )
  63. topic_4, registration_4 = find_registration_and_topic(registration_id_4)
  64. assert isinstance(registration_id_4, str) and registration_id_4 == registration_4.registration_id
  65. assert isinstance(register_queue_4, SimpleQueue)
  66. assert len(Notifier._topics_registrations_list.keys()) == 4
  67. assert len(Notifier._topics_registrations_list[topic_4]) == 1
  68. assert registration_4.queue == register_queue_4
  69. assert register_queue_4 in [registration.queue for registration in Notifier._topics_registrations_list[topic_4]]
  70. registration_id_5, register_queue_5 = Notifier.register(EventEntityType.SCENARIO)
  71. topic_5, registration_5 = find_registration_and_topic(registration_id_5)
  72. assert topic_5 == topic_2
  73. assert registration_5 != registration_2
  74. assert isinstance(registration_id_5, str) and registration_id_5 == registration_5.registration_id
  75. assert isinstance(register_queue_5, SimpleQueue)
  76. assert len(Notifier._topics_registrations_list.keys()) == 4
  77. assert len(Notifier._topics_registrations_list[topic_5]) == 2
  78. assert registration_5.queue == register_queue_5
  79. assert register_queue_5 in [registration.queue for registration in Notifier._topics_registrations_list[topic_5]]
  80. registration_id_6, register_queue_6 = Notifier.register()
  81. topic_6, registration_6 = find_registration_and_topic(registration_id_6)
  82. assert topic_6 == topic_0
  83. assert registration_6 != registration_0
  84. assert len(Notifier._topics_registrations_list.keys()) == 4
  85. assert len(Notifier._topics_registrations_list[topic_6]) == 3
  86. Notifier.unregister(registration_id_6)
  87. assert len(Notifier._topics_registrations_list.keys()) == 4
  88. assert len(Notifier._topics_registrations_list[topic_6]) == 2
  89. Notifier.unregister(registration_id_4)
  90. assert len(Notifier._topics_registrations_list.keys()) == 3
  91. assert topic_4 not in Notifier._topics_registrations_list.keys()
  92. Notifier.unregister(registration_id_0)
  93. assert len(Notifier._topics_registrations_list.keys()) == 3
  94. assert len(Notifier._topics_registrations_list[topic_0]) == 1
  95. Notifier.unregister(registration_id_1)
  96. assert len(Notifier._topics_registrations_list.keys()) == 2
  97. assert all(topic not in Notifier._topics_registrations_list.keys() for topic in [topic_0, topic_1])
  98. Notifier.unregister(registration_id_2)
  99. Notifier.unregister(registration_id_3)
  100. Notifier.unregister(registration_id_5)
  101. assert len(Notifier._topics_registrations_list.keys()) == 0
  102. def test_matching():
  103. assert Notifier._is_matching(
  104. Event(entity_type=EventEntityType.CYCLE, entity_id="cycle_id", operation=EventOperation.CREATION), _Topic()
  105. )
  106. assert Notifier._is_matching(
  107. Event(entity_type=EventEntityType.CYCLE, entity_id="cycle_id", operation=EventOperation.CREATION),
  108. _Topic(EventEntityType.CYCLE),
  109. )
  110. assert Notifier._is_matching(
  111. Event(entity_type=EventEntityType.CYCLE, entity_id="cycle_id", operation=EventOperation.CREATION),
  112. _Topic(EventEntityType.CYCLE, "cycle_id"),
  113. )
  114. assert Notifier._is_matching(
  115. Event(entity_type=EventEntityType.CYCLE, entity_id="cycle_id", operation=EventOperation.CREATION),
  116. _Topic(operation=EventOperation.CREATION),
  117. )
  118. assert Notifier._is_matching(
  119. Event(entity_type=EventEntityType.CYCLE, entity_id="cycle_id", operation=EventOperation.CREATION),
  120. _Topic(EventEntityType.CYCLE, "cycle_id", EventOperation.CREATION),
  121. )
  122. assert Notifier._is_matching(
  123. Event(entity_type=EventEntityType.SCENARIO, entity_id="scenario_id", operation=EventOperation.SUBMISSION),
  124. _Topic(),
  125. )
  126. assert Notifier._is_matching(
  127. Event(entity_type=EventEntityType.SCENARIO, entity_id="scenario_id", operation=EventOperation.SUBMISSION),
  128. _Topic(EventEntityType.SCENARIO),
  129. )
  130. assert Notifier._is_matching(
  131. Event(entity_type=EventEntityType.SCENARIO, entity_id="scenario_id", operation=EventOperation.SUBMISSION),
  132. _Topic(
  133. EventEntityType.SCENARIO,
  134. "scenario_id",
  135. ),
  136. )
  137. assert Notifier._is_matching(
  138. Event(entity_type=EventEntityType.SCENARIO, entity_id="scenario_id", operation=EventOperation.SUBMISSION),
  139. _Topic(operation=EventOperation.SUBMISSION),
  140. )
  141. assert Notifier._is_matching(
  142. Event(entity_type=EventEntityType.SCENARIO, entity_id="scenario_id", operation=EventOperation.SUBMISSION),
  143. _Topic(EventEntityType.SCENARIO, "scenario_id", EventOperation.SUBMISSION),
  144. )
  145. assert Notifier._is_matching(
  146. Event(
  147. entity_type=EventEntityType.SEQUENCE,
  148. entity_id="sequence_id",
  149. operation=EventOperation.UPDATE,
  150. attribute_name=r"tasks",
  151. ),
  152. _Topic(),
  153. )
  154. assert Notifier._is_matching(
  155. Event(
  156. entity_type=EventEntityType.SEQUENCE,
  157. entity_id="sequence_id",
  158. operation=EventOperation.UPDATE,
  159. attribute_name="tasks",
  160. ),
  161. _Topic(EventEntityType.SEQUENCE),
  162. )
  163. assert Notifier._is_matching(
  164. Event(
  165. entity_type=EventEntityType.SEQUENCE,
  166. entity_id="sequence_id",
  167. operation=EventOperation.UPDATE,
  168. attribute_name="tasks",
  169. ),
  170. _Topic(
  171. EventEntityType.SEQUENCE,
  172. "sequence_id",
  173. ),
  174. )
  175. assert Notifier._is_matching(
  176. Event(
  177. entity_type=EventEntityType.SEQUENCE,
  178. entity_id="sequence_id",
  179. operation=EventOperation.UPDATE,
  180. attribute_name="tasks",
  181. ),
  182. _Topic(operation=EventOperation.UPDATE),
  183. )
  184. assert Notifier._is_matching(
  185. Event(
  186. entity_type=EventEntityType.SEQUENCE,
  187. entity_id="sequence_id",
  188. operation=EventOperation.UPDATE,
  189. attribute_name="tasks",
  190. ),
  191. _Topic(EventEntityType.SEQUENCE, "sequence_id", EventOperation.UPDATE),
  192. )
  193. assert Notifier._is_matching(
  194. Event(
  195. entity_type=EventEntityType.SEQUENCE,
  196. entity_id="sequence_id",
  197. operation=EventOperation.UPDATE,
  198. attribute_name="tasks",
  199. ),
  200. _Topic(attribute_name="tasks"),
  201. )
  202. assert Notifier._is_matching(
  203. Event(
  204. entity_type=EventEntityType.SEQUENCE,
  205. entity_id="sequence_id",
  206. operation=EventOperation.UPDATE,
  207. attribute_name="tasks",
  208. ),
  209. _Topic(EventEntityType.SEQUENCE, attribute_name="tasks"),
  210. )
  211. assert Notifier._is_matching(
  212. Event(
  213. entity_type=EventEntityType.SEQUENCE,
  214. entity_id="sequence_id",
  215. operation=EventOperation.UPDATE,
  216. attribute_name="tasks",
  217. ),
  218. _Topic(operation=EventOperation.UPDATE, attribute_name="tasks"),
  219. )
  220. assert Notifier._is_matching(
  221. Event(
  222. entity_type=EventEntityType.SEQUENCE,
  223. entity_id="sequence_id",
  224. operation=EventOperation.UPDATE,
  225. attribute_name="tasks",
  226. ),
  227. _Topic(EventEntityType.SEQUENCE, "sequence_id", EventOperation.UPDATE, "tasks"),
  228. )
  229. assert Notifier._is_matching(Event(EventEntityType.TASK, EventOperation.DELETION, "task_id"), _Topic())
  230. assert Notifier._is_matching(
  231. Event(EventEntityType.TASK, EventOperation.DELETION, "task_id"), _Topic(EventEntityType.TASK)
  232. )
  233. assert Notifier._is_matching(
  234. Event(entity_type=EventEntityType.TASK, entity_id="task_id", operation=EventOperation.DELETION),
  235. _Topic(
  236. EventEntityType.TASK,
  237. "task_id",
  238. ),
  239. )
  240. assert Notifier._is_matching(
  241. Event(entity_type=EventEntityType.TASK, entity_id="task_id", operation=EventOperation.DELETION),
  242. _Topic(operation=EventOperation.DELETION),
  243. )
  244. assert Notifier._is_matching(
  245. Event(entity_type=EventEntityType.TASK, entity_id="task_id", operation=EventOperation.DELETION),
  246. _Topic(EventEntityType.TASK, "task_id", EventOperation.DELETION),
  247. )
  248. assert not Notifier._is_matching(
  249. Event(entity_type=EventEntityType.DATA_NODE, entity_id="dn_id", operation=EventOperation.CREATION),
  250. _Topic(EventEntityType.CYCLE),
  251. )
  252. assert not Notifier._is_matching(
  253. Event(entity_type=EventEntityType.DATA_NODE, entity_id="dn_id", operation=EventOperation.CREATION),
  254. _Topic(EventEntityType.SCENARIO, "scenario_id"),
  255. )
  256. assert not Notifier._is_matching(
  257. Event(entity_type=EventEntityType.DATA_NODE, entity_id="dn_id", operation=EventOperation.CREATION),
  258. _Topic(EventEntityType.TASK, "task_id", EventOperation.CREATION),
  259. )
  260. assert not Notifier._is_matching(
  261. Event(entity_type=EventEntityType.JOB, entity_id="job_id", operation=EventOperation.DELETION),
  262. _Topic(EventEntityType.JOB, "job_id", EventOperation.CREATION),
  263. )
  264. assert not Notifier._is_matching(
  265. Event(entity_type=EventEntityType.JOB, entity_id="job_id", operation=EventOperation.DELETION),
  266. _Topic(EventEntityType.JOB, "job_id_1", EventOperation.DELETION),
  267. )
  268. assert not Notifier._is_matching(
  269. Event(
  270. entity_type=EventEntityType.JOB,
  271. entity_id="job_id",
  272. operation=EventOperation.UPDATE,
  273. attribute_name="status",
  274. ),
  275. _Topic(EventEntityType.JOB, "job_id", EventOperation.UPDATE, "submit_id"),
  276. )
  277. assert not Notifier._is_matching(
  278. Event(
  279. entity_type=EventEntityType.JOB,
  280. entity_id="job_id",
  281. operation=EventOperation.UPDATE,
  282. attribute_name="status",
  283. ),
  284. _Topic(operation=EventOperation.UPDATE, attribute_name="submit_id"),
  285. )
  286. def test_publish_creation_event():
  287. _, registration_queue = Notifier.register()
  288. dn_config = Config.configure_data_node("dn_config")
  289. task_config = Config.configure_task("task_config", print, [dn_config])
  290. scenario_config = Config.configure_scenario(
  291. "scenario_config", [task_config], frequency=Frequency.DAILY, properties={"flag": "test"}
  292. )
  293. scenario_config.add_sequences({"sequence_config": [task_config]})
  294. # Test CREATION Event
  295. scenario = _ScenarioManagerFactory._build_manager()._create(scenario_config)
  296. cycle = scenario.cycle
  297. task = scenario.tasks[task_config.id]
  298. dn = scenario.data_nodes[dn_config.id]
  299. sequence = scenario.sequences["sequence_config"]
  300. assert registration_queue.qsize() == 5
  301. published_events = []
  302. while registration_queue.qsize() != 0:
  303. published_events.append(registration_queue.get())
  304. expected_event_types = [
  305. EventEntityType.CYCLE,
  306. EventEntityType.DATA_NODE,
  307. EventEntityType.TASK,
  308. EventEntityType.SEQUENCE,
  309. EventEntityType.SCENARIO,
  310. ]
  311. expected_event_entity_id = [cycle.id, dn.id, task.id, sequence.id, scenario.id]
  312. assert all(
  313. event.entity_type == expected_event_types[i]
  314. and event.entity_id == expected_event_entity_id[i]
  315. and event.operation == EventOperation.CREATION
  316. and event.attribute_name is None
  317. for i, event in enumerate(published_events)
  318. )
  319. def test_publish_update_event():
  320. dn_config = Config.configure_data_node("dn_config")
  321. task_config = Config.configure_task("task_config", print, [dn_config])
  322. scenario_config = Config.configure_scenario(
  323. "scenario_config", [task_config], frequency=Frequency.DAILY, properties={"flag": "test"}
  324. )
  325. scenario_config.add_sequences({"sequence_config": [task_config]})
  326. _, registration_queue = Notifier.register()
  327. scenario = _ScenarioManagerFactory._build_manager()._create(scenario_config)
  328. cycle = scenario.cycle
  329. task = scenario.tasks[task_config.id]
  330. dn = scenario.data_nodes[dn_config.id]
  331. sequence = scenario.sequences["sequence_config"]
  332. assert registration_queue.qsize() == 5
  333. while registration_queue.qsize() > 0:
  334. registration_queue.get()
  335. # Test UPDATE Event
  336. scenario.is_primary = False
  337. assert registration_queue.qsize() == 1
  338. tp.set_primary(scenario)
  339. assert registration_queue.qsize() == 2
  340. tp.subscribe_scenario(print, None, scenario=scenario)
  341. assert registration_queue.qsize() == 3
  342. tp.unsubscribe_scenario(print, None, scenario=scenario)
  343. assert registration_queue.qsize() == 4
  344. tp.tag(scenario, "testing")
  345. assert registration_queue.qsize() == 5
  346. tp.untag(scenario, "testing")
  347. assert registration_queue.qsize() == 6
  348. scenario.properties["flag"] = "production"
  349. assert registration_queue.qsize() == 7
  350. scenario.properties.update({"description": "a scenario", "test_mult": True})
  351. assert registration_queue.qsize() == 9
  352. scenario.properties.pop("test_mult")
  353. assert registration_queue.qsize() == 10
  354. scenario.name = "my_scenario"
  355. assert registration_queue.qsize() == 11
  356. cycle.name = "new cycle name"
  357. assert registration_queue.qsize() == 12
  358. cycle.properties["valid"] = True
  359. assert registration_queue.qsize() == 13
  360. cycle.properties.update({"re_run_periodically": True})
  361. assert registration_queue.qsize() == 14
  362. cycle.properties.pop("re_run_periodically")
  363. assert registration_queue.qsize() == 15
  364. sequence.properties["name"] = "weather_forecast"
  365. assert registration_queue.qsize() == 16
  366. tp.subscribe_sequence(print, None, sequence)
  367. assert registration_queue.qsize() == 17
  368. tp.unsubscribe_sequence(print, None, sequence)
  369. assert registration_queue.qsize() == 18
  370. task.skippable = True
  371. assert registration_queue.qsize() == 19
  372. task.properties["number_of_run"] = 2
  373. assert registration_queue.qsize() == 20
  374. task.properties.update({"debug": True})
  375. assert registration_queue.qsize() == 21
  376. task.properties.pop("debug")
  377. assert registration_queue.qsize() == 22
  378. dn.editor_id = "new editor id"
  379. assert registration_queue.qsize() == 23
  380. dn.properties["sorted"] = True
  381. assert registration_queue.qsize() == 24
  382. dn.properties.update({"only_fetch_first_100": True})
  383. assert registration_queue.qsize() == 25
  384. dn.properties.pop("only_fetch_first_100")
  385. assert registration_queue.qsize() == 26
  386. published_events = []
  387. while registration_queue.qsize() != 0:
  388. published_events.append(registration_queue.get())
  389. expected_event_types = [
  390. EventEntityType.SCENARIO,
  391. EventEntityType.SCENARIO,
  392. EventEntityType.SCENARIO,
  393. EventEntityType.SCENARIO,
  394. EventEntityType.SCENARIO,
  395. EventEntityType.SCENARIO,
  396. EventEntityType.SCENARIO,
  397. EventEntityType.SCENARIO,
  398. EventEntityType.SCENARIO,
  399. EventEntityType.SCENARIO,
  400. EventEntityType.SCENARIO,
  401. EventEntityType.CYCLE,
  402. EventEntityType.CYCLE,
  403. EventEntityType.CYCLE,
  404. EventEntityType.CYCLE,
  405. EventEntityType.SEQUENCE,
  406. EventEntityType.SEQUENCE,
  407. EventEntityType.SEQUENCE,
  408. EventEntityType.TASK,
  409. EventEntityType.TASK,
  410. EventEntityType.TASK,
  411. EventEntityType.TASK,
  412. EventEntityType.DATA_NODE,
  413. EventEntityType.DATA_NODE,
  414. EventEntityType.DATA_NODE,
  415. EventEntityType.DATA_NODE,
  416. ]
  417. expected_attribute_names = [
  418. "is_primary",
  419. "is_primary",
  420. "subscribers",
  421. "subscribers",
  422. "tags",
  423. "tags",
  424. "properties",
  425. "properties",
  426. "properties",
  427. "properties",
  428. "properties",
  429. "name",
  430. "properties",
  431. "properties",
  432. "properties",
  433. "properties",
  434. "subscribers",
  435. "subscribers",
  436. "skippable",
  437. "properties",
  438. "properties",
  439. "properties",
  440. "editor_id",
  441. "properties",
  442. "properties",
  443. "properties",
  444. ]
  445. expected_event_entity_id = [
  446. scenario.id,
  447. scenario.id,
  448. scenario.id,
  449. scenario.id,
  450. scenario.id,
  451. scenario.id,
  452. scenario.id,
  453. scenario.id,
  454. scenario.id,
  455. scenario.id,
  456. scenario.id,
  457. cycle.id,
  458. cycle.id,
  459. cycle.id,
  460. cycle.id,
  461. sequence.id,
  462. sequence.id,
  463. sequence.id,
  464. task.id,
  465. task.id,
  466. task.id,
  467. task.id,
  468. dn.id,
  469. dn.id,
  470. dn.id,
  471. dn.id,
  472. ]
  473. expected_event_operation_type = [EventOperation.UPDATE] * len(expected_event_types)
  474. assert all(
  475. event.entity_type == expected_event_types[i]
  476. and event.entity_id == expected_event_entity_id[i]
  477. and event.operation == expected_event_operation_type[i]
  478. and event.attribute_name == expected_attribute_names[i]
  479. for i, event in enumerate(published_events)
  480. )
  481. def test_publish_update_event_in_context_manager():
  482. dn_config = Config.configure_data_node("dn_config")
  483. task_config = Config.configure_task("task_config", print, [dn_config])
  484. scenario_config = Config.configure_scenario(
  485. "scenario_config", [task_config], frequency=Frequency.DAILY, properties={"flag": "test"}
  486. )
  487. scenario_config.add_sequences({"sequence_config": [task_config]})
  488. _, registration_queue = Notifier.register()
  489. scenario = _ScenarioManagerFactory._build_manager()._create(scenario_config)
  490. cycle = scenario.cycle
  491. task = scenario.tasks[task_config.id]
  492. dn = scenario.data_nodes[dn_config.id]
  493. sequence = scenario.sequences["sequence_config"]
  494. scenario.properties.update({"description": "a scenario"})
  495. assert registration_queue.qsize() == 6
  496. while registration_queue.qsize() > 0:
  497. registration_queue.get()
  498. # Test UPDATE Event in Context Manager
  499. assert registration_queue.qsize() == 0
  500. # If multiple entities is in context, the last to enter will be the first to exit
  501. # So the published event will have the order starting with scenario first and ending with dn
  502. with dn as d, task as t, sequence as s, cycle as c, scenario as sc:
  503. sc.is_primary = True
  504. assert registration_queue.qsize() == 0
  505. tp.set_primary(sc)
  506. assert registration_queue.qsize() == 0
  507. sc.properties["flag"] = "production"
  508. assert registration_queue.qsize() == 0
  509. sc.properties.update({"description": "a scenario"})
  510. assert registration_queue.qsize() == 0
  511. sc.properties.pop("description")
  512. assert registration_queue.qsize() == 0
  513. sc.name = "my_scenario"
  514. assert registration_queue.qsize() == 0
  515. c.name = "another new cycle name"
  516. assert registration_queue.qsize() == 0
  517. c.properties["valid"] = True
  518. assert registration_queue.qsize() == 0
  519. c.properties.update({"re_run_periodically": True})
  520. assert registration_queue.qsize() == 0
  521. s.properties["name"] = "weather_forecast"
  522. assert registration_queue.qsize() == 0
  523. t.skippable = True
  524. assert registration_queue.qsize() == 0
  525. t.properties["number_of_run"] = 2
  526. assert registration_queue.qsize() == 0
  527. t.properties.update({"debug": True})
  528. assert registration_queue.qsize() == 0
  529. d.editor_id = "another new editor id"
  530. assert registration_queue.qsize() == 0
  531. d.properties["sorted"] = True
  532. assert registration_queue.qsize() == 0
  533. d.properties.update({"only_fetch_first_100": True})
  534. assert registration_queue.qsize() == 0
  535. published_events = []
  536. assert registration_queue.qsize() == 16
  537. while registration_queue.qsize() != 0:
  538. published_events.append(registration_queue.get())
  539. expected_event_types = [
  540. EventEntityType.SCENARIO,
  541. EventEntityType.SCENARIO,
  542. EventEntityType.SCENARIO,
  543. EventEntityType.SCENARIO,
  544. EventEntityType.SCENARIO,
  545. EventEntityType.SCENARIO,
  546. EventEntityType.CYCLE,
  547. EventEntityType.CYCLE,
  548. EventEntityType.CYCLE,
  549. EventEntityType.SEQUENCE,
  550. EventEntityType.TASK,
  551. EventEntityType.TASK,
  552. EventEntityType.TASK,
  553. EventEntityType.DATA_NODE,
  554. EventEntityType.DATA_NODE,
  555. EventEntityType.DATA_NODE,
  556. ]
  557. expected_attribute_names = [
  558. "is_primary",
  559. "is_primary",
  560. "properties",
  561. "properties",
  562. "properties",
  563. "properties",
  564. "name",
  565. "properties",
  566. "properties",
  567. "properties",
  568. "skippable",
  569. "properties",
  570. "properties",
  571. "editor_id",
  572. "properties",
  573. "properties",
  574. ]
  575. expected_event_entity_id = [
  576. scenario.id,
  577. scenario.id,
  578. scenario.id,
  579. scenario.id,
  580. scenario.id,
  581. scenario.id,
  582. cycle.id,
  583. cycle.id,
  584. cycle.id,
  585. sequence.id,
  586. task.id,
  587. task.id,
  588. task.id,
  589. dn.id,
  590. dn.id,
  591. dn.id,
  592. ]
  593. assert all(
  594. event.entity_type == expected_event_types[i]
  595. and event.entity_id == expected_event_entity_id[i]
  596. and event.operation == EventOperation.UPDATE
  597. and event.attribute_name == expected_attribute_names[i]
  598. for i, event in enumerate(published_events)
  599. )
  600. def test_publish_submission_event():
  601. _, registration_queue = Notifier.register()
  602. dn_config = Config.configure_data_node("dn_config")
  603. task_config = Config.configure_task("task_config", print, [dn_config])
  604. scenario_config = Config.configure_scenario(
  605. "scenario_config", [task_config], frequency=Frequency.DAILY, properties={"flag": "test"}
  606. )
  607. scenario_config.add_sequences({"sequence_config": [task_config]})
  608. scenario = _ScenarioManagerFactory._build_manager()._create(scenario_config)
  609. assert registration_queue.qsize() == 5
  610. while registration_queue.qsize() > 0:
  611. registration_queue.get()
  612. # Test SUBMISSION Event
  613. submission = scenario.submit()
  614. job = submission.jobs[0]
  615. assert registration_queue.qsize() == 6
  616. published_events = []
  617. while registration_queue.qsize() != 0:
  618. published_events.append(registration_queue.get())
  619. expected_operations = [
  620. EventOperation.CREATION,
  621. EventOperation.CREATION,
  622. EventOperation.UPDATE,
  623. EventOperation.UPDATE,
  624. EventOperation.UPDATE,
  625. EventOperation.SUBMISSION,
  626. ]
  627. expected_attribute_names = [None, None, "jobs", "status", "submission_status", None]
  628. expected_event_types = [
  629. EventEntityType.SUBMISSION,
  630. EventEntityType.JOB,
  631. EventEntityType.SUBMISSION,
  632. EventEntityType.JOB,
  633. EventEntityType.SUBMISSION,
  634. EventEntityType.SCENARIO,
  635. ]
  636. expected_event_entity_id = [submission.id, job.id, submission.id, job.id, submission.id, scenario.id]
  637. assert all(
  638. event.entity_type == expected_event_types[i]
  639. and event.entity_id == expected_event_entity_id[i]
  640. and event.operation == expected_operations[i]
  641. and event.attribute_name == expected_attribute_names[i]
  642. for i, event in enumerate(published_events)
  643. )
  644. assert "job_triggered_submission_status_changed" in published_events[4].metadata
  645. assert published_events[4].metadata["job_triggered_submission_status_changed"] == job.id
  646. # Test updating submission_status manually will not add the job_triggered_submission_status_changed
  647. # to the metadata as no job was used to update the submission_status
  648. submission.submission_status = SubmissionStatus.CANCELED
  649. assert registration_queue.qsize() == 1
  650. published_event = registration_queue.get()
  651. assert published_event.entity_type == EventEntityType.SUBMISSION
  652. assert published_event.entity_id == submission.id
  653. assert published_event.operation == EventOperation.UPDATE
  654. assert published_event.attribute_name == "submission_status"
  655. assert "job_triggered_submission_status_changed" not in published_event.metadata
  656. def test_publish_deletion_event():
  657. _, registration_queue = Notifier.register()
  658. dn_config = Config.configure_data_node("dn_config")
  659. task_config = Config.configure_task("task_config", print, [dn_config])
  660. scenario_config = Config.configure_scenario(
  661. "scenario_config", [task_config], frequency=Frequency.DAILY, properties={"flag": "test"}
  662. )
  663. scenario_config.add_sequences({"sequence_config": [task_config]})
  664. scenario = _ScenarioManagerFactory._build_manager()._create(scenario_config)
  665. cycle = scenario.cycle
  666. task = scenario.tasks[task_config.id]
  667. dn = scenario.data_nodes[dn_config.id]
  668. sequence = scenario.sequences["sequence_config"]
  669. submission = scenario.submit()
  670. job = submission.jobs[0]
  671. assert registration_queue.qsize() == 11
  672. while registration_queue.qsize() > 0:
  673. registration_queue.get()
  674. # Test DELETION Event
  675. tp.delete(scenario.id)
  676. assert registration_queue.qsize() == 7
  677. published_events = []
  678. while registration_queue.qsize() != 0:
  679. published_events.append(registration_queue.get())
  680. expected_event_types = [
  681. EventEntityType.CYCLE,
  682. EventEntityType.SEQUENCE,
  683. EventEntityType.SCENARIO,
  684. EventEntityType.TASK,
  685. EventEntityType.JOB,
  686. EventEntityType.DATA_NODE,
  687. EventEntityType.SUBMISSION,
  688. ]
  689. expected_event_entity_id = [cycle.id, sequence.id, scenario.id, task.id, job.id, dn.id, submission.id]
  690. expected_event_operation_type = [EventOperation.DELETION] * len(expected_event_types)
  691. assert all(
  692. event.entity_type == expected_event_types[i]
  693. and event.entity_id == expected_event_entity_id[i]
  694. and event.operation == expected_event_operation_type[i]
  695. and event.attribute_name is None
  696. for i, event in enumerate(published_events)
  697. )
  698. scenario = _ScenarioManagerFactory._build_manager()._create(scenario_config)
  699. cycle = scenario.cycle
  700. assert registration_queue.qsize() == 5
  701. # only to clear the queue
  702. while registration_queue.qsize() != 0:
  703. registration_queue.get()
  704. tp.clean_all_entities(_VersionManagerFactory._build_manager()._get_latest_version())
  705. assert registration_queue.qsize() == 6
  706. published_events = []
  707. while registration_queue.qsize() != 0:
  708. published_events.append(registration_queue.get())
  709. expected_event_types = [
  710. EventEntityType.JOB,
  711. EventEntityType.SUBMISSION,
  712. EventEntityType.CYCLE,
  713. EventEntityType.SCENARIO,
  714. EventEntityType.TASK,
  715. EventEntityType.DATA_NODE,
  716. ]
  717. expected_event_entity_id = [None, None, cycle.id, scenario.id, None, None]
  718. assert all(
  719. event.entity_type == expected_event_types[i]
  720. and event.entity_id == expected_event_entity_id[i]
  721. and event.operation == EventOperation.DELETION
  722. and event.attribute_name is None
  723. for i, event in enumerate(published_events)
  724. )
  725. def find_registration_and_topics(registration_id: str):
  726. topics = set()
  727. registration = None
  728. for topic, registrations in Notifier._topics_registrations_list.items():
  729. for reg in registrations:
  730. if reg.registration_id == registration_id:
  731. topics.add(topic)
  732. registration = reg
  733. break
  734. return topics, registration
  735. def test_register_no_topic():
  736. assert len(Notifier._topics_registrations_list) == 0
  737. empty_registration = _Registration()
  738. id, queue = Notifier._register_from_registration(empty_registration)
  739. assert id == empty_registration.registration_id
  740. assert queue == empty_registration.queue
  741. assert len(Notifier._topics_registrations_list) == 0
  742. retrieved_topics, retrieved_registration = find_registration_and_topics(id)
  743. assert retrieved_topics == set()
  744. assert retrieved_registration is None
  745. # Unregister the registration
  746. Notifier.unregister(id)
  747. assert len(Notifier._topics_registrations_list) == 0
  748. retrieved_topics, retrieved_registration = find_registration_and_topics(id)
  749. assert retrieved_topics == set()
  750. assert retrieved_registration is None
  751. def test_register_multiple_topics():
  752. assert len(Notifier._topics_registrations_list) == 0
  753. # Registration_0 with 4 topics
  754. registration_0 = _Registration()
  755. registration_0.add_topic(EventEntityType.SCENARIO)
  756. registration_0.add_topic(EventEntityType.TASK, "task_id")
  757. registration_0.add_topic(EventEntityType.DATA_NODE, operation=EventOperation.CREATION)
  758. registration_0.add_topic(operation=EventOperation.DELETION)
  759. id_0, queue_0 = Notifier._register_from_registration(registration_0)
  760. assert id_0 == registration_0.registration_id
  761. assert queue_0 == registration_0.queue
  762. assert len(registration_0.topics) == 4
  763. assert len(Notifier._topics_registrations_list) == 4
  764. for topic in registration_0.topics:
  765. assert topic in Notifier._topics_registrations_list
  766. assert len(Notifier._topics_registrations_list[topic]) == 1
  767. assert registration_0 in Notifier._topics_registrations_list[topic]
  768. retrieved_topics, retrieved_registration = find_registration_and_topics(id_0)
  769. assert retrieved_topics == registration_0.topics
  770. assert retrieved_registration == registration_0
  771. # Registration_1 with 3 common topics and 1 new topic
  772. registration_1 = _Registration()
  773. registration_1.add_topic(EventEntityType.SCENARIO)
  774. registration_1.add_topic(EventEntityType.TASK, "task_id")
  775. registration_1.add_topic(EventEntityType.DATA_NODE, operation=EventOperation.UPDATE)
  776. registration_1.add_topic(operation=EventOperation.DELETION)
  777. id_1, queue_1 = Notifier._register_from_registration(registration_1)
  778. retrieved_topics, retrieved_registration = find_registration_and_topics(id_1)
  779. assert retrieved_topics == registration_1.topics
  780. assert retrieved_registration == registration_1 != registration_0
  781. assert id_1 == registration_1.registration_id != id_0
  782. assert queue_1 == registration_1.queue != queue_0
  783. assert len(registration_1.topics) == 4
  784. assert len(Notifier._topics_registrations_list) == 5
  785. for topic in registration_1.topics:
  786. assert topic in Notifier._topics_registrations_list
  787. if topic.operation == EventOperation.UPDATE:
  788. assert len(Notifier._topics_registrations_list[topic]) == 1
  789. else:
  790. assert len(Notifier._topics_registrations_list[topic]) == 2
  791. assert registration_1 in Notifier._topics_registrations_list[topic]
  792. # Unregister registration_0
  793. Notifier.unregister(id_0)
  794. retrieved_topics, retrieved_registration = find_registration_and_topics(id_0)
  795. assert retrieved_topics == set()
  796. assert retrieved_registration is None
  797. assert len(Notifier._topics_registrations_list) == 4 # The 4 topics from registration_1
  798. for topic in registration_1.topics:
  799. assert topic in Notifier._topics_registrations_list
  800. assert len(Notifier._topics_registrations_list[topic]) == 1
  801. assert registration_1 in Notifier._topics_registrations_list[topic]
  802. # Unregister registration_1
  803. Notifier.unregister(id_1)
  804. retrieved_topics, retrieved_registration = find_registration_and_topics(id_1)
  805. assert retrieved_topics == set()
  806. assert retrieved_registration is None
  807. assert len(Notifier._topics_registrations_list) == 0