test_scenario_manager.py 70 KB

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