jsbuildingcontext.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 contextlib import contextmanager
from os.path import exists, dirname
 
from robot.output.loggerhelper import LEVELS
from robot.utils import (attribute_escape, get_link_path, html_escape, is_string,
                         safe_str, timestamp_to_secs)
 
from .expandkeywordmatcher import ExpandKeywordMatcher
from .stringcache import StringCache
 
 
class JsBuildingContext:
 
    def __init__(self, log_path=None, split_log=False, expand_keywords=None,
                 prune_input=False):
        # log_path can be a custom object in unit tests
        self._log_dir_log_dir = dirname(log_path) if is_string(log_path) else None
        self._split_log_split_log = split_log
        self._prune_input_prune_input = prune_input
        self._strings_strings = self._top_level_strings_top_level_strings = StringCache()
        self.basemillisbasemillis = None
        self.split_resultssplit_results = []
        self.min_levelmin_level = 'NONE'
        self._msg_links_msg_links = {}
        self._expand_matcher_expand_matcher = ExpandKeywordMatcher(expand_keywords) \
            if expand_keywords else None
 
    def string(self, string, escape=True, attr=False):
        if escape and string:
            if not is_string(string):
                string = safe_str(string)
            string = (html_escape if not attr else attribute_escape)(string)
        return self._strings_strings.add(string)
 
    def html(self, string):
        return self._strings_strings.add(string, html=True)
 
    def relative_source(self, source):
        rel_source = get_link_path(source, self._log_dir_log_dir) \
            if self._log_dir_log_dir and source and exists(source) else ''
        return self.stringstring(rel_source)
 
    def timestamp(self, time):
        if not time:
            return None
        millis = int(timestamp_to_secs(time) * 1000)
        if self.basemillisbasemillis is None:
            self.basemillisbasemillis = millis
        return millis - self.basemillisbasemillis
 
    def message_level(self, level):
        if LEVELS[level] < LEVELS[self.min_levelmin_level]:
            self.min_levelmin_level = level
 
    def create_link_target(self, msg):
        id = self._top_level_strings_top_level_strings.add(msg.parent.id)
        self._msg_links_msg_links[self._link_key_link_key(msg)] = id
 
    def check_expansion(self, kw):
        if self._expand_matcher_expand_matcher is not None:
            self._expand_matcher_expand_matcher.match(kw)
 
    @property
    expand_keywords = property
    
    def expand_keywords(self):
        return self._expand_matcher_expand_matcher.matched_ids if self._expand_matcher_expand_matcher else None
 
    def link(self, msg):
        return self._msg_links_msg_links.get(self._link_key_link_key(msg))
 
    def _link_key(self, msg):
        return (msg.message, msg.level, msg.timestamp)
 
    @property
    strings = property
    
    def strings(self):
        return self._strings_strings.dump()
 
    def start_splitting_if_needed(self, split=False):
        if self._split_log_split_log and split:
            self._strings_strings = StringCache()
            return True
        return False
 
    def end_splitting(self, model):
        self.split_resultssplit_results.append((model, self.stringsstringsstrings))
        self._strings_strings = self._top_level_strings_top_level_strings
        return len(self.split_resultssplit_results)
 
    @contextmanager
    def prune_input(self, *items):
        yield
        if self._prune_input_prune_input:
            for item in items:
                item.clear()