suiterunner.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.errors import ExecutionFailed, ExecutionStatus, DataError, PassExecution
from robot.model import SuiteVisitor, TagPatterns
from robot.result import TestSuite, Result
from robot.utils import get_timestamp, is_list_like, NormalizedDict, test_or_task
from robot.variables import VariableScopes
 
from .bodyrunner import BodyRunner, KeywordRunner
from .context import EXECUTION_CONTEXTS
from .modelcombiner import ModelCombiner
from .namespace import Namespace
from .status import SuiteStatus, TestStatus
from .timeouts import TestTimeout
 
 
class SuiteRunner(SuiteVisitor):
 
    def __init__(self, output, settings):
        self.resultresult = None
        self._output_output = output
        self._settings_settings = settings
        self._variables_variables = VariableScopes(settings)
        self._suite_suite = None
        self._suite_status_suite_status = None
        self._executed_executed = [NormalizedDict(ignore='_')]
        self._skipped_tags_skipped_tags = TagPatterns(settings.skip)
 
    @property
    _context = property
    
    def _context(self):
        return EXECUTION_CONTEXTS.current
 
    def start_suite(self, suite):
        if suite.name in self._executed_executed[-1] and suite.parent.source:
            self._output_output.warn(f"Multiple suites with name '{suite.name}' executed in "
                              f"suite '{suite.parent.longname}'.")
        self._executed_executed[-1][suite.name] = True
        self._executed_executed.append(NormalizedDict(ignore='_'))
        self._output_output.library_listeners.new_suite_scope()
        result = TestSuite(source=suite.source,
                           name=suite.name,
                           doc=suite.doc,
                           metadata=suite.metadata,
                           starttime=get_timestamp(),
                           rpa=self._settings_settings.rpa)
        if not self.resultresult:
            self.resultresult = Result(root_suite=result, rpa=self._settings_settings.rpa)
            self.resultresult.configure(status_rc=self._settings_settings.status_rc,
                                  stat_config=self._settings_settings.statistics_config)
        else:
            self._suite_suite.suites.append(result)
        self._suite_suite = result
        self._suite_status_suite_status = SuiteStatus(self._suite_status_suite_status,
                                         self._settings_settings.exit_on_failure,
                                         self._settings_settings.exit_on_error,
                                         self._settings_settings.skip_teardown_on_exit)
        ns = Namespace(self._variables_variables, result, suite.resource, self._settings_settings.languages)
        ns.start_suite()
        ns.variables.set_from_variable_table(suite.resource.variables)
        EXECUTION_CONTEXTS.start_suite(result, ns, self._output_output,
                                       self._settings_settings.dry_run)
        self._context_context_context.set_suite_variables(result)
        if not self._suite_status_suite_status.failed:
            ns.handle_imports()
            ns.variables.resolve_delayed()
        result.doc = self._resolve_setting_resolve_setting(result.doc)
        result.metadata = [(self._resolve_setting_resolve_setting(n), self._resolve_setting_resolve_setting(v))
                           for n, v in result.metadata.items()]
        self._context_context_context.set_suite_variables(result)
        self._output_output.start_suite(ModelCombiner(suite, result,
                                               tests=suite.tests,
                                               suites=suite.suites,
                                               test_count=suite.test_count))
        self._output_output.register_error_listener(self._suite_status_suite_status.error_occurred)
        self._run_setup_run_setup(suite.setup, self._suite_status_suite_status)
 
    def _resolve_setting(self, value):
        if is_list_like(value):
            return self._variables_variables.replace_list(value, ignore_errors=True)
        return self._variables_variables.replace_string(value, ignore_errors=True)
 
    def end_suite(self, suite):
        self._suite_suite.message = self._suite_status_suite_status.message
        self._context_context_context.report_suite_status(self._suite_suite.status,
                                          self._suite_suite.full_message)
        with self._context_context_context.suite_teardown():
            failure = self._run_teardown_run_teardown(suite.teardown, self._suite_status_suite_status)
            if failure:
                if failure.skip:
                    self._suite_suite.suite_teardown_skipped(str(failure))
                else:
                    self._suite_suite.suite_teardown_failed(str(failure))
        self._suite_suite.endtime = get_timestamp()
        self._suite_suite.message = self._suite_status_suite_status.message
        self._context_context_context.end_suite(ModelCombiner(suite, self._suite_suite))
        self._executed_executed.pop()
        self._suite_suite = self._suite_suite.parent
        self._suite_status_suite_status = self._suite_status_suite_status.parent
        self._output_output.library_listeners.discard_suite_scope()
 
    def visit_test(self, test):
        settings = self._settings_settings
        if test.tags.robot('exclude'):
            return
        if test.name in self._executed_executed[-1]:
            self._output_output.warn(
                test_or_task(f"Multiple {{test}}s with name '{test.name}' executed in "
                             f"suite '{test.parent.longname}'.", settings.rpa))
        self._executed_executed[-1][test.name] = True
        result = self._suite_suite.tests.create(self._resolve_setting_resolve_setting(test.name),
                                          self._resolve_setting_resolve_setting(test.doc),
                                          self._resolve_setting_resolve_setting(test.tags),
                                          self._get_timeout_get_timeout(test),
                                          test.lineno,
                                          starttime=get_timestamp())
        self._context_context_context.start_test(result)
        self._output_output.start_test(ModelCombiner(test, result))
        status = TestStatus(self._suite_status_suite_status, result, settings.skip_on_failure,
                            settings.rpa)
        if status.exit:
            self._add_exit_combine_add_exit_combine()
            result.tags.add('robot:exit')
        if status.passed:
            if not test.name:
                status.test_failed(
                    test_or_task('{Test} name cannot be empty.', settings.rpa))
            elif not test.body:
                status.test_failed(
                    test_or_task('{Test} contains no keywords.', settings.rpa))
            elif test.tags.robot('skip'):
                status.test_skipped(
                    test_or_task("{Test} skipped using 'robot:skip' tag.",
                                 settings.rpa))
            elif self._skipped_tags_skipped_tags.match(test.tags):
                status.test_skipped(
                    test_or_task("{Test} skipped using '--skip' command line option.",
                                 settings.rpa))
        self._run_setup_run_setup(test.setup, status, result)
        if status.passed:
            try:
                BodyRunner(self._context_context_context, templated=bool(test.template)).run(test.body)
            except PassExecution as exception:
                err = exception.earlier_failures
                if err:
                    status.test_failed(error=err)
                else:
                    result.message = exception.message
            except ExecutionStatus as err:
                status.test_failed(error=err)
        elif status.skipped:
            status.test_skipped(status.message)
        else:
            status.test_failed(status.message)
        result.status = status.status
        result.message = status.message or result.message
        with self._context_context_context.test_teardown(result):
            self._run_teardown_run_teardown(test.teardown, status, result)
        if status.passed and result.timeout and result.timeout.timed_out():
            status.test_failed(result.timeout.get_message())
            result.message = status.message
        if status.skip_on_failure_after_tag_changes:
            result.message = status.message or result.message
        result.status = status.status
        result.endtime = get_timestamp()
        failed_before_listeners = result.failed
        self._output_output.end_test(ModelCombiner(test, result))
        if result.failed and not failed_before_listeners:
            status.failure_occurred()
        self._context_context_context.end_test(result)
 
    def _add_exit_combine(self):
        exit_combine = ('NOT robot:exit', '')
        if exit_combine not in self._settings_settings['TagStatCombine']:
            self._settings_settings['TagStatCombine'].append(exit_combine)
 
    def _get_timeout(self, test):
        if not test.timeout:
            return None
        return TestTimeout(test.timeout, self._variables_variables, rpa=test.parent.rpa)
 
    def _run_setup(self, setup, status, result=None):
        if status.passed:
            exception = self._run_setup_or_teardown_run_setup_or_teardown(setup)
            status.setup_executed(exception)
            if result and isinstance(exception, PassExecution):
                result.message = exception.message
        elif status.parent and status.parent.skipped:
            status.skipped = True
 
    def _run_teardown(self, teardown, status, result=None):
        if status.teardown_allowed:
            exception = self._run_setup_or_teardown_run_setup_or_teardown(teardown)
            status.teardown_executed(exception)
            failed = exception and not isinstance(exception, PassExecution)
            if result and exception:
                if failed or status.skipped or exception.skip:
                    result.message = status.message
                else:
                    # Pass execution used in teardown,
                    # and it overrides previous failure message
                    result.message = exception.message
            return exception if failed else None
 
    def _run_setup_or_teardown(self, data):
        if not data:
            return None
        try:
            name = self._variables_variables.replace_string(data.name)
        except DataError as err:
            if self._settings_settings.dry_run:
                return None
            return ExecutionFailed(message=err.message)
        if name.upper() in ('', 'NONE'):
            return None
        try:
            KeywordRunner(self._context_context_context).run(data, name=name)
        except ExecutionStatus as err:
            return err