apetest.plugin.softfab module

Plugin that creates a properties file summarizing the test results.

This properties file can be used as-is by SoftFab, but should be easy to use with other tools as well. The format is of a Java .properties file, similar to a Windows .ini file. It is a text with with one key-value pair per line, with = as the separator.

Source code 
# SPDX-License-Identifier: BSD-3-Clause

"""Plugin that creates a properties file summarizing the test results.

This properties file can be used as-is by SoftFab, but should be easy
to use with other tools as well. The format is of a Java `.properties`
file, similar to a Windows `.ini` file. It is a text with with one
key-value pair per line, with `=` as the separator.
"""

from apetest.plugin import Plugin

def plugin_arguments(parser):
    parser.add_argument(
        '--result',
        help='properties file (SoftFab compatible) to write results to'
        )

def plugin_create(args):
    if args.result is not None:
        yield PropertiesPlugin(args.result)

class PropertiesPlugin(Plugin):
    """Plugin that creates a SoftFab-compatible results properties file."""

    def __init__(self, properties_file):
        """Initialize the plugin to write `properties_file`."""
        self.properties_file = properties_file

    def postprocess(self, scribe):
        total = len(scribe.get_pages())
        num_failed_pages = len(scribe.get_failed_pages())
        data = {
            'result': 'ok' if num_failed_pages == 0 else 'warning',
            'summary': scribe.get_summary(),
            'data.pages_total': total,
            'data.pages_pass': total - num_failed_pages,
            'data.pages_fail': num_failed_pages,
            }
        path = self.properties_file
        print('Writing metadata to "%s"...' % path)
        with open(path, 'w') as out:
            for key in sorted(data.keys()):
                print('%s=%s' % (key, data[key]), file=out)}

Functions

def plugin_arguments(parser)
Source code 
def plugin_arguments(parser):
    parser.add_argument(
        '--result',
        help='properties file (SoftFab compatible) to write results to'
        )}
def plugin_create(args)
Source code 
def plugin_create(args):
    if args.result is not None:
        yield PropertiesPlugin(args.result)}

Classes

class PropertiesPlugin (ancestors: Plugin)

Plugin that creates a SoftFab-compatible results properties file.

Source code 
class PropertiesPlugin(Plugin):
    """Plugin that creates a SoftFab-compatible results properties file."""

    def __init__(self, properties_file):
        """Initialize the plugin to write `properties_file`."""
        self.properties_file = properties_file

    def postprocess(self, scribe):
        total = len(scribe.get_pages())
        num_failed_pages = len(scribe.get_failed_pages())
        data = {
            'result': 'ok' if num_failed_pages == 0 else 'warning',
            'summary': scribe.get_summary(),
            'data.pages_total': total,
            'data.pages_pass': total - num_failed_pages,
            'data.pages_fail': num_failed_pages,
            }
        path = self.properties_file
        print('Writing metadata to "%s"...' % path)
        with open(path, 'w') as out:
            for key in sorted(data.keys()):
                print('%s=%s' % (key, data[key]), file=out)}

Methods

def __init__(self, properties_file)

Initialize the plugin to write properties_file.

Source code 
def __init__(self, properties_file):
    """Initialize the plugin to write `properties_file`."""
    self.properties_file = properties_file}

Inherited members