combination_validator.py

import enum
import os
from subprocess import CalledProcessError
from subprocess_handler import run_subprocess
import logger
from globals import CombinationValidatorConfig


class CombinationValidator:
    UNIT_TEST_FILE_NAME = CombinationValidatorConfig.UNIT_TEST_FILE_NAME
    UNIT_TEST_DEFAULT_PATH = os.path.join(CombinationValidatorConfig.UNIT_TEST_DEFAULT_DIR_PATH, UNIT_TEST_FILE_NAME)
    UNIT_TEST_NAME = CombinationValidatorConfig.UNIT_TEST_NAME

    @staticmethod
    def trigger_test_output_test(test_file_path: str, working_dir: str = "", output_file_name: str = "",
                                 check_for_existence: bool = False):
        command = ["pytest"]
        command += [f"{test_file_path}::{CombinationValidator.UNIT_TEST_NAME}"]
        if working_dir:
            command += ["--working_dir", working_dir]
        if output_file_name:
            command += ["--output_file_name", output_file_name]
        command = " ".join(command)
        try:
            stdout, stderr, exit_code = run_subprocess(command)
        except CalledProcessError as e:
            if e.returncode is None or e.returncode not in [code for code in ExitCode]:
                logger.info_error(f"{CombinationValidator.__name__}: "
                                  f"pytest operation failed. could not run the test.\n{e}")
                return ExitCode.INTERNAL_ERROR
            stdout = e.stdout
            stderr = e.stderr
            exit_code = e.returncode
        except Exception as ex:
            logger.info_error(f"{CombinationValidator.__name__}: exception thrown during pytest operation."
                              f" could not run the test.\n{ex}")
            return ExitCode.INTERNAL_ERROR
        if not check_for_existence:
            if exit_code == ExitCode.OK:
                logger.verbose(f"{CombinationValidator.__name__}: test '{CombinationValidator.UNIT_TEST_NAME}' passed.")
            else:
                logger.info_error(f"{CombinationValidator.__name__}: "
                                  f"test '{CombinationValidator.UNIT_TEST_NAME}' failed.")
            logger.debug(f"{CombinationValidator.__name__}: {stdout}\n{stderr}.")
        return exit_code

    @staticmethod
    def run_unit_test(test_file_path: str, working_dir: str = "", output_file_name: str = ""):
        return CombinationValidator.trigger_test_output_test(
            test_file_path, working_dir, output_file_name) == ExitCode.OK

    @staticmethod
    def check_if_test_exists(test_file_path: str):
        logger.verbose(f"{CombinationValidator.__name__}: Checking the existence of test: '"
                       f"{CombinationValidator.UNIT_TEST_NAME}'.")
        return CombinationValidator.trigger_test_output_test(
            test_file_path, check_for_existence=True) not in [ExitCode.NO_TESTS_COLLECTED, ExitCode.USAGE_ERROR]


class ExitCode(enum.IntEnum):
    #: tests passed
    OK = 0
    #: tests failed
    TESTS_FAILED = 1
    #: pytest was interrupted
    INTERRUPTED = 2
    #: an internal error got in the way
    INTERNAL_ERROR = 3
    #: pytest was misused
    USAGE_ERROR = 4
    #: pytest couldn't find tests
    NO_TESTS_COLLECTED = 5