logreportwriters.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 os.path import basename, splitext
 
from robot.htmldata import HtmlFileWriter, ModelWriter, LOG, REPORT
from robot.utils import file_writer, is_string
 
from .jswriter import JsResultWriter, SplitLogWriter
 
 
class _LogReportWriter:
    usage = None
 
    def __init__(self, js_model):
        self._js_model_js_model = js_model
 
    def _write_file(self, path, config, template):
        outfile = file_writer(path, usage=self.usageusage) \
            if is_string(path) else path  # unit test hook
        with outfile:
            model_writer = RobotModelWriter(outfile, self._js_model_js_model, config)
            writer = HtmlFileWriter(outfile, model_writer)
            writer.write(template)
 
 
class LogWriter(_LogReportWriter):
    usage = 'log'
 
    def write(self, path, config):
        self._write_file_write_file(path, config, LOG)
        if self._js_model_js_model.split_results:
            self._write_split_logs_write_split_logs(splitext(path)[0])
 
    def _write_split_logs(self, base):
        for index, (keywords, strings) in enumerate(self._js_model_js_model.split_results,
                                                    start=1):
            self._write_split_log_write_split_log(index, keywords, strings, '%s-%d.js' % (base, index))
 
    def _write_split_log(self, index, keywords, strings, path):
        with file_writer(path, usage=self.usageusageusage) as outfile:
            writer = SplitLogWriter(outfile)
            writer.write(keywords, strings, index, basename(path))
 
 
class ReportWriter(_LogReportWriter):
    usage = 'report'
 
    def write(self, path, config):
        self._write_file_write_file(path, config, REPORT)
 
 
class RobotModelWriter(ModelWriter):
 
    def __init__(self, output, model, config):
        self._output_output = output
        self._model_model = model
        self._config_config = config
 
    def write(self, line):
        JsResultWriter(self._output_output).write(self._model_model, self._config_config)