Skip to content

resultwriter

ResultWriter

A class to create log, report, output XML and xUnit files.

:param sources: Either one :class:~robot.result.executionresult.Result object, or one or more paths to existing output XML files.

By default writes report.html and log.html, but no output XML or xUnit files. Custom file names can be given and results disabled or enabled using settings or options passed to the :meth:write_results method. The latter is typically more convenient::

1
2
writer = ResultWriter(result)
writer.write_results(report='custom.html', log=None, xunit='xunit.xml')
Source code in src/robot/reporting/resultwriter.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class ResultWriter:
    """A class to create log, report, output XML and xUnit files.

    :param sources: Either one :class:`~robot.result.executionresult.Result`
        object, or one or more paths to existing output XML files.

    By default writes ``report.html`` and ``log.html``, but no output XML
    or xUnit files. Custom file names can be given and results disabled
    or enabled using ``settings`` or ``options`` passed to the
    :meth:`write_results` method. The latter is typically more convenient::

        writer = ResultWriter(result)
        writer.write_results(report='custom.html', log=None, xunit='xunit.xml')
    """

    def __init__(self, *sources):
        self._sources = sources

    def write_results(self, settings=None, **options):
        """Writes results based on the given ``settings``  or ``options``.

        :param settings: :class:`~robot.conf.settings.RebotSettings` object
            to configure result writing.
        :param options: Used to construct new
            :class:`~robot.conf.settings.RebotSettings` object if ``settings``
            are not given.
        """
        settings = settings or RebotSettings(options)
        results = Results(settings, *self._sources)
        if settings.output:
            self._write_output(results.result, settings.output, settings.legacy_output)
        if settings.xunit:
            self._write_xunit(results.result, settings.xunit)
        if settings.log:
            config = dict(settings.log_config,
                          minLevel=results.js_result.min_level)
            self._write_log(results.js_result, settings.log, config)
        if settings.report:
            results.js_result.remove_data_not_needed_in_report()
            self._write_report(results.js_result, settings.report,
                               settings.report_config)
        return results.return_code

    def _write_output(self, result, path, legacy_output=False):
        self._write('Output', result.save, path, legacy_output)

    def _write_xunit(self, result, path):
        self._write('XUnit', XUnitWriter(result).write, path)

    def _write_log(self, js_result, path, config):
        self._write('Log', LogWriter(js_result).write, path, config)

    def _write_report(self, js_result, path, config):
        self._write('Report', ReportWriter(js_result).write, path, config)

    def _write(self, name, writer, path, *args):
        try:
            writer(path, *args)
        except DataError as err:
            LOGGER.error(err.message)
        else:
            LOGGER.result_file(name, path)

write_results(settings=None, **options)

Writes results based on the given settings or options.

:param settings: :class:~robot.conf.settings.RebotSettings object to configure result writing. :param options: Used to construct new :class:~robot.conf.settings.RebotSettings object if settings are not given.

Source code in src/robot/reporting/resultwriter.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def write_results(self, settings=None, **options):
    """Writes results based on the given ``settings``  or ``options``.

    :param settings: :class:`~robot.conf.settings.RebotSettings` object
        to configure result writing.
    :param options: Used to construct new
        :class:`~robot.conf.settings.RebotSettings` object if ``settings``
        are not given.
    """
    settings = settings or RebotSettings(options)
    results = Results(settings, *self._sources)
    if settings.output:
        self._write_output(results.result, settings.output, settings.legacy_output)
    if settings.xunit:
        self._write_xunit(results.result, settings.xunit)
    if settings.log:
        config = dict(settings.log_config,
                      minLevel=results.js_result.min_level)
        self._write_log(results.js_result, settings.log, config)
    if settings.report:
        results.js_result.remove_data_not_needed_in_report()
        self._write_report(results.js_result, settings.report,
                           settings.report_config)
    return results.return_code