robotframework 6.1rc1__zip → 7.0__zip

robotframework-7.0/src/robot/output/output.py

@@ -0,0 +1,185 @@
+#  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 . import pyloggingconf
+from .debugfile import DebugFile
+from .listeners import Listeners, LibraryListeners
+from .logger import LOGGER
+from .loggerapi import LoggerApi
+from .loggerhelper import AbstractLogger
+from .xmllogger import XmlLoggerAdapter
+
+
+class Output(AbstractLogger, LoggerApi):
+
+    def __init__(self, settings):
+        AbstractLogger.__init__(self)
+        self._xml_logger = XmlLoggerAdapter(settings.output, settings.log_level,
+                                            settings.rpa,
+                                            legacy_output=settings.legacy_output)
+        self.listeners = Listeners(settings.listeners, settings.log_level)
+        self.library_listeners = LibraryListeners(settings.log_level)
+        self._register_loggers(DebugFile(settings.debug_file))
+        self._settings = settings
+
+    @property
+    def initial_log_level(self):
+        return self._settings.log_level
+
+    def _register_loggers(self, debug_file):
+        LOGGER.register_xml_logger(self._xml_logger)
+        LOGGER.register_listeners(self.listeners or None, self.library_listeners)
+        if debug_file:
+            LOGGER.register_logger(debug_file)
+
+    def register_error_listener(self, listener):
+        LOGGER.register_error_listener(listener)
+
+    @property
+    def delayed_logging(self):
+        return LOGGER.delayed_logging
+
+    def close(self, result):
+        self._xml_logger.logger.visit_statistics(result.statistics)
+        self._xml_logger.close()
+        LOGGER.unregister_xml_logger()
+        LOGGER.output_file(self._settings['Output'])
+
+    def start_suite(self, data, result):
+        LOGGER.start_suite(data, result)
+
+    def end_suite(self, data, result):
+        LOGGER.end_suite(data, result)
+
+    def start_test(self, data, result):
+        LOGGER.start_test(data, result)
+
+    def end_test(self, data, result):
+        LOGGER.end_test(data, result)
+
+    def start_keyword(self, data, result):
+        LOGGER.start_keyword(data, result)
+
+    def end_keyword(self, data, result):
+        LOGGER.end_keyword(data, result)
+
+    def start_user_keyword(self, data, implementation, result):
+        LOGGER.start_user_keyword(data, implementation, result)
+
+    def end_user_keyword(self, data, implementation, result):
+        LOGGER.end_user_keyword(data, implementation, result)
+
+    def start_library_keyword(self, data, implementation, result):
+        LOGGER.start_library_keyword(data, implementation, result)
+
+    def end_library_keyword(self, data, implementation, result):
+        LOGGER.end_library_keyword(data, implementation, result)
+
+    def start_invalid_keyword(self, data, implementation, result):
+        LOGGER.start_invalid_keyword(data, implementation, result)
+
+    def end_invalid_keyword(self, data, implementation, result):
+        LOGGER.end_invalid_keyword(data, implementation, result)
+
+    def start_for(self, data, result):
+        LOGGER.start_for(data, result)
+
+    def end_for(self, data, result):
+        LOGGER.end_for(data, result)
+
+    def start_for_iteration(self, data, result):
+        LOGGER.start_for_iteration(data, result)
+
+    def end_for_iteration(self, data, result):
+        LOGGER.end_for_iteration(data, result)
+
+    def start_while(self, data, result):
+        LOGGER.start_while(data, result)
+
+    def end_while(self, data, result):
+        LOGGER.end_while(data, result)
+
+    def start_while_iteration(self, data, result):
+        LOGGER.start_while_iteration(data, result)
+
+    def end_while_iteration(self, data, result):
+        LOGGER.end_while_iteration(data, result)
+
+    def start_if(self, data, result):
+        LOGGER.start_if(data, result)
+
+    def end_if(self, data, result):
+        LOGGER.end_if(data, result)
+
+    def start_if_branch(self, data, result):
+        LOGGER.start_if_branch(data, result)
+
+    def end_if_branch(self, data, result):
+        LOGGER.end_if_branch(data, result)
+
+    def start_try(self, data, result):
+        LOGGER.start_try(data, result)
+
+    def end_try(self, data, result):
+        LOGGER.end_try(data, result)
+
+    def start_try_branch(self, data, result):
+        LOGGER.start_try_branch(data, result)
+
+    def end_try_branch(self, data, result):
+        LOGGER.end_try_branch(data, result)
+
+    def start_var(self, data, result):
+        LOGGER.start_var(data, result)
+
+    def end_var(self, data, result):
+        LOGGER.end_var(data, result)
+
+    def start_break(self, data, result):
+        LOGGER.start_break(data, result)
+
+    def end_break(self, data, result):
+        LOGGER.end_break(data, result)
+
+    def start_continue(self, data, result):
+        LOGGER.start_continue(data, result)
+
+    def end_continue(self, data, result):
+        LOGGER.end_continue(data, result)
+
+    def start_return(self, data, result):
+        LOGGER.start_return(data, result)
+
+    def end_return(self, data, result):
+        LOGGER.end_return(data, result)
+
+    def start_error(self, data, result):
+        LOGGER.start_error(data, result)
+
+    def end_error(self, data, result):
+        LOGGER.end_error(data, result)
+
+    def message(self, msg):
+        LOGGER.log_message(msg)
+
+    def trace(self, msg, write_if_flat=True):
+        if write_if_flat or not self._xml_logger.flatten_level:
+            self.write(msg, 'TRACE')
+
+    def set_log_level(self, level):
+        pyloggingconf.set_level(level)
+        self.listeners.set_log_level(level)
+        self.library_listeners.set_log_level(level)
+        return self._xml_logger.set_log_level(level)

