Module ploigos_step_runner.step_implementers.shared.maven_test_reporting_mixin

A mixin class designed to add Maven test reporting functionality to MavenGeneric based StepImplementers.

Step Configuration

Step configuration expected as input to this step. Could come from: * static configuration * runtime configuration * previous step results

Classes

class MavenTestReportingMixin

A mixin class designed to add Maven test reporting functionality to MavenGeneric based StepImplementers.

Expand source code

class MavenTestReportingMixin:
    """A mixin class designed to add Maven test reporting functionality to
    MavenGeneric based StepImplementers.
    """

    SUREFIRE_PLUGIN_NAME = 'maven-surefire-plugin'
    SUREFIRE_PLUGIN_REPORTS_DIR_CONFIG_NAME = 'reportsDirectory'
    FAILSAFE_PLUGIN_NAME = 'maven-failsafe-plugin'
    FAILSAFE_PLUGIN_REPORTS_DIR_CONFIG_NAME = 'reportsDirectory'
    SUREFIRE_PLUGIN_DEFAULT_REPORTS_DIR = 'target/surefire-reports'
    FAILSAFE_PLUGIN_DEFAULT_REPORTS_DIR = 'target/failsafe-reports'
    TESTSUITE_EVIDENCE_ATTRIBUTES = ["time", "tests", "failures", "errors", "skipped"]
    TESTSUITE_EVIDENCE_ATTRIBUTES_REQUIRED = ["time", "tests", "failures"]
    TESTSUITE_EVIDENCE_ELEMENTS = ["testsuites", "testsuite"]

    def _attempt_get_test_report_directory(
        self,
        plugin_name,
        configuration_key,
        default,
        require_phase_execution_config=False
    ):
        """Does it's darndest to dynamically determine the test report directory.

        Parameters
        ----------
        plugin_name : str
            Name of the Maven plugin to look for test report directory configuration.
        configuration_key : str
            Maven plugin configuration to look for the test directory path.
        default : str
            Value to use if can't find any user configured configuration.
        require_phase_execution_config : str
            True if the user supplied configuration via the pom should be for
            the specified phase or goals.
            False if the user supplied configuration via the pom does not
            need to be specific for the phase and goal.

        Returns
        -------
        str
            Determined test reports directory path.

        Raises
        ------
        StepRunnerException
            If can not find the given plugin to get configuration from.
        """
        test_report_dir = None
        print(
            'Attempt to get test report directory configuration'
            f' ({configuration_key}) for'
            f' maven test plugin ({plugin_name}).'
        )
        try:
            test_report_dirs = get_plugin_configuration_absolute_path_values(
                plugin_name=plugin_name,
                configuration_key=configuration_key,
                work_dir_path=self.work_dir_path,
                pom_file=self.get_value('pom-file'),
                profiles=self.get_value('maven-profiles'),
                phases_and_goals=self.maven_phases_and_goals,
                require_phase_execution_config=require_phase_execution_config
            )

            # if found at least one test report dir
            # else plugin exists but could not find config, use default
            if test_report_dirs:
                if len(test_report_dirs) > 1:
                    print(
                        'WARNING: In best attempt to dynamically determine where the the test'
                        ' report directory is, we were to successful and found more then one.'
                        ' This is not wholly unexpected because there is enumerable maven plugins,'
                        ' and enumerable ways to configure them.'
                        ' Randomly picking first match and hoping it is correct.'
                        ' Rather then relying on this step implementer to try and figure out'
                        ' where the test reports are you can configure it manually via the'
                        ' step implementer config (test-reports-dir).'
                    )

                test_report_dir = test_report_dirs[0]
            else:
                print(
                    'Did not find test report directory configuration'
                    f' ({configuration_key}) for maven test plugin ({plugin_name}),'
                    f' using default ({default}).'
                )
                test_report_dir = default

        except RuntimeError as error:
            # NOTE: this should only happen if couldn't find the plugin
            raise StepRunnerException(
                f'Error getting configuration ({configuration_key}) from'
                f' maven plugin ({plugin_name}): {error}'
            ) from error

        return test_report_dir

    @staticmethod
    def _gather_evidence_from_test_report_directory_testsuite_elements(
        step_result,
        test_report_dirs
    ):
        """Given a test report directory containing XML files with 'testsuite' xml elements
        collects evidence from those files and elements.

        Parameters
        ----------
        step_result : StepResult
            StepResult to add the evidence to.
        test_report_dirs : str or [str]
            Directory(s) to search for 'testsuite' xml elements in to collect evidence from.
        """

        # standardize input
        if not isinstance(test_report_dirs, list):
            test_report_dirs = [test_report_dirs]

         # gather evidence
        report_results, collection_warnings = MavenTestReportingMixin._collect_report_results(
            test_report_dirs=test_report_dirs
        )

        # Add the test results to the evidence
        missing_attributes = []
        for attribute in MavenTestReportingMixin.TESTSUITE_EVIDENCE_ATTRIBUTES:
            if attribute in report_results:
                step_result.add_evidence(
                    name=attribute,
                    value=report_results[attribute]
                )
            elif attribute in MavenTestReportingMixin.TESTSUITE_EVIDENCE_ATTRIBUTES_REQUIRED:
                missing_attributes.append(attribute)

        # Add a warning to the step_result for required attributes that were not found
        if missing_attributes:
            step_result.message += "\nWARNING: could not find expected evidence" \
                f" attributes ({missing_attributes}) on a recognized xml root element" \
                f" ({MavenTestReportingMixin.TESTSUITE_EVIDENCE_ELEMENTS}) in test report" \
                f" directory ({test_report_dirs})."

        # Add any warnings encountered during collecting the test results to the step_result
        for warning in collection_warnings:
            step_result.message += f"\n{warning}"

    @staticmethod
    def _collect_report_results(
        test_report_dirs
    ):
        report_results = {}
        warnings = []

        # collect all the xml file paths
        xml_files = []
        for xml_file_path in test_report_dirs:
            if os.path.isdir(xml_file_path):
                xml_files += glob.glob(xml_file_path + '/*.xml', recursive=False)
            elif os.path.isfile(xml_file_path):
                xml_files += [xml_file_path]

        # Iterate over each file that contains test results
        for file in xml_files:
            element = MavenTestReportingMixin._read_evidence_element(file)

            # If this file does not have an element that contains evidence, warn but continue processing other files.
            if element is None: # Elements that exist but have no child elements are falsy!
                warnings += [f"WARNING: could not parse test results in file ({file}). Ignoring."]
                continue

            # Iterate over the XML attributes that are evidence
            for attrib in element.attrib:
                if attrib in MavenTestReportingMixin.TESTSUITE_EVIDENCE_ATTRIBUTES: # Is this attribute evidence?

                    # Parse each attribute as a number
                    attrib_value = 0
                    try:
                        attrib_value = MavenTestReportingMixin._to_number(element.attrib[attrib])
                    except ValueError:
                        warnings += [
                            "WARNING: While parsing test results, expected the value of"
                            f" attribute ({attrib}) in file ({file}) to be a number."
                            f" Value was '{element.attrib[attrib]}'. Ignoring."
                        ]

                    # Add up the totals across all files
                    if attrib in report_results:
                        report_results[attrib] += attrib_value
                    else:
                        report_results[attrib] = attrib_value

        return report_results, warnings

    @staticmethod
    def _read_evidence_element(file):
        # Check if the base xml element of the file has one of the element names that is allowed
        for candidate in MavenTestReportingMixin.TESTSUITE_EVIDENCE_ELEMENTS:
            element = get_xml_element_if_present(file, candidate)
            if element is not None: # Elements that exist but have no child elements are falsy!
                return element
        return None

    @staticmethod
    def _to_number(string):
        if string.isnumeric():
            return int(string)
        return float(string)

Subclasses

• NpmXunitGeneric
• MavenIntegrationTest
• NpmXunitIntegrationTest
• MavenTest
• NpmXunitTest

Class variables

var FAILSAFE_PLUGIN_DEFAULT_REPORTS_DIR

var FAILSAFE_PLUGIN_NAME

var FAILSAFE_PLUGIN_REPORTS_DIR_CONFIG_NAME

var SUREFIRE_PLUGIN_DEFAULT_REPORTS_DIR

var SUREFIRE_PLUGIN_NAME

var SUREFIRE_PLUGIN_REPORTS_DIR_CONFIG_NAME

var TESTSUITE_EVIDENCE_ATTRIBUTES

var TESTSUITE_EVIDENCE_ATTRIBUTES_REQUIRED

var TESTSUITE_EVIDENCE_ELEMENTS