import os

import re

import shutil

import sys

import tempfile

from enum import Enum

from pathlib import Path

from typing import Dict, Optional

import invoke

from invoke import task

from developer.git.commit_validator import (

    validate_commits_locally_or_ci,

)

from strictdoc.core.environment import (

    BINARY_HTML_TEMPLATES_DIR,

    HTML_TEMPLATE_DIRS,

)

# Specifying encoding because Windows crashes otherwise when running Invoke

# tasks below:

# UnicodeEncodeError: 'charmap' codec can't encode character '\ufffd'

# in position 16: character maps to <undefined>

# People say, it might also be possible to export PYTHONIOENCODING=utf8 but this

# seems to work.

# FIXME: If you are a Windows user and expert, please advise on how to do this

# properly.

sys.stdout = open(1, "w", encoding="utf-8", closefd=False, buffering=1)

STRICTDOC_TMP_DIR = os.path.join(tempfile.gettempdir(), "strictdoc_tmp_dir")

TEST_REPORTS_DIR = "build/test_reports"

def get_pyinstaller_html_template_data_options() -> str:

    return "\n".join(

        f'--add-data "{template_dir}{os.pathsep}{BINARY_HTML_TEMPLATES_DIR}"'

        for template_dir in HTML_TEMPLATE_DIRS

    )

def get_nuitka_html_template_data_options() -> str:

    return "\n".join(

        f'--include-data-dir="{template_dir}={BINARY_HTML_TEMPLATES_DIR}"'

        for template_dir in HTML_TEMPLATE_DIRS

    )

# To prevent all tasks from building to the same virtual environment.

# All values correspond to the configuration in the tox.ini config file.

class ToxEnvironment(str, Enum):

    DEVELOPMENT = "development"

    CHECK = "check"

    DOCUMENTATION = "documentation"

    RELEASE = "release"

    RELEASE_LOCAL = "release-local"

    PYINSTALLER = "pyinstaller"

def run_invoke(

    context,

    cmd,

    environment: Optional[dict] = None,

    pty: bool = False,

    warn: bool = False,

) -> invoke.runners.Result:

    def one_line_command(string):

        return re.sub("\\s+", " ", string).strip()

    return context.run(

        one_line_command(cmd),

        env=environment,

        hide=False,

        warn=warn,

        pty=pty,

        echo=True,

    )

def run_invoke_with_tox(

    context,

    environment_type: ToxEnvironment,

    command: str,

    environment: Optional[Dict] = None,

    pty: bool = False,

) -> invoke.runners.Result:

    assert isinstance(environment_type, ToxEnvironment)

    assert isinstance(command, str)

    tox_py_version = f"py{sys.version_info.major}{sys.version_info.minor}"

    return run_invoke(

        context,

        f"""

            tox

                -e {tox_py_version}-{environment_type.value} --

                {command}

        """,

        environment=environment,

        pty=pty,

    )

@task(default=True)

def list_tasks(context):

    clean_command = """

        invoke --list

    """

    run_invoke(context, clean_command)

@task

def clean(context):

    # https://unix.stackexchange.com/a/689930/77389

    clean_command = """

        rm -rf output/ docs/sphinx/build/

    """

    run_invoke(context, clean_command)

@task(aliases=["s"])

def server(context, input_path=".", config=None):

    assert os.path.isdir(input_path), input_path

    if config is not None:

        assert os.path.isfile(config), config

    config_argument = f"--config {config}" if config is not None else ""

    run_invoke_with_tox(

        context,

        ToxEnvironment.DEVELOPMENT,

        f"""

            python -m strictdoc.cli.main

                --debug

                server {input_path} {config_argument}

                    --host 127.0.0.1

                    --reload

        """,

    )

@task(aliases=["d"])

