merger.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.errors import DataError
from robotide.lib.robot.model import SuiteVisitor
from robotide.lib.robot.utils import html_escape
 
 
class Merger(SuiteVisitor):
 
    def __init__(self, result):
        self.resultresult = result
        self.currentcurrent = None
 
    def merge(self, merged):
        self.resultresult.set_execution_mode(merged)
        merged.suite.visit(self)
        self.resultresult.errors.add(merged.errors)
 
    def start_suite(self, suite):
        try:
            self.currentcurrent = self._find_suite_find_suite(self.currentcurrent, suite.name)
        except IndexError:
            suite.message = self._create_add_message_create_add_message(suite, test=False)
            self.currentcurrent.suites.append(suite)
            return False
 
    def _find_suite(self, parent, name):
        if not parent:
            suite = self._find_root_find_root(name)
        else:
            suite = self._find_find(parent.suites, name)
        suite.starttime = suite.endtime = None
        return suite
 
    def _find_root(self, name):
        root = self.resultresult.suite
        if root.name != name:
            raise DataError("Cannot merge outputs containing different root "
                            "suites. Original suite is '%s' and merged is "
                            "'%s'." % (root.name, name))
        return root
 
    def _find(self, items, name):
        for item in items:
            if item.name == name:
                return item
        raise IndexError
 
    def end_suite(self, suite):
        self.currentcurrent = self.currentcurrent.parent
 
    def visit_test(self, test):
        try:
            old = self._find_find(self.currentcurrent.tests, test.name)
        except IndexError:
            test.message = self._create_add_message_create_add_message(test)
            self.currentcurrent.tests.append(test)
        else:
            test.message = self._create_merge_message_create_merge_message(test, old)
            index = self.currentcurrent.tests.index(old)
            self.currentcurrent.tests[index] = test
 
    def _create_add_message(self, item, test=True):
        prefix = ('*HTML* %s added from merged output.'
                  % ('Test' if test else 'Suite'))
        if not item.message:
            return prefix
        return ''.join([prefix, '<hr>', self._html_escape_html_escape(item.message)])
 
    def _html_escape(self, message):
        if message.startswith('*HTML*'):
            return message[6:].lstrip()
        else:
            return html_escape(message)
 
    def _create_merge_message(self, new, old):
        return ''.join([
            '*HTML* Re-executed test has been merged.<hr>',
            'New status: %s<br>' % self._format_status_format_status(new.status),
            'New message: %s<hr>' % self._html_escape_html_escape(new.message),
            'Old status: %s<br>' % self._format_status_format_status(old.status),
            'Old message: %s' % self._html_escape_html_escape(old.message)
        ])
 
    def _format_status(self, status):
        return '<span class="%s">%s</span>' % (status.lower(), status)