xunitwriter.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
from robot.result import ResultVisitor
from robot.utils import XmlWriter
 
 
class XUnitWriter:
 
    def __init__(self, execution_result):
        self._execution_result_execution_result = execution_result
 
    def write(self, output):
        xml_writer = XmlWriter(output, usage='xunit')
        writer = XUnitFileWriter(xml_writer)
        self._execution_result_execution_result.visit(writer)
 
 
 
class XUnitFileWriter(ResultVisitor):
 
    def __init__(self, xml_writer):
        self._writer_writer = xml_writer
 
    def start_suite(self, suite):
        stats = suite.statistics  # Accessing property only once.
        attrs = {'name': suite.name,
                 'tests': f'{stats.total}',
                 'errors': '0',
                 'failures': f'{stats.failed}',
                 'skipped': f'{stats.skipped}',
                 'time': self._time_as_seconds_time_as_seconds(suite.elapsedtime),
                 'timestamp' : self._starttime_to_isoformat_starttime_to_isoformat(suite.starttime)}
        self._writer_writer.start('testsuite', attrs)
 
    def end_suite(self, suite):
        if suite.metadata or suite.doc:
            self._writer_writer.start('properties')
            if suite.doc:
                self._writer_writer.element('property', attrs={'name': 'Documentation', 'value': suite.doc})
            for meta_name, meta_value in suite.metadata.items():
                self._writer_writer.element('property', attrs={'name': meta_name, 'value': meta_value})
            self._writer_writer.end('properties')
        self._writer_writer.end('testsuite')
 
    def visit_test(self, test):
        self._writer_writer.start('testcase',
                           {'classname': test.parent.longname,
                            'name': test.name,
                            'time': self._time_as_seconds_time_as_seconds(test.elapsedtime)})
        if test.failed:
            self._writer_writer.element('failure', attrs={'message': test.message,
                                                   'type': 'AssertionError'})
        if test.skipped:
            self._writer_writer.element('skipped', attrs={'message': test.message,
                                                   'type': 'SkipExecution'})
        self._writer_writer.end('testcase')
 
    def _time_as_seconds(self, millis):
        return format(millis / 1000, '.3f')
 
    def visit_keyword(self, kw):
        pass
 
    def visit_statistics(self, stats):
        pass
 
    def visit_errors(self, errors):
        pass
 
    def end_result(self, result):
        self._writer.close()
 
    def _starttime_to_isoformat(self, stime):
        if not stime:
            return None
        return f'{stime[:4]}-{stime[4:6]}-{stime[6:8]}T{stime[9:22]}000'