def docs(context):

    run_invoke_with_tox(

        context,

        ToxEnvironment.DOCUMENTATION,

        """

            python3 -m strictdoc.cli.main

                export .

                    --formats=html

                    --output-dir output/strictdoc_website

                    --project-title "StrictDoc"

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.DOCUMENTATION,

        """

            python3 -m strictdoc.cli.main

                export ./

                    --formats=rst

                    --output-dir output/sphinx

                    --project-title "StrictDoc"

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.DOCUMENTATION,

        """

            cp -r output/sphinx/rst/docs/* docs/sphinx/source/ &&

            cp -r output/sphinx/rst/docs_extra/* docs/sphinx/source/ &&

            mkdir -p docs/sphinx/source/_assets/ &&

            cp -v docs/_assets/* docs/sphinx/source/_assets/

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.DOCUMENTATION,

        """

            make --directory docs/sphinx html latexpdf SPHINXOPTS="-W --keep-going"

        """,

    )

    run_invoke(

        context,

        (

            """

                open docs/sphinx/build/latex/strictdoc.pdf

            """

        ),

    )

@task(aliases=["tus"])

def test_unit_server(context, focus=None):

    focus_argument = f"-k {focus}" if focus is not None else ""

    Path(TEST_REPORTS_DIR).mkdir(parents=True, exist_ok=True)

    cwd = os.getcwd()

    path_to_coverage_file = f"{cwd}/build/coverage/unit_server/.coverage"

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        f"""

            coverage run

            --rcfile=.coveragerc.unit_server

            --data-file={path_to_coverage_file}

            -m pytest

            tests/unit_server/

                {focus_argument}

                --junit-xml={TEST_REPORTS_DIR}/tests_unit_server.pytest.junit.xml

                -o junit_suite_name="StrictDoc Web Server Unit Tests"

                -o cache_dir=build/pytest_unit_server

        """,

    )

@task(test_unit_server, aliases=["tusc"])

def test_unit_server_report(context):

    cwd = os.getcwd()

    path_to_coverage_file = f"{cwd}/build/coverage/unit_server/.coverage"

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        f"""

            coverage html

                --rcfile=.coveragerc.unit_server

                --data-file={path_to_coverage_file}

        """,

    )

@task(aliases=["te"])

def test_end2end(

    context,

    *,

    focus=None,

    exit_first=False,

    parallelize=False,

    long_timeouts=False,

    headless=False,

    headed=False,

    shard=None,

    test_path=None,

    coverage: bool = False,

):

    """

    @relation(SDOC-SRS-46, scope=function)

    """

    environment = {}

    coverage_command_or_none = ""

    coverage_argument_or_none = ""

    if coverage:

        cwd = os.getcwd()

        coverage_file_dir = f"{cwd}/build/coverage/end2end/"

        coverage_file_dir2 = f"{cwd}/build/coverage/end2end_strictdoc/"

        coverage_file = os.path.join(coverage_file_dir, ".coverage")

        coverage_rc = os.path.join(cwd, ".coveragerc.end2end")

        shutil.rmtree(coverage_file_dir, ignore_errors=True)

        shutil.rmtree(coverage_file_dir2, ignore_errors=True)

        coverage_command_or_none = f"""

            coverage run

                --rcfile={coverage_rc}

                --data-file={coverage_file}

                -m

        """

        coverage_argument_or_none = "--strictdoc-coverage"

    long_timeouts_argument = (

        "--strictdoc-long-timeouts" if long_timeouts else ""

    )

    parallelize_argument = ""

    if parallelize:

        print(  # noqa: T201

            "warning: "

            "Running parallelized end-2-end tests is supported "

            "but is not stable."

        )

        parallelize_argument = "--numprocesses=2 --strictdoc-parallelize"

    assert shard is None or re.match(r"[1-9][0-9]*/[1-9][0-9]*", shard), (

        f"--shard argument has an incorrect format: {shard}."

    )

    shard_argument = f"--strictdoc-shard={shard}" if shard else ""

    focus_argument = f"-k {focus}" if focus is not None else ""

    exit_first_argument = "--exitfirst" if exit_first else ""

    headless_argument = "--headless2" if headless and not headed else "--gui"

    test_command = f"""

            {coverage_command_or_none}

            pytest

            --failed-first

            --capture=no

            --reuse-session

            {parallelize_argument}

            {shard_argument}

            {coverage_argument_or_none}

            {focus_argument}

            {exit_first_argument}

            {long_timeouts_argument}

            {headless_argument}

            --junit-xml={TEST_REPORTS_DIR}/tests_end2end.pytest.junit.xml

            -o junit_suite_name="StrictDoc End-to-End Tests"

            -o cache_dir=build/pytest_end2end

            tests/end2end

    """

    if test_path:

        test_command = test_command.rstrip() + f"/{test_path}"

    Path(TEST_REPORTS_DIR).mkdir(parents=True, exist_ok=True)

    # On Windows, GitHub Actions fails with:

    # response = {'status': 500, 'value':

    # '{"value":{"error":"unknown error",

    # "message":"unknown error: cannot find Chrome binary",  # noqa: ERA001

    # This very likely has to do with PATH isolation that Tox does.

    # FIXME: If you are a Windows expert, please fix this to run on Tox.

    if os.name == "nt":

        run_invoke(context, test_command)

        return

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        test_command,

        environment=environment,

    )

@task(aliases=["tu"])

def test_unit(context, coverage=False, focus=None, path=None, output=False):

    """

    @relation(SDOC-SRS-44, scope=function)

    """

    Path(TEST_REPORTS_DIR).mkdir(parents=True, exist_ok=True)

    focus_argument = f"-k {focus}" if focus is not None else ""

    output_argument = "--capture=no" if output else ""

    cwd = os.getcwd()

    if path is None:

        path = "tests/unit"

    else:

        assert "tests/unit" in path, path

    path_to_coverage_file = f"{cwd}/build/coverage/unit/.coverage"

    pytest_command = (

        """

        coverage run

            --rcfile=.coveragerc.unit

            --data-file={path_to_coverage_file}

            -m pytest

    """

        if coverage

        else "pytest"

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        f"""

            {pytest_command}

            {focus_argument}

            {output_argument}

            --junit-xml={TEST_REPORTS_DIR}/tests_unit.pytest.junit.xml

            -o cache_dir=build/pytest_unit_with_coverage

            -o junit_suite_name="StrictDoc Unit Tests"

            -p no:seleniumbase

            {path}

        """,

    )

    if coverage and not focus and path == "tests/unit":

        run_invoke_with_tox(

            context,

            ToxEnvironment.CHECK,

            f"""

                coverage report

                    --sort=cover

                    --rcfile=.coveragerc.unit

                    --data-file={path_to_coverage_file}

            """,

        )

@task(test_unit, aliases=["tuc"])

def test_unit_report(context):

    cwd = os.getcwd()

    path_to_coverage_file = f"{cwd}/build/coverage/unit/.coverage"

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        f"""

            coverage html

                --rcfile=.coveragerc.unit

                --data-file={path_to_coverage_file}

        """,

    )

@task(aliases=["ti"])

def test_integration(

    context,

    focus=None,

    debug=False,

    no_parallelization=False,

    fail_first=False,

    coverage=False,

    strictdoc=None,

    html2pdf=False,

    shard=None,

    environment=ToxEnvironment.CHECK,

):

    """

    @relation(SDOC-SRS-45, scope=function)

    """

    cwd = os.getcwd()

    if strictdoc is None:

        strictdoc_exec = "python3 -m strictdoc.cli.main"

    else:

        strictdoc_exec = strictdoc

    coverage_path_argument = ""

    if coverage:

        path_to_coverage_rc = f"{cwd}/.coveragerc.integration"

        strictdoc_exec = (

            f"coverage run --rcfile={path_to_coverage_rc} -m strictdoc.cli.main"

        )

        if html2pdf:

            path_to_coverage_dir = f"{cwd}/build/coverage/integration_html2pdf/"

        else:

            path_to_coverage_dir = f"{cwd}/build/coverage/integration/"

        path_to_coverage = os.path.join(path_to_coverage_dir, ".coverage")

        shutil.rmtree(path_to_coverage_dir, ignore_errors=True)

        coverage_path_argument = (

            f'--param COVERAGE_FILE="{path_to_coverage}" '

            f'--param COVERAGE_PROCESS_START="{path_to_coverage_rc}"'

        )

    debug_opts = "-vv --show-all" if debug else ""

    focus_or_none = f"--filter {focus}" if focus else ""

    fail_first_argument = "--max-failures 1" if fail_first else ""

    junit_xml_report_argument = (

        "--xunit-xml-output build/test_reports/tests_integration_html2pdf.lit.junit.xml"

        if html2pdf

        else "--xunit-xml-output build/test_reports/tests_integration.lit.junit.xml"

    )

    # Allow partitioning of integration and html2pdf tests

    partition_opts = ""

    if shard is not None:

        match = re.match(r"([1-9][0-9]*)/([1-9][0-9]*)", shard)

        assert match, f"--shard argument has an incorrect format: {shard}."

        run_shard = int(match.group(1))

        num_shards = int(match.group(2))

        partition_opts = f"--num-shards={num_shards} --run-shard={run_shard}"

    # HTML2PDF tests are running Chrome Driver which does not seem to be

    # parallelizable, or at least not in the way StrictDoc uses it.

    # If HTML2PDF option is provided, do not parallelize and only run the

    # HTML2PDF-specific tests.

    # HTML2PDF tests can be safely partitioned.

    chromedriver_param = ""

    if not html2pdf:

        parallelize_opts = "" if not no_parallelization else "--threads 1"

        html2pdf_param = ""

        test_folder = f"{cwd}/tests/integration"

        test_output_dir = "build/tests_integration"

    else:

        parallelize_opts = "--threads 1"

        html2pdf_param = "--param TEST_HTML2PDF=1"

        chromedriver_path = os.environ.get("CHROMEWEBDRIVER")

        if chromedriver_path is not None:

            # NOTE: isfile() check does not work on GitHub Actions / Linux,

            #       the exists() check works.

            assert os.path.exists(chromedriver_path), chromedriver_path

            chromedriver_param = f"--param CHROMEDRIVER={os.path.join(chromedriver_path, 'chromedriver')}"

            if os.name == "nt":

                # On Windows, its chromdriver.exe

                chromedriver_param = chromedriver_param + ".exe"

        test_folder = f"{cwd}/tests/integration/features/html2pdf"

        test_output_dir = "build/tests_integration_html2pdf"

    # The command sometimes exits with 1 even if the files are deleted.

    # warn=True ensures that the execution continues.

    run_invoke(

        context,

        f"""

        rm -rf {test_output_dir}

        """,

        warn=True,

    )

    run_invoke(

        context,

        f"""

        rm -rf {STRICTDOC_TMP_DIR}

        """,

    )

    Path(STRICTDOC_TMP_DIR).mkdir(exist_ok=True)

    Path(TEST_REPORTS_DIR).mkdir(parents=True, exist_ok=True)

    itest_command = f"""

        lit

        --param STRICTDOC_EXEC="{strictdoc_exec}"

        --param STRICTDOC_TMP_DIR="{STRICTDOC_TMP_DIR}"

        --param TEST_OUTPUT_DIR="{test_output_dir}"

        --timeout 180

        --order smart

        {junit_xml_report_argument}

        {coverage_path_argument}

        {html2pdf_param}

        {chromedriver_param}

        -v

        {debug_opts}

        {focus_or_none}

        {fail_first_argument}

        {parallelize_opts}

        {partition_opts}

        {test_folder}

    """

    # It looks like LIT does not open the RUN: subprocesses in the same

    # environment from which it itself is run from. This issue has been known by

    # us for a couple of years by now. Not using Tox on Windows for the time

    # being.

    if os.name == "nt":

        run_invoke(context, itest_command)

        return

    run_invoke_with_tox(

        context,

        environment,

        itest_command,

        environment={"STRICTDOC_CACHE_DIR": "Output/_cache"},

    )

@task

def coverage_combine(context):

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            coverage combine

                --data-file build/coverage/.coverage.combined

                --keep

                build/coverage/end2end_strictdoc/.coverage.*

                build/coverage/integration/.coverage.*

                build/coverage/integration_html2pdf/.coverage.*

                build/coverage/unit/.coverage

                build/coverage/unit_server/.coverage

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            coverage html

                --rcfile .coveragerc.combined

                --data-file build/coverage/.coverage.combined

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            coverage json

                --rcfile .coveragerc.combined

                --data-file build/coverage/.coverage.combined

                --pretty-print

                -o build/coverage/coverage.combined.json

        """,

    )

