taipy/tests/core/task/test_task.py

# Copyright 2021-2024 Avaiga Private Limited
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.

from unittest import mock

import pytest

from taipy.config.common.scope import Scope
from taipy.config.config import Config
from taipy.config.exceptions.exceptions import InvalidConfigurationId
from taipy.core.config.data_node_config import DataNodeConfig
from taipy.core.data._data_manager import _DataManager
from taipy.core.data.csv import CSVDataNode
from taipy.core.data.data_node import DataNode
from taipy.core.data.in_memory import InMemoryDataNode
from taipy.core.exceptions import AttributeKeyAlreadyExisted, PropertyKeyAlreadyExisted
from taipy.core.scenario._scenario_manager import _ScenarioManager
from taipy.core.task._task_manager import _TaskManager
from taipy.core.task._task_manager_factory import _TaskManagerFactory
from taipy.core.task.task import Task


@pytest.fixture
def output():
    return [DataNode("name_1"), DataNode("name_2"), DataNode("name_3")]


@pytest.fixture
def output_config():
    return [DataNodeConfig("name_1"), DataNodeConfig("name_2"), DataNodeConfig("name_3")]


@pytest.fixture
def input():
    return [DataNode("input_name_1"), DataNode("input_name_2"), DataNode("input_name_3")]


@pytest.fixture
def input_config():
    return [DataNodeConfig("input_name_1"), DataNodeConfig("input_name_2"), DataNodeConfig("input_name_3")]


def test_task_equals(task):
    task_manager = _TaskManagerFactory()._build_manager()

    task_id = task.id
    task_manager._set(task)

    # To test if instance is same type
    dn = CSVDataNode("foo_bar", Scope.SCENARIO, task_id)

    task_2 = task_manager._get(task_id)
    assert task == task_2
    assert task != task_id
    assert task != dn


def test_create_task():
    name = "name_1"
    task = Task(name, {}, print, [], [])
    assert f"TASK_{name}_" in task.id
    assert task.config_id == "name_1"

    with pytest.raises(InvalidConfigurationId):
        Task("foo bar", {}, print, [], [])

    path = "my/csv/path"
    foo_dn = CSVDataNode("foo", Scope.SCENARIO, properties={"path": path, "has_header": True})
    task = Task("name_1", {}, print, [foo_dn], [])
    assert task.config_id == "name_1"
    assert task.id is not None
    assert task.owner_id is None
    assert task.parent_ids == set()
    assert task.foo == foo_dn
    assert task.foo.path == path
    with pytest.raises(AttributeError):
        _ = task.bar

    task = Task("name_1", {}, print, [foo_dn], [], parent_ids={"parent_id"})
    assert task.parent_ids == {"parent_id"}

    path = "my/csv/path"
    abc_dn = InMemoryDataNode("name_1ea", Scope.SCENARIO, properties={"path": path})

    task = Task("name_1ea", {}, print, [abc_dn], [], owner_id="owner_id", parent_ids={"parent_id_1", "parent_id_2"})
    assert task.config_id == "name_1ea"
    assert task.id is not None
    assert task.owner_id == "owner_id"
    assert task.parent_ids == {"parent_id_1", "parent_id_2"}
    assert task.name_1ea == abc_dn
    assert task.name_1ea.path == path
    with pytest.raises(AttributeError):
        _ = task.bar
    with mock.patch("taipy.core.get") as get_mck:

        class MockOwner:
            label = "owner_label"

            def get_label(self):
                return self.label

        get_mck.return_value = MockOwner()
        assert task.get_label() == "owner_label > " + task.config_id
        assert task.get_simple_label() == task.config_id


