test_sequence_manager.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893
  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 typing import Callable, Iterable, Optional
  12. from unittest import mock
  13. from unittest.mock import ANY
  14. import pytest
  15. from taipy import Scope
  16. from taipy.common.config import Config
  17. from taipy.core._orchestrator._orchestrator import _Orchestrator
  18. from taipy.core._version._version_manager import _VersionManager
  19. from taipy.core.common import _utils
  20. from taipy.core.common._utils import _Subscriber
  21. from taipy.core.data._data_manager import _DataManager
  22. from taipy.core.data.in_memory import InMemoryDataNode
  23. from taipy.core.exceptions.exceptions import (
  24. InvalidSequenceId,
  25. ModelNotFound,
  26. NonExistingSequence,
  27. SequenceAlreadyExists,
  28. SequenceBelongsToNonExistingScenario,
  29. )
  30. from taipy.core.job._job_manager import _JobManager
  31. from taipy.core.scenario._scenario_manager import _ScenarioManager
  32. from taipy.core.scenario.scenario import Scenario
  33. from taipy.core.sequence._sequence_manager import _SequenceManager
  34. from taipy.core.sequence._sequence_manager_factory import _SequenceManagerFactory
  35. from taipy.core.sequence.sequence import Sequence
  36. from taipy.core.sequence.sequence_id import SequenceId
  37. from taipy.core.task._task_manager import _TaskManager
  38. from taipy.core.task.task import Task
  39. from taipy.core.task.task_id import TaskId
  40. from tests.core.utils.NotifyMock import NotifyMock
  41. def test_breakdown_sequence_id():
  42. with pytest.raises(InvalidSequenceId):
  43. _SequenceManager._breakdown_sequence_id("scenario_id")
  44. with pytest.raises(InvalidSequenceId):
  45. _SequenceManager._breakdown_sequence_id("sequence_id")
  46. with pytest.raises(InvalidSequenceId):
  47. _SequenceManager._breakdown_sequence_id("SEQUENCE_sequence_id")
  48. with pytest.raises(InvalidSequenceId):
  49. _SequenceManager._breakdown_sequence_id("SCENARIO_scenario_id")
  50. with pytest.raises(InvalidSequenceId):
  51. _SequenceManager._breakdown_sequence_id("sequence_SCENARIO_scenario_id")
  52. with pytest.raises(InvalidSequenceId):
  53. _SequenceManager._breakdown_sequence_id("SEQUENCE_sequence_scenario_id")
  54. sequence_name, scenario_id = _SequenceManager._breakdown_sequence_id("SEQUENCE_sequence_SCENARIO_scenario")
  55. assert sequence_name == "sequence" and scenario_id == "SCENARIO_scenario"
  56. sequence_name, scenario_id = _SequenceManager._breakdown_sequence_id("SEQUENCEsequenceSCENARIO_scenario")
  57. assert sequence_name == "sequence" and scenario_id == "SCENARIO_scenario"
  58. def test_raise_sequence_does_not_belong_to_scenario():
  59. with pytest.raises(SequenceBelongsToNonExistingScenario):
  60. sequence = Sequence({"name": "sequence_name"}, [], "SEQUENCE_sequence_name_SCENARIO_scenario_id")
  61. _SequenceManager._update(sequence)
  62. def __init():
  63. input_dn = InMemoryDataNode("foo", Scope.SCENARIO)
  64. output_dn = InMemoryDataNode("foo", Scope.SCENARIO)
  65. task = Task("task", {}, print, [input_dn], [output_dn], TaskId("Task_task_id"))
  66. _TaskManager._create(task)
  67. scenario = Scenario("scenario", {task}, {}, set())
  68. _ScenarioManager._repository._save(scenario)
  69. return scenario, task
  70. def test_save_and_get_sequence_no_existing_sequence():
  71. scenario, _ = __init()
  72. sequence_name_1 = "p1"
  73. sequence_id_1 = SequenceId(f"SEQUENCE_{sequence_name_1}_{scenario.id}")
  74. sequence_name_2 = "p2"
  75. sequence_id_2 = SequenceId(f"SEQUENCE_{sequence_name_2}_{scenario.id}")
  76. assert _SequenceManager._get(sequence_id_1) is None
  77. assert _SequenceManager._get(sequence_id_2) is None
  78. assert _SequenceManager._get("sequence") is None
  79. def test_save_and_get():
  80. scenario, task = __init()
  81. sequence_name_1 = "p1"
  82. sequence_id_1 = SequenceId(f"SEQUENCE_{sequence_name_1}_{scenario.id}")
  83. sequence_name_2 = "p2"
  84. sequence_id_2 = SequenceId(f"SEQUENCE_{sequence_name_2}_{scenario.id}")
  85. scenario.add_sequences({sequence_name_1: []})
  86. sequence_1 = scenario.sequences[sequence_name_1]
  87. assert _SequenceManager._get(sequence_id_1).id == sequence_1.id
  88. assert len(_SequenceManager._get(sequence_id_1).tasks) == 0
  89. assert _SequenceManager._get(sequence_1).id == sequence_1.id
  90. assert len(_SequenceManager._get(sequence_1).tasks) == 0
  91. assert _SequenceManager._get(sequence_id_2) is None
  92. # Save a second sequence. Now, we expect to have a total of two sequences stored
  93. scenario.add_sequences({sequence_name_2: [task]})
  94. sequence_2 = scenario.sequences[sequence_name_2]
  95. assert _SequenceManager._get(sequence_id_1).id == sequence_1.id
  96. assert len(_SequenceManager._get(sequence_id_1).tasks) == 0
  97. assert _SequenceManager._get(sequence_1).id == sequence_1.id
  98. assert len(_SequenceManager._get(sequence_1).tasks) == 0
  99. assert _SequenceManager._get(sequence_id_2).id == sequence_2.id
  100. assert len(_SequenceManager._get(sequence_id_2).tasks) == 1
  101. assert _SequenceManager._get(sequence_2).id == sequence_2.id
  102. assert len(_SequenceManager._get(sequence_2).tasks) == 1
  103. assert _TaskManager._get(task.id).id == task.id
  104. # We save the first sequence again. We expect an exception and nothing to change
  105. with pytest.raises(SequenceAlreadyExists):
  106. scenario.add_sequence(sequence_name_1, [])
  107. sequence_1 = scenario.sequences[sequence_name_1]
  108. assert _SequenceManager._get(sequence_id_1).id == sequence_1.id
  109. assert len(_SequenceManager._get(sequence_id_1).tasks) == 0
  110. assert _SequenceManager._get(sequence_1).id == sequence_1.id
  111. assert len(_SequenceManager._get(sequence_1).tasks) == 0
  112. assert _SequenceManager._get(sequence_id_2).id == sequence_2.id
  113. assert len(_SequenceManager._get(sequence_id_2).tasks) == 1
  114. assert _SequenceManager._get(sequence_2).id == sequence_2.id
  115. assert len(_SequenceManager._get(sequence_2).tasks) == 1
  116. assert _TaskManager._get(task.id).id == task.id
  117. def test_task_parent_id_set_only_when_create():
  118. scenario, task = __init()
  119. sequence_name_1 = "p1"
  120. with mock.patch("taipy.core.task._task_manager._TaskManager._update") as mck:
  121. scenario.add_sequences({sequence_name_1: [task]})
  122. mck.assert_called_once()
  123. with mock.patch("taipy.core.task._task_manager._TaskManager._update") as mck:
  124. scenario.sequences[sequence_name_1]
  125. mck.assert_not_called()
  126. def test_get_all_on_multiple_versions_environment():
  127. # Create 5 sequences from Scenario with 2 versions each
  128. for version in range(1, 3):
  129. for i in range(5):
  130. _ScenarioManager._repository._save(
  131. Scenario(
  132. f"config_id_{i+version}",
  133. [],
  134. {},
  135. [],
  136. f"SCENARIO_id_{i}_v{version}",
  137. version=f"{version}.0",
  138. sequences={"sequence": {}},
  139. )
  140. )
  141. _VersionManager._set_experiment_version("1.0")
  142. assert len(_SequenceManager._get_all()) == 5
  143. assert (
  144. len(_SequenceManager._get_all_by(filters=[{"version": "1.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v1"}])) == 1
  145. )
  146. assert (
  147. len(_SequenceManager._get_all_by(filters=[{"version": "2.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v1"}])) == 0
  148. )
  149. _VersionManager._set_experiment_version("2.0")
  150. assert len(_SequenceManager._get_all()) == 5
  151. assert (
  152. len(_SequenceManager._get_all_by(filters=[{"version": "2.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v1"}])) == 0
  153. )
  154. assert (
  155. len(_SequenceManager._get_all_by(filters=[{"version": "2.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v2"}])) == 1
  156. )
  157. _VersionManager._set_development_version("1.0")
  158. assert len(_SequenceManager._get_all()) == 5
  159. assert (
  160. len(_SequenceManager._get_all_by(filters=[{"version": "1.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v1"}])) == 1
  161. )
  162. assert (
  163. len(_SequenceManager._get_all_by(filters=[{"version": "1.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v2"}])) == 0
  164. )
  165. _VersionManager._set_development_version("2.0")
  166. assert len(_SequenceManager._get_all()) == 5
  167. assert (
  168. len(_SequenceManager._get_all_by(filters=[{"version": "2.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v1"}])) == 0
  169. )
  170. assert (
  171. len(_SequenceManager._get_all_by(filters=[{"version": "2.0", "id": "SEQUENCE_sequence_SCENARIO_id_1_v2"}])) == 1
  172. )
  173. def test_is_submittable():
  174. dn = InMemoryDataNode("dn", Scope.SCENARIO, properties={"default_data": 10})
  175. task = Task("task", {}, print, [dn])
  176. _TaskManager._create(task)
  177. scenario = Scenario("scenario", {task}, {}, set())
  178. _ScenarioManager._repository._save(scenario)
  179. rc = _SequenceManager._is_submittable("some_sequence")
  180. assert not rc
  181. assert "Entity 'some_sequence' does not exist in the repository." in rc.reasons
  182. scenario.add_sequences({"sequence": [task]})
  183. sequence = scenario.sequences["sequence"]
  184. assert len(_SequenceManager._get_all()) == 1
  185. assert _SequenceManager._is_submittable(sequence)
  186. assert _SequenceManager._is_submittable(sequence.id)
  187. assert not _SequenceManager._is_submittable("Sequence_temp")
  188. assert not _SequenceManager._is_submittable("SEQUENCE_temp_SCENARIO_scenario")
  189. scenario.dn.edit_in_progress = True
  190. assert not _SequenceManager._is_submittable(sequence)
  191. assert not _SequenceManager._is_submittable(sequence.id)
  192. scenario.dn.edit_in_progress = False
  193. assert _SequenceManager._is_submittable(sequence)
  194. assert _SequenceManager._is_submittable(sequence.id)
  195. def test_submit():
  196. data_node_1 = InMemoryDataNode("foo", Scope.SCENARIO, "s1")
  197. data_node_2 = InMemoryDataNode("bar", Scope.SCENARIO, "s2")
  198. data_node_3 = InMemoryDataNode("baz", Scope.SCENARIO, "s3")
  199. data_node_4 = InMemoryDataNode("qux", Scope.SCENARIO, "s4")
  200. data_node_5 = InMemoryDataNode("quux", Scope.SCENARIO, "s5")
  201. data_node_6 = InMemoryDataNode("quuz", Scope.SCENARIO, "s6")
  202. data_node_7 = InMemoryDataNode("corge", Scope.SCENARIO, "s7")
  203. task_1 = Task(
  204. "grault",
  205. {},
  206. print,
  207. [data_node_1, data_node_2],
  208. [data_node_3, data_node_4],
  209. TaskId("t1"),
  210. )
  211. task_2 = Task("garply", {}, print, [data_node_3], [data_node_5], TaskId("t2"))
  212. task_3 = Task("waldo", {}, print, [data_node_5, data_node_4], [data_node_6], TaskId("t3"))
  213. task_4 = Task("fred", {}, print, [data_node_4], [data_node_7], TaskId("t4"))
  214. _TaskManager._create(task_1)
  215. _TaskManager._create(task_2)
  216. _TaskManager._create(task_3)
  217. _TaskManager._create(task_4)
  218. scenario = Scenario("sce", {task_1, task_2, task_3, task_4}, {})
  219. sequence_name = "sequence"
  220. sequence_id = Sequence._new_id(sequence_name, scenario.id)
  221. class MockOrchestrator(_Orchestrator):
  222. submit_calls = []
  223. @classmethod
  224. def _lock_dn_output_and_create_job(
  225. cls,
  226. task: Task,
  227. submit_id: str,
  228. submit_entity_id: str,
  229. callbacks: Optional[Iterable[Callable]] = None,
  230. force: bool = False,
  231. ):
  232. cls.submit_calls.append(task)
  233. return super()._lock_dn_output_and_create_job(task, submit_id, submit_entity_id, callbacks, force)
  234. with mock.patch("taipy.core.task._task_manager._TaskManager._orchestrator", new=MockOrchestrator):
  235. # sequence does not exist. We expect an exception to be raised
  236. with pytest.raises(NonExistingSequence):
  237. _SequenceManager._submit(sequence_id)
  238. _ScenarioManager._repository._save(scenario)
  239. scenario.add_sequences({sequence_name: [task_4, task_2, task_1, task_3]})
  240. # sequence, and tasks does exist. We expect the tasks to be submitted
  241. # in a specific order
  242. _TaskManager._repository._save(task_1)
  243. _TaskManager._repository._save(task_2)
  244. _TaskManager._repository._save(task_3)
  245. _TaskManager._repository._save(task_4)
  246. sequence = scenario.sequences[sequence_name]
  247. _SequenceManager._submit(sequence.id)
  248. calls_ids = [t.id for t in _TaskManager._orchestrator().submit_calls]
  249. tasks_ids = [task_1.id, task_2.id, task_4.id, task_3.id]
  250. assert calls_ids == tasks_ids
  251. _SequenceManager._submit(sequence)
  252. calls_ids = [t.id for t in _TaskManager._orchestrator().submit_calls]
  253. tasks_ids = tasks_ids * 2
  254. assert set(calls_ids) == set(tasks_ids)
  255. def test_assign_sequence_as_parent_of_task():
  256. dn_config_1 = Config.configure_data_node("dn_1", "in_memory", scope=Scope.SCENARIO)
  257. dn_config_2 = Config.configure_data_node("dn_2", "in_memory", scope=Scope.SCENARIO)
  258. dn_config_3 = Config.configure_data_node("dn_3", "in_memory", scope=Scope.SCENARIO)
  259. task_config_1 = Config.configure_task("task_1", print, [dn_config_1], [dn_config_2])
  260. task_config_2 = Config.configure_task("task_2", print, [dn_config_2], [dn_config_3])
  261. task_config_3 = Config.configure_task("task_3", print, [dn_config_2], [dn_config_3])
  262. tasks = _TaskManager._bulk_get_or_create([task_config_1, task_config_2, task_config_3], "scenario_id")
  263. sequence_1 = _SequenceManager._create("sequence_1", [tasks[0], tasks[1]], scenario_id="scenario_id")
  264. sequence_2 = _SequenceManager._create("sequence_2", [tasks[0], tasks[2]], scenario_id="scenario_id")
  265. tasks_1 = list(sequence_1.tasks.values())
  266. tasks_2 = list(sequence_2.tasks.values())
  267. assert len(tasks_1) == 2
  268. assert len(tasks_2) == 2
  269. assert tasks_1[0].parent_ids == {sequence_1.id, sequence_2.id}
  270. assert tasks_2[0].parent_ids == {sequence_1.id, sequence_2.id}
  271. assert tasks_1[1].parent_ids == {sequence_1.id}
  272. assert tasks_2[1].parent_ids == {sequence_2.id}
  273. g = 0
  274. def mock_function_no_input_no_output():
  275. global g
  276. g += 1
  277. def mock_function_one_input_no_output(inp):
  278. global g
  279. g += inp
  280. def mock_function_no_input_one_output():
  281. global g
  282. return g
  283. def test_submit_sequence_from_tasks_with_one_or_no_input_output():
  284. # test no input and no output Task
  285. task_no_input_no_output = Task("task_no_input_no_output", {}, mock_function_no_input_no_output)
  286. scenario_1 = Scenario("scenario_1", {task_no_input_no_output}, {})
  287. _TaskManager._repository._save(task_no_input_no_output)
  288. _ScenarioManager._repository._save(scenario_1)
  289. scenario_1.add_sequences({"my_sequence_1": [task_no_input_no_output]})
  290. sequence_1 = scenario_1.sequences["my_sequence_1"]
  291. assert len(sequence_1._get_sorted_tasks()) == 1
  292. _SequenceManager._submit(sequence_1)
  293. assert g == 1
  294. # test one input and no output Task
  295. data_node_input = InMemoryDataNode("input_dn", Scope.SCENARIO, properties={"default_data": 2})
  296. task_one_input_no_output = Task(
  297. "task_one_input_no_output", {}, mock_function_one_input_no_output, input=[data_node_input]
  298. )
  299. scenario_2 = Scenario("scenario_2", {task_one_input_no_output}, {})
  300. _DataManager._repository._save(data_node_input)
  301. data_node_input.unlock_edit()
  302. _TaskManager._repository._save(task_one_input_no_output)
  303. _ScenarioManager._repository._save(scenario_2)
  304. scenario_2.add_sequences({"my_sequence_2": [task_one_input_no_output]})
  305. sequence_2 = scenario_2.sequences["my_sequence_2"]
  306. assert len(sequence_2._get_sorted_tasks()) == 1
  307. _SequenceManager._submit(sequence_2)
  308. assert g == 3
  309. # test no input and one output Task
  310. data_node_output = InMemoryDataNode("output_dn", Scope.SCENARIO, properties={"default_data": None})
  311. task_no_input_one_output = Task(
  312. "task_no_input_one_output", {}, mock_function_no_input_one_output, output=[data_node_output]
  313. )
  314. scenario_3 = Scenario("scenario_3", {task_no_input_one_output}, {})
  315. _DataManager._repository._save(data_node_output)
  316. assert data_node_output.read() is None
  317. _TaskManager._repository._save(task_no_input_one_output)
  318. _ScenarioManager._repository._save(scenario_3)
  319. scenario_3.add_sequences({"my_sequence_3": [task_no_input_one_output]})
  320. sequence_3 = scenario_3.sequences["my_sequence_3"]
  321. assert len(sequence_2._get_sorted_tasks()) == 1
  322. _SequenceManager._submit(sequence_3)
  323. assert data_node_output.read() == 3
  324. def mult_by_two(nb: int):
  325. return nb * 2
  326. def mult_by_3(nb: int):
  327. return nb * 3
  328. def test_get_or_create_data():
  329. # only create intermediate data node once
  330. dn_config_1 = Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)
  331. dn_config_2 = Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0)
  332. dn_config_6 = Config.configure_data_node("baz", "in_memory", Scope.SCENARIO, default_data=0)
  333. task_config_mult_by_two = Config.configure_task("mult_by_two", mult_by_two, [dn_config_1], dn_config_2)
  334. task_config_mult_by_3 = Config.configure_task("mult_by_3", mult_by_3, [dn_config_2], dn_config_6)
  335. # dn_1 ---> mult_by_two ---> dn_2 ---> mult_by_3 ---> dn_6
  336. scenario_config = Config.configure_scenario("scenario", [task_config_mult_by_two, task_config_mult_by_3])
  337. assert len(_DataManager._get_all()) == 0
  338. assert len(_TaskManager._get_all()) == 0
  339. scenario = _ScenarioManager._create(scenario_config)
  340. scenario.add_sequences({"by_6": list(scenario.tasks.values())})
  341. sequence = scenario.sequences["by_6"]
  342. assert sequence.properties["name"] == "by_6"
  343. assert len(_DataManager._get_all()) == 3
  344. assert len(_TaskManager._get_all()) == 2
  345. assert len(sequence._get_sorted_tasks()) == 2
  346. assert sequence.foo.read() == 1
  347. assert sequence.bar.read() == 0
  348. assert sequence.baz.read() == 0
  349. assert sequence._get_sorted_tasks()[0][0].config_id == task_config_mult_by_two.id
  350. assert sequence._get_sorted_tasks()[1][0].config_id == task_config_mult_by_3.id
  351. _SequenceManager._submit(sequence.id)
  352. assert sequence.foo.read() == 1
  353. assert sequence.bar.read() == 2
  354. assert sequence.baz.read() == 6
  355. sequence.foo.write("new data value")
  356. assert sequence.foo.read() == "new data value"
  357. assert sequence.bar.read() == 2
  358. assert sequence.baz.read() == 6
  359. sequence.bar.write(7)
  360. assert sequence.foo.read() == "new data value"
  361. assert sequence.bar.read() == 7
  362. assert sequence.baz.read() == 6
  363. with pytest.raises(AttributeError):
  364. sequence.WRONG.write(7)
  365. def notify1(*args, **kwargs): ...
  366. def notify2(*args, **kwargs): ...
  367. def notify_multi_param(*args, **kwargs): ...
  368. def test_sequence_notification_subscribe(mocker):
  369. mocker.patch("taipy.core._entity._reload._Reloader._reload", side_effect=lambda m, o: o)
  370. task_configs = [
  371. Config.configure_task(
  372. "mult_by_two",
  373. mult_by_two,
  374. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  375. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  376. )
  377. ]
  378. tasks = _TaskManager._bulk_get_or_create(task_configs=task_configs)
  379. scenario = Scenario("scenario", set(tasks), {}, sequences={"by_1": {"tasks": tasks}})
  380. _ScenarioManager._repository._save(scenario)
  381. sequence = scenario.sequences["by_1"]
  382. notify_1 = NotifyMock(sequence)
  383. notify_1.__name__ = "notify_1"
  384. notify_1.__module__ = "notify_1"
  385. notify_2 = NotifyMock(sequence)
  386. notify_2.__name__ = "notify_2"
  387. notify_2.__module__ = "notify_2"
  388. # Mocking this because NotifyMock is a class that does not loads correctly when getting the sequence
  389. # from the storage.
  390. mocker.patch.object(
  391. _utils,
  392. "_load_fct",
  393. side_effect=[notify_1, notify_1, notify_2, notify_2, notify_2, notify_2],
  394. )
  395. # test subscription
  396. callback = mock.MagicMock()
  397. _SequenceManager._submit(sequence.id, [callback])
  398. callback.assert_called()
  399. # test sequence subscribe notification
  400. _SequenceManager._subscribe(callback=notify_1, sequence=sequence)
  401. _SequenceManager._submit(sequence.id)
  402. notify_1.assert_called_3_times()
  403. notify_1.reset()
  404. # test sequence unsubscribe notification
  405. # test subscribe notification only on new job
  406. _SequenceManager._unsubscribe(callback=notify_1, sequence=sequence)
  407. _SequenceManager._subscribe(callback=notify_2, sequence=sequence)
  408. _SequenceManager._submit(sequence)
  409. notify_1.assert_not_called()
  410. notify_2.assert_called_3_times()
  411. def test_sequence_notification_subscribe_multi_param(mocker):
  412. mocker.patch("taipy.core._entity._reload._Reloader._reload", side_effect=lambda m, o: o)
  413. task_configs = [
  414. Config.configure_task(
  415. "mult_by_two",
  416. mult_by_two,
  417. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  418. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  419. )
  420. ]
  421. tasks = _TaskManager._bulk_get_or_create(task_configs)
  422. scenario = Scenario("scenario", set(tasks), {}, sequences={"by_6": {"tasks": tasks}})
  423. _ScenarioManager._repository._save(scenario)
  424. sequence = scenario.sequences["by_6"]
  425. notify = mocker.Mock()
  426. # test sequence subscribe notification
  427. _SequenceManager._subscribe(callback=notify, params=["foobar", 123, 1.2], sequence=sequence)
  428. mocker.patch.object(_SequenceManager, "_get", return_value=sequence)
  429. _SequenceManager._submit(sequence.id)
  430. # as the callback is called with Sequence/Scenario and Job objects
  431. # we can assert that is called with params plus a sequence object that we know
  432. # of and a job object that is represented by ANY in this case
  433. notify.assert_called_with("foobar", 123, 1.2, sequence, ANY)
  434. def test_sequence_notification_unsubscribe(mocker):
  435. mocker.patch("taipy.core._entity._reload._Reloader._reload", side_effect=lambda m, o: o)
  436. task_configs = [
  437. Config.configure_task(
  438. "mult_by_two",
  439. mult_by_two,
  440. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  441. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  442. )
  443. ]
  444. tasks = _TaskManager._bulk_get_or_create(task_configs)
  445. scenario = Scenario("scenario", set(tasks), {}, sequences={"by_6": {"tasks": tasks}})
  446. _ScenarioManager._repository._save(scenario)
  447. sequence = scenario.sequences["by_6"]
  448. notify_1 = notify1
  449. notify_2 = notify2
  450. _SequenceManager._subscribe(callback=notify_1, sequence=sequence)
  451. _SequenceManager._unsubscribe(callback=notify_1, sequence=sequence)
  452. _SequenceManager._subscribe(callback=notify_2, sequence=sequence)
  453. _SequenceManager._submit(sequence.id)
  454. with pytest.raises(ValueError):
  455. _SequenceManager._unsubscribe(callback=notify_1, sequence=sequence)
  456. _SequenceManager._unsubscribe(callback=notify_2, sequence=sequence)
  457. def test_sequence_notification_unsubscribe_multi_param():
  458. task_configs = [
  459. Config.configure_task(
  460. "mult_by_two",
  461. mult_by_two,
  462. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  463. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  464. )
  465. ]
  466. tasks = _TaskManager._bulk_get_or_create(task_configs)
  467. scenario = Scenario("scenario", tasks, {}, sequences={"by_6": {"tasks": tasks}})
  468. _ScenarioManager._repository._save(scenario)
  469. sequence = scenario.sequences["by_6"]
  470. _SequenceManager._subscribe(callback=notify_multi_param, params=["foobar", 123, 0], sequence=sequence)
  471. _SequenceManager._subscribe(callback=notify_multi_param, params=["foobar", 123, 1], sequence=sequence)
  472. _SequenceManager._subscribe(callback=notify_multi_param, params=["foobar", 123, 2], sequence=sequence)
  473. assert len(sequence.subscribers) == 3
  474. sequence.unsubscribe(notify_multi_param)
  475. assert len(sequence.subscribers) == 2
  476. assert _Subscriber(notify_multi_param, ["foobar", 123, 0]) not in sequence.subscribers
  477. sequence.unsubscribe(notify_multi_param, ["foobar", 123, 2])
  478. assert len(sequence.subscribers) == 1
  479. assert _Subscriber(notify_multi_param, ["foobar", 123, 2]) not in sequence.subscribers
  480. with pytest.raises(ValueError):
  481. sequence.unsubscribe(notify_multi_param, ["foobar", 123, 10000])
  482. def test_sequence_notification_subscribe_all():
  483. task_configs = [
  484. Config.configure_task(
  485. "mult_by_two",
  486. mult_by_two,
  487. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  488. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  489. )
  490. ]
  491. tasks = _TaskManager._bulk_get_or_create(task_configs)
  492. scenario = Scenario("scenario", tasks, {}, sequences={"by_6": {"tasks": tasks}, "other_sequence": {"tasks": tasks}})
  493. _ScenarioManager._repository._save(scenario)
  494. sequence = scenario.sequences["by_6"]
  495. other_sequence = scenario.sequences["other_sequence"]
  496. notify_1 = NotifyMock(sequence)
  497. _SequenceManager._subscribe(notify_1)
  498. assert len(_SequenceManager._get(sequence.id).subscribers) == 1
  499. assert len(_SequenceManager._get(other_sequence.id).subscribers) == 1
  500. def test_delete():
  501. sequence_id = "SEQUENCE_sequence_SCENARIO_scenario_id_1"
  502. with pytest.raises(ModelNotFound):
  503. _SequenceManager._delete(sequence_id)
  504. scenario_1 = Scenario("scenario_1", set(), {}, scenario_id="SCENARIO_scenario_id_1")
  505. scenario_2 = Scenario("scenario_2", set(), {}, scenario_id="SCENARIO_scenario_id_2")
  506. _ScenarioManager._repository._save(scenario_1)
  507. _ScenarioManager._repository._save(scenario_2)
  508. with pytest.raises(ModelNotFound):
  509. _SequenceManager._delete(SequenceId(sequence_id))
  510. scenario_1.add_sequences({"sequence": []})
  511. assert len(_SequenceManager._get_all()) == 1
  512. _SequenceManager._delete(SequenceId(sequence_id))
  513. assert len(_SequenceManager._get_all()) == 0
  514. scenario_1.add_sequences({"sequence": [], "sequence_1": []})
  515. assert len(_SequenceManager._get_all()) == 2
  516. _SequenceManager._delete(SequenceId(sequence_id))
  517. assert len(_SequenceManager._get_all()) == 1
  518. with pytest.raises(SequenceAlreadyExists):
  519. scenario_1.add_sequences({"sequence_1": [], "sequence_2": [], "sequence_3": []})
  520. scenario_1.add_sequences({"sequence_2": [], "sequence_3": []})
  521. scenario_2.add_sequences({"sequence_1_2": [], "sequence_2_2": []})
  522. assert len(_SequenceManager._get_all()) == 5
  523. _SequenceManager._delete_all()
  524. assert len(_SequenceManager._get_all()) == 0
  525. scenario_1.add_sequences({"sequence_1": [], "sequence_2": [], "sequence_3": [], "sequence_4": []})
  526. scenario_2.add_sequences({"sequence_1_2": [], "sequence_2_2": []})
  527. assert len(_SequenceManager._get_all()) == 6
  528. _SequenceManager._delete_many(
  529. [
  530. "SEQUENCE_sequence_1_SCENARIO_scenario_id_1",
  531. "SEQUENCE_sequence_2_SCENARIO_scenario_id_1",
  532. "SEQUENCE_sequence_1_2_SCENARIO_scenario_id_2",
  533. ]
  534. )
  535. assert len(_SequenceManager._get_all()) == 3
  536. with pytest.raises(ModelNotFound):
  537. _SequenceManager._delete_many(
  538. ["SEQUENCE_sequence_1_SCENARIO_scenario_id_1", "SEQUENCE_sequence_2_SCENARIO_scenario_id_1"]
  539. )
  540. def test_delete_version():
  541. scenario_1_0 = Scenario(
  542. "scenario_config",
  543. [],
  544. {},
  545. scenario_id="SCENARIO_id_1_v1_0",
  546. version="1.0",
  547. sequences={"sequence_1": {}, "sequence_2": {}},
  548. )
  549. scenario_1_1 = Scenario(
  550. "scenario_config",
  551. [],
  552. {},
  553. scenario_id="SCENARIO_id_1_v1_1",
  554. version="1.1",
  555. sequences={"sequence_1": {}, "sequence_2": {}},
  556. )
  557. _ScenarioManager._repository._save(scenario_1_0)
  558. _ScenarioManager._repository._save(scenario_1_1)
  559. _VersionManager._set_experiment_version("1.1")
  560. assert len(_ScenarioManager._get_all()) == 1
  561. assert len(_SequenceManager._get_all()) == 2
  562. _VersionManager._set_experiment_version("1.0")
  563. assert len(_ScenarioManager._get_all()) == 1
  564. assert len(_SequenceManager._get_all()) == 2
  565. _SequenceManager._delete_by_version("1.0")
  566. assert len(_ScenarioManager._get_all()) == 1
  567. assert len(_SequenceManager._get_all()) == 0
  568. assert len(scenario_1_0.sequences) == 0
  569. assert len(scenario_1_1.sequences) == 2
  570. _VersionManager._set_experiment_version("1.1")
  571. assert len(_ScenarioManager._get_all()) == 1
  572. assert len(_SequenceManager._get_all()) == 2
  573. assert len(scenario_1_0.sequences) == 0
  574. assert len(scenario_1_1.sequences) == 2
  575. _SequenceManager._delete_by_version("1.1")
  576. assert len(_ScenarioManager._get_all()) == 1
  577. assert len(_SequenceManager._get_all()) == 0
  578. def test_exists():
  579. scenario = Scenario("scenario", [], {}, scenario_id="SCENARIO_scenario", sequences={"sequence": {}})
  580. _ScenarioManager._repository._save(scenario)
  581. assert len(_ScenarioManager._get_all()) == 1
  582. assert len(_SequenceManager._get_all()) == 1
  583. assert not _SequenceManager._exists("SEQUENCE_sequence_not_exist_SCENARIO_scenario")
  584. assert not _SequenceManager._exists("SEQUENCE_sequence_SCENARIO_scenario_id")
  585. assert _SequenceManager._exists("SEQUENCE_sequence_SCENARIO_scenario")
  586. assert _SequenceManager._exists(scenario.sequences["sequence"])
  587. def test_hard_delete_one_single_sequence_with_scenario_data_nodes():
  588. dn_input_config = Config.configure_data_node("my_input", "in_memory", scope=Scope.SCENARIO, default_data="testing")
  589. dn_output_config = Config.configure_data_node("my_output", "in_memory", scope=Scope.SCENARIO)
  590. task_config = Config.configure_task("task_config", print, dn_input_config, dn_output_config)
  591. tasks = _TaskManager._bulk_get_or_create([task_config])
  592. scenario = Scenario("scenario", tasks, {}, sequences={"sequence": {"tasks": tasks}})
  593. _ScenarioManager._repository._save(scenario)
  594. sequence = scenario.sequences["sequence"]
  595. sequence.submit()
  596. assert len(_ScenarioManager._get_all()) == 1
  597. assert len(_SequenceManager._get_all()) == 1
  598. assert len(_TaskManager._get_all()) == 1
  599. assert len(_DataManager._get_all()) == 2
  600. assert len(_JobManager._get_all()) == 1
  601. _SequenceManager._hard_delete(sequence.id)
  602. assert len(_ScenarioManager._get_all()) == 1
  603. assert len(_SequenceManager._get_all()) == 0
  604. assert len(_TaskManager._get_all()) == 1
  605. assert len(_DataManager._get_all()) == 2
  606. assert len(_JobManager._get_all()) == 1
  607. def test_hard_delete_one_single_sequence_with_cycle_data_nodes():
  608. dn_input_config = Config.configure_data_node("my_input", "in_memory", scope=Scope.CYCLE, default_data="testing")
  609. dn_output_config = Config.configure_data_node("my_output", "in_memory", scope=Scope.CYCLE)
  610. task_config = Config.configure_task("task_config", print, dn_input_config, dn_output_config)
  611. tasks = _TaskManager._bulk_get_or_create([task_config])
  612. scenario = Scenario("scenario", tasks, {}, sequences={"sequence": {"tasks": tasks}})
  613. _ScenarioManager._repository._save(scenario)
  614. sequence = scenario.sequences["sequence"]
  615. sequence.submit()
  616. assert len(_ScenarioManager._get_all()) == 1
  617. assert len(_SequenceManager._get_all()) == 1
  618. assert len(_TaskManager._get_all()) == 1
  619. assert len(_DataManager._get_all()) == 2
  620. assert len(_JobManager._get_all()) == 1
  621. _SequenceManager._hard_delete(sequence.id)
  622. assert len(_ScenarioManager._get_all()) == 1
  623. assert len(_SequenceManager._get_all()) == 0
  624. assert len(_TaskManager._get_all()) == 1
  625. assert len(_DataManager._get_all()) == 2
  626. assert len(_JobManager._get_all()) == 1
  627. def test_hard_delete_shared_entities():
  628. input_dn = Config.configure_data_node("my_input", "in_memory", default_data="testing")
  629. intermediate_dn = Config.configure_data_node("my_inter", "in_memory")
  630. output_dn = Config.configure_data_node("my_output", "in_memory")
  631. task_1 = Config.configure_task("task_1", print, input_dn, intermediate_dn)
  632. task_2 = Config.configure_task("task_2", print, intermediate_dn, output_dn)
  633. scenario_config = Config.configure_scenario("sc", [task_1, task_2])
  634. import taipy as tp
  635. scenario_1 = tp.create_scenario(scenario_config, name="scenario_1")
  636. scenario_1.add_sequence("sequence", [scenario_1.task_1, scenario_1.task_2])
  637. scenario_2 = tp.create_scenario(scenario_config, name="scenario_2")
  638. scenario_2.add_sequence("sequence", [scenario_2.task_1, scenario_2.task_2])
  639. sequence_1 = scenario_1.sequences["sequence"]
  640. sequence_2 = scenario_2.sequences["sequence"]
  641. _SequenceManager._submit(sequence_1.id)
  642. _SequenceManager._submit(sequence_2.id)
  643. assert len(_ScenarioManager._get_all()) == 2
  644. assert len(_SequenceManager._get_all()) == 2
  645. assert len(_TaskManager._get_all()) == 4
  646. assert len(_DataManager._get_all()) == 6
  647. assert len(_JobManager._get_all()) == 4
  648. _SequenceManager._hard_delete(sequence_1.id)
  649. assert len(_ScenarioManager._get_all()) == 2
  650. assert len(_SequenceManager._get_all()) == 1
  651. assert len(_TaskManager._get_all()) == 4
  652. assert len(_DataManager._get_all()) == 6
  653. assert len(_JobManager._get_all()) == 4
  654. def my_print(a, b):
  655. print(a + b) # noqa: T201
  656. def test_submit_task_with_input_dn_wrong_file_path(caplog):
  657. csv_dn_cfg = Config.configure_csv_data_node("wrong_csv_file_path", default_path="wrong_path.csv")
  658. pickle_dn_cfg = Config.configure_pickle_data_node("wrong_pickle_file_path", default_path="wrong_path.pickle")
  659. parquet_dn_cfg = Config.configure_parquet_data_node("wrong_parquet_file_path", default_path="wrong_path.parquet")
  660. json_dn_cfg = Config.configure_parquet_data_node("wrong_json_file_path", default_path="wrong_path.json")
  661. task_cfg = Config.configure_task("task", my_print, [csv_dn_cfg, pickle_dn_cfg], parquet_dn_cfg)
  662. task_2_cfg = Config.configure_task("task2", my_print, [csv_dn_cfg, parquet_dn_cfg], json_dn_cfg)
  663. tasks = _TaskManager._bulk_get_or_create([task_cfg, task_2_cfg])
  664. scenario = Scenario("scenario", tasks, {}, sequences={"sequence": {"tasks": tasks}})
  665. _ScenarioManager._repository._save(scenario)
  666. sequence = scenario.sequences["sequence"]
  667. pip_manager = _SequenceManagerFactory._build_manager()
  668. pip_manager._submit(sequence)
  669. stdout = caplog.text
  670. expected_outputs = [
  671. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  672. f"path : {input_dn.path} "
  673. for input_dn in sequence.get_inputs()
  674. ]
  675. not_expected_outputs = [
  676. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  677. f"path : {input_dn.path} "
  678. for input_dn in sequence.data_nodes.values()
  679. if input_dn not in sequence.get_inputs()
  680. ]
  681. assert all(expected_output in stdout for expected_output in expected_outputs)
  682. assert all(expected_output not in stdout for expected_output in not_expected_outputs)
  683. def test_submit_task_with_one_input_dn_wrong_file_path(caplog):
  684. csv_dn_cfg = Config.configure_csv_data_node("wrong_csv_file_path", default_path="wrong_path.csv")
  685. pickle_dn_cfg = Config.configure_pickle_data_node("wrong_pickle_file_path", default_data="value")
  686. parquet_dn_cfg = Config.configure_parquet_data_node("wrong_parquet_file_path", default_path="wrong_path.parquet")
  687. json_dn_cfg = Config.configure_parquet_data_node("wrong_json_file_path", default_path="wrong_path.json")
  688. task_cfg = Config.configure_task("task", my_print, [csv_dn_cfg, pickle_dn_cfg], parquet_dn_cfg)
  689. task_2_cfg = Config.configure_task("task2", my_print, [csv_dn_cfg, parquet_dn_cfg], json_dn_cfg)
  690. tasks = _TaskManager._bulk_get_or_create([task_cfg, task_2_cfg])
  691. scenario = Scenario("scenario", tasks, {}, sequences={"sequence": {"tasks": tasks}})
  692. _ScenarioManager._repository._save(scenario)
  693. sequence = scenario.sequences["sequence"]
  694. pip_manager = _SequenceManagerFactory._build_manager()
  695. pip_manager._submit(sequence)
  696. stdout = caplog.text
  697. expected_outputs = [
  698. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  699. f"path : {input_dn.path} "
  700. for input_dn in sequence.get_inputs()
  701. if input_dn.config_id == "wrong_csv_file_path"
  702. ]
  703. not_expected_outputs = [
  704. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  705. f"path : {input_dn.path} "
  706. for input_dn in sequence.data_nodes.values()
  707. if input_dn.config_id != "wrong_csv_file_path"
  708. ]
  709. assert all(expected_output in stdout for expected_output in expected_outputs)
  710. assert all(expected_output not in stdout for expected_output in not_expected_outputs)