# 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 robot.errors import DataError
[docs]class XmlElementHandler:
def __init__(self, execution_result, root_handler=None):
self._stack = [(root_handler or RootHandler(), execution_result)]
[docs] def start(self, elem):
handler, result = self._stack[-1]
handler = handler.get_child_handler(elem.tag)
# Previous `result` being `None` means child elements should be ignored.
if result is not None:
result = handler.start(elem, result)
self._stack.append((handler, result))
[docs] def end(self, elem):
handler, result = self._stack.pop()
if result is not None:
handler.end(elem, result)
[docs]class ElementHandler:
element_handlers = {}
tag = None
children = frozenset()
[docs] @classmethod
def register(cls, handler):
cls.element_handlers[handler.tag] = handler()
return handler
[docs] def get_child_handler(self, tag):
if tag not in self.children:
if not self.tag:
raise DataError(f"Incompatible root element '{tag}'.")
raise DataError(f"Incompatible child element '{tag}' for '{self.tag}'.")
return self.element_handlers[tag]
[docs] def start(self, elem, result):
return result
[docs] def end(self, elem, result):
pass
def _timestamp(self, elem, attr_name):
timestamp = elem.get(attr_name)
return timestamp if timestamp != 'N/A' else None
[docs]class RootHandler(ElementHandler):
children = frozenset(('robot',))
[docs]@ElementHandler.register
class RobotHandler(ElementHandler):
tag = 'robot'
children = frozenset(('suite', 'statistics', 'errors'))
[docs] def start(self, elem, result):
generator = elem.get('generator', 'unknown').split()[0].upper()
result.generated_by_robot = generator == 'ROBOT'
if result.rpa is None:
result.rpa = elem.get('rpa', 'false') == 'true'
return result
[docs]@ElementHandler.register
class SuiteHandler(ElementHandler):
tag = 'suite'
# 'metadata' is for RF < 4 compatibility.
children = frozenset(('doc', 'metadata', 'meta', 'status', 'kw', 'test', 'suite'))
[docs] def start(self, elem, result):
if hasattr(result, 'suite'): # root
return result.suite.config(name=elem.get('name', ''),
source=elem.get('source'),
rpa=result.rpa)
return result.suites.create(name=elem.get('name', ''),
source=elem.get('source'),
rpa=result.rpa)
[docs] def get_child_handler(self, tag):
if tag == 'status':
return StatusHandler(set_status=False)
return ElementHandler.get_child_handler(self, tag)
[docs]@ElementHandler.register
class TestHandler(ElementHandler):
tag = 'test'
# 'tags' is for RF < 4 compatibility.
children = frozenset(('doc', 'tags', 'tag', 'timeout', 'status', 'kw', 'if', 'for',
'try', 'while', 'return', 'break', 'continue', 'error', 'msg'))
[docs] def start(self, elem, result):
lineno = elem.get('line')
if lineno:
lineno = int(lineno)
return result.tests.create(name=elem.get('name', ''), lineno=lineno)
[docs]@ElementHandler.register
class KeywordHandler(ElementHandler):
tag = 'kw'
# 'arguments', 'assign' and 'tags' are for RF < 4 compatibility.
children = frozenset(('doc', 'arguments', 'arg', 'assign', 'var', 'tags', 'tag',
'timeout', 'status', 'msg', 'kw', 'if', 'for', 'try',
'while', 'return', 'break', 'continue', 'error'))
[docs] def start(self, elem, result):
elem_type = elem.get('type')
if not elem_type:
creator = self._create_keyword
else:
creator = getattr(self, '_create_' + elem_type.lower())
return creator(elem, result)
def _create_keyword(self, elem, result):
try:
body = result.body
except AttributeError:
body = self._get_body_for_suite_level_keyword(result)
return body.create_keyword(kwname=elem.get('name', ''),
libname=elem.get('library'),
sourcename=elem.get('sourcename'))
def _get_body_for_suite_level_keyword(self, result):
# Someone, most likely a listener, has created a `<kw>` element on suite level.
# Add the keyword into a suite setup or teardown, depending on have we already
# seen tests or not. Create an implicit setup/teardown if needed. Possible real
# setup/teardown parsed later will reset the implicit one otherwise, but leaves
# the added keyword into its body.
kw_type = 'teardown' if result.tests or result.suites else 'setup'
keyword = getattr(result, kw_type)
if not keyword:
keyword.config(kwname=f'Implicit {kw_type}', status=keyword.PASS)
return keyword.body
def _create_setup(self, elem, result):
return result.setup.config(kwname=elem.get('name', ''),
libname=elem.get('library'))
def _create_teardown(self, elem, result):
return result.teardown.config(kwname=elem.get('name', ''),
libname=elem.get('library'))
# RF < 4 compatibility.
def _create_for(self, elem, result):
return result.body.create_keyword(kwname=elem.get('name'), type='FOR')
def _create_foritem(self, elem, result):
return result.body.create_keyword(kwname=elem.get('name'), type='ITERATION')
_create_iteration = _create_foritem
[docs]@ElementHandler.register
class ForHandler(ElementHandler):
tag = 'for'
children = frozenset(('var', 'value', 'iter', 'status', 'doc', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_for(flavor=elem.get('flavor'),
start=elem.get('start'),
mode=elem.get('mode'),
fill=elem.get('fill'))
[docs]@ElementHandler.register
class WhileHandler(ElementHandler):
tag = 'while'
children = frozenset(('iter', 'status', 'doc', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_while(
condition=elem.get('condition'),
limit=elem.get('limit'),
on_limit=elem.get('on_limit'),
on_limit_message=elem.get('on_limit_message')
)
[docs]@ElementHandler.register
class IterationHandler(ElementHandler):
tag = 'iter'
children = frozenset(('var', 'doc', 'status', 'kw', 'if', 'for', 'msg', 'try',
'while', 'return', 'break', 'continue', 'error'))
[docs] def start(self, elem, result):
return result.body.create_iteration()
[docs]@ElementHandler.register
class IfHandler(ElementHandler):
tag = 'if'
children = frozenset(('branch', 'status', 'doc', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_if()
[docs]@ElementHandler.register
class BranchHandler(ElementHandler):
tag = 'branch'
children = frozenset(('status', 'kw', 'if', 'for', 'try', 'while', 'msg', 'doc',
'return', 'pattern', 'break', 'continue', 'error'))
[docs] def start(self, elem, result):
return result.body.create_branch(**elem.attrib)
[docs]@ElementHandler.register
class TryHandler(ElementHandler):
tag = 'try'
children = frozenset(('branch', 'status', 'doc', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_try()
[docs]@ElementHandler.register
class PatternHandler(ElementHandler):
tag = 'pattern'
children = frozenset()
[docs] def end(self, elem, result):
result.patterns += (elem.text or '',)
[docs]@ElementHandler.register
class ReturnHandler(ElementHandler):
tag = 'return'
children = frozenset(('status', 'value', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_return()
[docs]@ElementHandler.register
class ContinueHandler(ElementHandler):
tag = 'continue'
children = frozenset(('status', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_continue()
[docs]@ElementHandler.register
class BreakHandler(ElementHandler):
tag = 'break'
children = frozenset(('status', 'msg', 'kw'))
[docs] def start(self, elem, result):
return result.body.create_break()
[docs]@ElementHandler.register
class ErrorHandler(ElementHandler):
tag = 'error'
children = frozenset(('status', 'msg', 'value'))
[docs] def start(self, elem, result):
return result.body.create_error()
[docs]@ElementHandler.register
class MessageHandler(ElementHandler):
tag = 'msg'
[docs] def end(self, elem, result):
html_true = ('true', 'yes') # 'yes' is compatibility for RF < 4.
result.body.create_message(elem.text or '',
elem.get('level', 'INFO'),
elem.get('html') in html_true,
self._timestamp(elem, 'timestamp'))
[docs]@ElementHandler.register
class StatusHandler(ElementHandler):
tag = 'status'
def __init__(self, set_status=True):
self.set_status = set_status
[docs] def end(self, elem, result):
if self.set_status:
result.status = elem.get('status', 'FAIL')
result.starttime = self._timestamp(elem, 'starttime')
result.endtime = self._timestamp(elem, 'endtime')
if elem.text:
result.message = elem.text
[docs]@ElementHandler.register
class DocHandler(ElementHandler):
tag = 'doc'
[docs] def end(self, elem, result):
result.doc = elem.text or ''
[docs]@ElementHandler.register
class TagHandler(ElementHandler):
tag = 'tag'
[docs] def end(self, elem, result):
result.tags.add(elem.text or '')
[docs]@ElementHandler.register
class TimeoutHandler(ElementHandler):
tag = 'timeout'
[docs] def end(self, elem, result):
result.timeout = elem.get('value')
[docs]@ElementHandler.register
class AssignHandler(ElementHandler): # RF < 4 compatibility.
tag = 'assign'
children = frozenset(('var',))
[docs]@ElementHandler.register
class VarHandler(ElementHandler):
tag = 'var'
[docs] def end(self, elem, result):
value = elem.text or ''
if result.type == result.KEYWORD:
result.assign += (value,)
elif result.type == result.FOR:
result.variables += (value,)
elif result.type == result.ITERATION:
result.variables[elem.get('name')] = value
else:
raise DataError(f"Invalid element '{elem}' for result '{result!r}'.")
[docs]@ElementHandler.register
class ArgumentsHandler(ElementHandler): # RF < 4 compatibility.
tag = 'arguments'
children = frozenset(('arg',))
[docs]@ElementHandler.register
class ArgumentHandler(ElementHandler):
tag = 'arg'
[docs] def end(self, elem, result):
result.args += (elem.text or '',)
[docs]@ElementHandler.register
class ValueHandler(ElementHandler):
tag = 'value'
[docs] def end(self, elem, result):
result.values += (elem.text or '',)
[docs]@ElementHandler.register
class ErrorsHandler(ElementHandler):
tag = 'errors'
[docs] def start(self, elem, result):
return result.errors
[docs] def get_child_handler(self, tag):
return ErrorMessageHandler()
[docs]class ErrorMessageHandler(ElementHandler):
[docs] def end(self, elem, result):
html_true = ('true', 'yes') # 'yes' is compatibility for RF < 4.
result.messages.create(elem.text or '',
elem.get('level', 'INFO'),
elem.get('html') in html_true,
self._timestamp(elem, 'timestamp'))
[docs]@ElementHandler.register
class StatisticsHandler(ElementHandler):
tag = 'statistics'
[docs] def get_child_handler(self, tag):
return self