def test_get_set_property_and_attribute():
    dn_cfg = Config.configure_data_node("bar")
    task_config = Config.configure_task("print", print, [dn_cfg], None)
    scenario_config = Config.configure_scenario("scenario", [task_config])
    scenario = _ScenarioManager._create(scenario_config)
    task = scenario.tasks["print"]

    task.properties["key"] = "value"

    assert task.properties == {"key": "value"}
    assert task.key == "value"

    task.properties["new_key"] = "new_value"
    task.another_key = "another_value"

    assert task.key == "value"
    assert task.new_key == "new_value"
    assert task.another_key == "another_value"
    assert task.properties == {"key": "value", "new_key": "new_value"}

    with pytest.raises(AttributeKeyAlreadyExisted):
        task.bar = "KeyAlreadyUsed"

    with pytest.raises(PropertyKeyAlreadyExisted):
        task.properties["bar"] = "KeyAlreadyUsed"


def test_can_not_change_task_output(output):
    task = Task("name_1", {}, print, output=output)

    with pytest.raises(AttributeError):
        task.output = {}

    assert list(task.output.values()) == output
    output.append(output[0])
    assert list(task.output.values()) != output


def test_can_not_change_task_input(input):
    task = Task("name_1", {}, print, input=input)

    with pytest.raises(AttributeError):
        task.input = {}

    assert list(task.input.values()) == input
    input.append(input[0])
    assert list(task.input.values()) != input


def test_can_not_change_task_config_output(output_config):
    task_config = Config.configure_task("name_1", print, [], output=output_config)

    assert task_config.output_configs == output_config
    with pytest.raises(AttributeError):
        task_config.output_configs = []

    output_config.append(output_config[0])
    assert task_config._output != output_config


def test_can_not_update_task_output_values(output_config):
    data_node_cfg = Config.configure_data_node("data_node_cfg")
    task_config = Config.configure_task("name_1", print, [], output=output_config)

    task_config.output_configs.append(data_node_cfg)
    assert task_config.output_configs == output_config

    task_config.output_configs[0] = data_node_cfg
    assert task_config.output_configs[0] != data_node_cfg


def test_can_not_update_task_input_values(input_config):
    data_node_config = DataNodeConfig("data_node")
    task_config = Config.configure_task("name_1", print, input=input_config, output=[])

    task_config.input_configs.append(data_node_config)
    assert task_config.input_configs == input_config

    task_config.input_configs[0] = data_node_config
    assert task_config.input_configs[0] != data_node_config


def mock_func():
    pass


def test_auto_set_and_reload(data_node):
    task_1 = Task(
        config_id="foo", properties={}, function=print, input=None, output=None, owner_id=None, skippable=False
    )

    _DataManager._set(data_node)
    _TaskManager._set(task_1)

    task_2 = _TaskManager._get(task_1)

    # auto set & reload on function attribute
    assert task_1.function == print
    assert task_2.function == print
    task_1.function = sum
    assert task_1.function == sum
    assert task_2.function == sum
    task_2.function = mock_func
    assert task_1.function == mock_func
    assert task_2.function == mock_func

    # auto set & reload on skippable attribute
    assert not task_1.skippable
    assert not task_2.skippable
    task_1.skippable = True
    assert task_1.skippable
    assert task_2.skippable
    task_2.skippable = False
    assert not task_1.skippable
    assert not task_2.skippable

    # auto set & reload on parent_ids attribute (set() object does not have auto set yet)
    assert task_1.parent_ids == set()
    assert task_2.parent_ids == set()
    task_1._parent_ids.update(["sc2"])
    _TaskManager._set(task_1)
    assert task_1.parent_ids == {"sc2"}
    assert task_2.parent_ids == {"sc2"}
    task_2._parent_ids.clear()
    task_2._parent_ids.update(["sc1"])
    _TaskManager._set(task_2)
    assert task_1.parent_ids == {"sc1"}
    assert task_2.parent_ids == {"sc1"}

    with task_1 as task:
        assert task.config_id == "foo"
        assert task.owner_id is None
        assert task.function == mock_func
        assert not task.skippable
        assert task._is_in_context

        task.function = print
        task.skippable = True

        assert task.config_id == "foo"
        assert task.owner_id is None
        assert task.function == mock_func
        assert not task.skippable
        assert task._is_in_context

    assert task_1.config_id == "foo"
    assert task_1.owner_id is None
    assert task_1.function == print
    assert task.skippable
    assert not task_1._is_in_context


