testsuite.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 .configurer import SuiteConfigurer
from .filter import Filter, EmptySuiteRemover
from .fixture import create_fixture
from .itemlist import ItemList
from .keyword import Keyword, Keywords
from .metadata import Metadata
from .modelobject import ModelObject
from .tagsetter import TagSetter
from .testcase import TestCase, TestCases
 
 
 
class TestSuite(ModelObject):
    test_class = TestCase    #: Internal usage only.
    fixture_class = Keyword  #: Internal usage only.
    repr_args = ('name',)
    __slots__ = ['parent', 'source', '_name', 'doc', '_setup', '_teardown',  'rpa',
                 '_my_visitors']
 
    def __init__(self, name='', doc='', metadata=None, source=None, rpa=False,
                 parent=None):
        self._name_name = name
        self.docdoc = doc
        self.metadatametadatametadata = metadata
        self.sourcesource = source  #: Path to the source file or directory.
        self.parentparent = parent  #: Parent suite. ``None`` with the root suite.
        self.rparpa = rpa        #: ``True`` when RPA mode is enabled.
        self.suitessuitessuites = None
        self.teststeststests = None
        self._setup_setup = None
        self._teardown_teardown = None
        self._my_visitors_my_visitors = []
 
    @property
    _visitors = property
    
    def _visitors(self):
        parent_visitors = self.parentparent._visitors if self.parentparent else []
        return self._my_visitors_my_visitors + parent_visitors
 
    @property
    
    name = property
    
    def name(self):
        return self._name_name or ' & '.join(s.name for s in self.suitessuitessuites)
 
    @name.setter
    
    def name(self, name):
        self._name_name = name
 
    @property
    
    longname = property
    
    def longname(self):
        if not self.parentparent:
            return self.namenamenamename
        return '%s.%s' % (self.parentparent.longname, self.namenamenamename)
 
    @setter
    
    def metadata(self, metadata):
        return Metadata(metadata)
 
    @setter
    
    def suites(self, suites):
        return TestSuites(self.__class__, self, suites)
 
    @setter
    
    def tests(self, tests):
        return TestCases(self.test_classtest_class, self, tests)
 
    @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, 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 's1'
        return '%s-s%d' % (self.parentparent.id, self.parentparent.suites.index(self)+1)
 
    @property
    
    test_count = property
    
    def test_count(self):
        return len(self.teststeststests) + sum(suite.test_count for suite in self.suitessuitessuites)
 
    @property
    has_tests = property
    
    def has_tests(self):
        if self.teststeststests:
            return True
        return any(s.has_tests for s in self.suitessuitessuites)
 
    
    def set_tags(self, add=None, remove=None, persist=False):
        setter = TagSetter(add, remove)
        self.visitvisit(setter)
        if persist:
            self._my_visitors_my_visitors.append(setter)
 
    
    def filter(self, included_suites=None, included_tests=None,
               included_tags=None, excluded_tags=None):
        self.visitvisit(Filter(included_suites, included_tests,
                          included_tags, excluded_tags))
 
    
    def configure(self, **options):
        if self.parentparent is not None:
            raise ValueError("'TestSuite.configure()' can only be used with "
                             "the root test suite.")
        if options:
            self.visitvisit(SuiteConfigurer(**options))
 
    
    def remove_empty_suites(self, preserve_direct_children=False):
        self.visitvisit(EmptySuiteRemover(preserve_direct_children))
 
    
    def visit(self, visitor):
        visitor.visit_suite(self)
 
    def __str__(self):
        return self.namenamenamename
 
 
class TestSuites(ItemList):
    __slots__ = []
 
    def __init__(self, suite_class=TestSuite, parent=None, suites=None):
        ItemList.__init__(self, suite_class, {'parent': parent}, suites)