debugfile.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 get_timestamp, file_writer, seq2str2
 
from .logger import LOGGER
from .loggerhelper import IsLogged
 
 
def DebugFile(path):
    if not path:
        LOGGER.info('No debug file')
        return None
    try:
        outfile = file_writer(path)
    except EnvironmentError as err:
        LOGGER.error("Opening debug file '%s' failed: %s" % (path, err.strerror))
        return None
    else:
        LOGGER.info('Debug file: %s' % path)
        return _DebugFileWriter(outfile)
 
 
class _DebugFileWriter:
    
    _separators = {'SUITE': '=', 'TEST': '-', 'KW': '~'}
    
    _setup_or_teardown = ('setup', 'teardown')
 
    def __init__(self, outfile):
        self._indent_indent = 0
        self._kw_level_kw_level = 0
        self._separator_written_last_separator_written_last = False
        self._outfile_outfile = outfile
        self._is_logged_is_logged = IsLogged('DEBUG')
 
    def start_suite(self, suite):
        self._separator_separator('SUITE')
        self._start_start('SUITE', suite.longname)
        self._separator_separator('SUITE')
 
    def end_suite(self, suite):
        self._separator_separator('SUITE')
        self._end_end('SUITE', suite.longname, suite.elapsedtime)
        self._separator_separator('SUITE')
        if self._indent_indent == 0:
            LOGGER.output_file('Debug', self._outfile_outfile.name)
            self.closeclose()
 
    def start_test(self, test):
        self._separator_separator('TEST')
        self._start_start('TEST', test.name)
        self._separator_separator('TEST')
 
    def end_test(self, test):
        self._separator_separator('TEST')
        self._end_end('TEST', test.name, test.elapsedtime)
        self._separator_separator('TEST')
 
    def start_keyword(self, kw):
        if self._kw_level_kw_level == 0:
            self._separator_separator('KW')
        self._start_start(self._get_kw_type_get_kw_type(kw), kw.name, kw.args)
        self._kw_level_kw_level += 1
 
    def end_keyword(self, kw):
        self._end_end(self._get_kw_type_get_kw_type(kw), kw.name, kw.elapsedtime)
        self._kw_level_kw_level -= 1
 
    def log_message(self, msg):
        if self._is_logged_is_logged(msg.level):
            self._write_write(msg.message, level=msg.level, timestamp=msg.timestamp)
 
    def close(self):
        if not self._outfile_outfile.closed:
            self._outfile_outfile.close()
 
    def _get_kw_type(self, kw):
        if kw.type in self._setup_or_teardown_setup_or_teardown:
            return kw.type.upper()
        return 'KW'
 
    def _start(self, type_, name, args=''):
        args = ' ' + seq2str2(args)
        self._write_write('+%s START %s: %s%s' % ('-'*self._indent_indent, type_, name, args))
        self._indent_indent += 1
 
    def _end(self, type_, name, elapsed):
        self._indent_indent -= 1
        self._write_write('+%s END %s: %s (%s)' % ('-'*self._indent_indent, type_, name, elapsed))
 
    def _separator(self, type_):
        self._write_write(self._separators_separators[type_] * 78, separator=True)
 
    def _write(self, text, separator=False, level='INFO', timestamp=None):
        if separator and self._separator_written_last_separator_written_last:
            return
        if not separator:
            text = '%s - %s - %s' % (timestamp or get_timestamp(), level, text)
        self._outfile_outfile.write(text.rstrip() + '\n')
        self._outfile_outfile.flush()
        self._separator_written_last_separator_written_last = separator