@task

def lint_ruff_format(context):

    """

    @relation(SDOC-SRS-42, scope=function)

    """

    result: invoke.runners.Result = run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            ruff

                format

                --cache-dir build/ruff

                *.py

                developer/

                docs/

                strictdoc/

                tools/ecss

                tests/unit/

                tests/unit_server/

                tests/integration/*.py

                tests/end2end/

        """,

    )

    # Ruff always exits with 0, so we handle the output.

    if "reformatted" in result.stdout:

        print("invoke: ruff format found issues")  # noqa: T201

        result.exited = 1

        raise invoke.exceptions.UnexpectedExit(result)

@task(aliases=["lr"])

def lint_ruff(context):

    """

    @relation(SDOC-SRS-42, scope=function)

    """

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            ruff check . --fix --exit-non-zero-on-fix --cache-dir build/ruff

        """,

    )

@task(aliases=["lm"])

def lint_mypy(context):

    """

    @relation(SDOC-SRS-41, SDOC-SRS-43, scope=function)

    """

    # These checks do not seem to be useful:

    # - import

    # --disallow-any-expr

    # --disallow-any-explicit

    # --disallow-any-unimported  # noqa: ERA001

    # --disallow-any-decorated

    # - type-abstract. It is ignored on purpose because of assert_cast()

    #   implementation. See https://stackoverflow.com/a/74073453/598057.

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            mypy docs/

                 strictdoc/

                 tests/unit/strictdoc/backend/sdoc_source_code/test_marker_lexer.py

                --show-error-codes

                --disable-error-code=import

                --disable-error-code=type-abstract

                --cache-dir=build/mypy

                --extra-checks

                --strict

                --strict-optional

                --strict-equality

                --check-untyped-defs

                --disallow-any-generics

                --disallow-incomplete-defs

                --disallow-subclassing-any

                --disallow-untyped-calls

                --disallow-untyped-decorators

                --disallow-untyped-defs

                --no-implicit-optional

                --warn-no-return

                --warn-redundant-casts

                --warn-return-any

                --warn-unreachable

                --warn-unused-ignores

                --python-version=3.10

        """,

    )

@task

def lint_format_js(context):

    # NOTE: Could not find the '--' equivalent for -w80.

    result: invoke.runners.Result = run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            js-beautify

                --indent-size=2

                --end-with-newline

                --replace

                -w100

                strictdoc/export/html/_static/static_html_search.js

                strictdoc/export/html/_static/stable_uri_forwarder.js

        """,

    )

    # Ruff always exits with 0, so we handle the output.

    if "reformatted" in result.stdout:

        print("invoke: ruff format found issues")  # noqa: T201

        result.exited = 1

        raise invoke.exceptions.UnexpectedExit(result)

@task(aliases=["lc"])

def lint_commit(context):  # noqa: ARG001

    try:

        validate_commits_locally_or_ci()

    except ValueError as e:

        raise invoke.exceptions.Exit(message=str(e), code=1) from None

@task(aliases=["lf"])

def lint_fixit(context, fix=False, auto=False, path="strictdoc/"):

    if fix:

        auto_argument = "--automatic" if auto else ""

        run_invoke_with_tox(

            context,

            ToxEnvironment.CHECK,

            f"""

                fixit fix {path} {auto_argument}

            """,

            pty=True,

        )

    else:

        run_invoke_with_tox(

            context,

            ToxEnvironment.CHECK,

            f"""

                fixit lint --diff {path}

            """,

        )

@task(aliases=["l"])

def lint(context):

    lint_commit(context)

    lint_ruff_format(context)

    lint_ruff(context)

    lint_mypy(context)

@task(aliases=["t"])

def test(context, shard=None):

    test_unit(context)

    test_unit_server(context)

    test_integration(context, shard=shard)

@task(aliases=["ta"])

def test_all(context, coverage=False, headless=False):

    test_unit(context, coverage=coverage)

    test_unit_server(context)

    test_integration(context, coverage=coverage)

    test_integration(context, coverage=coverage, html2pdf=True)

    test_end2end(context, coverage=coverage, headless=headless)

@task(aliases=["c"])

def check(context):

    lint(context)

    test(context)

# https://github.com/github-changelog-generator/github-changelog-generator

# gem install github_changelog_generator

@task

def changelog(context, github_token):

    # The alpha release tags are excluded from the changelog.

    command = f"""

        github_changelog_generator

        --token {github_token}

        --user strictdoc-project

        --exclude-tags-regex ".*a\\d+"

        --project strictdoc

        """

    run_invoke(context, command)

@task

def check_dead_links(context):

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_01_user_guide.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_02_feature_map.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_03_faq.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_04_release_notes.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_05_troubleshooting.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_10_contributing.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_11_developer_guide.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_24_development_plan.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_20_l1_system_requirements.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_21_l2_high_level_requirements.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py docs/strictdoc_25_design.sdoc

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py CONTRIBUTING.md

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py NOTICE

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.CHECK,

        """

            python3 tools/link_health.py README.md

        """,

    )

@task

def release_local(context):

    run_invoke(

        context,

        """

            rm -rfv dist/ build/

        """,

    )

    run_invoke(

        context,

        """

            pip uninstall strictdoc -y

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.RELEASE_LOCAL,

        """

            python -m build

        """,

    )

    run_invoke_with_tox(

        context,

        ToxEnvironment.RELEASE_LOCAL,

        """

            twine check dist/*

        """,