# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Standard pytest fixtures for unit tests."""

from pathlib import Path
from typing import (
    Any,
    Callable,
    Optional,
    Union,
)
from unittest.mock import (
    Mock,
    create_autospec,
)

import pytest

from cylc.flow.cycling.iso8601 import init as iso8601_init
from cylc.flow.cycling.loader import (
    INTEGER_CYCLING_TYPE,
    ISO8601_CYCLING_TYPE,
)
from cylc.flow.data_store_mgr import DataStoreMgr
from cylc.flow.install import (
    link_runN,
    unlink_runN,
)
from cylc.flow.scheduler import Scheduler
from cylc.flow.workflow_files import WorkflowFiles
from cylc.flow.xtrigger_mgr import XtriggerManager


# Type alias for monkeymock()
MonkeyMock = Callable[..., Mock]


@pytest.fixture
def monkeymock(monkeypatch: pytest.MonkeyPatch):
    """Fixture that patches a function/attr with a Mock and returns that Mock.

    Args:
        pypath: The Python-style import path to be patched.
        **kwargs: Any kwargs to set on the Mock.

    Example:
        mock_clean = monkeymock('cylc.flow.workflow_files.clean')
        something()  # calls workflow_files.clean
        assert mock_clean.called is True
    """
    def _monkeymock(pypath: str, **kwargs: Any) -> Mock:
        _mock = Mock(**kwargs)
        monkeypatch.setattr(pypath, _mock)
        return _mock
    return _monkeymock


