test_sequence_manager.py 38 KB

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