model.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 itertools import chain
 
from robotide.lib.robot.model import TotalStatisticsBuilder, Criticality
from robotide.lib.robot import model, utils
 
from .configurer import SuiteConfigurer
from .messagefilter import MessageFilter
from .keywordremover import KeywordRemover
from .suiteteardownfailed import (SuiteTeardownFailureHandler,
                                  SuiteTeardownFailed)
 
 
# TODO: Should remove model.Message altogether and just implement the whole
# thing here. Additionally model.Keyword should not have `message_class` at
# all or it should be None.
 
 
class Message(model.Message):
    __slots__ = []
 
 
 
class Keyword(model.Keyword):
    __slots__ = ['kwname', 'libname', 'status', 'starttime', 'endtime', 'message']
    message_class = Message
 
    def __init__(self, kwname='', libname='', doc='', args=(), assign=(),
                 tags=(), timeout=None, type='kw',  status='FAIL',
                 starttime=None, endtime=None):
        model.Keyword.__init__(self, '', doc, args, assign, tags, timeout, type)
        #: Name of the keyword without library or resource name.
        self.kwnamekwname = kwname or ''
        #: Name of the library or resource containing this keyword.
        self.libnamelibname = libname or ''
        #: Execution status as a string. Typically ``PASS`` or ``FAIL``, but
        #: library keywords have status ``NOT_RUN`` in the dry-ryn mode.
        #: See also :attr:`passed`.
        self.statusstatus = status
        #: Keyword execution start time in format ``%Y%m%d %H:%M:%S.%f``.
        self.starttimestarttime = starttime
        #: Keyword execution end time in format ``%Y%m%d %H:%M:%S.%f``.
        self.endtimeendtime = endtime
        #: Keyword status message. Used only if suite teardowns fails.
        self.messagemessage = ''
 
    @property
    
    elapsedtime = property
    
    def elapsedtime(self):
        return utils.get_elapsed_time(self.starttimestarttime, self.endtimeendtime)
 
    @property
    
    name = property
    
    def name(self):
        if not self.libnamelibname:
            return self.kwnamekwname
        return '%s.%s' % (self.libnamelibname, self.kwnamekwname)
 
    @property
    
    passed = property
    
    def passed(self):
        return self.statusstatus == 'PASS'
 
    @passed.setter
    
    def passed(self, passed):
        self.statusstatus = 'PASS' if passed else 'FAIL'
 
 
 
class TestCase(model.TestCase):
    __slots__ = ['status', 'message', 'starttime', 'endtime']
    keyword_class = Keyword
 
    def __init__(self, name='', doc='', tags=None, timeout=None, status='FAIL',
                 message='', starttime=None, endtime=None):
        model.TestCase.__init__(self, name, doc, tags, timeout)
        #: Status as a string ``PASS`` or ``FAIL``. See also :attr:`passed`.
        self.statusstatus = status
        #: Test message. Typically a failure message but can be set also when
        #: test passes.
        self.messagemessage = message
        #: Test case execution start time in format ``%Y%m%d %H:%M:%S.%f``.
        self.starttimestarttime = starttime
        #: Test case execution end time in format ``%Y%m%d %H:%M:%S.%f``.
        self.endtimeendtime = endtime
 
    @property
    
    elapsedtime = property
    
    def elapsedtime(self):
        return utils.get_elapsed_time(self.starttimestarttime, self.endtimeendtime)
 
    @property
    
    passed = property
    
    def passed(self):
        return self.statusstatus == 'PASS'
 
    @passed.setter
    
    def passed(self, passed):
        self.statusstatus = 'PASS' if passed else 'FAIL'
 
    @property
    
    critical = property
    
    def critical(self):
        if not self.parentparent:
            return True
        return self.parentparent.criticality.test_is_critical(self)
 
 
 
class TestSuite(model.TestSuite):
    __slots__ = ['message', 'starttime', 'endtime', '_criticality']
    test_class = TestCase
    keyword_class = Keyword
 
    def __init__(self, name='', doc='', metadata=None, source=None,
                 message='', starttime=None, endtime=None, rpa=False):
        model.TestSuite.__init__(self, name, doc, metadata, source, rpa)
        #: Possible suite setup or teardown error message.
        self.messagemessage = message
        #: Suite execution start time in format ``%Y%m%d %H:%M:%S.%f``.
        self.starttimestarttime = starttime
        #: Suite execution end time in format ``%Y%m%d %H:%M:%S.%f``.
        self.endtimeendtime = endtime
        self._criticality_criticality = None
 
    @property
    
    passed = property
    
    def passed(self):
        return not self.statisticsstatisticsstatistics.critical.failed
 
    @property
    
    status = property
    
    def status(self):
        return 'PASS' if self.passedpassedpassed else 'FAIL'
 
    @property
    
    statistics = property
    
    def statistics(self):
        return TotalStatisticsBuilder(self, self.rparpa).stats
 
    @property
    
    full_message = property
    
    def full_message(self):
        if not self.messagemessage:
            return self.stat_messagestat_messagestat_message
        return '%s\n\n%s' % (self.messagemessage, self.stat_messagestat_messagestat_message)
 
    @property
    
    stat_message = property
    
    def stat_message(self):
        return self.statisticsstatisticsstatistics.message
 
    @property
    
    elapsedtime = property
    
    def elapsedtime(self):
        if self.starttimestarttime and self.endtimeendtime:
            return utils.get_elapsed_time(self.starttimestarttime, self.endtimeendtime)
        return sum(child.elapsedtime for child in
                   chain(self.suitessuitessuites, self.teststeststests, self.keywordskeywordskeywords))
 
    @property
    
    criticality = property
    
    def criticality(self):
        if self.parentparent:
            return self.parentparent.criticality
        if self._criticality_criticality is None:
            self.set_criticalityset_criticality()
        return self._criticality_criticality
 
    
    def set_criticality(self, critical_tags=None, non_critical_tags=None):
        if self.parentparent is not None:
            raise ValueError('Criticality can only be set to the root suite.')
        self._criticality_criticality = Criticality(critical_tags, non_critical_tags)
 
    
    def remove_keywords(self, how):
        self.visitvisit(KeywordRemover(how))
 
    
    def filter_messages(self, log_level='TRACE'):
        self.visitvisit(MessageFilter(log_level))
 
    
    def configure(self, **options):
        model.TestSuite.configure(self)    # Parent validates call is allowed.
        self.visitvisit(SuiteConfigurer(**options))
 
    
    def handle_suite_teardown_failures(self):
        self.visitvisit(SuiteTeardownFailureHandler())
 
    
    def suite_teardown_failed(self, message):
        self.visitvisit(SuiteTeardownFailed(message))