testcase.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.utils import setter
 
from .body import Body
from .fixture import create_fixture
from .itemlist import ItemList
from .keyword import Keyword, Keywords
from .modelobject import ModelObject
from .tags import Tags
 
 
 
class TestCase(ModelObject):
    body_class = Body
    fixture_class = Keyword
    repr_args = ('name',)
    __slots__ = ['parent', 'name', 'doc', 'timeout', 'lineno', '_setup', '_teardown']
 
    def __init__(self, name='', doc='', tags=None, timeout=None, lineno=None,
                 parent=None):
        self.namename = name
        self.docdoc = doc
        self.tagstagstags = tags
        self.timeouttimeout = timeout
        self.linenolineno = lineno
        self.parentparent = parent
        self.bodybodybody = None
        self._setup_setup = None
        self._teardown_teardown = None
 
    @setter
    
    def body(self, body):
        return self.body_classbody_class(self, body)
 
    @setter
    
    def tags(self, tags):
        return Tags(tags)
 
    @property
    
    setup = property
    
    def setup(self):
        if self._setup_setup is None and self:
            self._setup_setup = create_fixture(None, self, Keyword.SETUP)
        return self._setup_setup
 
    @setup.setter
    
    def setup(self, setup):
        self._setup_setup = create_fixture(setup, self, Keyword.SETUP)
 
    @property
    
    has_setup = property
    
    def has_setup(self):
        return bool(self._setup_setup)
 
    @property
    
    teardown = property
    
    def teardown(self):
        if self._teardown_teardown is None and self:
            self._teardown_teardown = create_fixture(None, self, Keyword.TEARDOWN)
        return self._teardown_teardown
 
    @teardown.setter
    
    def teardown(self, teardown):
        self._teardown_teardown = create_fixture(teardown, self, Keyword.TEARDOWN)
 
    @property
    
    has_teardown = property
    
    def has_teardown(self):
        return bool(self._teardown_teardown)
 
    @property
    
    keywords = property
    
    def keywords(self):
        keywords = [self.setupsetupsetupsetup] + list(self.bodybodybody) + [self.teardownteardownteardownteardown]
        return Keywords(self, [kw for kw in keywords if kw])
 
    @keywords.setter
    
    def keywords(self, keywords):
        Keywords.raise_deprecation_error()
 
    @property
    
    id = property
    
    def id(self):
        if not self.parentparent:
            return 't1'
        return '%s-t%d' % (self.parentparent.id, self.parentparent.tests.index(self)+1)
 
    @property
    
    longname = property
    
    def longname(self):
        if not self.parentparent:
            return self.namename
        return '%s.%s' % (self.parentparent.longname, self.namename)
 
    @property
    source = property
    
    def source(self):
        return self.parentparent.source if self.parentparent is not None else None
 
    
    def visit(self, visitor):
        visitor.visit_test(self)
 
    def __str__(self):
        return self.namename
 
 
class TestCases(ItemList):
    __slots__ = []
 
    def __init__(self, test_class=TestCase, parent=None, tests=None):
        ItemList.__init__(self, test_class, {'parent': parent}, tests)
 
    def _check_type_and_set_attrs(self, *tests):
        tests = ItemList._check_type_and_set_attrs(self, *tests)
        for test in tests:
            for visitor in test.parent._visitors:
                test.visit(visitor)
        return tests