Source code for robot.model.filter

#  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
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  See the License for the specific language governing permissions and
#  limitations under the License.

from robot.utils import setter

from .tags import TagPatterns
from .namepatterns import SuiteNamePatterns, TestNamePatterns
from .visitor import SuiteVisitor

[docs]class EmptySuiteRemover(SuiteVisitor): def __init__(self, preserve_direct_children=False): self.preserve_direct_children = preserve_direct_children
[docs] def end_suite(self, suite): if suite.parent or not self.preserve_direct_children: suite.suites = [s for s in suite.suites if s.test_count]
[docs] def visit_test(self, test): pass
[docs] def visit_keyword(self, kw): pass
[docs]class Filter(EmptySuiteRemover): def __init__(self, include_suites=None, include_tests=None, include_tags=None, exclude_tags=None): super().__init__() self.include_suites = include_suites self.include_tests = include_tests self.include_tags = include_tags self.exclude_tags = exclude_tags @setter def include_suites(self, suites): return self._patterns_or_none(suites, SuiteNamePatterns) @setter def include_tests(self, tests): return self._patterns_or_none(tests, TestNamePatterns) @setter def include_tags(self, tags): return self._patterns_or_none(tags, TagPatterns) @setter def exclude_tags(self, tags): return self._patterns_or_none(tags, TagPatterns) def _patterns_or_none(self, items, pattern_class): if items is None or isinstance(items, pattern_class): return items return pattern_class(items)
[docs] def start_suite(self, suite): if not self: return False if hasattr(suite, 'starttime'): suite.starttime = suite.endtime = None if self.include_suites is not None: return self._filter_by_suite_name(suite) if self.include_tests is not None: suite.tests = self._filter(suite, self._included_by_test_name) if self.include_tags is not None: suite.tests = self._filter(suite, self._included_by_tags) if self.exclude_tags is not None: suite.tests = self._filter(suite, self._not_excluded_by_tags) return bool(suite.suites)
def _filter_by_suite_name(self, suite): if self.include_suites.match(, suite.longname): suite.visit(Filter(include_tests=self.include_tests, include_tags=self.include_tags, exclude_tags=self.exclude_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_tests.match(, test.longname) def _included_by_tags(self, test): return self.include_tags.match(test.tags) def _not_excluded_by_tags(self, test): return not self.exclude_tags.match(test.tags) def __bool__(self): return bool(self.include_suites is not None or self.include_tests is not None or self.include_tags is not None or self.exclude_tags is not None)