# 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 pathlib import Path
from robot.output.loggerhelper import LEVELS
from robot.utils import (attribute_escape, get_link_path, html_escape, safe_str,
timestamp_to_secs)
from .expandkeywordmatcher import ExpandKeywordMatcher
from .stringcache import StringCache
[docs]class JsBuildingContext:
def __init__(self, log_path=None, split_log=False, expand_keywords=None,
prune_input=False):
self._log_dir = self._get_log_dir(log_path)
self._split_log = split_log
self._prune_input = prune_input
self._strings = self._top_level_strings = StringCache()
self.basemillis = None
self.split_results = []
self.min_level = 'NONE'
self._msg_links = {}
self._expand_matcher = ExpandKeywordMatcher(expand_keywords) \
if expand_keywords else None
def _get_log_dir(self, log_path):
# log_path can be a custom object in unit tests
if isinstance(log_path, Path):
return log_path.parent
if isinstance(log_path, str):
return Path(log_path).parent
return None
[docs] def string(self, string, escape=True, attr=False):
if escape and string:
if not isinstance(string, str):
string = safe_str(string)
string = (html_escape if not attr else attribute_escape)(string)
return self._strings.add(string)
[docs] def html(self, string):
return self._strings.add(string, html=True)
[docs] def relative_source(self, source):
if isinstance(source, str):
source = Path(source)
rel_source = get_link_path(source, self._log_dir) \
if self._log_dir and source and source.exists() else ''
return self.string(rel_source)
[docs] def timestamp(self, time):
if not time:
return None
millis = int(timestamp_to_secs(time) * 1000)
if self.basemillis is None:
self.basemillis = millis
return millis - self.basemillis
[docs] def message_level(self, level):
if LEVELS[level] < LEVELS[self.min_level]:
self.min_level = level
[docs] def create_link_target(self, msg):
id = self._top_level_strings.add(msg.parent.id)
self._msg_links[self._link_key(msg)] = id
[docs] def check_expansion(self, kw):
if self._expand_matcher is not None:
self._expand_matcher.match(kw)
@property
def expand_keywords(self):
return self._expand_matcher.matched_ids if self._expand_matcher else None
[docs] def link(self, msg):
return self._msg_links.get(self._link_key(msg))
def _link_key(self, msg):
return (msg.message, msg.level, msg.timestamp)
@property
def strings(self):
return self._strings.dump()
[docs] def start_splitting_if_needed(self, split=False):
if self._split_log and split:
self._strings = StringCache()
return True
return False
[docs] def end_splitting(self, model):
self.split_results.append((model, self.strings))
self._strings = self._top_level_strings
return len(self.split_results)
[docs] @contextmanager
def prune_input(self, *items):
yield
if self._prune_input:
for item in items:
item.clear()