executionresult.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.errors import DataError
from robot.model import Statistics
 
from .executionerrors import ExecutionErrors
from .model import TestSuite
 
 
 
class Result:
 
    def __init__(self, source=None, root_suite=None, errors=None, rpa=None):
        #: Path to the XML file where results are read from.
        self.sourcesource = source
        #: Hierarchical execution results as a
        #: :class:`~.result.model.TestSuite` object.
        self.suitesuite = root_suite or TestSuite()
        #: Execution errors as an
        #: :class:`~.executionerrors.ExecutionErrors` object.
        self.errorserrors = errors or ExecutionErrors()
        self.generated_by_robotgenerated_by_robot = True
        self._status_rc_status_rc = True
        self._stat_config_stat_config = {}
        self.rparpa = rpa
 
    @property
    
    statistics = property
    
    def statistics(self):
        return Statistics(self.suitesuite, rpa=self.rparpa, **self._stat_config_stat_config)
 
    @property
    
    return_code = property
    
    def return_code(self):
        if self._status_rc_status_rc:
            return min(self.suitesuite.statistics.failed, 250)
        return 0
 
    
    def configure(self, status_rc=True, suite_config=None, stat_config=None):
        if suite_config:
            self.suitesuite.configure(**suite_config)
        self._status_rc_status_rc = status_rc
        self._stat_config_stat_config = stat_config or {}
 
    
    def save(self, path=None):
        from robot.reporting.outputwriter import OutputWriter
        self.visitvisit(OutputWriter(path or self.sourcesource, rpa=self.rparpa))
 
    
    def visit(self, visitor):
        visitor.visit_result(self)
 
    
    def handle_suite_teardown_failures(self):
        if self.generated_by_robotgenerated_by_robot:
            self.suitesuite.handle_suite_teardown_failures()
 
    
    def set_execution_mode(self, other):
        if other.rpa is None:
            pass
        elif self.rparpa is None:
            self.rparpa = other.rpa
        elif self.rparpa is not other.rpa:
            this, that = ('task', 'test') if other.rpa else ('test', 'task')
            raise DataError("Conflicting execution modes. File '%s' has %ss "
                            "but files parsed earlier have %ss. Use '--rpa' "
                            "or '--norpa' options to set the execution mode "
                            "explicitly." % (other.source, this, that))
 
 
 
class CombinedResult(Result):
 
    def __init__(self, results=None):
        Result.__init__(self)
        for result in results or ():
            self.add_resultadd_result(result)
 
    def add_result(self, other):
        self.set_execution_modeset_execution_mode(other)
        self.suitesuite.suites.append(other.suite)
        self.errorserrors.add(other.errors)