Merge pull request #1799 from Avaiga/feature/#1734-Recreate-the-Core-service

feature/#1734 Recreate the Core service

taipy/core/_core.py

@@ -0,0 +1,29 @@
+# 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 taipy.logger._taipy_logger import _TaipyLogger
+
+from .common._warnings import _warn_deprecated
+from .orchestrator import Orchestrator
+
+
+class Core:
+    """Deprecated. Use the `Orchestrator^` service class with `taipy.Orchestrator()` instead."""
+
+    __logger = _TaipyLogger._get_logger()
+
+    def __new__(cls) -> Orchestrator:  # type: ignore
+        _warn_deprecated("'Core'", suggest="the 'Orchestrator' class")
+        cls.__logger.warning(
+            "The `Core` service is deprecated and replaced by the `Orchestrator` service. "
+            "An `Orchestrator` instance has been instantiated instead."
+        )
+        return Orchestrator()

taipy/core/_init.py

@@ -9,6 +9,7 @@
 # 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 ._core import Core
 from ._entity.submittable import Submittable
 from .cycle.cycle import Cycle
 from .cycle.cycle_id import CycleId

tests/core/test_core.py

@@ -12,105 +12,20 @@
 
 import pytest
 
-from taipy.config import Config
-from taipy.config.exceptions.exceptions import ConfigurationUpdateBlocked
-from taipy.core import Orchestrator
-from taipy.core._orchestrator._dispatcher import _DevelopmentJobDispatcher, _StandaloneJobDispatcher
-from taipy.core._orchestrator._orchestrator import _Orchestrator
-from taipy.core._orchestrator._orchestrator_factory import _OrchestratorFactory
-from taipy.core.config.job_config import JobConfig
-from taipy.core.exceptions.exceptions import OrchestratorServiceIsAlreadyRunning
+from taipy.core import Core, Orchestrator
 
 
-class TestOrchestrator:
-    def test_run_orchestrator_trigger_config_check(self, caplog):
-        Config.configure_data_node(id="d0", storage_type="toto")
-        with pytest.raises(SystemExit):
-            orchestrator = Orchestrator()
-            orchestrator.run()
-        expected_error_message = (
-            "`storage_type` field of DataNodeConfig `d0` must be either csv, sql_table,"
-            " sql, mongo_collection, pickle, excel, generic, json, parquet, s3_object, or in_memory."
-            ' Current value of property `storage_type` is "toto".'
-        )
-        assert expected_error_message in caplog.text
-        orchestrator.stop()
-
-    def test_run_orchestrator_as_a_service_development_mode(self):
-        _OrchestratorFactory._dispatcher = None
-
-        orchestrator = Orchestrator()
-        assert orchestrator._orchestrator is None
-        assert orchestrator._dispatcher is None
-        assert _OrchestratorFactory._dispatcher is None
-
-        orchestrator.run()
-        assert orchestrator._orchestrator is not None
-        assert orchestrator._orchestrator == _Orchestrator
-        assert _OrchestratorFactory._orchestrator is not None
-        assert _OrchestratorFactory._orchestrator == _Orchestrator
-        assert orchestrator._dispatcher is not None
-        assert isinstance(orchestrator._dispatcher, _DevelopmentJobDispatcher)
-        assert isinstance(_OrchestratorFactory._dispatcher, _DevelopmentJobDispatcher)
-        orchestrator.stop()
-
-    def test_run_orchestrator_as_a_service_standalone_mode(self):
-        _OrchestratorFactory._dispatcher = None
-
-        orchestrator = Orchestrator()
-        assert orchestrator._orchestrator is None
-
-        assert orchestrator._dispatcher is None
-        assert _OrchestratorFactory._dispatcher is None
-
-        Config.configure_job_executions(mode=JobConfig._STANDALONE_MODE, max_nb_of_workers=2)
-        orchestrator.run()
-        assert orchestrator._orchestrator is not None
-        assert orchestrator._orchestrator == _Orchestrator
-        assert _OrchestratorFactory._orchestrator is not None
-        assert _OrchestratorFactory._orchestrator == _Orchestrator
-        assert orchestrator._dispatcher is not None
-        assert isinstance(orchestrator._dispatcher, _StandaloneJobDispatcher)
-        assert isinstance(_OrchestratorFactory._dispatcher, _StandaloneJobDispatcher)
-        assert orchestrator._dispatcher.is_running()
-        assert _OrchestratorFactory._dispatcher.is_running()
-        orchestrator.stop()
+class TestCore:
+    def test_run_core_with_depracated_message(self, caplog):
+        with pytest.warns(DeprecationWarning):
+            core = Core()
+        core.run()
 
-    def test_orchestrator_service_can_only_be_run_once(self):
-        orchestrator_instance_1 = Orchestrator()
-        orchestrator_instance_2 = Orchestrator()
-
-        orchestrator_instance_1.run()
-
-        with pytest.raises(OrchestratorServiceIsAlreadyRunning):
-            orchestrator_instance_1.run()
-        with pytest.raises(OrchestratorServiceIsAlreadyRunning):
-            orchestrator_instance_2.run()
-
-        # Stop the Orchestrator service and run it again should work
-        orchestrator_instance_1.stop()
-
-        orchestrator_instance_1.run()
-        orchestrator_instance_1.stop()
-        orchestrator_instance_2.run()
-        orchestrator_instance_2.stop()
-
-    def test_block_config_update_when_orchestrator_service_is_running_development_mode(self):
-        _OrchestratorFactory._dispatcher = None
-
-        orchestrator = Orchestrator()
-        orchestrator.run()
-        with pytest.raises(ConfigurationUpdateBlocked):
-            Config.configure_data_node(id="i1")
-        orchestrator.stop()
-
-    @pytest.mark.standalone
-    def test_block_config_update_when_orchestrator_service_is_running_standalone_mode(self):
-        _OrchestratorFactory._dispatcher = None
+        assert isinstance(core, Orchestrator)
+        expected_message = (
+            "The `Core` service is deprecated and replaced by the `Orchestrator` service. "
+            "An `Orchestrator` instance has been instantiated instead."
+        )
+        assert expected_message in caplog.text
 
