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 robotide.lib.robot.utils import setter
 
from .configurer import SuiteConfigurer
from .filter import Filter, EmptySuiteRemover
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):
    __slots__ = ['parent', 'source', '_name', 'doc', '_my_visitors', 'rpa']
    test_class = TestCase    #: Internal usage only.
    keyword_class = Keyword  #: Internal usage only.
 
    def __init__(self, name='', doc='', metadata=None, source=None, rpa=False):
        self.parentparent = None  #: Parent suite. ``None`` with the root suite.
        self._name_name = name
        self.docdoc = doc  #: Test suite documentation.
        self.metadatametadatametadata = metadata
        self.sourcesource = source  #: Path to the source file or directory.
        self.rparpa = rpa
        self.suitessuitessuites = None
        self.teststeststests = None
        self.keywordskeywordskeywords = 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)
 
    @setter
    
    def keywords(self, keywords):
        return Keywords(self.keyword_classkeyword_class, self, keywords)
 
    @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)
 
    
    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):
        self.visitvisit(EmptySuiteRemover())
 
    
    def visit(self, visitor):
        visitor.visit_suite(self)
 
 
class TestSuites(ItemList):
    __slots__ = []
 
    def __init__(self, suite_class=TestSuite, parent=None, suites=None):
        ItemList.__init__(self, suite_class, {'parent': parent}, suites)