1
0

test_data_node.py 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933
  1. # Copyright 2021-2024 Avaiga Private Limited
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  4. # the License. You may obtain a copy of the License at
  5. #
  6. # http://www.apache.org/licenses/LICENSE-2.0
  7. #
  8. # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
  9. # an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
  10. # specific language governing permissions and limitations under the License.
  11. import os
  12. from datetime import datetime, timedelta
  13. from time import sleep
  14. from unittest import mock
  15. import freezegun
  16. import pandas as pd
  17. import pytest
  18. import taipy.core as tp
  19. from taipy.common.config import Config
  20. from taipy.common.config.common.scope import Scope
  21. from taipy.common.config.exceptions.exceptions import InvalidConfigurationId
  22. from taipy.core.data._data_manager import _DataManager
  23. from taipy.core.data._data_manager_factory import _DataManagerFactory
  24. from taipy.core.data.data_node import DataNode
  25. from taipy.core.data.data_node_id import (
  26. EDIT_COMMENT_KEY,
  27. EDIT_EDITOR_ID_KEY,
  28. EDIT_JOB_ID_KEY,
  29. EDIT_TIMESTAMP_KEY,
  30. DataNodeId,
  31. )
  32. from taipy.core.data.in_memory import InMemoryDataNode
  33. from taipy.core.exceptions.exceptions import DataNodeIsBeingEdited, NoData
  34. from taipy.core.job.job_id import JobId
  35. from taipy.core.task.task import Task
  36. from .utils import FakeDataNode
  37. def funct_a_b(input: str):
  38. print("task_a_b") # noqa: T201
  39. return "B"
  40. def funct_b_c(input: str):
  41. print("task_b_c") # noqa: T201
  42. return "C"
  43. def funct_b_d(input: str):
  44. print("task_b_d") # noqa: T201
  45. return "D"
  46. class TestDataNode:
  47. def test_dn_equals(self, data_node):
  48. data_manager = _DataManagerFactory()._build_manager()
  49. dn_id = data_node.id
  50. data_manager._set(data_node)
  51. # # To test if instance is same type
  52. task = Task("task", {}, print, [], [], dn_id)
  53. dn_2 = data_manager._get(dn_id)
  54. assert data_node == dn_2
  55. assert data_node != dn_id
  56. assert data_node != task
  57. def test_create_with_default_values(self):
  58. dn = DataNode("foo_bar")
  59. assert dn.config_id == "foo_bar"
  60. assert dn.scope == Scope.SCENARIO
  61. assert dn.id is not None
  62. assert dn.name is None
  63. assert dn.owner_id is None
  64. assert dn.parent_ids == set()
  65. assert dn.last_edit_date is None
  66. assert dn.job_ids == []
  67. assert not dn.is_ready_for_reading
  68. assert len(dn.properties) == 0
  69. def test_is_up_to_date_when_not_written(self):
  70. dn_confg_1 = Config.configure_in_memory_data_node("dn_1", default_data="a")
  71. dn_confg_2 = Config.configure_in_memory_data_node("dn_2")
  72. task_config_1 = Config.configure_task("t1", funct_a_b, [dn_confg_1], [dn_confg_2])
  73. scenario_config = Config.configure_scenario("sc", [task_config_1])
  74. scenario = tp.create_scenario(scenario_config)
  75. assert scenario.dn_1.is_up_to_date is True
  76. assert scenario.dn_2.is_up_to_date is False
  77. tp.submit(scenario)
  78. assert scenario.dn_1.is_up_to_date is True
  79. assert scenario.dn_2.is_up_to_date is True
  80. def test_create(self):
  81. a_date = datetime.now()
  82. dn = DataNode(
  83. "foo_bar",
  84. Scope.SCENARIO,
  85. DataNodeId("an_id"),
  86. "a_scenario_id",
  87. {"a_parent_id"},
  88. a_date,
  89. [{"job_id": "a_job_id"}],
  90. edit_in_progress=False,
  91. prop="erty",
  92. name="a name",
  93. )
  94. assert dn.config_id == "foo_bar"
  95. assert dn.scope == Scope.SCENARIO
  96. assert dn.id == "an_id"
  97. assert dn.name == "a name"
  98. assert dn.owner_id == "a_scenario_id"
  99. assert dn.parent_ids == {"a_parent_id"}
  100. assert dn.last_edit_date == a_date
  101. assert dn.job_ids == ["a_job_id"]
  102. assert dn.is_ready_for_reading
  103. assert len(dn.properties) == 2
  104. assert dn.properties == {"prop": "erty", "name": "a name"}
  105. with pytest.raises(InvalidConfigurationId):
  106. DataNode("foo bar")
  107. def test_read_write(self):
  108. dn = FakeDataNode("foo_bar")
  109. with pytest.raises(NoData):
  110. assert dn.read() is None
  111. dn.read_or_raise()
  112. assert dn.write_has_been_called == 0
  113. assert dn.read_has_been_called == 0
  114. assert not dn.is_ready_for_reading
  115. assert dn.last_edit_date is None
  116. assert dn.job_ids == []
  117. assert dn.edits == []
  118. dn.write("Any data")
  119. assert dn.write_has_been_called == 1
  120. assert dn.read_has_been_called == 0
  121. assert dn.last_edit_date is not None
  122. first_edition = dn.last_edit_date
  123. assert dn.is_ready_for_reading
  124. assert dn.job_ids == []
  125. assert len(dn.edits) == 1
  126. assert dn.get_last_edit()["timestamp"] == dn.last_edit_date
  127. sleep(0.1)
  128. dn.write("Any other data", job_id := JobId("a_job_id"))
  129. assert dn.write_has_been_called == 2
  130. assert dn.read_has_been_called == 0
  131. second_edition = dn.last_edit_date
  132. assert first_edition < second_edition
  133. assert dn.is_ready_for_reading
  134. assert dn.job_ids == [job_id]
  135. assert len(dn.edits) == 2
  136. assert dn.get_last_edit()["timestamp"] == dn.last_edit_date
  137. dn.read()
  138. assert dn.write_has_been_called == 2
  139. assert dn.read_has_been_called == 1
  140. second_edition = dn.last_edit_date
  141. assert first_edition < second_edition
  142. assert dn.is_ready_for_reading
  143. assert dn.job_ids == [job_id]
  144. def test_lock_initialization(self):
  145. dn = InMemoryDataNode("dn", Scope.SCENARIO)
  146. assert not dn.edit_in_progress
  147. assert dn._editor_id is None
  148. assert dn._editor_expiration_date is None
  149. def test_locked_dn_unlockable_only_by_same_editor(self):
  150. dn = InMemoryDataNode("dn", Scope.SCENARIO)
  151. dn.lock_edit("user_1")
  152. assert dn.edit_in_progress
  153. assert dn._editor_id == "user_1"
  154. assert dn._editor_expiration_date is not None
  155. with pytest.raises(DataNodeIsBeingEdited):
  156. dn.lock_edit("user_2")
  157. with pytest.raises(DataNodeIsBeingEdited):
  158. dn.unlock_edit("user_2")
  159. dn.unlock_edit("user_1")
  160. assert not dn.edit_in_progress
  161. assert dn._editor_id is None
  162. assert dn._editor_expiration_date is None
  163. def test_none_editor_can_lock_a_locked_dn(self):
  164. dn = InMemoryDataNode("dn", Scope.SCENARIO)
  165. dn.lock_edit("user")
  166. assert dn.edit_in_progress
  167. assert dn._editor_id == "user"
  168. assert dn._editor_expiration_date is not None
  169. dn.lock_edit()
  170. assert dn.edit_in_progress
  171. assert dn._editor_id is None
  172. assert dn._editor_expiration_date is None
  173. def test_none_editor_can_unlock_a_locked_dn(self):
  174. dn = InMemoryDataNode("dn", Scope.SCENARIO)
  175. dn.lock_edit("user")
  176. assert dn.edit_in_progress
  177. assert dn._editor_id == "user"
  178. assert dn._editor_expiration_date is not None
  179. dn.unlock_edit()
  180. assert not dn.edit_in_progress
  181. assert dn._editor_id is None
  182. assert dn._editor_expiration_date is None
  183. dn.lock_edit()
  184. assert dn.edit_in_progress
  185. assert dn._editor_id is None
  186. assert dn._editor_expiration_date is None
  187. dn.unlock_edit()
  188. assert not dn.edit_in_progress
  189. assert dn._editor_id is None
  190. assert dn._editor_expiration_date is None
  191. def test_ready_for_reading(self):
  192. dn = InMemoryDataNode("foo_bar", Scope.CYCLE)
  193. assert dn.last_edit_date is None
  194. assert not dn.is_ready_for_reading
  195. assert dn.job_ids == []
  196. dn.lock_edit()
  197. assert dn.last_edit_date is None
  198. assert not dn.is_ready_for_reading
  199. assert dn.job_ids == []
  200. dn.unlock_edit()
  201. assert dn.last_edit_date is None
  202. assert not dn.is_ready_for_reading
  203. assert dn.job_ids == []
  204. dn.lock_edit()
  205. assert dn.last_edit_date is None
  206. assert not dn.is_ready_for_reading
  207. assert dn.job_ids == []
  208. dn.write("toto", job_id := JobId("a_job_id"))
  209. assert dn.last_edit_date is not None
  210. assert dn.is_ready_for_reading
  211. assert dn.job_ids == [job_id]
  212. def test_is_valid_no_validity_period(self):
  213. # Test Never been written
  214. dn = InMemoryDataNode("foo", Scope.SCENARIO, DataNodeId("id"), "name", "owner_id")
  215. assert not dn.is_valid
  216. # test has been written
  217. dn.write("My data")
  218. assert dn.is_valid
  219. def test_is_valid_with_30_min_validity_period(self):
  220. # Test Never been written
  221. dn = InMemoryDataNode(
  222. "foo", Scope.SCENARIO, DataNodeId("id"), "name", "owner_id", validity_period=timedelta(minutes=30)
  223. )
  224. assert dn.is_valid is False
  225. # Has been written less than 30 minutes ago
  226. dn.write("My data")
  227. assert dn.is_valid is True
  228. # Has been written more than 30 minutes ago
  229. dn.last_edit_date = datetime.now() + timedelta(days=-1)
  230. assert dn.is_valid is False
  231. def test_is_valid_with_5_days_validity_period(self):
  232. # Test Never been written
  233. dn = InMemoryDataNode("foo", Scope.SCENARIO, validity_period=timedelta(days=5))
  234. assert dn.is_valid is False
  235. # Has been written less than 30 minutes ago
  236. dn.write("My data")
  237. assert dn.is_valid is True
  238. # Has been written more than 30 minutes ago
  239. dn._last_edit_date = datetime.now() - timedelta(days=6)
  240. _DataManager()._set(dn)
  241. assert dn.is_valid is False
  242. def test_is_up_to_date(self, current_datetime):
  243. dn_confg_1 = Config.configure_in_memory_data_node("dn_1")
  244. dn_confg_2 = Config.configure_in_memory_data_node("dn_2")
  245. dn_confg_3 = Config.configure_in_memory_data_node("dn_3", scope=Scope.GLOBAL)
  246. task_config_1 = Config.configure_task("t1", print, [dn_confg_1], [dn_confg_2])
  247. task_config_2 = Config.configure_task("t2", print, [dn_confg_2], [dn_confg_3])
  248. scenario_config = Config.configure_scenario("sc", [task_config_1, task_config_2])
  249. scenario_1 = tp.create_scenario(scenario_config)
  250. assert len(_DataManager._get_all()) == 3
  251. dn_1_1 = scenario_1.data_nodes["dn_1"]
  252. dn_2_1 = scenario_1.data_nodes["dn_2"]
  253. dn_3_1 = scenario_1.data_nodes["dn_3"]
  254. assert dn_1_1.last_edit_date is None
  255. assert dn_2_1.last_edit_date is None
  256. assert dn_3_1.last_edit_date is None
  257. dn_1_1.last_edit_date = current_datetime + timedelta(1)
  258. dn_2_1.last_edit_date = current_datetime + timedelta(2)
  259. dn_3_1.last_edit_date = current_datetime + timedelta(3)
  260. assert dn_1_1.is_up_to_date
  261. assert dn_2_1.is_up_to_date
  262. assert dn_3_1.is_up_to_date
  263. dn_2_1.last_edit_date = current_datetime + timedelta(4)
  264. assert dn_1_1.is_up_to_date
  265. assert dn_2_1.is_up_to_date
  266. assert not dn_3_1.is_up_to_date
  267. dn_1_1.last_edit_date = current_datetime + timedelta(5)
  268. assert dn_1_1.is_up_to_date
  269. assert not dn_2_1.is_up_to_date
  270. assert not dn_3_1.is_up_to_date
  271. dn_1_1.last_edit_date = current_datetime + timedelta(1)
  272. dn_2_1.last_edit_date = current_datetime + timedelta(2)
  273. dn_3_1.last_edit_date = current_datetime + timedelta(3)
  274. def test_is_up_to_date_across_scenarios(self, current_datetime):
  275. dn_confg_1 = Config.configure_in_memory_data_node("dn_1", scope=Scope.SCENARIO)
  276. dn_confg_2 = Config.configure_in_memory_data_node("dn_2", scope=Scope.SCENARIO)
  277. dn_confg_3 = Config.configure_in_memory_data_node("dn_3", scope=Scope.GLOBAL)
  278. task_config_1 = Config.configure_task("t1", print, [dn_confg_1], [dn_confg_2])
  279. task_config_2 = Config.configure_task("t2", print, [dn_confg_2], [dn_confg_3])
  280. scenario_config = Config.configure_scenario("sc", [task_config_1, task_config_2])
  281. scenario_1 = tp.create_scenario(scenario_config)
  282. scenario_2 = tp.create_scenario(scenario_config)
  283. assert len(_DataManager._get_all()) == 5
  284. dn_1_1 = scenario_1.data_nodes["dn_1"]
  285. dn_2_1 = scenario_1.data_nodes["dn_2"]
  286. dn_1_2 = scenario_2.data_nodes["dn_1"]
  287. dn_2_2 = scenario_2.data_nodes["dn_2"]
  288. dn_3 = scenario_1.data_nodes["dn_3"]
  289. assert dn_3 == scenario_2.data_nodes["dn_3"]
  290. assert dn_1_1.last_edit_date is None
  291. assert dn_2_1.last_edit_date is None
  292. assert dn_1_2.last_edit_date is None
  293. assert dn_2_2.last_edit_date is None
  294. assert dn_3.last_edit_date is None
  295. dn_1_1.last_edit_date = current_datetime + timedelta(1)
  296. dn_2_1.last_edit_date = current_datetime + timedelta(2)
  297. dn_1_2.last_edit_date = current_datetime + timedelta(3)
  298. dn_2_2.last_edit_date = current_datetime + timedelta(4)
  299. dn_3.last_edit_date = current_datetime + timedelta(5)
  300. assert dn_1_1.is_up_to_date
  301. assert dn_2_1.is_up_to_date
  302. assert dn_1_2.is_up_to_date
  303. assert dn_2_2.is_up_to_date
  304. assert dn_3.is_up_to_date
  305. dn_2_1.last_edit_date = current_datetime + timedelta(6)
  306. assert dn_1_1.is_up_to_date
  307. assert dn_2_1.is_up_to_date
  308. assert dn_1_2.is_up_to_date
  309. assert dn_2_2.is_up_to_date
  310. assert not dn_3.is_up_to_date
  311. dn_2_1.last_edit_date = current_datetime + timedelta(2)
  312. dn_2_2.last_edit_date = current_datetime + timedelta(6)
  313. assert dn_1_1.is_up_to_date
  314. assert dn_2_1.is_up_to_date
  315. assert dn_1_2.is_up_to_date
  316. assert dn_2_2.is_up_to_date
  317. assert not dn_3.is_up_to_date
  318. dn_2_2.last_edit_date = current_datetime + timedelta(4)
  319. dn_1_1.last_edit_date = current_datetime + timedelta(6)
  320. assert dn_1_1.is_up_to_date
  321. assert not dn_2_1.is_up_to_date
  322. assert dn_1_2.is_up_to_date
  323. assert dn_2_2.is_up_to_date
  324. assert not dn_3.is_up_to_date
  325. dn_1_2.last_edit_date = current_datetime + timedelta(6)
  326. assert dn_1_1.is_up_to_date
  327. assert not dn_2_1.is_up_to_date
  328. assert dn_1_2.is_up_to_date
  329. assert not dn_2_2.is_up_to_date
  330. assert not dn_3.is_up_to_date
  331. def test_do_not_recompute_data_node_valid_but_continue_sequence_execution(self):
  332. a = Config.configure_data_node("A", "pickle", default_data="A")
  333. b = Config.configure_data_node("B", "pickle")
  334. c = Config.configure_data_node("C", "pickle")
  335. d = Config.configure_data_node("D", "pickle")
  336. task_a_b = Config.configure_task("task_a_b", funct_a_b, input=a, output=b, skippable=True)
  337. task_b_c = Config.configure_task("task_b_c", funct_b_c, input=b, output=c)
  338. task_b_d = Config.configure_task("task_b_d", funct_b_d, input=b, output=d)
  339. scenario_cfg = Config.configure_scenario("scenario", [task_a_b, task_b_c, task_b_d])
  340. scenario = tp.create_scenario(scenario_cfg)
  341. scenario.submit()
  342. assert scenario.A.read() == "A"
  343. assert scenario.B.read() == "B"
  344. assert scenario.C.read() == "C"
  345. assert scenario.D.read() == "D"
  346. scenario.submit()
  347. assert len(tp.get_jobs()) == 6
  348. jobs_and_status = [(job.task.config_id, job.status) for job in tp.get_jobs()]
  349. assert ("task_a_b", tp.Status.COMPLETED) in jobs_and_status
  350. assert ("task_a_b", tp.Status.SKIPPED) in jobs_and_status
  351. assert ("task_b_c", tp.Status.COMPLETED) in jobs_and_status
  352. assert ("task_b_d", tp.Status.COMPLETED) in jobs_and_status
  353. def test_data_node_update_after_writing(self):
  354. dn = FakeDataNode("foo")
  355. _DataManager._set(dn)
  356. assert not _DataManager._get(dn.id).is_ready_for_reading
  357. dn.write("Any data")
  358. assert dn.is_ready_for_reading
  359. assert _DataManager._get(dn.id).is_ready_for_reading
  360. def test_expiration_date_raise_if_never_write(self):
  361. dn = FakeDataNode("foo")
  362. with pytest.raises(NoData):
  363. _ = dn.expiration_date
  364. def test_validity_null_if_never_write(self):
  365. dn = FakeDataNode("foo")
  366. assert dn.validity_period is None
  367. def test_auto_set_and_reload(self, current_datetime):
  368. dn_1 = InMemoryDataNode(
  369. "foo",
  370. scope=Scope.GLOBAL,
  371. id=DataNodeId("an_id"),
  372. owner_id=None,
  373. parent_ids=None,
  374. last_edit_date=current_datetime,
  375. edits=[{"job_id": "a_job_id"}],
  376. edit_in_progress=False,
  377. validity_period=None,
  378. properties={
  379. "name": "foo",
  380. },
  381. )
  382. dm = _DataManager()
  383. dm._set(dn_1)
  384. dn_2 = dm._get(dn_1)
  385. # auto set & reload on scope attribute
  386. assert dn_1.scope == Scope.GLOBAL
  387. assert dn_2.scope == Scope.GLOBAL
  388. dn_1.scope = Scope.CYCLE
  389. assert dn_1.scope == Scope.CYCLE
  390. assert dn_2.scope == Scope.CYCLE
  391. dn_2.scope = Scope.SCENARIO
  392. assert dn_1.scope == Scope.SCENARIO
  393. assert dn_2.scope == Scope.SCENARIO
  394. new_datetime = current_datetime + timedelta(1)
  395. new_datetime_1 = current_datetime + timedelta(3)
  396. # auto set & reload on last_edit_date attribute
  397. assert dn_1.last_edit_date == current_datetime
  398. assert dn_2.last_edit_date == current_datetime
  399. dn_1.last_edit_date = new_datetime_1
  400. assert dn_1.last_edit_date == new_datetime_1
  401. assert dn_2.last_edit_date == new_datetime_1
  402. dn_2.last_edit_date = new_datetime
  403. assert dn_1.last_edit_date == new_datetime
  404. assert dn_2.last_edit_date == new_datetime
  405. # auto set & reload on name attribute
  406. assert dn_1.name == "foo"
  407. assert dn_2.name == "foo"
  408. dn_1.name = "fed"
  409. assert dn_1.name == "fed"
  410. assert dn_2.name == "fed"
  411. dn_2.name = "def"
  412. assert dn_1.name == "def"
  413. assert dn_2.name == "def"
  414. # auto set & reload on parent_ids attribute (set() object does not have auto set yet)
  415. assert dn_1.parent_ids == set()
  416. assert dn_2.parent_ids == set()
  417. dn_1._parent_ids.update(["sc2"])
  418. _DataManager._set(dn_1)
  419. assert dn_1.parent_ids == {"sc2"}
  420. assert dn_2.parent_ids == {"sc2"}
  421. dn_2._parent_ids.clear()
  422. dn_2._parent_ids.update(["sc1"])
  423. _DataManager._set(dn_2)
  424. assert dn_1.parent_ids == {"sc1"}
  425. assert dn_2.parent_ids == {"sc1"}
  426. dn_2._parent_ids.clear()
  427. _DataManager._set(dn_2)
  428. # auto set & reload on edit_in_progress attribute
  429. assert not dn_2.edit_in_progress
  430. assert not dn_1.edit_in_progress
  431. dn_1.edit_in_progress = True
  432. assert dn_1.edit_in_progress
  433. assert dn_2.edit_in_progress
  434. dn_2.unlock_edit()
  435. assert not dn_1.edit_in_progress
  436. assert not dn_2.edit_in_progress
  437. dn_1.lock_edit()
  438. assert dn_1.edit_in_progress
  439. assert dn_2.edit_in_progress
  440. # auto set & reload on validity_period attribute
  441. time_period_1 = timedelta(1)
  442. time_period_2 = timedelta(5)
  443. assert dn_1.validity_period is None
  444. assert dn_2.validity_period is None
  445. dn_1.validity_period = time_period_1
  446. assert dn_1.validity_period == time_period_1
  447. assert dn_2.validity_period == time_period_1
  448. dn_2.validity_period = time_period_2
  449. assert dn_1.validity_period == time_period_2
  450. assert dn_2.validity_period == time_period_2
  451. dn_1.last_edit_date = new_datetime
  452. assert len(dn_1.job_ids) == 1
  453. assert len(dn_2.job_ids) == 1
  454. with dn_1 as dn:
  455. assert dn.config_id == "foo"
  456. assert dn.owner_id is None
  457. assert dn.scope == Scope.SCENARIO
  458. assert dn.last_edit_date == new_datetime
  459. assert dn.name == "def"
  460. assert dn.edit_in_progress
  461. assert dn.validity_period == time_period_2
  462. assert len(dn.job_ids) == 1
  463. assert dn._is_in_context
  464. new_datetime_2 = new_datetime + timedelta(5)
  465. dn.scope = Scope.CYCLE
  466. dn.last_edit_date = new_datetime_2
  467. dn.name = "abc"
  468. dn.edit_in_progress = False
  469. dn.validity_period = None
  470. assert dn.config_id == "foo"
  471. assert dn.owner_id is None
  472. assert dn.scope == Scope.SCENARIO
  473. assert dn.last_edit_date == new_datetime
  474. assert dn.name == "def"
  475. assert dn.edit_in_progress
  476. assert dn.validity_period == time_period_2
  477. assert len(dn.job_ids) == 1
  478. assert dn_1.config_id == "foo"
  479. assert dn_1.owner_id is None
  480. assert dn_1.scope == Scope.CYCLE
  481. assert dn_1.last_edit_date == new_datetime_2
  482. assert dn_1.name == "abc"
  483. assert not dn_1.edit_in_progress
  484. assert dn_1.validity_period is None
  485. assert not dn_1._is_in_context
  486. assert len(dn_1.job_ids) == 1
  487. def test_auto_set_and_reload_properties(self):
  488. dn_1 = InMemoryDataNode("foo", scope=Scope.GLOBAL, properties={"name": "def"})
  489. dm = _DataManager()
  490. dm._set(dn_1)
  491. dn_2 = dm._get(dn_1)
  492. # auto set & reload on properties attribute
  493. assert dn_1.properties == {"name": "def"}
  494. assert dn_2.properties == {"name": "def"}
  495. dn_1._properties["qux"] = 4
  496. assert dn_1.properties["qux"] == 4
  497. assert dn_2.properties["qux"] == 4
  498. assert dn_1.properties == {"qux": 4, "name": "def"}
  499. assert dn_2.properties == {"qux": 4, "name": "def"}
  500. dn_2._properties["qux"] = 5
  501. assert dn_1.properties["qux"] == 5
  502. assert dn_2.properties["qux"] == 5
  503. dn_1.properties["temp_key_1"] = "temp_value_1"
  504. dn_1.properties["temp_key_2"] = "temp_value_2"
  505. assert dn_1.properties == {
  506. "name": "def",
  507. "qux": 5,
  508. "temp_key_1": "temp_value_1",
  509. "temp_key_2": "temp_value_2",
  510. }
  511. assert dn_2.properties == {"name": "def", "qux": 5, "temp_key_1": "temp_value_1", "temp_key_2": "temp_value_2"}
  512. dn_1.properties.pop("temp_key_1")
  513. assert "temp_key_1" not in dn_1.properties.keys()
  514. assert "temp_key_1" not in dn_1.properties.keys()
  515. assert dn_1.properties == {"name": "def", "qux": 5, "temp_key_2": "temp_value_2"}
  516. assert dn_2.properties == {"name": "def", "qux": 5, "temp_key_2": "temp_value_2"}
  517. dn_2.properties.pop("temp_key_2")
  518. assert dn_1.properties == {"qux": 5, "name": "def"}
  519. assert dn_2.properties == {"qux": 5, "name": "def"}
  520. assert "temp_key_2" not in dn_1.properties.keys()
  521. assert "temp_key_2" not in dn_2.properties.keys()
  522. dn_1.properties["temp_key_3"] = 0
  523. assert dn_1.properties == {"qux": 5, "temp_key_3": 0, "name": "def"}
  524. assert dn_2.properties == {"qux": 5, "temp_key_3": 0, "name": "def"}
  525. dn_1.properties.update({"temp_key_3": 1})
  526. assert dn_1.properties == {"qux": 5, "temp_key_3": 1, "name": "def"}
  527. assert dn_2.properties == {"qux": 5, "temp_key_3": 1, "name": "def"}
  528. dn_1.properties.update({})
  529. assert dn_1.properties == {"qux": 5, "temp_key_3": 1, "name": "def"}
  530. assert dn_2.properties == {"qux": 5, "temp_key_3": 1, "name": "def"}
  531. dn_1.properties["temp_key_4"] = 0
  532. dn_1.properties["temp_key_5"] = 0
  533. with dn_1 as dn:
  534. assert dn._is_in_context
  535. assert dn.properties["qux"] == 5
  536. assert dn.properties["temp_key_3"] == 1
  537. assert dn.properties["temp_key_4"] == 0
  538. assert dn.properties["temp_key_5"] == 0
  539. dn.properties["qux"] = 9
  540. dn.properties.pop("temp_key_3")
  541. dn.properties.pop("temp_key_4")
  542. dn.properties.update({"temp_key_4": 1})
  543. dn.properties.update({"temp_key_5": 2})
  544. dn.properties.pop("temp_key_5")
  545. dn.properties.update({})
  546. assert dn.properties["qux"] == 5
  547. assert dn.properties["temp_key_3"] == 1
  548. assert dn.properties["temp_key_4"] == 0
  549. assert dn.properties["temp_key_5"] == 0
  550. assert not dn_1._is_in_context
  551. assert dn_1.properties["qux"] == 9
  552. assert "temp_key_3" not in dn_1.properties.keys()
  553. assert dn_1.properties["temp_key_4"] == 1
  554. assert "temp_key_5" not in dn_1.properties.keys()
  555. def test_get_parents(self, data_node):
  556. with mock.patch("taipy.core.get_parents") as mck:
  557. data_node.get_parents()
  558. mck.assert_called_once_with(data_node)
  559. def test_data_node_with_env_variable_value_not_stored(self):
  560. dn_config = Config.configure_data_node("A", prop="ENV[FOO]")
  561. with mock.patch.dict(os.environ, {"FOO": "bar"}):
  562. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  563. assert dn._properties.data["prop"] == "ENV[FOO]"
  564. assert dn.properties["prop"] == "bar"
  565. def test_path_populated_with_config_default_path(self):
  566. dn_config = Config.configure_data_node("data_node", "pickle", default_path="foo.p")
  567. assert dn_config.default_path == "foo.p"
  568. data_node = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  569. assert data_node.path == "foo.p"
  570. data_node.path = "baz.p"
  571. assert data_node.path == "baz.p"
  572. def test_edit_edit_tracking(self):
  573. dn_config = Config.configure_data_node("A")
  574. data_node = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  575. data_node.write(data="1", job_id="job_1")
  576. data_node.write(data="2", job_id="job_1")
  577. data_node.write(data="3", job_id="job_1")
  578. assert len(data_node.edits) == 3
  579. assert len(data_node.job_ids) == 3
  580. assert data_node.edits[-1] == data_node.get_last_edit()
  581. assert data_node.last_edit_date == data_node.get_last_edit().get("timestamp")
  582. date = datetime(2050, 1, 1, 12, 12)
  583. data_node.write(data="4", timestamp=date, message="This is a comment on this edit", env="staging")
  584. assert len(data_node.edits) == 4
  585. assert len(data_node.job_ids) == 3
  586. assert data_node.edits[-1] == data_node.get_last_edit()
  587. last_edit = data_node.get_last_edit()
  588. assert last_edit["message"] == "This is a comment on this edit"
  589. assert last_edit["env"] == "staging"
  590. assert last_edit["timestamp"] == date
  591. def test_label(self):
  592. a_date = datetime.now()
  593. dn = DataNode(
  594. "foo_bar",
  595. Scope.SCENARIO,
  596. DataNodeId("an_id"),
  597. "a_scenario_id",
  598. {"a_parent_id"},
  599. a_date,
  600. [{"job_id": "a_job_id"}],
  601. edit_in_progress=False,
  602. prop="erty",
  603. name="a name",
  604. )
  605. with mock.patch("taipy.core.get") as get_mck:
  606. class MockOwner:
  607. label = "owner_label"
  608. def get_label(self):
  609. return self.label
  610. get_mck.return_value = MockOwner()
  611. assert dn.get_label() == "owner_label > " + dn.name
  612. assert dn.get_simple_label() == dn.name
  613. def test_explicit_label(self):
  614. a_date = datetime.now()
  615. dn = DataNode(
  616. "foo_bar",
  617. Scope.SCENARIO,
  618. DataNodeId("an_id"),
  619. "a_scenario_id",
  620. {"a_parent_id"},
  621. a_date,
  622. [{"job_id": "a_job_id"}],
  623. edit_in_progress=False,
  624. label="a label",
  625. name="a name",
  626. )
  627. assert dn.get_label() == "a label"
  628. assert dn.get_simple_label() == "a label"
  629. def test_change_data_node_name(self):
  630. cgf = Config.configure_data_node("foo", scope=Scope.GLOBAL)
  631. dn = tp.create_global_data_node(cgf)
  632. dn.name = "bar"
  633. assert dn.name == "bar"
  634. # This new syntax will be the only one allowed: https://github.com/Avaiga/taipy-core/issues/806
  635. dn.properties["name"] = "baz"
  636. assert dn.name == "baz"
  637. def test_locked_data_node_write_should_fail_with_wrong_editor(self):
  638. dn_config = Config.configure_data_node("A")
  639. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  640. dn.lock_edit("editor_1")
  641. # Should raise exception for wrong editor
  642. with pytest.raises(DataNodeIsBeingEdited):
  643. dn.write("data", editor_id="editor_2")
  644. # Should succeed with correct editor
  645. dn.write("data", editor_id="editor_1")
  646. assert dn.read() == "data"
  647. def test_locked_data_node_write_should_fail_before_expiration_date_and_succeed_after(self):
  648. dn_config = Config.configure_data_node("A")
  649. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  650. lock_time = datetime.now()
  651. with freezegun.freeze_time(lock_time):
  652. dn.lock_edit("editor_1")
  653. with freezegun.freeze_time(lock_time + timedelta(minutes=29)):
  654. # Should raise exception for wrong editor and expiration date NOT passed
  655. with pytest.raises(DataNodeIsBeingEdited):
  656. dn.write("data", editor_id="editor_2")
  657. with freezegun.freeze_time(lock_time + timedelta(minutes=31)):
  658. # Should succeed with wrong editor but expiration date passed
  659. dn.write("data", editor_id="editor_2")
  660. assert dn.read() == "data"
  661. def test_locked_data_node_append_should_fail_with_wrong_editor(self):
  662. dn_config = Config.configure_csv_data_node("A")
  663. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  664. first_line = pd.DataFrame(data={'col1': [1], 'col2': [3]})
  665. second_line = pd.DataFrame(data={'col1': [2], 'col2': [4]})
  666. data = pd.DataFrame(data={'col1': [1, 2], 'col2': [3, 4]})
  667. dn.write(first_line)
  668. assert first_line.equals(dn.read())
  669. dn.lock_edit("editor_1")
  670. with pytest.raises(DataNodeIsBeingEdited):
  671. dn.append(second_line, editor_id="editor_2")
  672. dn.append(second_line, editor_id="editor_1")
  673. assert dn.read().equals(data)
  674. def test_locked_data_node_append_should_fail_before_expiration_date_and_succeed_after(self):
  675. dn_config = Config.configure_csv_data_node("A")
  676. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  677. first_line = pd.DataFrame(data={'col1': [1], 'col2': [3]})
  678. second_line = pd.DataFrame(data={'col1': [2], 'col2': [4]})
  679. data = pd.DataFrame(data={'col1': [1, 2], 'col2': [3, 4]})
  680. dn.write(first_line)
  681. assert first_line.equals(dn.read())
  682. lock_time = datetime.now()
  683. with freezegun.freeze_time(lock_time):
  684. dn.lock_edit("editor_1")
  685. with freezegun.freeze_time(lock_time + timedelta(minutes=29)):
  686. # Should raise exception for wrong editor and expiration date NOT passed
  687. with pytest.raises(DataNodeIsBeingEdited):
  688. dn.append(second_line, editor_id="editor_2")
  689. with freezegun.freeze_time(lock_time + timedelta(minutes=31)):
  690. # Should succeed with wrong editor but expiration date passed
  691. dn.append(second_line, editor_id="editor_2")
  692. assert dn.read().equals(data)
  693. def test_orchestrator_write_without_editor_id(self):
  694. dn_config = Config.configure_data_node("A")
  695. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  696. dn.lock_edit("editor_1")
  697. # Orchestrator write without editor_id should succeed
  698. dn.write("orchestrator_data")
  699. assert dn.read() == "orchestrator_data"
  700. def test_editor_fails_writing_a_data_node_locked_by_orchestrator(self):
  701. dn_config = Config.configure_data_node("A")
  702. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  703. dn.lock_edit() # Locked by orchestrator
  704. with pytest.raises(DataNodeIsBeingEdited):
  705. dn.write("data", editor_id="editor_1")
  706. # Orchestrator write without editor_id should succeed
  707. dn.write("orchestrator_data", job_id=JobId("job_1"))
  708. assert dn.read() == "orchestrator_data"
  709. def test_editor_fails_appending_a_data_node_locked_by_orchestrator(self):
  710. dn_config = Config.configure_csv_data_node("A")
  711. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  712. first_line = pd.DataFrame(data={'col1': [1], 'col2': [3]})
  713. second_line = pd.DataFrame(data={'col1': [2], 'col2': [4]})
  714. data = pd.DataFrame(data={'col1': [1, 2], 'col2': [3, 4]})
  715. dn.write(first_line)
  716. assert first_line.equals(dn.read())
  717. dn = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  718. dn.lock_edit() # Locked by orchestrator
  719. with pytest.raises(DataNodeIsBeingEdited):
  720. dn.append(second_line, editor_id="editor_1")
  721. assert dn.read().equals(first_line)
  722. dn.append(second_line, job_id=JobId("job_1"))
  723. assert dn.read().equals(data)
  724. def test_track_edit(self):
  725. dn_config = Config.configure_data_node("A")
  726. data_node = _DataManager._bulk_get_or_create([dn_config])[dn_config]
  727. before = datetime.now()
  728. data_node.track_edit(job_id="job_1")
  729. data_node.track_edit(editor_id="editor_1")
  730. data_node.track_edit(comment="This is a comment on this edit")
  731. data_node.track_edit(editor_id="editor_2", comment="This is another comment on this edit")
  732. data_node.track_edit(editor_id="editor_3", foo="bar")
  733. after = datetime.now()
  734. timestamp = datetime.now()
  735. data_node.track_edit(timestamp=timestamp)
  736. _DataManagerFactory._build_manager()._set(data_node)
  737. # To save the edits because track edit does not save the data node
  738. assert len(data_node.edits) == 6
  739. assert data_node.edits[-1] == data_node.get_last_edit()
  740. assert data_node.last_edit_date == data_node.get_last_edit().get(EDIT_TIMESTAMP_KEY)
  741. edit_0 = data_node.edits[0]
  742. assert len(edit_0) == 2
  743. assert edit_0[EDIT_JOB_ID_KEY] == "job_1"
  744. assert edit_0[EDIT_TIMESTAMP_KEY] >= before
  745. assert edit_0[EDIT_TIMESTAMP_KEY] <= after
  746. edit_1 = data_node.edits[1]
  747. assert len(edit_1) == 2
  748. assert edit_1[EDIT_EDITOR_ID_KEY] == "editor_1"
  749. assert edit_1[EDIT_TIMESTAMP_KEY] >= before
  750. assert edit_1[EDIT_TIMESTAMP_KEY] <= after
  751. edit_2 = data_node.edits[2]
  752. assert len(edit_2) == 2
  753. assert edit_2[EDIT_COMMENT_KEY] == "This is a comment on this edit"
  754. assert edit_2[EDIT_TIMESTAMP_KEY] >= before
  755. assert edit_2[EDIT_TIMESTAMP_KEY] <= after
  756. edit_3 = data_node.edits[3]
  757. assert len(edit_3) == 3
  758. assert edit_3[EDIT_EDITOR_ID_KEY] == "editor_2"
  759. assert edit_3[EDIT_COMMENT_KEY] == "This is another comment on this edit"
  760. assert edit_3[EDIT_TIMESTAMP_KEY] >= before
  761. assert edit_3[EDIT_TIMESTAMP_KEY] <= after
  762. edit_4 = data_node.edits[4]
  763. assert len(edit_4) == 3
  764. assert edit_4[EDIT_EDITOR_ID_KEY] == "editor_3"
  765. assert edit_4["foo"] == "bar"
  766. assert edit_4[EDIT_TIMESTAMP_KEY] >= before
  767. assert edit_4[EDIT_TIMESTAMP_KEY] <= after
  768. edit_5 = data_node.edits[5]
  769. assert len(edit_5) == 1
  770. assert edit_5[EDIT_TIMESTAMP_KEY] == timestamp
  771. def test_normalize_path(self):
  772. dn = DataNode(
  773. config_id="foo_bar",
  774. scope=Scope.SCENARIO,
  775. id=DataNodeId("an_id"),
  776. path=r"data\foo\bar.csv",
  777. )
  778. assert dn.config_id == "foo_bar"
  779. assert dn.scope == Scope.SCENARIO
  780. assert dn.id == "an_id"
  781. assert dn.properties["path"] == "data/foo/bar.csv"