dotted.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.
 
import sys
 
from robot.model import SuiteVisitor
from robot.utils import plural_or_not, secs_to_timestr
 
from .highlighting import HighlightingStream
 
 
class DottedOutput:
 
    def __init__(self, width=78, colors='AUTO', stdout=None, stderr=None):
        self._width_width = width
        self._stdout_stdout = HighlightingStream(stdout or sys.__stdout__, colors)
        self._stderr_stderr = HighlightingStream(stderr or sys.__stderr__, colors)
        self._markers_on_row_markers_on_row = 0
 
    def start_suite(self, suite):
        if not suite.parent:
            self._stdout_stdout.write("Running suite '%s' with %d %s%s.\n"
                               % (suite.name, suite.test_count,
                                  'test' if not suite.rpa else 'task',
                                  plural_or_not(suite.test_count)))
            self._stdout_stdout.write('=' * self._width_width + '\n')
 
    def end_test(self, test):
        if self._markers_on_row_markers_on_row == self._width_width:
            self._stdout_stdout.write('\n')
            self._markers_on_row_markers_on_row = 0
        self._markers_on_row_markers_on_row += 1
        if test.passed:
            self._stdout_stdout.write('.')
        elif test.skipped:
            self._stdout_stdout.highlight('s', 'SKIP')
        elif test.tags.robot('exit'):
            self._stdout_stdout.write('x')
        else:
            self._stdout_stdout.highlight('F', 'FAIL')
 
    def end_suite(self, suite):
        if not suite.parent:
            self._stdout_stdout.write('\n')
            StatusReporter(self._stdout_stdout, self._width_width).report(suite)
            self._stdout_stdout.write('\n')
 
    def message(self, msg):
        if msg.level in ('WARN', 'ERROR'):
            self._stderr_stderr.error(msg.message, msg.level)
 
    def output_file(self, name, path):
        self._stdout_stdout.write('%-8s %s\n' % (name+':', path))
 
 
class StatusReporter(SuiteVisitor):
 
    def __init__(self, stream, width):
        self._stream_stream = stream
        self._width_width = width
 
    def report(self, suite):
        suite.visit(self)
        stats = suite.statistics
        self._stream_stream.write("%s\nRun suite '%s' with %d %s%s in %s.\n\n"
                           % ('=' * self._width_width, suite.name, stats.total,
                              'test' if not suite.rpa else 'task',
                              plural_or_not(stats.total),
                              secs_to_timestr(suite.elapsedtime/1000.0)))
        self._stream_stream.highlight(suite.status + ('PED' if suite.status == 'SKIP' else 'ED'), suite.status)
        self._stream_stream.write('\n%s\n' % stats.message)
 
    def visit_test(self, test):
        if test.failed and not test.tags.robot('exit'):
            self._stream_stream.write('-' * self._width_width + '\n')
            self._stream_stream.highlight('FAIL')
            self._stream_stream.write(': %s\n%s\n' % (test.longname,
                                               test.message.strip()))