status.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 robotide.lib.robot.errors import ExecutionFailed, PassExecution
from robotide.lib.robot.utils import html_escape, py2to3, unic
 
 
@py2to3
class Failure():
 
    def __init__(self):
        self.setupsetup = None
        self.testtest = None
        self.teardownteardown = None
 
    def __nonzero__(self):
        return bool(self.setupsetup or self.testtest or self.teardownteardown)
 
 
@py2to3
class Exit():
 
    def __init__(self, failure_mode=False, error_mode=False,
                 skip_teardown_mode=False):
        self.failure_modefailure_mode = failure_mode
        self.error_modeerror_mode = error_mode
        self.skip_teardown_modeskip_teardown_mode = skip_teardown_mode
        self.failurefailure = False
        self.errorerror = False
        self.fatalfatal = False
 
    def failure_occurred(self, failure=None, critical=False):
        if isinstance(failure, ExecutionFailed) and failure.exit:
            self.fatalfatal = True
        if critical and self.failure_modefailure_mode:
            self.failurefailure = True
 
    def error_occurred(self):
        if self.error_modeerror_mode:
            self.errorerror = True
 
    @property
    teardown_allowed = property
    
    def teardown_allowed(self):
        return not (self.skip_teardown_modeskip_teardown_mode and self)
 
    def __nonzero__(self):
        return self.failurefailure or self.errorerror or self.fatalfatal
 
 
class _ExecutionStatus():
 
    def __init__(self, parent=None, *exit_modes):
        self.parentparent = parent
        self.childrenchildren = []
        self.failurefailure = Failure()
        self.exitexit = parent.exit if parent else Exit(*exit_modes)
        self._teardown_allowed_teardown_allowed = False
        if parent:
            parent.children.append(self)
 
    def setup_executed(self, failure=None):
        if failure and not isinstance(failure, PassExecution):
            self.failurefailure.setup = unic(failure)
            self.exitexit.failure_occurred(failure)
        self._teardown_allowed_teardown_allowed = True
 
    def teardown_executed(self, failure=None):
        if failure and not isinstance(failure, PassExecution):
            self.failurefailure.teardown = unic(failure)
            self.exitexit.failure_occurred(failure)
 
    def critical_failure_occurred(self):
        self.exitexit.failure_occurred(critical=True)
 
    def error_occurred(self):
        self.exitexit.error_occurred()
 
    @property
    teardown_allowed = property
    
    def teardown_allowed(self):
        return self.exitexit.teardown_allowed and self._teardown_allowed_teardown_allowed
 
    @property
    failures = property
    
    def failures(self):
        return bool(self.parentparent and self.parentparent.failures or
                    self.failurefailure or self.exitexit)
 
    def _parent_failures(self):
        return self.parentparent and self.parentparent.failures
 
    @property
    status = property
    
    def status(self):
        return 'FAIL' if self.failuresfailuresfailures else 'PASS'
 
    @property
    message = property
    
    def message(self):
        if self.failurefailure or self.exitexit:
            return self._my_message_my_message()
        if self.parentparent and self.parentparent.failures:
            return self._parent_message_parent_message()
        return ''
 
    def _my_message(self):
        raise NotImplementedError
 
    def _parent_message(self):
        return ParentMessage(self.parentparent).message
 
 
class SuiteStatus(_ExecutionStatus):
 
    def __init__(self, parent=None, exit_on_failure_mode=False,
                 exit_on_error_mode=False,
                 skip_teardown_on_exit_mode=False):
        _ExecutionStatus.__init__(self, parent, exit_on_failure_mode,
                                  exit_on_error_mode,
                                  skip_teardown_on_exit_mode)
 
    def _my_message(self):
        return SuiteMessage(self).message
 
 
class TestStatus(_ExecutionStatus):
 
    def __init__(self, parent, critical):
        _ExecutionStatus.__init__(self, parent)
        self.exitexitexit = parent.exit
        self._critical_critical = critical
 
    def test_failed(self, failure):
        self.failurefailure.test = unic(failure)
        self.exitexitexit.failure_occurred(failure, self._critical_critical)
 
    def _my_message(self):
        return TestMessage(self).message
 
 
class _Message():
    setup_message = NotImplemented
    teardown_message = NotImplemented
    also_teardown_message = NotImplemented
 
    def __init__(self, status):
        self.failurefailure = status.failure
 
    @property
    message = property
    
    def message(self):
        message = self._get_message_before_teardown_get_message_before_teardown()
        return self._get_message_after_teardown_get_message_after_teardown(message)
 
    def _get_message_before_teardown(self):
        if self.failurefailure.setup:
            return self._format_setup_or_teardown_message_format_setup_or_teardown_message(self.setup_messagesetup_message,
                                                          self.failurefailure.setup)
        return self.failurefailure.test or ''
 
    def _format_setup_or_teardown_message(self, prefix, message):
        if message.startswith('*HTML*'):
            prefix = '*HTML* ' + prefix
            message = message[6:].lstrip()
        return prefix % message
 
    def _get_message_after_teardown(self, message):
        if not self.failurefailure.teardown:
            return message
        if not message:
            return self._format_setup_or_teardown_message_format_setup_or_teardown_message(self.teardown_messageteardown_message,
                                                          self.failurefailure.teardown)
        return self._format_message_with_teardown_message_format_message_with_teardown_message(message)
 
    def _format_message_with_teardown_message(self, message):
        teardown = self.failurefailure.teardown
        if teardown.startswith('*HTML*'):
            teardown = teardown[6:].lstrip()
            if not message.startswith('*HTML*'):
                message = '*HTML* ' + html_escape(message)
        elif message.startswith('*HTML*'):
            teardown = html_escape(teardown)
        return self.also_teardown_messagealso_teardown_message % (message, teardown)
 
 
class TestMessage(_Message):
    setup_message = 'Setup failed:\n%s'
    teardown_message = 'Teardown failed:\n%s'
    also_teardown_message = '%s\n\nAlso teardown failed:\n%s'
    exit_on_fatal_message = 'Test execution stopped due to a fatal error.'
    exit_on_failure_message = \
        'Critical failure occurred and exit-on-failure mode is in use.'
    exit_on_error_message = 'Error occurred and exit-on-error mode is in use.'
 
    def __init__(self, status):
        _Message.__init__(self, status)
        self.exitexit = status.exit
 
    @property
    message = property
    
    def message(self):
        message = super(TestMessage, self).message
        if message:
            return message
        if self.exitexit.failure:
            return self.exit_on_failure_messageexit_on_failure_message
        if self.exitexit.fatal:
            return self.exit_on_fatal_messageexit_on_fatal_message
        if self.exitexit.error:
            return self.exit_on_error_messageexit_on_error_message
        return ''
 
 
class SuiteMessage(_Message):
    setup_message = 'Suite setup failed:\n%s'
    teardown_message = 'Suite teardown failed:\n%s'
    also_teardown_message = '%s\n\nAlso suite teardown failed:\n%s'
 
 
class ParentMessage(SuiteMessage):
    setup_message = 'Parent suite setup failed:\n%s'
    teardown_message = 'Parent suite teardown failed:\n%s'
    also_teardown_message = '%s\n\nAlso parent suite teardown failed:\n%s'
 
    def __init__(self, status):
        while status.parent and status.parent.failures:
            status = status.parent
        SuiteMessage.__init__(self, status)