avocado-framework/avocado

# 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 2 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 LICENSE for more details.
#
# Copyright: Red Hat Inc. 2017
# Authors: Cleber Rosa <crosa@redhat.com>

import hashlib
import os
import sys

from avocado.core import exit_codes
from avocado.core.output import LOG_UI
from avocado.core.plugin_interfaces import CLI, Varianter
from avocado.core.settings import settings
from avocado.core.tree import TreeNode
from avocado.utils import path as utils_path
from avocado.utils import process


class VarianterPictCLI(CLI):
    """
    Pict based Varianter options
    """

    name = "pict"
    description = "PICT based Varianter options for the 'run' subcommand"

    def configure(self, parser):
        try:
            pict_binary = utils_path.find_command("pict")
        except utils_path.CmdNotFoundError:
            pict_binary = None

        for name in ("run", "variants"):  # intentionally omitting "multiplex"
            subparser = parser.subcommands.choices.get(name, None)
            if subparser is None:
                continue
            pict = subparser.add_argument_group("pict based varianter options")

            help_msg = (
                "Where to find the binary version of the pict tool. "
                "Tip: download it from "
                '"https://github.com/Microsoft/pict" and run `make` '
                "to build it"
            )
            settings.register_option(
                section=name,
                key="pict_binary",
                help_msg=help_msg,
                default=pict_binary,
                metavar="PATH",
                parser=pict,
                long_arg="--pict-binary",
            )

            help_msg = "Paths to a pict parameter file"
            settings.register_option(
                section=name,
                key="pict_parameter_file",
                metavar="PATH",
                help_msg=help_msg,
                default=None,
                parser=pict,
                long_arg="--pict-parameter-file",
            )

            help_msg = (
                "Default path for parameters generated on the Pict based variants"
            )
            settings.register_option(
                section=name,
                key="pict_parameter_path",
                metavar="PATH",
                help_msg=help_msg,
                default="/run",
                parser=pict,
                long_arg="--pict-parameter-path",
            )

            help_msg = (
                "Order of combinations. Maximum number is specific to "
                "parameter file content"
            )
            settings.register_option(
                section=name,
                key="pict_combinations_order",
                metavar="ORDER",
                key_type=int,
                help_msg=help_msg,
                default=2,
                parser=pict,
                long_arg="--pict-order-of-combinations",
            )

    def run(self, config):
        pass


def run_pict(binary, parameter_file, order):
    cmd = f"{binary} {parameter_file} /o:{order}"
    return process.run(cmd, shell=True).stdout_text


def parse_pict_output(output):
    variants = []
    lines = output.splitlines()
    header = lines[0]
    headers = header.split("\t")
    for line in lines[1:]:
        variants.append(dict(zip(headers, line.split("\t"))))
    return (headers, variants)


class VarianterPict(Varianter):
    """
    Processes the pict file into variants
    """

    name = "pict"
    description = "PICT based Varianter"

    def initialize(self, config):
        self.variants = None  # pylint: disable=W0201
        error = False

        subcommand = config.get("subcommand", "run")

        namespace = f"{subcommand}.pict_parameter_file"
        pict_parameter_file = config.get(namespace)
        if pict_parameter_file is None:
            return
        else:
            pict_parameter_file = os.path.expanduser(pict_parameter_file)
            if not os.access(pict_parameter_file, os.R_OK):
                LOG_UI.error(
                    "pict parameter file '%s' could not be found or is not readable",
                    pict_parameter_file,
                )
                error = True
        pict_binary = config.get(f"{subcommand}.pict_binary")
        if pict_binary is None:
            LOG_UI.error(
                "pict binary could not be found in $PATH. Please set "
                "its location with --pict-binary or put it in your "
                "$PATH"
            )
            error = True
        else:
            pict_binary = os.path.expanduser(pict_binary)
            if not os.access(pict_binary, os.R_OK | os.X_OK):
                LOG_UI.error(
                    "pict binary '%s' can not be executed, please check "
                    "the option given with --pict-binary and/or the file "
                    "permissions",
                    pict_binary,
                )
                error = True

        if error:
            if subcommand == "run":
                sys.exit(exit_codes.AVOCADO_JOB_FAIL)
            else:
                sys.exit(exit_codes.AVOCADO_FAIL)

        path_namespace = f"{subcommand}.pict_parameter_path"
        self.parameter_path = config.get(path_namespace)  # pylint: disable=W0201

        order_namespace = f"{subcommand}.pict_combinations_order"
        output = run_pict(pict_binary, pict_parameter_file, config.get(order_namespace))
        self.headers, self.variants = parse_pict_output(output)  # pylint: disable=W0201

    def __iter__(self):
        if self.variants is None:
            return

        variant_ids = []
        for variant in self.variants:
            base_id = "-".join([variant.get(key) for key in self.headers])
            variant_ids.append(
                base_id + "-" + hashlib.sha1(base_id.encode()).hexdigest()[:4]
            )

        for vid, variant in zip(variant_ids, self.variants):
            variant_tree_nodes = []
            for key, val in variant.items():
                variant_tree_nodes.append(TreeNode(key, {key: val}))

            yield {
                "variant_id": vid,
                "variant": variant_tree_nodes,
                "paths": [self.parameter_path],
            }

    def __len__(self):
        return sum(1 for _ in self)

    def to_str(self, summary, variants, **kwargs):
        """
        Return human readable representation

        The summary/variants accepts verbosity where 0 means silent and
        maximum is up to the plugin.

        :param summary: How verbose summary to output (int)
        :param variants: How verbose list of variants to output (int)
        :param kwargs: Other free-form arguments
        :rtype: str
        """
        if not self.variants:
            return ""

        out = []
        verbose = variants > 1
        out.append(f"Pict Variants ({len(self)}):")
        for variant in self:
            out.append(
                "%sVariant %s:    %s"
                % ("\n" if verbose else "", variant["variant_id"], self.parameter_path)
            )
            if not verbose:
                continue
            env = set()
            for node in variant["variant"]:
                for key, value in node.environment.items():
                    origin = node.environment.origin[key].path
                    env.add((f"{origin}:{key}", str(value)))
            if not env:
                return out
            fmt = "    %%-%ds => %%s" % max(  # pylint: disable=C0209
                len(_[0]) for _ in env
            )
            for record in sorted(env):
                out.append(fmt % record)

        return "\n".join(out)