def _tmp_run_dir(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
    """Fixture that patches the cylc-run dir to the tests's
    {tmp_path}/cylc-run, and optionally creates a workflow run dir inside.

    Adds the runN symlink automatically if the workflow ID ends with /run__.

    Args:
        id_: Workflow name.
        installed: If True, make it look like the workflow was installed
            using cylc install (creates _cylc-install dir).
        named: If True and installed is True, the _cylc-install dir will
            be created in the parent to make it look like this is a
            named run.

    Example:
        run_dir = tmp_run_dir('foo')
        # Or:
        cylc_run_dir = tmp_run_dir()
    """
    cylc_run_dir = tmp_path / 'cylc-run'
    cylc_run_dir.mkdir(exist_ok=True)
    monkeypatch.setattr('cylc.flow.pathutil._CYLC_RUN_DIR', cylc_run_dir)

    def __tmp_run_dir(
        id_: Optional[str] = None,
        installed: bool = False,
        named: bool = False
    ) -> Path:
        if not id_:
            return cylc_run_dir

        run_dir = cylc_run_dir.joinpath(id_)
        run_dir.mkdir(parents=True, exist_ok=True)
        (run_dir / WorkflowFiles.FLOW_FILE).touch(exist_ok=True)
        (run_dir / WorkflowFiles.Service.DIRNAME).mkdir(exist_ok=True)
        if run_dir.name.startswith('run'):
            unlink_runN(run_dir.parent)
            link_runN(run_dir)
        if installed:
            if named:
                if len(Path(id_).parts) < 2:
                    raise ValueError("Named run requires two-level id_")
                (run_dir.parent / WorkflowFiles.Install.DIRNAME).mkdir(
                    exist_ok=True)
            else:
                (run_dir / WorkflowFiles.Install.DIRNAME).mkdir(exist_ok=True)

        return run_dir

    return __tmp_run_dir


@pytest.fixture
def tmp_run_dir(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
    return _tmp_run_dir(tmp_path, monkeypatch)


@pytest.fixture(scope='module')
def mod_tmp_run_dir(tmp_path_factory: pytest.TempPathFactory):
    """Module-scoped version of tmp_run_dir()"""
    tmp_path = tmp_path_factory.getbasetemp()
    with pytest.MonkeyPatch.context() as mp:
        yield _tmp_run_dir(tmp_path, mp)


def _tmp_src_dir(tmp_path: Path):
    """Fixture that creates a temporary workflow source dir.

    (Actually the fixture is below, this is the re-usable meat of it.)

    Args:
        path: Path of source dir relative to cylc-src/.

    Example:
        src_dir = tmp_src_dir('foo')
    """
    def __tmp_src_dir(path: Union[Path, str]) -> Path:
        cylc_src_dir = tmp_path / 'cylc-src'
        cylc_src_dir.mkdir(exist_ok=True)
        src_dir = cylc_src_dir / path
        src_dir.mkdir(parents=True)
        (src_dir / WorkflowFiles.FLOW_FILE).touch()
        return src_dir
    return __tmp_src_dir


@pytest.fixture
def tmp_src_dir(tmp_path: Path):
    # This is the actual tmp_src_dir fixture
    return _tmp_src_dir(tmp_path)


@pytest.fixture(scope='module')
def mod_tmp_src_dir(tmp_path_factory: pytest.TempPathFactory):
    """Module-scoped version of tmp_src_dir()"""
    tmp_path = tmp_path_factory.getbasetemp()
    return _tmp_src_dir(tmp_path)


@pytest.fixture
def set_cycling_type(monkeypatch: pytest.MonkeyPatch):
    """Initialize the Cylc cycling type.

    Args:
        ctype: The cycling type (integer or iso8601).
        time_zone: If using ISO8601/datetime cycling type, you can specify a
            custom time zone to use.
        dump_format: If using ISO8601, specify custom dump format.
    """

    def _set_cycling_type(
        ctype: str = INTEGER_CYCLING_TYPE,
        time_zone: Optional[str] = 'Z',
        dump_format: Optional[str] = None,
    ) -> None:
        class _DefaultCycler:
            TYPE = ctype

        monkeypatch.setattr(
            'cylc.flow.cycling.loader.DefaultCycler', _DefaultCycler
        )
        if ctype == ISO8601_CYCLING_TYPE:
            monkeypatch.setattr(
                'cylc.flow.cycling.iso8601.WorkflowSpecifics',
                iso8601_init(
                    time_zone=time_zone, custom_dump_format=dump_format
                ),
            )

    return _set_cycling_type


@pytest.fixture
def xtrigger_mgr() -> XtriggerManager:
    """A fixture to build an XtriggerManager which uses a mocked proc_pool,
    and uses a mocked broadcast_mgr."""
    workflow_name = "sample_workflow"
    user = "john-foo"
    return XtriggerManager(
        workflow=workflow_name,
        user=user,
        proc_pool=Mock(put_command=lambda *a, **k: True),
        workflow_db_mgr=Mock(housekeep=lambda *a, **k: True),
        broadcast_mgr=Mock(put_broadcast=lambda *a, **k: True),
        data_store_mgr=DataStoreMgr(
            create_autospec(Scheduler, workflow=workflow_name, owner=user)
        )
    )


@pytest.fixture()
def prevent_symlinking(monkeypatch: pytest.MonkeyPatch):
    monkeypatch.setattr(
        'cylc.flow.pathutil.make_symlink_dir',
        lambda *_, **__: {}
    )


def _tmp_flow_config(tmp_run_dir: Callable):
    """Create a temporary flow config file for use in init'ing WorkflowConfig.
    Args:
        id_: Workflow name.
        config: The flow file content.
    Returns the path to the flow file.
    """
    def __tmp_flow_config(id_: str, config: str) -> 'Path':
        run_dir: 'Path' = tmp_run_dir(id_)
        flow_file = run_dir / WorkflowFiles.FLOW_FILE
        flow_file.write_text(config)
        return flow_file
    return __tmp_flow_config


@pytest.fixture
def tmp_flow_config(tmp_run_dir: Callable):
    return _tmp_flow_config(tmp_run_dir)


@pytest.fixture(scope='module')
def mod_tmp_flow_config(mod_tmp_run_dir: Callable):
    return _tmp_flow_config(mod_tmp_run_dir)