test_notifier.py 30 KB

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