Source code for innoconv_mintmod.runner

"""Runner module"""

import os
import subprocess

from innoconv_mintmod.constants import (
    PANZER_SUPPORT_DIR,
    PANZER_TIMEOUT,
    DEFAULT_OUTPUT_FORMAT,
    OUTPUT_FORMAT_EXT_MAP,
    DEFAULT_INPUT_FORMAT,
)


class InnoconvRunner:
    """innoConv (mintmod) runner that spawns a panzer instance."""

    # pylint: disable=too-many-instance-attributes

    def __init__(
        self,
        source,
        output_dir_base,
        language_code,
        ignore_exercises=False,
        remove_exercises=False,
        generate_innodoc=False,
        input_format=DEFAULT_INPUT_FORMAT,
        output_format=DEFAULT_OUTPUT_FORMAT,
        generate_innodoc_markdown=False,
        debug=False,
    ):
        # pylint: disable=too-many-arguments
        self.source = source
        self.output_dir_base = output_dir_base
        self.language_code = language_code
        self.ignore_exercises = ignore_exercises
        self.remove_exercises = remove_exercises
        self.generate_innodoc = generate_innodoc
        self.input_format = input_format
        self.output_format = output_format
        self.generate_innodoc_markdown = generate_innodoc_markdown
        self.debug = debug

    def run(self):
        """Setup paths and options and run the panzer command.

        :rtype: str
        :returns: output filename
        """

        if os.path.isdir(self.source):
            source_dir = os.path.join(self.source, self.language_code)
            filename = "index.{}".format(OUTPUT_FORMAT_EXT_MAP[self.output_format])
            source_file = "index.tex"
            output_dir = os.path.join(self.output_dir_base, self.language_code)
        elif os.path.isfile(self.source):
            source_dir = os.path.dirname(os.path.abspath(self.source))
            filename = "{}.{}".format(
                os.path.splitext(self.source)[0],
                OUTPUT_FORMAT_EXT_MAP[self.output_format],
            )
            source_file = self.source
            output_dir = self.output_dir_base
        else:
            raise FileNotFoundError("Couldn't find {}".format(self.source))

        # create output directory
        os.makedirs(output_dir, exist_ok=True)

        # output filename
        filename_path = os.path.abspath(os.path.join(output_dir, filename))

        # set debug mode
        env = os.environ.copy()
        if self.debug and self.generate_innodoc:
            env["INNOCONV_DEBUG"] = "1"
            style = "innoconv-debug-generate-innodoc"
        elif self.debug:
            env["INNOCONV_DEBUG"] = "1"
            style = "innoconv-debug"
        elif self.generate_innodoc:
            style = "innoconv-generate-innodoc"
        else:
            style = "innoconv"

        if self.ignore_exercises:
            env["INNOCONV_IGNORE_EXERCISES"] = "1"

        if self.remove_exercises:
            env["INNOCONV_REMOVE_EXERCISES"] = "1"

        if self.generate_innodoc_markdown:
            env["INNOCONV_GENERATE_INNODOC_MARKDOWN"] = "1"

        cmd = [
            "panzer",
            "---panzer-support",
            PANZER_SUPPORT_DIR,
            "--metadata=style:{}".format(style),
            "--metadata=lang:{}".format(self.language_code),
            "--from={}".format(self.input_format),
            "--to={}".format(self.output_format),
            "--standalone",
            "--output={}".format(filename_path),
            source_file,
        ]

        proc = subprocess.Popen(cmd, cwd=source_dir, stderr=subprocess.STDOUT, env=env)

        return_code = proc.wait(timeout=PANZER_TIMEOUT)
        if return_code != 0:
            raise RuntimeError("Failed to run panzer!")

        return filename_path