taipy/tests/conftest.py

# Copyright 2021-2025 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 argparse
import typing as t

import pytest

from taipy.common._cli._base_cli._taipy_parser import _TaipyParser
from taipy.common.config import Config, _inject_section
from taipy.common.config._config import _Config
from taipy.common.config._config_comparator._config_comparator import _ConfigComparator
from taipy.common.config._serializer._base_serializer import _BaseSerializer
from taipy.common.config._serializer._toml_serializer import _TomlSerializer
from taipy.common.config.checker._checker import _Checker
from taipy.common.config.checker.issue_collector import IssueCollector
from taipy.core.config import CoreSection, DataNodeConfig, JobConfig, ScenarioConfig, TaskConfig
from taipy.rest.config import RestConfig


def pytest_addoption(parser: pytest.Parser) -> None:
    """Add custom command line options for pytest."""
    parser.addoption("--e2e-base-url", action="store", default="/", help="base url for e2e testing")
    parser.addoption("--e2e-port", action="store", default="5000", help="port for e2e testing")
    parser.addoption("--gui-server", action="store", default="flask", help="server for e2e testing")


@pytest.fixture(scope="session")
def e2e_base_url(request: pytest.FixtureRequest) -> str:
    """Fixture to get the base URL for e2e testing."""
    return request.config.getoption("--e2e-base-url")


@pytest.fixture(scope="session")
def e2e_port(request: pytest.FixtureRequest) -> str:
    """Fixture to get the port for e2e testing."""
    return request.config.getoption("--e2e-port")


@pytest.fixture(scope="session")
def gui_server(request: pytest.FixtureRequest) -> str:
    """Fixture to get the server for e2e testing."""
    return request.config.getoption("--gui-server")


def remove_subparser(name: str) -> None:
    """Remove a subparser from argparse."""
    _TaipyParser._sub_taipyparsers.pop(name, None)

    if _TaipyParser._subparser_action:
        _TaipyParser._subparser_action._name_parser_map.pop(name, None)

        for action in _TaipyParser._subparser_action._choices_actions:
            if action.dest == name:
                _TaipyParser._subparser_action._choices_actions.remove(action)


@pytest.fixture
def clean_argparser() -> t.Callable:
    """Fixture to clean the argument parser."""

    def _clean_argparser() -> None:
        _TaipyParser._parser = argparse.ArgumentParser(conflict_handler="resolve")
        _TaipyParser._subparser_action = None
        _TaipyParser._arg_groups = {}
        subcommands = list(_TaipyParser._sub_taipyparsers.keys())
        for subcommand in subcommands:
            remove_subparser(subcommand)

    return _clean_argparser


@pytest.fixture
def reset_configuration_singleton() -> t.Callable:
    """Fixture to reset the configuration singleton."""

    def _reset_configuration_singleton() -> None:
        Config.unblock_update()

        Config._default_config = _Config()._default_config()
        Config._python_config = _Config()
        Config._file_config = _Config()
        Config._env_file_config = _Config()
        Config._applied_config = _Config()
        Config._collector = IssueCollector()
        Config._serializer = _TomlSerializer()
        Config._comparator = _ConfigComparator()
        _BaseSerializer._SERIALIZABLE_TYPES = [
            "bool",
            "str",
            "int",
            "float",
            "datetime",
            "timedelta",
            "function",
            "class",
            "SECTION",
        ]
        _Checker._checkers = []

    return _reset_configuration_singleton


@pytest.fixture
def inject_core_sections() -> t.Callable:
    """Fixture to inject core sections into the configuration."""

    def _inject_core_sections() -> None:
        _inject_section(
            JobConfig,
            "job_config",
            JobConfig("development"),
            [("configure_job_executions", JobConfig._configure)],
            True,
        )
        _inject_section(
            CoreSection,
            "core",
            CoreSection.default_config(),
            [("configure_core", CoreSection._configure)],
            add_to_unconflicted_sections=True,
        )
        _inject_section(
            DataNodeConfig,
            "data_nodes",
            DataNodeConfig.default_config(),
            [
                ("configure_data_node", DataNodeConfig._configure),
                ("configure_data_node_from", DataNodeConfig._configure_from),
                ("set_default_data_node_configuration", DataNodeConfig._set_default_configuration),
                ("configure_csv_data_node", DataNodeConfig._configure_csv),
                ("configure_json_data_node", DataNodeConfig._configure_json),
                ("configure_sql_table_data_node", DataNodeConfig._configure_sql_table),
                ("configure_sql_data_node", DataNodeConfig._configure_sql),
                ("configure_mongo_collection_data_node", DataNodeConfig._configure_mongo_collection),
                ("configure_in_memory_data_node", DataNodeConfig._configure_in_memory),
                ("configure_pickle_data_node", DataNodeConfig._configure_pickle),
                ("configure_excel_data_node", DataNodeConfig._configure_excel),
                ("configure_generic_data_node", DataNodeConfig._configure_generic),
                ("configure_s3_object_data_node", DataNodeConfig._configure_s3_object),
            ],
        )
        _inject_section(
            TaskConfig,
            "tasks",
            TaskConfig.default_config(),
            [
                ("configure_task", TaskConfig._configure),
                ("set_default_task_configuration", TaskConfig._set_default_configuration),
            ],
        )
        _inject_section(
            ScenarioConfig,
            "scenarios",
            ScenarioConfig.default_config(),
            [
                ("configure_scenario", ScenarioConfig._configure),
                ("set_default_scenario_configuration", ScenarioConfig._set_default_configuration),
            ],
        )

    return _inject_core_sections


@pytest.fixture
def inject_rest_sections() -> t.Callable:
    """Fixture to inject core sections into the configuration."""

    def _inject_rest_sections() -> None:
        _inject_section(
            RestConfig,
            "rest",
            default=RestConfig.default_config(),
            configuration_methods=[("configure_rest", RestConfig._configure_rest)],
        )

    return _inject_rest_sections