configurer.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 seq2str
from robotide.lib.robot.errors import DataError
 
from .visitor import SuiteVisitor
 
 
class SuiteConfigurer(SuiteVisitor):
 
    def __init__(self, name=None, doc=None, metadata=None, set_tags=None,
                 include_tags=None, exclude_tags=None, include_suites=None,
                 include_tests=None, empty_suite_ok=False):
        self.namename = name
        self.docdoc = doc
        self.metadatametadata = metadata
        self.set_tagsset_tags = set_tags or []
        self.include_tagsinclude_tags = include_tags
        self.exclude_tagsexclude_tags = exclude_tags
        self.include_suitesinclude_suites = include_suites
        self.include_testsinclude_tests = include_tests
        self.empty_suite_okempty_suite_ok = empty_suite_ok
 
    @property
    add_tags = property
    
    def add_tags(self):
        return [t for t in self.set_tagsset_tags if not t.startswith('-')]
 
    @property
    remove_tags = property
    
    def remove_tags(self):
        return [t[1:] for t in self.set_tagsset_tags if t.startswith('-')]
 
    def visit_suite(self, suite):
        self._set_suite_attributes_set_suite_attributes(suite)
        self._filter_filter(suite)
        suite.set_tags(self.add_tagsadd_tagsadd_tags, self.remove_tagsremove_tagsremove_tags)
 
    def _set_suite_attributes(self, suite):
        if self.namename:
            suite.name = self.namename
        if self.docdoc:
            suite.doc = self.docdoc
        if self.metadatametadata:
            suite.metadata.update(self.metadatametadata)
 
    def _filter(self, suite):
        name = suite.name
        suite.filter(self.include_suitesinclude_suites, self.include_testsinclude_tests,
                     self.include_tagsinclude_tags, self.exclude_tagsexclude_tags)
        if not (suite.test_count or self.empty_suite_okempty_suite_ok):
            self._raise_no_tests_error_raise_no_tests_error(name, suite.rpa)
 
    def _raise_no_tests_error(self, suite, rpa=False):
        parts = ['tests' if not rpa else 'tasks',
                 self._get_test_selector_msgs_get_test_selector_msgs(),
                 self._get_suite_selector_msg_get_suite_selector_msg()]
        raise DataError("Suite '%s' contains no %s."
                        % (suite, ' '.join(p for p in parts if p)))
 
    def _get_test_selector_msgs(self):
        parts = []
        for explanation, selector in [('matching tags', self.include_tagsinclude_tags),
                                      ('not matching tags', self.exclude_tagsexclude_tags),
                                      ('matching name', self.include_testsinclude_tests)]:
            if selector:
                parts.append(self._format_selector_msg_format_selector_msg(explanation, selector))
        return seq2str(parts, quote='')
 
    def _format_selector_msg(self, explanation, selector):
        if len(selector) == 1 and explanation[-1] == 's':
            explanation = explanation[:-1]
        return '%s %s' % (explanation, seq2str(selector, lastsep=' or '))
 
    def _get_suite_selector_msg(self):
        if not self.include_suitesinclude_suites:
            return ''
        return self._format_selector_msg_format_selector_msg('in suites', self.include_suitesinclude_suites)