test_scenario_manager.py 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555
  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 datetime import datetime, timedelta
  12. from typing import Callable, Iterable, Optional
  13. from unittest.mock import ANY, patch
  14. import freezegun
  15. import pytest
  16. from taipy.common.config import Config
  17. from taipy.common.config.common.frequency import Frequency
  18. from taipy.common.config.common.scope import Scope
  19. from taipy.core import Job
  20. from taipy.core import taipy as tp
  21. from taipy.core._orchestrator._orchestrator import _Orchestrator
  22. from taipy.core._version._version_manager import _VersionManager
  23. from taipy.core.common import _utils
  24. from taipy.core.common._utils import _Subscriber
  25. from taipy.core.config.scenario_config import ScenarioConfig
  26. from taipy.core.cycle._cycle_manager import _CycleManager
  27. from taipy.core.data._data_manager import _DataManager
  28. from taipy.core.data.in_memory import InMemoryDataNode
  29. from taipy.core.exceptions.exceptions import (
  30. DeletingPrimaryScenario,
  31. DifferentScenarioConfigs,
  32. InsufficientScenarioToCompare,
  33. NonExistingComparator,
  34. NonExistingScenario,
  35. NonExistingScenarioConfig,
  36. NonExistingTask,
  37. SequenceTaskConfigDoesNotExistInSameScenarioConfig,
  38. UnauthorizedTagError,
  39. )
  40. from taipy.core.job._job_manager import _JobManager
  41. from taipy.core.reason import WrongConfigType
  42. from taipy.core.scenario._scenario_manager import _ScenarioManager
  43. from taipy.core.scenario._scenario_manager_factory import _ScenarioManagerFactory
  44. from taipy.core.scenario.scenario import Scenario
  45. from taipy.core.scenario.scenario_id import ScenarioId
  46. from taipy.core.sequence._sequence_manager import _SequenceManager
  47. from taipy.core.task._task_manager import _TaskManager
  48. from taipy.core.task.task import Task
  49. from taipy.core.task.task_id import TaskId
  50. from tests.core.utils.NotifyMock import NotifyMock
  51. def test_set_and_get_scenario(cycle):
  52. scenario_id_1 = ScenarioId("scenario_id_1")
  53. scenario_1 = Scenario("scenario_name_1", [], {}, [], scenario_id_1)
  54. input_dn_2 = InMemoryDataNode("foo", Scope.SCENARIO)
  55. output_dn_2 = InMemoryDataNode("bar", Scope.SCENARIO)
  56. additional_dn_2 = InMemoryDataNode("zyx", Scope.SCENARIO)
  57. task_name_2 = "task_2"
  58. task_2 = Task(task_name_2, {}, print, [input_dn_2], [output_dn_2], TaskId("task_id_2"))
  59. scenario_id_2 = ScenarioId("scenario_id_2")
  60. scenario_2 = Scenario(
  61. "scenario_name_2",
  62. [task_2],
  63. {},
  64. [additional_dn_2],
  65. scenario_id_2,
  66. datetime.now(),
  67. True,
  68. cycle,
  69. sequences={"sequence_2": {"tasks": [task_2]}},
  70. )
  71. additional_dn_3 = InMemoryDataNode("baz", Scope.SCENARIO)
  72. task_name_3 = "task_3"
  73. task_3 = Task(task_name_3, {}, print, id=TaskId("task_id_3"))
  74. scenario_3_with_same_id = Scenario(
  75. "scenario_name_3",
  76. [task_3],
  77. {},
  78. [additional_dn_3],
  79. scenario_id_1,
  80. datetime.now(),
  81. False,
  82. cycle,
  83. sequences={"sequence_3": {}},
  84. )
  85. # No existing scenario
  86. assert len(_ScenarioManager._get_all()) == 0
  87. assert _ScenarioManager._get(scenario_id_1) is None
  88. assert _ScenarioManager._get(scenario_1) is None
  89. assert _ScenarioManager._get(scenario_id_2) is None
  90. assert _ScenarioManager._get(scenario_2) is None
  91. # Save one scenario. We expect to have only one scenario stored
  92. _ScenarioManager._set(scenario_1)
  93. assert len(_ScenarioManager._get_all()) == 1
  94. assert _ScenarioManager._get(scenario_id_1).id == scenario_1.id
  95. assert _ScenarioManager._get(scenario_id_1).config_id == scenario_1.config_id
  96. assert len(_ScenarioManager._get(scenario_id_1).tasks) == 0
  97. assert len(_ScenarioManager._get(scenario_id_1).additional_data_nodes) == 0
  98. assert len(_ScenarioManager._get(scenario_id_1).data_nodes) == 0
  99. assert len(_ScenarioManager._get(scenario_id_1).sequences) == 0
  100. assert _ScenarioManager._get(scenario_1).id == scenario_1.id
  101. assert _ScenarioManager._get(scenario_1).config_id == scenario_1.config_id
  102. assert len(_ScenarioManager._get(scenario_1).tasks) == 0
  103. assert len(_ScenarioManager._get(scenario_1).additional_data_nodes) == 0
  104. assert len(_ScenarioManager._get(scenario_1).data_nodes) == 0
  105. assert len(_ScenarioManager._get(scenario_1).sequences) == 0
  106. assert _ScenarioManager._get(scenario_id_2) is None
  107. assert _ScenarioManager._get(scenario_2) is None
  108. # Save a second scenario. Now, we expect to have a total of two scenarios stored
  109. _TaskManager._set(task_2)
  110. _CycleManager._set(cycle)
  111. _ScenarioManager._set(scenario_2)
  112. _DataManager._set(additional_dn_2)
  113. assert len(_ScenarioManager._get_all()) == 2
  114. assert _ScenarioManager._get(scenario_id_1).id == scenario_1.id
  115. assert _ScenarioManager._get(scenario_id_1).config_id == scenario_1.config_id
  116. assert len(_ScenarioManager._get(scenario_id_1).tasks) == 0
  117. assert len(_ScenarioManager._get(scenario_id_1).additional_data_nodes) == 0
  118. assert len(_ScenarioManager._get(scenario_id_1).data_nodes) == 0
  119. assert len(_ScenarioManager._get(scenario_id_1).sequences) == 0
  120. assert _ScenarioManager._get(scenario_1).id == scenario_1.id
  121. assert _ScenarioManager._get(scenario_1).config_id == scenario_1.config_id
  122. assert len(_ScenarioManager._get(scenario_1).tasks) == 0
  123. assert len(_ScenarioManager._get(scenario_1).additional_data_nodes) == 0
  124. assert len(_ScenarioManager._get(scenario_1).data_nodes) == 0
  125. assert len(_ScenarioManager._get(scenario_1).sequences) == 0
  126. assert _ScenarioManager._get(scenario_id_2).id == scenario_2.id
  127. assert _ScenarioManager._get(scenario_id_2).config_id == scenario_2.config_id
  128. assert len(_ScenarioManager._get(scenario_id_2).tasks) == 1
  129. assert len(_ScenarioManager._get(scenario_id_2).additional_data_nodes) == 1
  130. assert len(_ScenarioManager._get(scenario_id_2).data_nodes) == 3
  131. assert len(_ScenarioManager._get(scenario_id_2).sequences) == 1
  132. assert _ScenarioManager._get(scenario_2).id == scenario_2.id
  133. assert _ScenarioManager._get(scenario_2).config_id == scenario_2.config_id
  134. assert len(_ScenarioManager._get(scenario_2).tasks) == 1
  135. assert len(_ScenarioManager._get(scenario_2).additional_data_nodes) == 1
  136. assert len(_ScenarioManager._get(scenario_2).data_nodes) == 3
  137. assert len(_ScenarioManager._get(scenario_2).sequences) == 1
  138. assert _TaskManager._get(task_2.id).id == task_2.id
  139. assert _ScenarioManager._get(scenario_id_2).cycle == cycle
  140. assert _ScenarioManager._get(scenario_2).cycle == cycle
  141. assert _CycleManager._get(cycle.id).id == cycle.id
  142. # We save the first scenario again. We expect nothing to change
  143. _ScenarioManager._set(scenario_1)
  144. assert len(_ScenarioManager._get_all()) == 2
  145. assert _ScenarioManager._get(scenario_id_1).id == scenario_1.id
  146. assert _ScenarioManager._get(scenario_id_1).config_id == scenario_1.config_id
  147. assert len(_ScenarioManager._get(scenario_id_1).tasks) == 0
  148. assert len(_ScenarioManager._get(scenario_id_1).additional_data_nodes) == 0
  149. assert len(_ScenarioManager._get(scenario_id_1).data_nodes) == 0
  150. assert len(_ScenarioManager._get(scenario_id_1).sequences) == 0
  151. assert _ScenarioManager._get(scenario_1).id == scenario_1.id
  152. assert _ScenarioManager._get(scenario_1).config_id == scenario_1.config_id
  153. assert len(_ScenarioManager._get(scenario_1).tasks) == 0
  154. assert len(_ScenarioManager._get(scenario_1).additional_data_nodes) == 0
  155. assert len(_ScenarioManager._get(scenario_1).data_nodes) == 0
  156. assert len(_ScenarioManager._get(scenario_1).sequences) == 0
  157. assert _ScenarioManager._get(scenario_id_2).id == scenario_2.id
  158. assert _ScenarioManager._get(scenario_id_2).config_id == scenario_2.config_id
  159. assert len(_ScenarioManager._get(scenario_id_2).tasks) == 1
  160. assert len(_ScenarioManager._get(scenario_id_2).additional_data_nodes) == 1
  161. assert len(_ScenarioManager._get(scenario_id_2).data_nodes) == 3
  162. assert len(_ScenarioManager._get(scenario_id_2).sequences) == 1
  163. assert _ScenarioManager._get(scenario_2).id == scenario_2.id
  164. assert _ScenarioManager._get(scenario_2).config_id == scenario_2.config_id
  165. assert len(_ScenarioManager._get(scenario_2).tasks) == 1
  166. assert len(_ScenarioManager._get(scenario_2).additional_data_nodes) == 1
  167. assert len(_ScenarioManager._get(scenario_2).data_nodes) == 3
  168. assert len(_ScenarioManager._get(scenario_2).sequences) == 1
  169. assert _TaskManager._get(task_2.id).id == task_2.id
  170. assert _CycleManager._get(cycle.id).id == cycle.id
  171. # We save a third scenario with same id as the first one.
  172. # We expect the first scenario to be updated
  173. _DataManager._set(additional_dn_3)
  174. _TaskManager._set(task_3)
  175. _TaskManager._set(scenario_2.tasks[task_name_2])
  176. _ScenarioManager._set(scenario_3_with_same_id)
  177. assert len(_ScenarioManager._get_all()) == 2
  178. assert _ScenarioManager._get(scenario_id_1).id == scenario_1.id
  179. assert _ScenarioManager._get(scenario_id_1).config_id == scenario_3_with_same_id.config_id
  180. assert len(_ScenarioManager._get(scenario_id_1).tasks) == 1
  181. assert len(_ScenarioManager._get(scenario_id_1).additional_data_nodes) == 1
  182. assert len(_ScenarioManager._get(scenario_id_1).data_nodes) == 1
  183. assert len(_ScenarioManager._get(scenario_id_1).sequences) == 1
  184. assert _ScenarioManager._get(scenario_id_1).cycle == cycle
  185. assert _ScenarioManager._get(scenario_1).id == scenario_1.id
  186. assert _ScenarioManager._get(scenario_1).config_id == scenario_3_with_same_id.config_id
  187. assert len(_ScenarioManager._get(scenario_1).tasks) == 1
  188. assert len(_ScenarioManager._get(scenario_1).additional_data_nodes) == 1
  189. assert len(_ScenarioManager._get(scenario_1).data_nodes) == 1
  190. assert len(_ScenarioManager._get(scenario_1).sequences) == 1
  191. assert _ScenarioManager._get(scenario_1).cycle == cycle
  192. assert _ScenarioManager._get(scenario_id_2).id == scenario_2.id
  193. assert _ScenarioManager._get(scenario_id_2).config_id == scenario_2.config_id
  194. assert len(_ScenarioManager._get(scenario_id_2).tasks) == 1
  195. assert len(_ScenarioManager._get(scenario_id_2).additional_data_nodes) == 1
  196. assert len(_ScenarioManager._get(scenario_id_2).data_nodes) == 3
  197. assert len(_ScenarioManager._get(scenario_id_2).sequences) == 1
  198. assert _ScenarioManager._get(scenario_2).id == scenario_2.id
  199. assert _ScenarioManager._get(scenario_2).config_id == scenario_2.config_id
  200. assert len(_ScenarioManager._get(scenario_2).tasks) == 1
  201. assert len(_ScenarioManager._get(scenario_2).additional_data_nodes) == 1
  202. assert len(_ScenarioManager._get(scenario_2).data_nodes) == 3
  203. assert len(_ScenarioManager._get(scenario_2).sequences) == 1
  204. assert _TaskManager._get(task_2.id).id == task_2.id
  205. def test_raise_sequence_task_configs_not_in_scenario_config():
  206. data_node = Config.configure_pickle_data_node("temp")
  207. task_config_1 = Config.configure_task("task_1", print, output=[data_node])
  208. task_config_2 = Config.configure_task("task_2", print, input=[data_node])
  209. scenario_config_1 = Config.configure_scenario("scenario_1")
  210. scenario_config_1.add_sequences({"sequence_0": []})
  211. _ScenarioManager._create(scenario_config_1)
  212. scenario_config_1.add_sequences({"sequence_1": [task_config_1]})
  213. with pytest.raises(SequenceTaskConfigDoesNotExistInSameScenarioConfig) as err:
  214. _ScenarioManager._create(scenario_config_1)
  215. assert err.value.args == ([task_config_1.id], "sequence_1", scenario_config_1.id)
  216. scenario_config_1._tasks = [task_config_1]
  217. _ScenarioManager._create(scenario_config_1)
  218. scenario_config_1.add_sequences({"sequence_2": [task_config_1]})
  219. _ScenarioManager._create(scenario_config_1)
  220. scenario_config_1.add_sequences({"sequence_3": [task_config_1, task_config_2]})
  221. with pytest.raises(SequenceTaskConfigDoesNotExistInSameScenarioConfig) as err:
  222. _ScenarioManager._create(scenario_config_1)
  223. assert err.value.args == ([task_config_2.id], "sequence_3", scenario_config_1.id)
  224. scenario_config_1._tasks = [task_config_1, task_config_2]
  225. _ScenarioManager._create(scenario_config_1)
  226. def test_get_all_on_multiple_versions_environment():
  227. # Create 5 scenarios with 2 versions each
  228. # Only version 1.0 has the scenario with config_id = "config_id_1"
  229. # Only version 2.0 has the scenario with config_id = "config_id_6"
  230. for version in range(1, 3):
  231. for i in range(5):
  232. _ScenarioManager._set(
  233. Scenario(f"config_id_{i+version}", [], {}, [], ScenarioId(f"id{i}_v{version}"), version=f"{version}.0")
  234. )
  235. _VersionManager._set_experiment_version("1.0")
  236. assert len(_ScenarioManager._get_all()) == 5
  237. assert len(_ScenarioManager._get_all_by(filters=[{"version": "1.0", "config_id": "config_id_1"}])) == 1
  238. assert len(_ScenarioManager._get_all_by(filters=[{"version": "1.0", "config_id": "config_id_6"}])) == 0
  239. _VersionManager._set_experiment_version("2.0")
  240. assert len(_ScenarioManager._get_all()) == 5
  241. assert len(_ScenarioManager._get_all_by(filters=[{"version": "2.0", "config_id": "config_id_1"}])) == 0
  242. assert len(_ScenarioManager._get_all_by(filters=[{"version": "2.0", "config_id": "config_id_6"}])) == 1
  243. _VersionManager._set_development_version("1.0")
  244. assert len(_ScenarioManager._get_all()) == 5
  245. assert len(_ScenarioManager._get_all_by(filters=[{"version": "1.0", "config_id": "config_id_1"}])) == 1
  246. assert len(_ScenarioManager._get_all_by(filters=[{"version": "1.0", "config_id": "config_id_6"}])) == 0
  247. _VersionManager._set_development_version("2.0")
  248. assert len(_ScenarioManager._get_all()) == 5
  249. assert len(_ScenarioManager._get_all_by(filters=[{"version": "2.0", "config_id": "config_id_1"}])) == 0
  250. assert len(_ScenarioManager._get_all_by(filters=[{"version": "2.0", "config_id": "config_id_6"}])) == 1
  251. def test_create_scenario_does_not_modify_config():
  252. creation_date_1 = datetime.now()
  253. name_1 = "name_1"
  254. scenario_config = Config.configure_scenario("sc", None, None, Frequency.DAILY)
  255. assert scenario_config.properties.get("name") is None
  256. assert len(scenario_config.properties) == 0
  257. scenario = _ScenarioManager._create(scenario_config, creation_date=creation_date_1, name=name_1)
  258. assert len(scenario_config.properties) == 0
  259. assert len(scenario.properties) == 1
  260. assert scenario.properties.get("name") == name_1
  261. assert scenario.name == name_1
  262. scenario.properties["foo"] = "bar"
  263. _ScenarioManager._set(scenario)
  264. assert len(scenario_config.properties) == 0
  265. assert len(scenario.properties) == 2
  266. assert scenario.properties.get("foo") == "bar"
  267. assert scenario.properties.get("name") == name_1
  268. assert scenario.name == name_1
  269. scenario_2 = _ScenarioManager._create(scenario_config, creation_date=creation_date_1)
  270. assert scenario_2.name is None
  271. def test_create_and_delete_scenario():
  272. creation_date_1 = datetime.now()
  273. creation_date_2 = creation_date_1 + timedelta(minutes=10)
  274. name_1 = "name_1"
  275. _ScenarioManager._delete_all()
  276. assert len(_ScenarioManager._get_all()) == 0
  277. scenario_config = Config.configure_scenario("sc", None, None, Frequency.DAILY)
  278. scenario_1 = _ScenarioManager._create(scenario_config, creation_date=creation_date_1, name=name_1)
  279. assert scenario_1.config_id == "sc"
  280. assert scenario_1.sequences == {}
  281. assert scenario_1.tasks == {}
  282. assert scenario_1.additional_data_nodes == {}
  283. assert scenario_1.data_nodes == {}
  284. assert scenario_1.cycle.frequency == Frequency.DAILY
  285. assert scenario_1.is_primary
  286. assert scenario_1.cycle.creation_date == creation_date_1
  287. assert scenario_1.cycle.start_date.date() == creation_date_1.date()
  288. assert scenario_1.cycle.end_date.date() == creation_date_1.date()
  289. assert scenario_1.creation_date == creation_date_1
  290. assert scenario_1.name == name_1
  291. assert scenario_1.properties["name"] == name_1
  292. assert scenario_1.tags == set()
  293. cycle_id_1 = scenario_1.cycle.id
  294. assert _CycleManager._get(cycle_id_1).id == cycle_id_1
  295. _ScenarioManager._delete(scenario_1.id)
  296. assert _ScenarioManager._get(scenario_1.id) is None
  297. assert _CycleManager._get(cycle_id_1) is None
  298. # Recreate scenario_1
  299. scenario_1 = _ScenarioManager._create(scenario_config, creation_date=creation_date_1, name=name_1)
  300. scenario_2 = _ScenarioManager._create(scenario_config, creation_date=creation_date_2)
  301. assert scenario_2.config_id == "sc"
  302. assert scenario_2.sequences == {}
  303. assert scenario_2.tasks == {}
  304. assert scenario_2.additional_data_nodes == {}
  305. assert scenario_2.data_nodes == {}
  306. assert scenario_2.cycle.frequency == Frequency.DAILY
  307. assert not scenario_2.is_primary
  308. assert scenario_2.cycle.creation_date == creation_date_1
  309. assert scenario_2.cycle.start_date.date() == creation_date_2.date()
  310. assert scenario_2.cycle.end_date.date() == creation_date_2.date()
  311. assert scenario_2.properties.get("name") is None
  312. assert scenario_2.tags == set()
  313. assert scenario_1 != scenario_2
  314. assert scenario_1.cycle == scenario_2.cycle
  315. assert len(_ScenarioManager._get_all()) == 2
  316. with pytest.raises(DeletingPrimaryScenario):
  317. _ScenarioManager._delete(
  318. scenario_1.id,
  319. )
  320. _ScenarioManager._delete(
  321. scenario_2.id,
  322. )
  323. assert len(_ScenarioManager._get_all()) == 1
  324. _ScenarioManager._delete(scenario_1.id)
  325. assert len(_ScenarioManager._get_all()) == 0
  326. def test_can_create():
  327. dn_config = Config.configure_in_memory_data_node("dn", 10)
  328. task_config = Config.configure_task("task", print, [dn_config])
  329. scenario_config = Config.configure_scenario("sc", {task_config}, [], Frequency.DAILY)
  330. reasons = _ScenarioManager._can_create()
  331. assert bool(reasons) is True
  332. assert reasons._reasons == {}
  333. reasons = _ScenarioManager._can_create(scenario_config)
  334. assert bool(reasons) is True
  335. assert reasons._reasons == {}
  336. _ScenarioManager._create(scenario_config)
  337. reasons = _ScenarioManager._can_create(task_config)
  338. assert bool(reasons) is False
  339. assert reasons._reasons[task_config.id] == {WrongConfigType(task_config.id, ScenarioConfig.__name__)}
  340. assert str(list(reasons._reasons[task_config.id])[0]) == 'Object "task" must be a valid ScenarioConfig'
  341. with pytest.raises(AttributeError):
  342. _ScenarioManager._create(task_config)
  343. reasons = _ScenarioManager._can_create(1)
  344. assert bool(reasons) is False
  345. assert reasons._reasons["1"] == {WrongConfigType(1, ScenarioConfig.__name__)}
  346. assert str(list(reasons._reasons["1"])[0]) == 'Object "1" must be a valid ScenarioConfig'
  347. with pytest.raises(AttributeError):
  348. _ScenarioManager._create(1)
  349. def test_is_deletable():
  350. assert len(_ScenarioManager._get_all()) == 0
  351. scenario_config = Config.configure_scenario("sc", None, None, Frequency.DAILY)
  352. creation_date = datetime.now()
  353. scenario_1_primary = _ScenarioManager._create(scenario_config, creation_date=creation_date, name="1")
  354. scenario_2 = _ScenarioManager._create(scenario_config, creation_date=creation_date, name="2")
  355. rc = _ScenarioManager._is_deletable("some_scenario")
  356. assert not rc
  357. assert "Entity some_scenario does not exist in the repository." in rc.reasons
  358. assert len(_ScenarioManager._get_all()) == 2
  359. assert scenario_1_primary.is_primary
  360. assert not _ScenarioManager._is_deletable(scenario_1_primary)
  361. assert not _ScenarioManager._is_deletable(scenario_1_primary.id)
  362. assert not scenario_2.is_primary
  363. assert _ScenarioManager._is_deletable(scenario_2)
  364. assert _ScenarioManager._is_deletable(scenario_2.id)
  365. _ScenarioManager._hard_delete(scenario_2.id)
  366. del scenario_2
  367. assert len(_ScenarioManager._get_all()) == 1
  368. assert scenario_1_primary.is_primary
  369. assert _ScenarioManager._is_deletable(scenario_1_primary)
  370. assert _ScenarioManager._is_deletable(scenario_1_primary.id)
  371. def test_assign_scenario_as_parent_of_task_and_additional_data_nodes():
  372. dn_config_1 = Config.configure_data_node("dn_1", "in_memory", scope=Scope.GLOBAL)
  373. dn_config_2 = Config.configure_data_node("dn_2", "in_memory", scope=Scope.GLOBAL)
  374. dn_config_3 = Config.configure_data_node("dn_3", "in_memory", scope=Scope.SCENARIO)
  375. additional_dn_config_1 = Config.configure_data_node("additional_dn_1", "in_memory", scope=Scope.GLOBAL)
  376. additional_dn_config_2 = Config.configure_data_node("additional_dn_2", "in_memory", scope=Scope.SCENARIO)
  377. task_config_1 = Config.configure_task("task_1", print, [dn_config_1], [dn_config_2])
  378. task_config_2 = Config.configure_task("task_2", print, [dn_config_2], [dn_config_3])
  379. task_config_3 = Config.configure_task("task_3", print, [dn_config_2], [dn_config_3])
  380. scenario_config_1 = Config.configure_scenario(
  381. "scenario_1", [task_config_1, task_config_2], [additional_dn_config_1, additional_dn_config_2]
  382. )
  383. scenario_config_1.add_sequences({"sequence_1": [task_config_1, task_config_2]})
  384. scenario_config_2 = Config.configure_scenario(
  385. "scenario_2", [task_config_1, task_config_2, task_config_3], [additional_dn_config_1, additional_dn_config_2]
  386. )
  387. scenario_config_2.add_sequences(
  388. {"sequence_1": [task_config_1, task_config_2], "sequence_2": [task_config_1, task_config_3]}
  389. )
  390. scenario_1 = _ScenarioManager._create(scenario_config_1)
  391. sequence_1_s1 = scenario_1.sequences["sequence_1"]
  392. assert all(sequence.parent_ids == {scenario_1.id} for sequence in scenario_1.sequences.values())
  393. tasks = scenario_1.tasks.values()
  394. assert all(task.parent_ids == {scenario_1.id, sequence_1_s1.id} for task in tasks)
  395. data_nodes = {}
  396. for task in tasks:
  397. data_nodes.update(task.data_nodes)
  398. assert data_nodes["dn_1"].parent_ids == {scenario_1.tasks["task_1"].id}
  399. assert data_nodes["dn_2"].parent_ids == {scenario_1.tasks["task_1"].id, scenario_1.tasks["task_2"].id}
  400. assert data_nodes["dn_3"].parent_ids == {scenario_1.tasks["task_2"].id}
  401. additional_data_nodes = scenario_1.additional_data_nodes
  402. assert additional_data_nodes["additional_dn_1"].parent_ids == {scenario_1.id}
  403. assert additional_data_nodes["additional_dn_2"].parent_ids == {scenario_1.id}
  404. scenario_2 = _ScenarioManager._create(scenario_config_2)
  405. sequence_1_s2 = scenario_2.sequences["sequence_1"]
  406. sequence_2_s2 = scenario_2.sequences["sequence_2"]
  407. assert all(sequence.parent_ids == {scenario_2.id} for sequence in scenario_2.sequences.values())
  408. assert scenario_1.tasks["task_1"] == scenario_2.tasks["task_1"]
  409. assert scenario_1.tasks["task_1"].parent_ids == {
  410. scenario_1.id,
  411. sequence_1_s1.id,
  412. scenario_2.id,
  413. sequence_1_s2.id,
  414. sequence_2_s2.id,
  415. }
  416. assert scenario_1.tasks["task_2"].parent_ids == {scenario_1.id, sequence_1_s1.id}
  417. assert scenario_2.tasks["task_2"].parent_ids == {scenario_2.id, sequence_1_s2.id}
  418. assert scenario_2.tasks["task_3"].parent_ids == {scenario_2.id, sequence_2_s2.id}
  419. additional_data_nodes = scenario_2.additional_data_nodes
  420. assert additional_data_nodes["additional_dn_1"].parent_ids == {scenario_1.id, scenario_2.id}
  421. assert additional_data_nodes["additional_dn_2"].parent_ids == {scenario_2.id}
  422. _ScenarioManager._hard_delete(scenario_1.id)
  423. _ScenarioManager._hard_delete(scenario_2.id)
  424. _TaskManager._delete_all()
  425. _DataManager._delete_all()
  426. dn_config_1 = Config.configure_data_node("dn_1", "in_memory", scope=Scope.GLOBAL)
  427. dn_config_2 = Config.configure_data_node("dn_2", "in_memory", scope=Scope.GLOBAL)
  428. dn_config_3 = Config.configure_data_node("dn_3", "in_memory", scope=Scope.GLOBAL)
  429. additional_dn_config_1 = Config.configure_data_node("additional_dn_1", "in_memory", scope=Scope.GLOBAL)
  430. additional_dn_config_2 = Config.configure_data_node("additional_dn_2", "in_memory", scope=Scope.GLOBAL)
  431. task_config_1 = Config.configure_task("task_1", print, [dn_config_1], [dn_config_2])
  432. task_config_2 = Config.configure_task("task_2", print, [dn_config_2], [dn_config_3])
  433. task_config_3 = Config.configure_task("task_3", print, [dn_config_2], [dn_config_3])
  434. scenario_config_1 = Config.configure_scenario(
  435. "scenario_1", [task_config_1, task_config_2], [additional_dn_config_1, additional_dn_config_2]
  436. )
  437. scenario_config_1.add_sequences({"sequence_1": [task_config_1, task_config_2]})
  438. scenario_config_2 = Config.configure_scenario(
  439. "scenario_2", [task_config_1, task_config_2, task_config_3], [additional_dn_config_1, additional_dn_config_2]
  440. )
  441. scenario_config_2.add_sequences(
  442. {"sequence_1": [task_config_1, task_config_2], "sequence_2": [task_config_1, task_config_3]}
  443. )
  444. scenario_1 = _ScenarioManager._create(scenario_config_1)
  445. sequence_1_s1 = scenario_1.sequences["sequence_1"]
  446. assert scenario_1.sequences["sequence_1"].parent_ids == {scenario_1.id}
  447. tasks = scenario_1.tasks.values()
  448. assert all(task.parent_ids == {scenario_1.id, sequence_1_s1.id} for task in tasks)
  449. data_nodes = {}
  450. for task in tasks:
  451. data_nodes.update(task.data_nodes)
  452. assert data_nodes["dn_1"].parent_ids == {scenario_1.tasks["task_1"].id}
  453. assert data_nodes["dn_2"].parent_ids == {scenario_1.tasks["task_1"].id, scenario_1.tasks["task_2"].id}
  454. assert data_nodes["dn_3"].parent_ids == {scenario_1.tasks["task_2"].id}
  455. additional_data_nodes = scenario_1.additional_data_nodes
  456. assert additional_data_nodes["additional_dn_1"].parent_ids == {scenario_1.id}
  457. assert additional_data_nodes["additional_dn_2"].parent_ids == {scenario_1.id}
  458. scenario_2 = _ScenarioManager._create(scenario_config_2)
  459. sequence_1_s2 = scenario_2.sequences["sequence_1"]
  460. sequence_2_s2 = scenario_2.sequences["sequence_2"]
  461. assert scenario_1.sequences["sequence_1"].parent_ids == {scenario_1.id}
  462. assert scenario_2.sequences["sequence_1"].parent_ids == {scenario_2.id}
  463. assert scenario_2.sequences["sequence_2"].parent_ids == {scenario_2.id}
  464. tasks = {**scenario_1.tasks, **scenario_2.tasks}
  465. assert tasks["task_1"].parent_ids == {
  466. scenario_1.id,
  467. scenario_2.id,
  468. sequence_1_s1.id,
  469. sequence_1_s2.id,
  470. sequence_2_s2.id,
  471. }
  472. assert tasks["task_2"].parent_ids == {scenario_1.id, scenario_2.id, sequence_1_s1.id, sequence_1_s2.id}
  473. assert tasks["task_3"].parent_ids == {scenario_2.id, sequence_2_s2.id}
  474. additional_data_nodes = scenario_2.additional_data_nodes
  475. assert additional_data_nodes["additional_dn_1"].parent_ids == {scenario_1.id, scenario_2.id}
  476. assert additional_data_nodes["additional_dn_2"].parent_ids == {scenario_1.id, scenario_2.id}
  477. def mult_by_2(nb: int):
  478. return nb * 2
  479. def mult_by_3(nb: int):
  480. return nb * 3
  481. def mult_by_4(nb: int):
  482. return nb * 4
  483. def test_scenario_manager_only_creates_data_node_once():
  484. # dn_1 ---> mult_by_2 ---> dn_2 ---> mult_by_3 ---> dn_6
  485. # dn_1 ---> mult_by_4 ---> dn_4
  486. dn_config_1 = Config.configure_data_node("foo", "in_memory", Scope.GLOBAL, default_data=1)
  487. dn_config_2 = Config.configure_data_node("bar", "in_memory", Scope.CYCLE, default_data=0)
  488. dn_config_6 = Config.configure_data_node("baz", "in_memory", Scope.CYCLE, default_data=0)
  489. dn_config_4 = Config.configure_data_node("qux", "in_memory", Scope.SCENARIO, default_data=0)
  490. task_mult_by_2_config = Config.configure_task("mult_by_2", mult_by_2, [dn_config_1], dn_config_2)
  491. task_mult_by_3_config = Config.configure_task("mult_by_3", mult_by_3, [dn_config_2], dn_config_6)
  492. task_mult_by_4_config = Config.configure_task("mult_by_4", mult_by_4, [dn_config_1], dn_config_4)
  493. scenario_config = Config.configure_scenario(
  494. "awesome_scenario", [task_mult_by_2_config, task_mult_by_3_config, task_mult_by_4_config], None, Frequency.DAILY
  495. )
  496. scenario_config.add_sequences(
  497. {"by_6": [task_mult_by_2_config, task_mult_by_3_config], "by_4": [task_mult_by_4_config]}
  498. )
  499. assert len(_DataManager._get_all()) == 0
  500. assert len(_TaskManager._get_all()) == 0
  501. assert len(_SequenceManager._get_all()) == 0
  502. assert len(_ScenarioManager._get_all()) == 0
  503. assert len(_CycleManager._get_all()) == 0
  504. scenario_1 = _ScenarioManager._create(scenario_config)
  505. assert len(_DataManager._get_all()) == 4
  506. assert len(_TaskManager._get_all()) == 3
  507. assert len(_SequenceManager._get_all()) == 2
  508. assert len(_ScenarioManager._get_all()) == 1
  509. assert scenario_1.foo.read() == 1
  510. assert scenario_1.bar.read() == 0
  511. assert scenario_1.baz.read() == 0
  512. assert scenario_1.qux.read() == 0
  513. assert scenario_1.by_6._get_sorted_tasks()[0][0].config_id == task_mult_by_2_config.id
  514. assert scenario_1.by_6._get_sorted_tasks()[1][0].config_id == task_mult_by_3_config.id
  515. assert scenario_1.by_4._get_sorted_tasks()[0][0].config_id == task_mult_by_4_config.id
  516. assert scenario_1.tasks.keys() == {task_mult_by_2_config.id, task_mult_by_3_config.id, task_mult_by_4_config.id}
  517. scenario_1_sorted_tasks = scenario_1._get_sorted_tasks()
  518. expected = [{task_mult_by_2_config.id, task_mult_by_4_config.id}, {task_mult_by_3_config.id}]
  519. for i, list_tasks_by_level in enumerate(scenario_1_sorted_tasks):
  520. assert {t.config_id for t in list_tasks_by_level} == expected[i]
  521. assert scenario_1.cycle.frequency == Frequency.DAILY
  522. _ScenarioManager._create(scenario_config)
  523. assert len(_DataManager._get_all()) == 5
  524. assert len(_TaskManager._get_all()) == 4
  525. assert len(_SequenceManager._get_all()) == 4
  526. assert len(_ScenarioManager._get_all()) == 2
  527. def test_notification_subscribe(mocker):
  528. mocker.patch("taipy.core._entity._reload._Reloader._reload", side_effect=lambda m, o: o)
  529. scenario_config = Config.configure_scenario(
  530. "awesome_scenario",
  531. [
  532. Config.configure_task(
  533. "mult_by_2",
  534. mult_by_2,
  535. [Config.configure_data_node("foo", "pickle", Scope.SCENARIO, default_data=1)],
  536. Config.configure_data_node("bar", "pickle", Scope.SCENARIO, default_data=0),
  537. )
  538. ],
  539. )
  540. scenario = _ScenarioManager._create(scenario_config)
  541. notify_1 = NotifyMock(scenario)
  542. notify_2 = NotifyMock(scenario)
  543. mocker.patch.object(
  544. _utils,
  545. "_load_fct",
  546. side_effect=[
  547. notify_1,
  548. notify_1,
  549. notify_1,
  550. notify_1,
  551. notify_2,
  552. notify_2,
  553. notify_2,
  554. notify_2,
  555. ],
  556. )
  557. # test subscribing notification
  558. _ScenarioManager._subscribe(callback=notify_1, scenario=scenario)
  559. _ScenarioManager._submit(scenario)
  560. notify_1.assert_called_3_times()
  561. notify_1.reset()
  562. # test unsubscribing notification
  563. # test notif subscribe only on new jobs
  564. _ScenarioManager._unsubscribe(callback=notify_1, scenario=scenario)
  565. _ScenarioManager._subscribe(callback=notify_2, scenario=scenario)
  566. _ScenarioManager._submit(scenario)
  567. notify_1.assert_not_called()
  568. notify_2.assert_called_3_times()
  569. def test_notification_subscribe_multiple_params(mocker):
  570. mocker.patch("taipy.core._entity._reload._Reloader._reload", side_effect=lambda m, o: o)
  571. scenario_config = Config.configure_scenario(
  572. "awesome_scenario",
  573. [
  574. Config.configure_task(
  575. "mult_by_2",
  576. mult_by_2,
  577. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  578. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  579. )
  580. ],
  581. )
  582. notify = mocker.Mock()
  583. scenario = _ScenarioManager._create(scenario_config)
  584. _ScenarioManager._subscribe(callback=notify, params=["foobar", 123, 1.2], scenario=scenario)
  585. mocker.patch.object(_ScenarioManager, "_get", return_value=scenario)
  586. _ScenarioManager._submit(scenario)
  587. notify.assert_called_with("foobar", 123, 1.2, scenario, ANY)
  588. def notify_multi_param(param, *args):
  589. assert len(param) == 3
  590. def notify1(*args, **kwargs): ...
  591. def notify2(*args, **kwargs): ...
  592. def test_notification_unsubscribe(mocker):
  593. mocker.patch("taipy.core._entity._reload._Reloader._reload", side_effect=lambda m, o: o)
  594. scenario_config = Config.configure_scenario(
  595. "awesome_scenario",
  596. [
  597. Config.configure_task(
  598. "mult_by_2",
  599. mult_by_2,
  600. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  601. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  602. )
  603. ],
  604. )
  605. scenario = _ScenarioManager._create(scenario_config)
  606. notify_1 = notify1
  607. notify_2 = notify2
  608. # test subscribing notification
  609. _ScenarioManager._subscribe(callback=notify_1, scenario=scenario)
  610. _ScenarioManager._unsubscribe(callback=notify_1, scenario=scenario)
  611. _ScenarioManager._subscribe(callback=notify_2, scenario=scenario)
  612. _ScenarioManager._submit(scenario.id)
  613. with pytest.raises(ValueError):
  614. _ScenarioManager._unsubscribe(callback=notify_1, scenario=scenario)
  615. _ScenarioManager._unsubscribe(callback=notify_2, scenario=scenario)
  616. def test_notification_unsubscribe_multi_param():
  617. scenario_config = Config.configure_scenario(
  618. "awesome_scenario",
  619. [
  620. Config.configure_task(
  621. "mult_by_2",
  622. mult_by_2,
  623. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  624. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  625. )
  626. ],
  627. )
  628. scenario = _ScenarioManager._create(scenario_config)
  629. # test subscribing notification
  630. _ScenarioManager._subscribe(callback=notify_multi_param, params=["foobar", 123, 0], scenario=scenario)
  631. _ScenarioManager._subscribe(callback=notify_multi_param, params=["foobar", 123, 1], scenario=scenario)
  632. _ScenarioManager._subscribe(callback=notify_multi_param, params=["foobar", 123, 2], scenario=scenario)
  633. assert len(scenario.subscribers) == 3
  634. # if no params are passed, removes the first occurrence of the subscriber when there's more than one copy
  635. scenario.unsubscribe(notify_multi_param)
  636. assert len(scenario.subscribers) == 2
  637. assert _Subscriber(notify_multi_param, ["foobar", 123, 0]) not in scenario.subscribers
  638. # If params are passed, find the corresponding pair of callback and params to remove
  639. scenario.unsubscribe(notify_multi_param, ["foobar", 123, 2])
  640. assert len(scenario.subscribers) == 1
  641. assert _Subscriber(notify_multi_param, ["foobar", 123, 2]) not in scenario.subscribers
  642. # If params are passed but is not on the list of subscribers, throws a ValueErrors
  643. with pytest.raises(ValueError):
  644. scenario.unsubscribe(notify_multi_param, ["foobar", 123, 10000])
  645. def test_scenario_notification_subscribe_all():
  646. scenario_config = Config.configure_scenario(
  647. "awesome_scenario",
  648. [
  649. Config.configure_task(
  650. "mult_by_2",
  651. mult_by_2,
  652. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  653. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  654. )
  655. ],
  656. )
  657. other_scenario_config = Config.configure_scenario(
  658. "other_scenario",
  659. [
  660. Config.configure_task(
  661. "other_mult_by_2_2",
  662. mult_by_2,
  663. [Config.configure_data_node("other_foo", "in_memory", Scope.SCENARIO, default_data=1)],
  664. Config.configure_data_node("other_bar", "in_memory", Scope.SCENARIO, default_data=0),
  665. )
  666. ],
  667. )
  668. scenario = _ScenarioManager._create(scenario_config)
  669. other_scenario = _ScenarioManager._create(other_scenario_config)
  670. notify_1 = NotifyMock(scenario)
  671. _ScenarioManager._subscribe(notify_1)
  672. assert len(_ScenarioManager._get(scenario.id).subscribers) == 1
  673. assert len(_ScenarioManager._get(other_scenario.id).subscribers) == 1
  674. def test_is_promotable_to_primary_scenario():
  675. assert len(_ScenarioManager._get_all()) == 0
  676. scenario_config = Config.configure_scenario("sc", set(), set(), Frequency.DAILY)
  677. creation_date = datetime.now()
  678. scenario_1 = _ScenarioManager._create(scenario_config, creation_date=creation_date, name="1") # primary scenario
  679. scenario_2 = _ScenarioManager._create(scenario_config, creation_date=creation_date, name="2")
  680. assert len(_ScenarioManager._get_all()) == 2
  681. assert scenario_1.is_primary
  682. assert not _ScenarioManager._is_promotable_to_primary(scenario_1)
  683. assert not _ScenarioManager._is_promotable_to_primary(scenario_1.id)
  684. assert not scenario_2.is_primary
  685. assert _ScenarioManager._is_promotable_to_primary(scenario_2)
  686. assert _ScenarioManager._is_promotable_to_primary(scenario_2.id)
  687. _ScenarioManager._set_primary(scenario_2)
  688. assert len(_ScenarioManager._get_all()) == 2
  689. assert not scenario_1.is_primary
  690. assert _ScenarioManager._is_promotable_to_primary(scenario_1)
  691. assert _ScenarioManager._is_promotable_to_primary(scenario_1.id)
  692. assert scenario_2.is_primary
  693. assert not _ScenarioManager._is_promotable_to_primary(scenario_2)
  694. assert not _ScenarioManager._is_promotable_to_primary(scenario_2.id)
  695. def test_get_set_primary_scenario():
  696. cycle_1 = _CycleManager._create(Frequency.DAILY, name="foo")
  697. scenario_1 = Scenario("sc_1", [], {}, ScenarioId("sc_1"), is_primary=False, cycle=cycle_1)
  698. scenario_2 = Scenario("sc_2", [], {}, ScenarioId("sc_2"), is_primary=False, cycle=cycle_1)
  699. _ScenarioManager._delete_all()
  700. _CycleManager._delete_all()
  701. assert len(_ScenarioManager._get_all()) == 0
  702. assert len(_CycleManager._get_all()) == 0
  703. _CycleManager._set(cycle_1)
  704. _ScenarioManager._set(scenario_1)
  705. _ScenarioManager._set(scenario_2)
  706. assert len(_ScenarioManager._get_primary_scenarios()) == 0
  707. assert len(_ScenarioManager._get_all_by_cycle(cycle_1)) == 2
  708. _ScenarioManager._set_primary(scenario_1)
  709. assert len(_ScenarioManager._get_primary_scenarios()) == 1
  710. assert len(_ScenarioManager._get_all_by_cycle(cycle_1)) == 2
  711. assert _ScenarioManager._get_primary(cycle_1) == scenario_1
  712. _ScenarioManager._set_primary(scenario_2)
  713. assert len(_ScenarioManager._get_primary_scenarios()) == 1
  714. assert len(_ScenarioManager._get_all_by_cycle(cycle_1)) == 2
  715. assert _ScenarioManager._get_primary(cycle_1) == scenario_2
  716. def test_get_primary_scenarios_sorted():
  717. scenario_1_cfg = Config.configure_scenario(id="scenario_1", frequency=Frequency.DAILY)
  718. scenario_2_cfg = Config.configure_scenario(id="scenario_2", frequency=Frequency.DAILY)
  719. not_primary_scenario = _ScenarioManager._create(scenario_1_cfg, name="not_primary_scenario")
  720. now = datetime.now()
  721. scenario_1 = _ScenarioManager._create(scenario_1_cfg, now, "B_scenario")
  722. scenario_2 = _ScenarioManager._create(scenario_2_cfg, now + timedelta(days=2), "A_scenario")
  723. scenario_3 = _ScenarioManager._create(scenario_2_cfg, now + timedelta(days=4), "C_scenario")
  724. scenario_4 = _ScenarioManager._create(scenario_2_cfg, now + timedelta(days=3), "D_scenario")
  725. _ScenarioManager._set_primary(scenario_1)
  726. scenario_1.tags = ["banana", "kiwi"]
  727. _ScenarioManager._set_primary(scenario_2)
  728. scenario_2.tags = ["apple", "banana"]
  729. _ScenarioManager._set_primary(scenario_3)
  730. scenario_3.tags = ["banana", "kiwi"]
  731. _ScenarioManager._set_primary(scenario_4)
  732. all_scenarios = tp.get_scenarios()
  733. assert not_primary_scenario in all_scenarios
  734. primary_scenarios = _ScenarioManager._get_primary_scenarios()
  735. assert not_primary_scenario not in primary_scenarios
  736. primary_scenarios_sorted_by_name = [scenario_2, scenario_1, scenario_3, scenario_4]
  737. assert primary_scenarios_sorted_by_name == _ScenarioManager._sort_scenarios(
  738. primary_scenarios, descending=False, sort_key="name"
  739. )
  740. scenarios_with_same_config_id = [scenario_2, scenario_3, scenario_4]
  741. scenarios_with_same_config_id.sort(key=lambda x: x.id)
  742. primary_scenarios_sorted_by_config_id = [
  743. scenario_1,
  744. scenarios_with_same_config_id[0],
  745. scenarios_with_same_config_id[1],
  746. scenarios_with_same_config_id[2],
  747. ]
  748. assert primary_scenarios_sorted_by_config_id == _ScenarioManager._sort_scenarios(
  749. primary_scenarios, descending=False, sort_key="config_id"
  750. )
  751. scenarios_sorted_by_id = [scenario_1, scenario_2, scenario_3, scenario_4]
  752. scenarios_sorted_by_id.sort(key=lambda x: x.id)
  753. assert scenarios_sorted_by_id == _ScenarioManager._sort_scenarios(
  754. primary_scenarios, descending=False, sort_key="id"
  755. )
  756. primary_scenarios_sorted_by_creation_date = [scenario_1, scenario_2, scenario_4, scenario_3]
  757. assert primary_scenarios_sorted_by_creation_date == _ScenarioManager._sort_scenarios(
  758. primary_scenarios, descending=False, sort_key="creation_date"
  759. )
  760. scenarios_with_same_tags = [scenario_1, scenario_3]
  761. scenarios_with_same_tags.sort(key=lambda x: x.id)
  762. primary_scenarios_sorted_by_tags = [
  763. scenario_4,
  764. scenario_2,
  765. scenarios_with_same_tags[0],
  766. scenarios_with_same_tags[1],
  767. ]
  768. assert primary_scenarios_sorted_by_tags == _ScenarioManager._sort_scenarios(
  769. primary_scenarios, descending=False, sort_key="tags"
  770. )
  771. primary_scenarios_sorted_by_name_descending_order = [scenario_4, scenario_3, scenario_1, scenario_2]
  772. assert primary_scenarios_sorted_by_name_descending_order == _ScenarioManager._sort_scenarios(
  773. primary_scenarios, descending=True, sort_key="name"
  774. )
  775. def test_hard_delete_one_single_scenario_with_scenario_data_nodes():
  776. dn_input_config = Config.configure_data_node("my_input", "in_memory", scope=Scope.SCENARIO, default_data="testing")
  777. dn_output_config = Config.configure_data_node("my_output", "in_memory", scope=Scope.SCENARIO)
  778. task_config = Config.configure_task("task_config", print, dn_input_config, dn_output_config)
  779. scenario_config = Config.configure_scenario("scenario_config", [task_config])
  780. scenario_config.add_sequences({"sequence_config": [task_config]})
  781. scenario = _ScenarioManager._create(scenario_config)
  782. _ScenarioManager._submit(scenario.id)
  783. assert len(_ScenarioManager._get_all()) == 1
  784. assert len(_SequenceManager._get_all()) == 1
  785. assert len(_TaskManager._get_all()) == 1
  786. assert len(_DataManager._get_all()) == 2
  787. assert len(_JobManager._get_all()) == 1
  788. _ScenarioManager._hard_delete(scenario.id)
  789. assert len(_ScenarioManager._get_all()) == 0
  790. assert len(_SequenceManager._get_all()) == 0
  791. assert len(_TaskManager._get_all()) == 0
  792. assert len(_DataManager._get_all()) == 0
  793. assert len(_JobManager._get_all()) == 0
  794. def test_hard_delete_one_scenario_among_two_with_scenario_data_nodes():
  795. dn_input_config = Config.configure_data_node("my_input", "in_memory", scope=Scope.SCENARIO, default_data="testing")
  796. dn_output_config = Config.configure_data_node("my_output", "in_memory", scope=Scope.SCENARIO)
  797. task_config = Config.configure_task("task_config", print, dn_input_config, dn_output_config)
  798. scenario_config = Config.configure_scenario("scenario_config", [task_config])
  799. scenario_config.add_sequences({"sequence_config": [task_config]})
  800. scenario_1 = _ScenarioManager._create(scenario_config)
  801. scenario_2 = _ScenarioManager._create(scenario_config)
  802. _ScenarioManager._submit(scenario_1.id)
  803. _ScenarioManager._submit(scenario_2.id)
  804. assert len(_ScenarioManager._get_all()) == 2
  805. assert len(_SequenceManager._get_all()) == 2
  806. assert len(_TaskManager._get_all()) == 2
  807. assert len(_DataManager._get_all()) == 4
  808. assert len(_JobManager._get_all()) == 2
  809. _ScenarioManager._hard_delete(scenario_1.id)
  810. assert len(_ScenarioManager._get_all()) == 1
  811. assert len(_SequenceManager._get_all()) == 1
  812. assert len(_TaskManager._get_all()) == 1
  813. assert len(_DataManager._get_all()) == 2
  814. assert len(_JobManager._get_all()) == 1
  815. assert _ScenarioManager._get(scenario_2.id) is not None
  816. def test_hard_delete_one_scenario_among_two_with_cycle_data_nodes():
  817. dn_input_config = Config.configure_data_node("my_input", "in_memory", scope=Scope.CYCLE, default_data="testing")
  818. dn_output_config = Config.configure_data_node("my_output", "in_memory", scope=Scope.CYCLE)
  819. task_config = Config.configure_task("task_config", print, dn_input_config, dn_output_config)
  820. scenario_config = Config.configure_scenario("scenario_config", [task_config])
  821. scenario_config.add_sequences({"sequence_config": [task_config]})
  822. scenario_1 = _ScenarioManager._create(scenario_config)
  823. scenario_2 = _ScenarioManager._create(scenario_config)
  824. _ScenarioManager._submit(scenario_1.id)
  825. _ScenarioManager._submit(scenario_2.id)
  826. assert len(_ScenarioManager._get_all()) == 2
  827. assert len(_SequenceManager._get_all()) == 2
  828. assert len(_TaskManager._get_all()) == 1
  829. assert len(_DataManager._get_all()) == 2
  830. assert len(_JobManager._get_all()) == 2
  831. _ScenarioManager._hard_delete(scenario_1.id)
  832. assert len(_ScenarioManager._get_all()) == 1
  833. assert len(_SequenceManager._get_all()) == 1
  834. assert len(_TaskManager._get_all()) == 1
  835. assert len(_DataManager._get_all()) == 2
  836. assert len(_JobManager._get_all()) == 2
  837. assert _ScenarioManager._get(scenario_2.id) is not None
  838. def test_hard_delete_shared_entities():
  839. dn_config_1 = Config.configure_data_node("my_input_1", "in_memory", scope=Scope.CYCLE, default_data="testing")
  840. dn_config_2 = Config.configure_data_node("my_input_2", "in_memory", scope=Scope.SCENARIO, default_data="testing")
  841. dn_config_3 = Config.configure_data_node("my_input_3", "in_memory", scope=Scope.GLOBAL, default_data="testing")
  842. dn_config_4 = Config.configure_data_node("my_input_4", "in_memory", scope=Scope.GLOBAL, default_data="testing")
  843. task_config_1 = Config.configure_task("task_config_1", print, dn_config_1, dn_config_2)
  844. task_config_2 = Config.configure_task("task_config_2", print, dn_config_2, dn_config_3)
  845. task_config_3 = Config.configure_task("task_config_3", print, dn_config_3, dn_config_4) # scope = global
  846. task_config_4 = Config.configure_task("task_config_4", print, dn_config_1) # scope = cycle
  847. scenario_config_1 = Config.configure_scenario(
  848. "scenario_config_1",
  849. [task_config_1, task_config_2, task_config_3, task_config_4],
  850. frequency=Frequency.WEEKLY,
  851. )
  852. scenario_config_1.add_sequences(
  853. {
  854. "sequence_config_1": [task_config_1, task_config_2],
  855. "sequence_config_2": [task_config_1, task_config_2],
  856. "sequence_config_3": [task_config_3],
  857. "sequence_config_4": [task_config_4],
  858. }
  859. )
  860. scenario_1 = _ScenarioManager._create(scenario_config_1)
  861. scenario_2 = _ScenarioManager._create(scenario_config_1)
  862. scenario_1.submit()
  863. scenario_2.submit()
  864. assert len(_CycleManager._get_all()) == 1
  865. assert len(_ScenarioManager._get_all()) == 2
  866. assert len(_SequenceManager._get_all()) == 8
  867. assert len(_TaskManager._get_all()) == 6
  868. assert len(_DataManager._get_all()) == 5
  869. assert len(_JobManager._get_all()) == 8
  870. _ScenarioManager._hard_delete(scenario_2.id)
  871. assert len(_CycleManager._get_all()) == 1
  872. assert len(_ScenarioManager._get_all()) == 1
  873. assert len(_SequenceManager._get_all()) == 4
  874. assert len(_TaskManager._get_all()) == 4
  875. assert len(_DataManager._get_all()) == 4
  876. assert len(_JobManager._get_all()) == 6
  877. def test_is_submittable():
  878. assert len(_ScenarioManager._get_all()) == 0
  879. dn_config = Config.configure_in_memory_data_node("dn", 10)
  880. task_config = Config.configure_task("task", print, [dn_config])
  881. scenario_config = Config.configure_scenario("sc", {task_config}, set(), Frequency.DAILY)
  882. scenario = _ScenarioManager._create(scenario_config)
  883. rc = _ScenarioManager._is_submittable("some_scenario")
  884. assert not rc
  885. assert "Entity some_scenario does not exist in the repository." in rc.reasons
  886. assert len(_ScenarioManager._get_all()) == 1
  887. assert _ScenarioManager._is_submittable(scenario)
  888. assert _ScenarioManager._is_submittable(scenario.id)
  889. assert not _ScenarioManager._is_submittable("Scenario_temp")
  890. scenario.dn.edit_in_progress = True
  891. assert not _ScenarioManager._is_submittable(scenario)
  892. assert not _ScenarioManager._is_submittable(scenario.id)
  893. scenario.dn.edit_in_progress = False
  894. assert _ScenarioManager._is_submittable(scenario)
  895. assert _ScenarioManager._is_submittable(scenario.id)
  896. def test_submit():
  897. data_node_1 = InMemoryDataNode("foo", Scope.SCENARIO, "s1")
  898. data_node_2 = InMemoryDataNode("bar", Scope.SCENARIO, "s2")
  899. data_node_3 = InMemoryDataNode("baz", Scope.SCENARIO, "s3")
  900. data_node_4 = InMemoryDataNode("qux", Scope.SCENARIO, "s4")
  901. data_node_5 = InMemoryDataNode("quux", Scope.SCENARIO, "s5")
  902. data_node_6 = InMemoryDataNode("quuz", Scope.SCENARIO, "s6")
  903. data_node_7 = InMemoryDataNode("corge", Scope.SCENARIO, "s7")
  904. data_node_8 = InMemoryDataNode("fum", Scope.SCENARIO, "s8")
  905. task_1 = Task(
  906. "grault",
  907. {},
  908. print,
  909. [data_node_1, data_node_2],
  910. [data_node_3, data_node_4],
  911. TaskId("t1"),
  912. )
  913. task_2 = Task("garply", {}, print, [data_node_3], [data_node_5], TaskId("t2"))
  914. task_3 = Task("waldo", {}, print, [data_node_5, data_node_4], [data_node_6], TaskId("t3"))
  915. task_4 = Task("fred", {}, print, [data_node_4], [data_node_7], TaskId("t4"))
  916. task_5 = Task("thud", {}, print, [data_node_6], [data_node_8], TaskId("t5"))
  917. scenario = Scenario(
  918. "scenario_name",
  919. [task_5, task_4, task_2, task_1, task_3],
  920. {},
  921. [],
  922. ScenarioId("sce_id"),
  923. )
  924. class MockOrchestrator(_Orchestrator):
  925. submit_calls = []
  926. @classmethod
  927. def _lock_dn_output_and_create_job(
  928. cls,
  929. task: Task,
  930. submit_id: str,
  931. submit_entity_id: str,
  932. callbacks: Optional[Iterable[Callable]] = None,
  933. force: bool = False,
  934. ) -> Job:
  935. cls.submit_calls.append(task.id)
  936. return super()._lock_dn_output_and_create_job(task, submit_id, submit_entity_id, callbacks, force)
  937. with patch("taipy.core.task._task_manager._TaskManager._orchestrator", new=MockOrchestrator):
  938. with pytest.raises(NonExistingScenario):
  939. _ScenarioManager._submit(scenario.id)
  940. with pytest.raises(NonExistingScenario):
  941. _ScenarioManager._submit(scenario)
  942. # scenario and sequence do exist, but tasks does not exist.
  943. # We expect an exception to be raised
  944. _ScenarioManager._set(scenario)
  945. with pytest.raises(NonExistingTask):
  946. _ScenarioManager._submit(scenario.id)
  947. with pytest.raises(NonExistingTask):
  948. _ScenarioManager._submit(scenario)
  949. # scenario, sequence, and tasks do exist.
  950. # We expect all the tasks to be submitted once,
  951. # and respecting specific constraints on the order
  952. _TaskManager._set(task_1)
  953. _TaskManager._set(task_2)
  954. _TaskManager._set(task_3)
  955. _TaskManager._set(task_4)
  956. _TaskManager._set(task_5)
  957. _ScenarioManager._submit(scenario.id)
  958. submit_calls = _TaskManager._orchestrator().submit_calls
  959. assert len(submit_calls) == 5
  960. assert set(submit_calls) == {task_1.id, task_2.id, task_4.id, task_3.id, task_5.id}
  961. assert submit_calls.index(task_2.id) < submit_calls.index(task_3.id)
  962. assert submit_calls.index(task_1.id) < submit_calls.index(task_3.id)
  963. assert submit_calls.index(task_1.id) < submit_calls.index(task_2.id)
  964. assert submit_calls.index(task_1.id) < submit_calls.index(task_4.id)
  965. _ScenarioManager._submit(scenario)
  966. submit_calls = _TaskManager._orchestrator().submit_calls
  967. assert len(submit_calls) == 10
  968. assert set(submit_calls) == {task_1.id, task_2.id, task_4.id, task_3.id, task_5.id}
  969. assert submit_calls.index(task_2.id) < submit_calls.index(task_3.id)
  970. assert submit_calls.index(task_1.id) < submit_calls.index(task_3.id)
  971. assert submit_calls.index(task_1.id) < submit_calls.index(task_2.id)
  972. assert submit_calls.index(task_1.id) < submit_calls.index(task_4.id)
  973. def my_print(a, b):
  974. print(a + b) # noqa: T201
  975. def test_submit_task_with_input_dn_wrong_file_path(caplog):
  976. csv_dn_cfg = Config.configure_csv_data_node("wrong_csv_file_path", default_path="wrong_path.csv")
  977. pickle_dn_cfg = Config.configure_pickle_data_node("wrong_pickle_file_path", default_path="wrong_path.pickle")
  978. parquet_dn_cfg = Config.configure_parquet_data_node("wrong_parquet_file_path", default_path="wrong_path.parquet")
  979. json_dn_cfg = Config.configure_parquet_data_node("wrong_json_file_path", default_path="wrong_path.json")
  980. task_cfg = Config.configure_task("task", my_print, [csv_dn_cfg, pickle_dn_cfg], parquet_dn_cfg)
  981. task_2_cfg = Config.configure_task("task2", my_print, [csv_dn_cfg, parquet_dn_cfg], json_dn_cfg)
  982. scenario_cfg = Config.configure_scenario("scenario", [task_cfg, task_2_cfg])
  983. sc_manager = _ScenarioManagerFactory._build_manager()
  984. scenario = sc_manager._create(scenario_cfg)
  985. sc_manager._submit(scenario)
  986. stdout = caplog.text
  987. expected_outputs = [
  988. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  989. f"path : {input_dn.path} "
  990. for input_dn in scenario.get_inputs()
  991. ]
  992. not_expected_outputs = [
  993. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  994. f"path : {input_dn.path} "
  995. for input_dn in scenario.data_nodes.values()
  996. if input_dn not in scenario.get_inputs()
  997. ]
  998. assert all(expected_output in stdout for expected_output in expected_outputs)
  999. assert all(expected_output not in stdout for expected_output in not_expected_outputs)
  1000. def test_submit_task_with_one_input_dn_wrong_file_path(caplog):
  1001. csv_dn_cfg = Config.configure_csv_data_node("wrong_csv_file_path", default_path="wrong_path.csv")
  1002. pickle_dn_cfg = Config.configure_pickle_data_node("wrong_pickle_file_path", default_data="value")
  1003. parquet_dn_cfg = Config.configure_parquet_data_node("wrong_parquet_file_path", default_path="wrong_path.parquet")
  1004. json_dn_cfg = Config.configure_parquet_data_node("wrong_json_file_path", default_path="wrong_path.json")
  1005. task_cfg = Config.configure_task("task", my_print, [csv_dn_cfg, pickle_dn_cfg], parquet_dn_cfg)
  1006. task_2_cfg = Config.configure_task("task2", my_print, [csv_dn_cfg, parquet_dn_cfg], json_dn_cfg)
  1007. scenario_cfg = Config.configure_scenario("scenario", [task_cfg, task_2_cfg])
  1008. sce_manager = _ScenarioManagerFactory._build_manager()
  1009. scenario = sce_manager._create(scenario_cfg)
  1010. sce_manager._submit(scenario)
  1011. stdout = caplog.text
  1012. expected_outputs = [
  1013. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  1014. f"path : {input_dn.path} "
  1015. for input_dn in scenario.get_inputs()
  1016. if input_dn.config_id == "wrong_csv_file_path"
  1017. ]
  1018. not_expected_outputs = [
  1019. f"{input_dn.id} cannot be read because it has never been written. Hint: The data node may refer to a wrong "
  1020. f"path : {input_dn.path} "
  1021. for input_dn in scenario.data_nodes.values()
  1022. if input_dn.config_id != "wrong_csv_file_path"
  1023. ]
  1024. assert all(expected_output in stdout for expected_output in expected_outputs)
  1025. assert all(expected_output not in stdout for expected_output in not_expected_outputs)
  1026. def subtraction(n1, n2):
  1027. return n1 - n2
  1028. def addition(n1, n2):
  1029. return n1 + n2
  1030. def test_scenarios_comparison():
  1031. scenario_config = Config.configure_scenario(
  1032. "Awesome_scenario",
  1033. [
  1034. Config.configure_task(
  1035. "mult_by_2",
  1036. mult_by_2,
  1037. [Config.configure_data_node("foo", "in_memory", Scope.SCENARIO, default_data=1)],
  1038. Config.configure_data_node("bar", "in_memory", Scope.SCENARIO, default_data=0),
  1039. )
  1040. ],
  1041. comparators={"bar": [subtraction], "foo": [subtraction, addition]},
  1042. )
  1043. assert scenario_config.comparators is not None
  1044. scenario_1 = _ScenarioManager._create(scenario_config)
  1045. scenario_2 = _ScenarioManager._create(scenario_config)
  1046. with pytest.raises(InsufficientScenarioToCompare):
  1047. _ScenarioManager._compare(scenario_1, data_node_config_id="bar")
  1048. scenario_3 = Scenario("awesome_scenario_config", [], {})
  1049. with pytest.raises(DifferentScenarioConfigs):
  1050. _ScenarioManager._compare(scenario_1, scenario_3, data_node_config_id="bar")
  1051. _ScenarioManager._submit(scenario_1.id)
  1052. _ScenarioManager._submit(scenario_2.id)
  1053. bar_comparison = _ScenarioManager._compare(scenario_1, scenario_2, data_node_config_id="bar")["bar"]
  1054. assert bar_comparison["subtraction"] == 0
  1055. foo_comparison = _ScenarioManager._compare(scenario_1, scenario_2, data_node_config_id="foo")["foo"]
  1056. assert len(foo_comparison.keys()) == 2
  1057. assert foo_comparison["addition"] == 2
  1058. assert foo_comparison["subtraction"] == 0
  1059. assert len(_ScenarioManager._compare(scenario_1, scenario_2).keys()) == 2
  1060. with pytest.raises(NonExistingScenarioConfig):
  1061. _ScenarioManager._compare(scenario_3, scenario_3)
  1062. with pytest.raises(NonExistingComparator):
  1063. _ScenarioManager._compare(scenario_1, scenario_2, data_node_config_id="abc")
  1064. def test_tags():
  1065. cycle_1 = _CycleManager._create(Frequency.DAILY, name="today", creation_date=datetime.now())
  1066. cycle_2 = _CycleManager._create(
  1067. Frequency.DAILY,
  1068. name="tomorrow",
  1069. creation_date=datetime.now() + timedelta(days=1),
  1070. )
  1071. cycle_3 = _CycleManager._create(
  1072. Frequency.DAILY,
  1073. name="yesterday",
  1074. creation_date=datetime.now() + timedelta(days=-1),
  1075. )
  1076. scenario_no_tag = Scenario("scenario_no_tag", [], {}, [], ScenarioId("scenario_no_tag"), cycle=cycle_1)
  1077. scenario_1_tag = Scenario(
  1078. "scenario_1_tag",
  1079. [],
  1080. {},
  1081. [],
  1082. ScenarioId("scenario_1_tag"),
  1083. cycle=cycle_1,
  1084. tags={"fst"},
  1085. )
  1086. scenario_2_tags = Scenario(
  1087. "scenario_2_tags",
  1088. [],
  1089. {},
  1090. [],
  1091. ScenarioId("scenario_2_tags"),
  1092. cycle=cycle_2,
  1093. tags={"fst", "scd"},
  1094. )
  1095. # Test has_tag
  1096. assert len(scenario_no_tag.tags) == 0
  1097. assert not scenario_no_tag.has_tag("fst")
  1098. assert not scenario_no_tag.has_tag("scd")
  1099. assert len(scenario_1_tag.tags) == 1
  1100. assert scenario_1_tag.has_tag("fst")
  1101. assert not scenario_1_tag.has_tag("scd")
  1102. assert len(scenario_2_tags.tags) == 2
  1103. assert scenario_2_tags.has_tag("fst")
  1104. assert scenario_2_tags.has_tag("scd")
  1105. # test get and set serialize/deserialize tags
  1106. _CycleManager._set(cycle_1)
  1107. _CycleManager._set(cycle_2)
  1108. _CycleManager._set(cycle_3)
  1109. _ScenarioManager._set(scenario_no_tag)
  1110. _ScenarioManager._set(scenario_1_tag)
  1111. _ScenarioManager._set(scenario_2_tags)
  1112. assert len(_ScenarioManager._get(ScenarioId("scenario_no_tag")).tags) == 0
  1113. assert not _ScenarioManager._get(ScenarioId("scenario_no_tag")).has_tag("fst")
  1114. assert not _ScenarioManager._get(ScenarioId("scenario_no_tag")).has_tag("scd")
  1115. assert len(_ScenarioManager._get(ScenarioId("scenario_1_tag")).tags) == 1
  1116. assert "fst" in _ScenarioManager._get(ScenarioId("scenario_1_tag")).tags
  1117. assert "scd" not in _ScenarioManager._get(ScenarioId("scenario_1_tag")).tags
  1118. assert len(_ScenarioManager._get(ScenarioId("scenario_2_tags")).tags) == 2
  1119. assert "fst" in _ScenarioManager._get(ScenarioId("scenario_2_tags")).tags
  1120. assert "scd" in _ScenarioManager._get(ScenarioId("scenario_2_tags")).tags
  1121. # Test tag & untag
  1122. _ScenarioManager._tag(scenario_no_tag, "thd") # add new tag
  1123. _ScenarioManager._untag(scenario_1_tag, "NOT_EXISTING_TAG") # remove not existing tag does nothing
  1124. _ScenarioManager._untag(scenario_1_tag, "fst") # remove `fst` tag
  1125. assert len(scenario_no_tag.tags) == 1
  1126. assert not scenario_no_tag.has_tag("fst")
  1127. assert not scenario_no_tag.has_tag("scd")
  1128. assert scenario_no_tag.has_tag("thd")
  1129. assert len(scenario_1_tag.tags) == 0
  1130. assert not scenario_1_tag.has_tag("fst")
  1131. assert not scenario_1_tag.has_tag("scd")
  1132. assert not scenario_1_tag.has_tag("thd")
  1133. assert len(scenario_2_tags.tags) == 2
  1134. assert scenario_2_tags.has_tag("fst")
  1135. assert scenario_2_tags.has_tag("scd")
  1136. assert not scenario_2_tags.has_tag("thd")
  1137. _ScenarioManager._untag(scenario_no_tag, "thd")
  1138. _ScenarioManager._set(scenario_no_tag)
  1139. _ScenarioManager._tag(scenario_1_tag, "fst")
  1140. _ScenarioManager._set(scenario_1_tag)
  1141. # test getters
  1142. assert _ScenarioManager._get_all_by_cycle_tag(cycle_3, "fst") == []
  1143. assert _ScenarioManager._get_all_by_cycle_tag(cycle_3, "scd") == []
  1144. assert _ScenarioManager._get_all_by_cycle_tag(cycle_3, "thd") == []
  1145. assert _ScenarioManager._get_all_by_cycle_tag(cycle_2, "fst") == [scenario_2_tags]
  1146. assert _ScenarioManager._get_all_by_cycle_tag(cycle_2, "scd") == [scenario_2_tags]
  1147. assert _ScenarioManager._get_all_by_cycle_tag(cycle_2, "thd") == []
  1148. assert _ScenarioManager._get_all_by_cycle_tag(cycle_1, "fst") == [scenario_1_tag]
  1149. assert _ScenarioManager._get_all_by_cycle_tag(cycle_1, "scd") == []
  1150. assert _ScenarioManager._get_all_by_cycle_tag(cycle_1, "thd") == []
  1151. assert len(_ScenarioManager._get_all_by_tag("NOT_EXISTING")) == 0
  1152. assert scenario_1_tag in _ScenarioManager._get_all_by_tag("fst")
  1153. assert scenario_2_tags in _ScenarioManager._get_all_by_tag("fst")
  1154. assert _ScenarioManager._get_all_by_tag("scd") == [scenario_2_tags]
  1155. assert len(_ScenarioManager._get_all_by_tag("thd")) == 0
  1156. # test tag cycle mgt
  1157. _ScenarioManager._tag(scenario_no_tag, "fst") # tag sc_no_tag with fst should not affect sc_1_tag and sc_2_tags
  1158. assert _ScenarioManager._get_all_by_cycle_tag(cycle_3, "fst") == []
  1159. assert _ScenarioManager._get_all_by_cycle_tag(cycle_3, "scd") == []
  1160. assert _ScenarioManager._get_all_by_cycle_tag(cycle_3, "thd") == []
  1161. assert _ScenarioManager._get_all_by_cycle_tag(cycle_2, "fst") == [scenario_2_tags]
  1162. assert _ScenarioManager._get_all_by_cycle_tag(cycle_2, "scd") == [scenario_2_tags]
  1163. assert _ScenarioManager._get_all_by_cycle_tag(cycle_2, "thd") == []
  1164. assert sorted([s.id for s in _ScenarioManager._get_all_by_cycle_tag(cycle_1, "fst")]) == sorted(
  1165. [s.id for s in [scenario_no_tag, scenario_1_tag]]
  1166. )
  1167. assert _ScenarioManager._get_all_by_cycle_tag(cycle_1, "scd") == []
  1168. assert _ScenarioManager._get_all_by_cycle_tag(cycle_1, "thd") == []
  1169. assert len(_ScenarioManager._get_all_by_tag("NOT_EXISTING")) == 0
  1170. assert len(_ScenarioManager._get_all_by_tag("fst")) == 3
  1171. assert scenario_2_tags in _ScenarioManager._get_all_by_tag("fst")
  1172. assert scenario_no_tag in _ScenarioManager._get_all_by_tag("fst")
  1173. assert _ScenarioManager._get_all_by_tag("scd") == [scenario_2_tags]
  1174. assert len(_ScenarioManager._get_all_by_tag("thd")) == 0
  1175. def test_authorized_tags():
  1176. scenario = Scenario("scenario_1", [], {"authorized_tags": ["foo", "bar"]}, [], ScenarioId("scenario_1"))
  1177. scenario_2_cfg = Config.configure_scenario("scenario_2", [], [], Frequency.DAILY, authorized_tags=["foo", "bar"])
  1178. scenario_2 = _ScenarioManager._create(scenario_2_cfg)
  1179. _ScenarioManager._set(scenario)
  1180. assert len(scenario.tags) == 0
  1181. assert len(scenario_2.tags) == 0
  1182. with pytest.raises(UnauthorizedTagError):
  1183. _ScenarioManager._tag(scenario, "baz")
  1184. _ScenarioManager._tag(scenario_2, "baz")
  1185. assert len(scenario.tags) == 0
  1186. assert len(scenario_2.tags) == 0
  1187. _ScenarioManager._tag(scenario, "foo")
  1188. _ScenarioManager._tag(scenario_2, "foo")
  1189. assert len(scenario.tags) == 1
  1190. assert len(scenario_2.tags) == 1
  1191. _ScenarioManager._tag(scenario, "bar")
  1192. _ScenarioManager._tag(scenario_2, "bar")
  1193. assert len(scenario.tags) == 2
  1194. assert len(scenario_2.tags) == 2
  1195. _ScenarioManager._tag(scenario, "foo")
  1196. _ScenarioManager._tag(scenario_2, "foo")
  1197. assert len(scenario.tags) == 2
  1198. assert len(scenario_2.tags) == 2
  1199. _ScenarioManager._untag(scenario, "foo")
  1200. _ScenarioManager._untag(scenario_2, "foo")
  1201. assert len(scenario.tags) == 1
  1202. assert len(scenario_2.tags) == 1
  1203. def test_get_scenarios_by_config_id():
  1204. scenario_config_1 = Config.configure_scenario("s1", sequence_configs=[])
  1205. scenario_config_2 = Config.configure_scenario("s2", sequence_configs=[])
  1206. scenario_config_3 = Config.configure_scenario("s3", sequence_configs=[])
  1207. s_1_1 = _ScenarioManager._create(scenario_config_1)
  1208. s_1_2 = _ScenarioManager._create(scenario_config_1)
  1209. s_1_3 = _ScenarioManager._create(scenario_config_1)
  1210. assert len(_ScenarioManager._get_all()) == 3
  1211. s_2_1 = _ScenarioManager._create(scenario_config_2)
  1212. s_2_2 = _ScenarioManager._create(scenario_config_2)
  1213. assert len(_ScenarioManager._get_all()) == 5
  1214. s_3_1 = _ScenarioManager._create(scenario_config_3)
  1215. assert len(_ScenarioManager._get_all()) == 6
  1216. s1_scenarios = _ScenarioManager._get_by_config_id(scenario_config_1.id)
  1217. assert len(s1_scenarios) == 3
  1218. assert sorted([s_1_1.id, s_1_2.id, s_1_3.id]) == sorted([scenario.id for scenario in s1_scenarios])
  1219. s2_scenarios = _ScenarioManager._get_by_config_id(scenario_config_2.id)
  1220. assert len(s2_scenarios) == 2
  1221. assert sorted([s_2_1.id, s_2_2.id]) == sorted([scenario.id for scenario in s2_scenarios])
  1222. s3_scenarios = _ScenarioManager._get_by_config_id(scenario_config_3.id)
  1223. assert len(s3_scenarios) == 1
  1224. assert sorted([s_3_1.id]) == sorted([scenario.id for scenario in s3_scenarios])
  1225. def test_get_scenarios_by_config_id_in_multiple_versions_environment():
  1226. scenario_config_1 = Config.configure_scenario("s1", sequence_configs=[])
  1227. scenario_config_2 = Config.configure_scenario("s2", sequence_configs=[])
  1228. _VersionManager._set_experiment_version("1.0")
  1229. _ScenarioManager._create(scenario_config_1)
  1230. _ScenarioManager._create(scenario_config_1)
  1231. _ScenarioManager._create(scenario_config_1)
  1232. _ScenarioManager._create(scenario_config_2)
  1233. _ScenarioManager._create(scenario_config_2)
  1234. assert len(_ScenarioManager._get_by_config_id(scenario_config_1.id)) == 3
  1235. assert len(_ScenarioManager._get_by_config_id(scenario_config_2.id)) == 2
  1236. _VersionManager._set_experiment_version("2.0")
  1237. _ScenarioManager._create(scenario_config_1)
  1238. _ScenarioManager._create(scenario_config_1)
  1239. _ScenarioManager._create(scenario_config_1)
  1240. _ScenarioManager._create(scenario_config_2)
  1241. _ScenarioManager._create(scenario_config_2)
  1242. assert len(_ScenarioManager._get_by_config_id(scenario_config_1.id)) == 3
  1243. assert len(_ScenarioManager._get_by_config_id(scenario_config_2.id)) == 2
  1244. def test_filter_scenarios_by_creation_datetime():
  1245. scenario_config_1 = Config.configure_scenario("s1", sequence_configs=[])
  1246. with freezegun.freeze_time("2024-01-01"):
  1247. s_1_1 = _ScenarioManager._create(scenario_config_1)
  1248. with freezegun.freeze_time("2024-01-03"):
  1249. s_1_2 = _ScenarioManager._create(scenario_config_1)
  1250. with freezegun.freeze_time("2024-02-01"):
  1251. s_1_3 = _ScenarioManager._create(scenario_config_1)
  1252. all_scenarios = _ScenarioManager._get_all()
  1253. filtered_scenarios = _ScenarioManager._filter_by_creation_time(
  1254. scenarios=all_scenarios,
  1255. created_start_time=datetime(2024, 1, 1),
  1256. created_end_time=datetime(2024, 1, 2),
  1257. )
  1258. assert len(filtered_scenarios) == 1
  1259. assert [s_1_1] == filtered_scenarios
  1260. # The start time is inclusive
  1261. filtered_scenarios = _ScenarioManager._filter_by_creation_time(
  1262. scenarios=all_scenarios,
  1263. created_start_time=datetime(2024, 1, 1),
  1264. created_end_time=datetime(2024, 1, 3),
  1265. )
  1266. assert len(filtered_scenarios) == 1
  1267. assert [s_1_1] == filtered_scenarios
  1268. # The end time is exclusive
  1269. filtered_scenarios = _ScenarioManager._filter_by_creation_time(
  1270. scenarios=all_scenarios,
  1271. created_start_time=datetime(2024, 1, 1),
  1272. created_end_time=datetime(2024, 1, 4),
  1273. )
  1274. assert len(filtered_scenarios) == 2
  1275. assert sorted([s_1_1.id, s_1_2.id]) == sorted([scenario.id for scenario in filtered_scenarios])
  1276. filtered_scenarios = _ScenarioManager._filter_by_creation_time(
  1277. scenarios=all_scenarios,
  1278. created_start_time=datetime(2023, 1, 1),
  1279. created_end_time=datetime(2025, 1, 1),
  1280. )
  1281. assert len(filtered_scenarios) == 3
  1282. assert sorted([s_1_1.id, s_1_2.id, s_1_3.id]) == sorted([scenario.id for scenario in filtered_scenarios])
  1283. filtered_scenarios = _ScenarioManager._filter_by_creation_time(
  1284. scenarios=all_scenarios,
  1285. created_start_time=datetime(2024, 2, 1),
  1286. )
  1287. assert len(filtered_scenarios) == 1
  1288. assert [s_1_3] == filtered_scenarios
  1289. filtered_scenarios = _ScenarioManager._filter_by_creation_time(
  1290. scenarios=all_scenarios,
  1291. created_end_time=datetime(2024, 1, 2),
  1292. )
  1293. assert len(filtered_scenarios) == 1
  1294. assert [s_1_1] == filtered_scenarios