-        orchestrator = Orchestrator()
-        Config.configure_job_executions(mode=JobConfig._STANDALONE_MODE, max_nb_of_workers=2)
-        orchestrator.run()
-        with pytest.raises(ConfigurationUpdateBlocked):
-            Config.configure_data_node(id="i1")
-        orchestrator.stop()
+        core.stop()

tests/core/test_orchestrator.py

@@ -0,0 +1,116 @@
+# 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.
+
+
+import pytest
+
+from taipy.config import Config
+from taipy.config.exceptions.exceptions import ConfigurationUpdateBlocked
+from taipy.core import Orchestrator
+from taipy.core._orchestrator._dispatcher import _DevelopmentJobDispatcher, _StandaloneJobDispatcher
+from taipy.core._orchestrator._orchestrator import _Orchestrator
+from taipy.core._orchestrator._orchestrator_factory import _OrchestratorFactory
+from taipy.core.config.job_config import JobConfig
+from taipy.core.exceptions.exceptions import OrchestratorServiceIsAlreadyRunning
+
+
+class TestOrchestrator:
+    def test_run_orchestrator_trigger_config_check(self, caplog):
+        Config.configure_data_node(id="d0", storage_type="toto")
+        with pytest.raises(SystemExit):
+            orchestrator = Orchestrator()
+            orchestrator.run()
+        expected_error_message = (
+            "`storage_type` field of DataNodeConfig `d0` must be either csv, sql_table,"
+            " sql, mongo_collection, pickle, excel, generic, json, parquet, s3_object, or in_memory."
+            ' Current value of property `storage_type` is "toto".'
+        )
+        assert expected_error_message in caplog.text
+        orchestrator.stop()
+
+    def test_run_orchestrator_as_a_service_development_mode(self):
+        _OrchestratorFactory._dispatcher = None
+
+        orchestrator = Orchestrator()
+        assert orchestrator._orchestrator is None
+        assert orchestrator._dispatcher is None
+        assert _OrchestratorFactory._dispatcher is None
+
+        orchestrator.run()
+        assert orchestrator._orchestrator is not None
+        assert orchestrator._orchestrator == _Orchestrator
+        assert _OrchestratorFactory._orchestrator is not None
+        assert _OrchestratorFactory._orchestrator == _Orchestrator
+        assert orchestrator._dispatcher is not None
+        assert isinstance(orchestrator._dispatcher, _DevelopmentJobDispatcher)
+        assert isinstance(_OrchestratorFactory._dispatcher, _DevelopmentJobDispatcher)
+        orchestrator.stop()
+
+    def test_run_orchestrator_as_a_service_standalone_mode(self):
+        _OrchestratorFactory._dispatcher = None
+
+        orchestrator = Orchestrator()
+        assert orchestrator._orchestrator is None
+
+        assert orchestrator._dispatcher is None
+        assert _OrchestratorFactory._dispatcher is None
+
+        Config.configure_job_executions(mode=JobConfig._STANDALONE_MODE, max_nb_of_workers=2)
+        orchestrator.run()
+        assert orchestrator._orchestrator is not None
+        assert orchestrator._orchestrator == _Orchestrator
+        assert _OrchestratorFactory._orchestrator is not None
+        assert _OrchestratorFactory._orchestrator == _Orchestrator
+        assert orchestrator._dispatcher is not None
+        assert isinstance(orchestrator._dispatcher, _StandaloneJobDispatcher)
+        assert isinstance(_OrchestratorFactory._dispatcher, _StandaloneJobDispatcher)
+        assert orchestrator._dispatcher.is_running()
+        assert _OrchestratorFactory._dispatcher.is_running()
+        orchestrator.stop()
+
+    def test_orchestrator_service_can_only_be_run_once(self):
+        orchestrator_instance_1 = Orchestrator()
+        orchestrator_instance_2 = Orchestrator()
+
+        orchestrator_instance_1.run()
+
+        with pytest.raises(OrchestratorServiceIsAlreadyRunning):
+            orchestrator_instance_1.run()
+        with pytest.raises(OrchestratorServiceIsAlreadyRunning):
+            orchestrator_instance_2.run()
+
+        # Stop the Orchestrator service and run it again should work
+        orchestrator_instance_1.stop()
+
+        orchestrator_instance_1.run()
+        orchestrator_instance_1.stop()
+        orchestrator_instance_2.run()
+        orchestrator_instance_2.stop()
+
+    def test_block_config_update_when_orchestrator_service_is_running_development_mode(self):
+        _OrchestratorFactory._dispatcher = None
+
+        orchestrator = Orchestrator()
+        orchestrator.run()
+        with pytest.raises(ConfigurationUpdateBlocked):
+            Config.configure_data_node(id="i1")
+        orchestrator.stop()
+
+    @pytest.mark.standalone
+    def test_block_config_update_when_orchestrator_service_is_running_standalone_mode(self):
+        _OrchestratorFactory._dispatcher = None
+
+        orchestrator = Orchestrator()
+        Config.configure_job_executions(mode=JobConfig._STANDALONE_MODE, max_nb_of_workers=2)
+        orchestrator.run()
+        with pytest.raises(ConfigurationUpdateBlocked):
+            Config.configure_data_node(id="i1")
+        orchestrator.stop()