def test_auto_set_and_reload_properties():
    task_1 = Task(
        config_id="foo", properties={}, function=print, input=None, output=None, owner_id=None, skippable=False
    )

    _TaskManager._set(task_1)

    task_2 = _TaskManager._get(task_1)

    # auto set & reload on properties attribute
    assert task_1.properties == {}
    assert task_2.properties == {}
    task_1._properties["qux"] = 4
    assert task_1.properties["qux"] == 4
    assert task_2.properties["qux"] == 4

    assert task_1.properties == {"qux": 4}
    assert task_2.properties == {"qux": 4}
    task_2._properties["qux"] = 5
    assert task_1.properties["qux"] == 5
    assert task_2.properties["qux"] == 5

    task_1.properties["temp_key_1"] = "temp_value_1"
    task_1.properties["temp_key_2"] = "temp_value_2"
    assert task_1.properties == {
        "qux": 5,
        "temp_key_1": "temp_value_1",
        "temp_key_2": "temp_value_2",
    }
    assert task_2.properties == {
        "qux": 5,
        "temp_key_1": "temp_value_1",
        "temp_key_2": "temp_value_2",
    }
    task_1.properties.pop("temp_key_1")
    assert "temp_key_1" not in task_1.properties.keys()
    assert "temp_key_1" not in task_1.properties.keys()
    assert task_1.properties == {
        "qux": 5,
        "temp_key_2": "temp_value_2",
    }
    assert task_2.properties == {
        "qux": 5,
        "temp_key_2": "temp_value_2",
    }
    task_2.properties.pop("temp_key_2")
    assert task_1.properties == {"qux": 5}
    assert task_2.properties == {"qux": 5}
    assert "temp_key_2" not in task_1.properties.keys()
    assert "temp_key_2" not in task_2.properties.keys()

    task_1.properties["temp_key_3"] = 0
    assert task_1.properties == {"qux": 5, "temp_key_3": 0}
    assert task_2.properties == {"qux": 5, "temp_key_3": 0}
    task_1.properties.update({"temp_key_3": 1})
    assert task_1.properties == {"qux": 5, "temp_key_3": 1}
    assert task_2.properties == {"qux": 5, "temp_key_3": 1}
    task_1.properties.update({})
    assert task_1.properties == {"qux": 5, "temp_key_3": 1}
    assert task_2.properties == {"qux": 5, "temp_key_3": 1}
    task_1.properties["temp_key_4"] = 0
    task_1.properties["temp_key_5"] = 0

    with task_1 as task:
        assert task._is_in_context
        assert task.properties["qux"] == 5
        assert task.properties["temp_key_3"] == 1
        assert task.properties["temp_key_4"] == 0
        assert task.properties["temp_key_5"] == 0

        task.properties["qux"] = 9
        task.properties.pop("temp_key_3")
        task.properties.pop("temp_key_4")
        task.properties.update({"temp_key_4": 1})
        task.properties.update({"temp_key_5": 2})
        task.properties.pop("temp_key_5")
        task.properties.update({})

        assert task._is_in_context
        assert task.properties["qux"] == 5
        assert task.properties["temp_key_3"] == 1
        assert task.properties["temp_key_4"] == 0
        assert task.properties["temp_key_5"] == 0

    assert not task_1._is_in_context
    assert task_1.properties["qux"] == 9
    assert "temp_key_3" not in task_1.properties.keys()
    assert task_1.properties["temp_key_4"] == 1
    assert "temp_key_5" not in task_1.properties.keys()


def test_get_parents(task):
    with mock.patch("taipy.core.get_parents") as mck:
        task.get_parents()
        mck.assert_called_once_with(task)


def test_submit_task(task: Task):
    with mock.patch("taipy.core.task._task_manager._TaskManager._submit") as mock_submit:
        task.submit([], True)
        mock_submit.assert_called_once_with(task, [], True, False, None)