{robotframework-6.1rc1 → robotframework-7.0}/src/robot/output/stdoutlogsplitter.py

@@ -14,8 +14,8 @@
 #  limitations under the License.
 
 import re
+from datetime import datetime
 
-from robot.utils import format_time
 from .loggerhelper import Message, write_to_console
 
 
@@ -36,7 +36,7 @@ class StdoutLogSplitter:
                 write_to_console(msg.lstrip())
                 level = 'INFO'
             if timestamp:
-                timestamp = self._format_timestamp(timestamp[1:])
+                timestamp = datetime.fromtimestamp(float(timestamp[1:]) / 1000)
             yield Message(msg.strip(), level, timestamp=timestamp)
 
     def _split_output(self, output):
@@ -53,8 +53,11 @@ class StdoutLogSplitter:
     def _output_started_with_level(self, tokens):
         return tokens[0] == ''
 
-    def _format_timestamp(self, millis):
-        return format_time(float(millis)/1000, millissep='.')
-
     def __iter__(self):
         return iter(self._messages)
+
+    def __len__(self):
+        return len(self._messages)
+
+    def __getitem__(self, item):
+        return self._messages[item]

robotframework-7.0/src/robot/output/xmllogger.py

@@ -0,0 +1,459 @@
+#  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 datetime import datetime
+
+from robot.utils import NullMarkupWriter, XmlWriter
+from robot.version import get_full_version
+from robot.result import Keyword, TestCase, TestSuite, ResultVisitor
+
+from .loggerapi import LoggerApi
+from .loggerhelper import IsLogged
+
+
+class XmlLoggerAdapter(LoggerApi):
+
+    def __init__(self, path, log_level='TRACE', rpa=False, generator='Robot',
+                 legacy_output=False):
+        logger = XmlLogger if not legacy_output else LegacyXmlLogger
+        self.logger = logger(path, log_level, rpa, generator)
+
+    @property
+    def flatten_level(self):
+        return self.logger.flatten_level
+
+    def close(self):
+        self.logger.close()
+
+    def set_log_level(self, level):
+        return self.logger.set_log_level(level)
+
+    def start_suite(self, data, result):
+        self.logger.start_suite(result)
+
+    def end_suite(self, data, result):
+        self.logger.end_suite(result)
+
+    def start_test(self, data, result):
+        self.logger.start_test(result)
+
+    def end_test(self, data, result):
+        self.logger.end_test(result)
+
+    def start_keyword(self, data, result):
+        self.logger.start_keyword(result)
+
+    def end_keyword(self, data, result):
+        self.logger.end_keyword(result)
+
+    def start_for(self, data, result):
+        self.logger.start_for(result)
+
+    def end_for(self, data, result):
+        self.logger.end_for(result)
+
+    def start_for_iteration(self, data, result):
+        self.logger.start_for_iteration(result)
+
+    def end_for_iteration(self, data, result):
+        self.logger.end_for_iteration(result)
+
+    def start_while(self, data, result):
+        self.logger.start_while(result)
+
+    def end_while(self, data, result):
+        self.logger.end_while(result)
+
+    def start_while_iteration(self, data, result):
+        self.logger.start_while_iteration(result)
+
+    def end_while_iteration(self, data, result):
+        self.logger.end_while_iteration(result)
+
+    def start_if(self, data, result):
+        self.logger.start_if(result)
+
+    def end_if(self, data, result):
+        self.logger.end_if(result)
+
+    def start_if_branch(self, data, result):
+        self.logger.start_if_branch(result)
+
+    def end_if_branch(self, data, result):
+        self.logger.end_if_branch(result)
+
+    def start_try(self, data, result):
+        self.logger.start_try(result)
+
+    def end_try(self, data, result):
+        self.logger.end_try(result)
+
+    def start_try_branch(self, data, result):
+        self.logger.start_try_branch(result)
+
+    def end_try_branch(self, data, result):
+        self.logger.end_try_branch(result)
+
+    def start_var(self, data, result):
+        self.logger.start_var(result)
+
+    def end_var(self, data, result):
+        self.logger.end_var(result)
+
+    def start_break(self, data, result):
+        self.logger.start_break(result)
+
+    def end_break(self, data, result):
+        self.logger.end_break(result)
+
+    def start_continue(self, data, result):
+        self.logger.start_continue(result)
+
+    def end_continue(self, data, result):
+        self.logger.end_continue(result)
+
+    def start_return(self, data, result):
+        self.logger.start_return(result)
+
+    def end_return(self, data, result):
+        self.logger.end_return(result)
+
+    def start_error(self, data, result):
+        self.logger.start_error(result)
+
+    def end_error(self, data, result):
+        self.logger.end_error(result)
+
+    def log_message(self, message):
+        self.logger.log_message(message)
+
+    def message(self, message):
+        self.logger.message(message)
+
+
+class XmlLogger(ResultVisitor):
+
+    def __init__(self, output, log_level='TRACE', rpa=False, generator='Robot',
+                 suite_only=False):
+        self._log_message_is_logged = IsLogged(log_level)
+        self._error_message_is_logged = IsLogged('WARN')
+        # `_writer` is set to NullMarkupWriter when flattening, `_xml_writer` is not.
+        self._writer = self._xml_writer = self._get_writer(output, rpa, generator,
+                                                           suite_only)
+        self.flatten_level = 0
+        self._errors = []
+
+    def _get_writer(self, output, rpa, generator, suite_only):
+        if not output:
+            return NullMarkupWriter()
+        writer = XmlWriter(output, write_empty=False, usage='output',
+                           preamble=not suite_only)
+        if not suite_only:
+            writer.start('robot', self._get_start_attrs(rpa, generator))
+        return writer
+
+    def _get_start_attrs(self, rpa, generator):
+        return {'generator': get_full_version(generator),
+                'generated': datetime.now().isoformat(),
+                'rpa': 'true' if rpa else 'false',
+                'schemaversion': '5'}
+
+    def close(self):
+        self.start_errors()
+        for msg in self._errors:
+            self._write_message(msg)
+        self.end_errors()
+        self._writer.end('robot')
+        self._writer.close()
+
+    def set_log_level(self, level):
+        return self._log_message_is_logged.set_level(level)
+
+    def message(self, msg):
+        if self._error_message_is_logged(msg.level):
+            self._errors.append(msg)
+
+    def log_message(self, msg):
+        if self._log_message_is_logged(msg.level):
+            self._write_message(msg)
+
+    def _write_message(self, msg):
+        attrs = {'time': msg.timestamp.isoformat() if msg.timestamp else None,
+                 'level': msg.level}
+        if msg.html:
+            attrs['html'] = 'true'
+        # Use `_xml_writer`, not `_writer` to write messages also when flattening.
+        self._xml_writer.element('msg', msg.message, attrs)
+
+    def start_keyword(self, kw):
+        self._writer.start('kw', self._get_start_keyword_attrs(kw))
+        if kw.tags.robot('flatten'):
+            self.flatten_level += 1
+            self._writer = NullMarkupWriter()
+
+    def _get_start_keyword_attrs(self, kw):
+        attrs = {'name': kw.name, 'owner': kw.owner}
+        if kw.type != 'KEYWORD':
+            attrs['type'] = kw.type
+        if kw.source_name:
+            attrs['source_name'] = kw.source_name
+        return attrs
+
+    def end_keyword(self, kw):
+        if kw.tags.robot('flatten'):
+            self.flatten_level -= 1
+            if self.flatten_level == 0:
+                self._writer = self._xml_writer
+        self._write_list('var', kw.assign)
+        self._write_list('arg', kw.args)
+        self._write_list('tag', kw.tags)
+        self._writer.element('doc', kw.doc)
+        if kw.timeout:
+            self._writer.element('timeout', attrs={'value': str(kw.timeout)})
+        self._write_status(kw)
+        self._writer.end('kw')
+
+    def start_if(self, if_):
+        self._writer.start('if')
+
+    def end_if(self, if_):
+        self._write_status(if_)
+        self._writer.end('if')
+
+    def start_if_branch(self, branch):
+        self._writer.start('branch', {'type': branch.type,
+                                      'condition': branch.condition})
+
+    def end_if_branch(self, branch):
+        self._write_status(branch)
+        self._writer.end('branch')
+
+    def start_for(self, for_):
+        self._writer.start('for', {'flavor': for_.flavor,
+                                   'start': for_.start,
+                                   'mode': for_.mode,
+                                   'fill': for_.fill})
+
+    def end_for(self, for_):
+        for name in for_.assign:
+            self._writer.element('var', name)
+        for value in for_.values:
+            self._writer.element('value', value)
+        self._write_status(for_)
+        self._writer.end('for')
+
+    def start_for_iteration(self, iteration):
+        self._writer.start('iter')
+
+    def end_for_iteration(self, iteration):
+        for name, value in iteration.assign.items():
+            self._writer.element('var', value, {'name': name})
+        self._write_status(iteration)
+        self._writer.end('iter')
+
+    def start_try(self, root):
+        self._writer.start('try')
+
+    def end_try(self, root):
+        self._write_status(root)
+        self._writer.end('try')
+
+    def start_try_branch(self, branch):
+        if branch.type == branch.EXCEPT:
+            self._writer.start('branch', attrs={
+                'type': 'EXCEPT',
+                'pattern_type': branch.pattern_type,
+                'assign': branch.assign
+            })
+            self._write_list('pattern', branch.patterns)
+        else:
+            self._writer.start('branch', attrs={'type': branch.type})
+
+    def end_try_branch(self, branch):
+        self._write_status(branch)
+        self._writer.end('branch')
+
+    def start_while(self, while_):
+        self._writer.start('while', attrs={
+            'condition': while_.condition,
+            'limit': while_.limit,
+            'on_limit': while_.on_limit,
+            'on_limit_message': while_.on_limit_message
+        })
+
+    def end_while(self, while_):
+        self._write_status(while_)
+        self._writer.end('while')
+
+    def start_while_iteration(self, iteration):
+        self._writer.start('iter')
+
+    def end_while_iteration(self, iteration):
+        self._write_status(iteration)
+        self._writer.end('iter')
+
+    def start_var(self, var):
+        attr = {'name': var.name}
+        if var.scope is not None:
+            attr['scope'] = var.scope
+        if var.separator is not None:
+            attr['separator'] = var.separator
+        self._writer.start('variable', attr, write_empty=True)
+
+    def end_var(self, var):
+        for val in var.value:
+            self._writer.element('var', val)
+        self._write_status(var)
+        self._writer.end('variable')
+
+    def start_return(self, return_):
+        self._writer.start('return')
+
+    def end_return(self, return_):
+        for value in return_.values:
+            self._writer.element('value', value)
+        self._write_status(return_)
+        self._writer.end('return')
+
+    def start_continue(self, continue_):
+        self._writer.start('continue')
+
+    def end_continue(self, continue_):
+        self._write_status(continue_)
+        self._writer.end('continue')
+
+    def start_break(self, break_):
+        self._writer.start('break')
+
+    def end_break(self, break_):
+        self._write_status(break_)
+        self._writer.end('break')
+
+    def start_error(self, error):
+        self._writer.start('error')
+
+    def end_error(self, error):
+        for value in error.values:
+            self._writer.element('value', value)
+        self._write_status(error)
+        self._writer.end('error')
+
+    def start_test(self, test):
+        self._writer.start('test', {'id': test.id, 'name': test.name,
+                                    'line': str(test.lineno or '')})
+
+    def end_test(self, test):
+        self._writer.element('doc', test.doc)
+        self._write_list('tag', test.tags)
+        if test.timeout:
+            self._writer.element('timeout', attrs={'value': str(test.timeout)})
+        self._write_status(test)
+        self._writer.end('test')
+
+    def start_suite(self, suite):
+        attrs = {'id': suite.id, 'name': suite.name}
+        if suite.source:
+            attrs['source'] = str(suite.source)
+        self._writer.start('suite', attrs)
+
+    def end_suite(self, suite):
+        self._writer.element('doc', suite.doc)
+        for name, value in suite.metadata.items():
+            self._writer.element('meta', value, {'name': name})
+        self._write_status(suite)
+        self._writer.end('suite')
+
+    def start_statistics(self, stats):
+        self._writer.start('statistics')
+
+    def end_statistics(self, stats):
+        self._writer.end('statistics')
+
+    def start_total_statistics(self, total_stats):
+        self._writer.start('total')
+
+    def end_total_statistics(self, total_stats):
+        self._writer.end('total')
+
+    def start_tag_statistics(self, tag_stats):
+        self._writer.start('tag')
+
+    def end_tag_statistics(self, tag_stats):
+        self._writer.end('tag')
+
+    def start_suite_statistics(self, tag_stats):
+        self._writer.start('suite')
+
+    def end_suite_statistics(self, tag_stats):
+        self._writer.end('suite')
+
+    def visit_stat(self, stat):
+        self._writer.element('stat', stat.name,
+                             stat.get_attributes(values_as_strings=True))
+
+    def start_errors(self, errors=None):
+        self._writer.start('errors')
+
+    def end_errors(self, errors=None):
+        self._writer.end('errors')
+
+    def _write_list(self, tag, items):
+        for item in items:
+            self._writer.element(tag, item)
+
+    def _write_status(self, item):
+        attrs = {'status': item.status,
+                 'start': item.start_time.isoformat() if item.start_time else None,
+                 'elapsed': format(item.elapsed_time.total_seconds(), 'f')}
+        self._writer.element('status', item.message, attrs)
+
+
+class LegacyXmlLogger(XmlLogger):
+
+    def _get_start_attrs(self, rpa, generator):
+        return {'generator': get_full_version(generator),
+                'generated': self._datetime_to_timestamp(datetime.now()),
+                'rpa': 'true' if rpa else 'false',
+                'schemaversion': '4'}
+
+    def _datetime_to_timestamp(self, dt):
+        return dt.isoformat(' ', timespec='milliseconds').replace('-', '')
+
+    def _get_start_keyword_attrs(self, kw):
+        attrs = {'name': kw.kwname, 'library': kw.libname}
+        if kw.type != 'KEYWORD':
+            attrs['type'] = kw.type
+        if kw.source_name:
+            attrs['sourcename'] = kw.source_name
+        return attrs
+
+    def _write_status(self, item):
+        attrs = {'status': item.status,
+                 'starttime': self._datetime_to_timestamp(item.start_time),
+                 'endtime': self._datetime_to_timestamp(item.end_time)}
+        if (isinstance(item, (TestSuite, TestCase))
+                or isinstance(item, Keyword) and item.type == 'TEARDOWN'):
+            message = item.message
+        else:
+            message = ''
+        self._writer.element('status', message, attrs)
+
+    def _write_message(self, msg):
+        ts = self._datetime_to_timestamp(msg.timestamp) if msg.timestamp else None
+        attrs = {'timestamp':  ts, 'level': msg.level}
+        if msg.html:
+            attrs['html'] = 'true'
+        # Use `_xml_writer`, not `_writer` to write messages also when flattening.
+        self._xml_writer.element('msg', msg.message, attrs)