Source code for robot.result.xmlelementhandlers

#  Copyright 2008-2015 Nokia Solutions and Networks
#
#  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(object): 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) result = handler.start(elem, result) self._stack.append((handler, result))
[docs] def end(self, elem): handler, result = self._stack.pop() handler.end(elem, result)
class _Handler(object): def __init__(self): self._child_handlers = dict((c.tag, c) for c in self._children()) def _children(self): return [] def get_child_handler(self, elem): try: return self._child_handlers[elem.tag] except KeyError: raise DataError("Incompatible XML element '%s'." % elem.tag) def start(self, elem, result): return result 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(_Handler): def _children(self): return [RobotHandler()]
[docs]class RobotHandler(_Handler): tag = 'robot'
[docs] def start(self, elem, result): generator = elem.get('generator', 'unknown').split()[0].upper() result.generated_by_robot = generator == 'ROBOT' return result
def _children(self): return [RootSuiteHandler(), StatisticsHandler(), ErrorsHandler()]
[docs]class SuiteHandler(_Handler): tag = 'suite'
[docs] def start(self, elem, result): return result.suites.create(name=elem.get('name', ''), source=elem.get('source'))
def _children(self): return [DocHandler(), MetadataHandler(), SuiteStatusHandler(), KeywordHandler(), TestCaseHandler(), self]
[docs]class RootSuiteHandler(SuiteHandler):
[docs] def start(self, elem, result): result.suite.name = elem.get('name', '') result.suite.source = elem.get('source') return result.suite
def _children(self): return SuiteHandler._children(self)[:-1] + [SuiteHandler()]
[docs]class TestCaseHandler(_Handler): tag = 'test'
[docs] def start(self, elem, result): return result.tests.create(name=elem.get('name', ''))
def _children(self): return [DocHandler(), TagsHandler(), TimeoutHandler(), TestStatusHandler(), KeywordHandler()]
[docs]class KeywordHandler(_Handler): tag = 'kw'
[docs] def start(self, elem, result): return result.keywords.create(kwname=elem.get('name', ''), libname=elem.get('library', ''), type=elem.get('type', 'kw'))
def _children(self): return [DocHandler(), ArgumentsHandler(), AssignHandler(), TagsHandler(), TimeoutHandler(), KeywordStatusHandler(), MessageHandler(), self]
[docs]class MessageHandler(_Handler): tag = 'msg'
[docs] def end(self, elem, result): result.messages.create(elem.text or '', elem.get('level', 'INFO'), elem.get('html', 'no') == 'yes', self._timestamp(elem, 'timestamp'))
class _StatusHandler(_Handler): tag = 'status' def _set_status(self, elem, result): result.status = elem.get('status', 'FAIL') def _set_message(self, elem, result): result.message = elem.text or '' def _set_times(self, elem, result): result.starttime = self._timestamp(elem, 'starttime') result.endtime = self._timestamp(elem, 'endtime')
[docs]class KeywordStatusHandler(_StatusHandler):
[docs] def end(self, elem, result): self._set_status(elem, result) self._set_times(elem, result) if result.type == result.TEARDOWN_TYPE: self._set_message(elem, result)
[docs]class SuiteStatusHandler(_StatusHandler):
[docs] def end(self, elem, result): self._set_message(elem, result) self._set_times(elem, result)
[docs]class TestStatusHandler(_StatusHandler):
[docs] def end(self, elem, result): self._set_status(elem, result) self._set_message(elem, result) self._set_times(elem, result)
[docs]class DocHandler(_Handler): tag = 'doc'
[docs] def end(self, elem, result): result.doc = elem.text or ''
[docs]class MetadataHandler(_Handler): tag = 'metadata' def _children(self): return [MetadataItemHandler()]
[docs]class MetadataItemHandler(_Handler): tag = 'item'
[docs] def end(self, elem, result): result.metadata[elem.get('name', '')] = elem.text or ''
[docs]class TagsHandler(_Handler): tag = 'tags' def _children(self): return [TagHandler()]
[docs]class TagHandler(_Handler): tag = 'tag'
[docs] def end(self, elem, result): result.tags.add(elem.text or '')
[docs]class TimeoutHandler(_Handler): tag = 'timeout'
[docs] def end(self, elem, result): result.timeout = elem.get('value')
[docs]class AssignHandler(_Handler): tag = 'assign' def _children(self): return [AssignVarHandler()]
[docs]class AssignVarHandler(_Handler): tag = 'var'
[docs] def end(self, elem, result): result.assign += (elem.text or '',)
[docs]class ArgumentsHandler(_Handler): tag = 'arguments' def _children(self): return [ArgumentHandler()]
[docs]class ArgumentHandler(_Handler): tag = 'arg'
[docs] def end(self, elem, result): result.args += (elem.text or '',)
[docs]class ErrorsHandler(_Handler): tag = 'errors'
[docs] def start(self, elem, result): return result.errors
def _children(self): return [MessageHandler()]
[docs]class StatisticsHandler(_Handler): tag = 'statistics'
[docs] def get_child_handler(self, elem): return self