filter.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 py2to3, setter
 
from .tags import TagPatterns
from .namepatterns import SuiteNamePatterns, TestNamePatterns
from .visitor import SuiteVisitor
 
 
class EmptySuiteRemover(SuiteVisitor):
 
    def end_suite(self, suite):
        suite.suites = [s for s in suite.suites if s.test_count]
 
    def visit_test(self, test):
        pass
 
    def visit_keyword(self, kw):
        pass
 
 
@py2to3
class Filter(EmptySuiteRemover):
 
    def __init__(self, include_suites=None, include_tests=None,
                 include_tags=None, exclude_tags=None):
        self.include_suitesinclude_suitesinclude_suites = include_suites
        self.include_testsinclude_testsinclude_tests = include_tests
        self.include_tagsinclude_tagsinclude_tags = include_tags
        self.exclude_tagsexclude_tagsexclude_tags = exclude_tags
 
    @setter
    def include_suites(self, suites):
        return SuiteNamePatterns(suites) \
            if not isinstance(suites, SuiteNamePatterns) else suites
 
    @setter
    def include_tests(self, tests):
        return TestNamePatterns(tests) \
            if not isinstance(tests, TestNamePatterns) else tests
 
    @setter
    def include_tags(self, tags):
        return TagPatterns(tags) if not isinstance(tags, TagPatterns) else tags
 
    @setter
    def exclude_tags(self, tags):
        return TagPatterns(tags) if not isinstance(tags, TagPatterns) else tags
 
    def start_suite(self, suite):
        if not self:
            return False
        if hasattr(suite, 'starttime'):
            suite.starttime = suite.endtime = None
        if self.include_suitesinclude_suitesinclude_suites:
            return self._filter_by_suite_name_filter_by_suite_name(suite)
        if self.include_testsinclude_testsinclude_tests:
            suite.tests = self._filter_filter(suite, self._included_by_test_name_included_by_test_name)
        if self.include_tagsinclude_tagsinclude_tags:
            suite.tests = self._filter_filter(suite, self._included_by_tags_included_by_tags)
        if self.exclude_tagsexclude_tagsexclude_tags:
            suite.tests = self._filter_filter(suite, self._not_excluded_by_tags_not_excluded_by_tags)
        return bool(suite.suites)
 
    def _filter_by_suite_name(self, suite):
        if self.include_suitesinclude_suitesinclude_suites.match(suite.name, suite.longname):
            suite.visit(Filter(include_suites=[],
                               include_tests=self.include_testsinclude_testsinclude_tests,
                               include_tags=self.include_tagsinclude_tagsinclude_tags,
                               exclude_tags=self.exclude_tagsexclude_tagsexclude_tags))
            return False
        suite.tests = []
        return True
 
    def _filter(self, suite, filter):
        return [t for t in suite.tests if filter(t)]
 
    def _included_by_test_name(self, test):
        return self.include_testsinclude_testsinclude_tests.match(test.name, test.longname)
 
    def _included_by_tags(self, test):
        return self.include_tagsinclude_tagsinclude_tags.match(test.tags)
 
    def _not_excluded_by_tags(self, test):
        return not self.exclude_tagsexclude_tagsexclude_tags.match(test.tags)
 
    def __nonzero__(self):
        return bool(self.include_suitesinclude_suitesinclude_suites or self.include_testsinclude_testsinclude_tests or
                    self.include_tagsinclude_tagsinclude_tags or self.exclude_tagsexclude_tagsexclude_tags)