test_scenario_manager.py 69 KB

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