Lib.robot.libraries.Remote.py Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sikulixapi Show documentation
Show all versions of sikulixapi Show documentation
... for visual testing and automation
# 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.
try:
import httplib
import xmlrpclib
except ImportError: # Py3
import http.client as httplib
import xmlrpc.client as xmlrpclib
import re
import socket
import sys
import time
try:
from xml.parsers.expat import ExpatError
except ImportError: # No expat in IronPython 2.7
class ExpatError(Exception):
pass
from robot.errors import RemoteError
from robot.utils import (is_bytes, is_dict_like, is_list_like, is_number,
is_string, timestr_to_secs, unic, DotDict, IRONPYTHON,
JYTHON)
class Remote(object):
ROBOT_LIBRARY_SCOPE = 'TEST SUITE'
def __init__(self, uri='http://127.0.0.1:8270', timeout=None):
"""Connects to a remote server at ``uri``.
Optional ``timeout`` can be used to specify a timeout to wait when
initially connecting to the server and if a connection accidentally
closes. Timeout can be given as seconds (e.g. ``60``) or using
Robot Framework time format (e.g. ``60s``, ``2 minutes 10 seconds``).
The default timeout is typically several minutes, but it depends on
the operating system and its configuration. Notice that setting
a timeout that is shorter than keyword execution time will interrupt
the keyword.
Support for timeouts is a new feature in Robot Framework 2.8.6.
Timeouts do not work with IronPython.
"""
if '://' not in uri:
uri = 'http://' + uri
if timeout:
timeout = timestr_to_secs(timeout)
self._uri = uri
self._client = XmlRpcRemoteClient(uri, timeout)
def get_keyword_names(self, attempts=2):
for i in range(attempts):
time.sleep(i)
try:
return self._client.get_keyword_names()
except TypeError as err:
error = err
raise RuntimeError('Connecting remote server at %s failed: %s'
% (self._uri, error))
def get_keyword_arguments(self, name):
try:
return self._client.get_keyword_arguments(name)
except TypeError:
return ['*args']
def get_keyword_documentation(self, name):
try:
return self._client.get_keyword_documentation(name)
except TypeError:
return None
def run_keyword(self, name, args, kwargs):
coercer = ArgumentCoercer()
args = coercer.coerce(args)
kwargs = coercer.coerce(kwargs)
result = RemoteResult(self._client.run_keyword(name, args, kwargs))
sys.stdout.write(result.output)
if result.status != 'PASS':
raise RemoteError(result.error, result.traceback, result.fatal,
result.continuable)
return result.return_
class ArgumentCoercer(object):
binary = re.compile('[\x00-\x08\x0B\x0C\x0E-\x1F]')
non_ascii = re.compile('[\x80-\xff]')
def coerce(self, argument):
for handles, handler in [(is_string, self._handle_string),
(is_bytes, self._handle_bytes),
(is_number, self._pass_through),
(is_dict_like, self._coerce_dict),
(is_list_like, self._coerce_list),
(lambda arg: True, self._to_string)]:
if handles(argument):
return handler(argument)
def _handle_string(self, arg):
if self._string_contains_binary(arg):
return self._handle_binary_in_string(arg)
return arg
def _string_contains_binary(self, arg):
return (self.binary.search(arg) or
is_bytes(arg) and self.non_ascii.search(arg))
def _handle_binary_in_string(self, arg):
try:
if not is_bytes(arg):
arg = arg.encode('ASCII')
except UnicodeError:
raise ValueError('Cannot represent %r as binary.' % arg)
return xmlrpclib.Binary(arg)
def _handle_bytes(self, arg):
# http://bugs.jython.org/issue2429
if IRONPYTHON or JYTHON:
arg = str(arg)
return xmlrpclib.Binary(arg)
def _pass_through(self, arg):
return arg
def _coerce_list(self, arg):
return [self.coerce(item) for item in arg]
def _coerce_dict(self, arg):
return dict((self._to_key(key), self.coerce(arg[key])) for key in arg)
def _to_key(self, item):
item = self._to_string(item)
if IRONPYTHON:
self._validate_key_on_ironpython(item)
return item
def _to_string(self, item):
item = unic(item) if item is not None else ''
return self._handle_string(item)
def _validate_key_on_ironpython(self, item):
try:
return str(item)
except UnicodeError:
raise ValueError('Dictionary keys cannot contain non-ASCII '
'characters on IronPython. Got %r.' % item)
class RemoteResult(object):
def __init__(self, result):
if not (is_dict_like(result) and 'status' in result):
raise RuntimeError('Invalid remote result dictionary: %s' % result)
self.status = result['status']
self.output = unic(self._get(result, 'output'))
self.return_ = self._get(result, 'return')
self.error = unic(self._get(result, 'error'))
self.traceback = unic(self._get(result, 'traceback'))
self.fatal = bool(self._get(result, 'fatal', False))
self.continuable = bool(self._get(result, 'continuable', False))
def _get(self, result, key, default=''):
value = result.get(key, default)
return self._convert(value)
def _convert(self, value):
if isinstance(value, xmlrpclib.Binary):
return bytes(value.data)
if is_dict_like(value):
return DotDict((k, self._convert(v)) for k, v in value.items())
if is_list_like(value):
return [self._convert(v) for v in value]
return value
class XmlRpcRemoteClient(object):
def __init__(self, uri, timeout=None):
transport = TimeoutTransport(timeout=timeout)
self._server = xmlrpclib.ServerProxy(uri, encoding='UTF-8',
transport=transport)
def get_keyword_names(self):
try:
return self._server.get_keyword_names()
except (socket.error, xmlrpclib.Error) as err:
raise TypeError(err)
def get_keyword_arguments(self, name):
try:
return self._server.get_keyword_arguments(name)
except xmlrpclib.Error:
raise TypeError
def get_keyword_documentation(self, name):
try:
return self._server.get_keyword_documentation(name)
except xmlrpclib.Error:
raise TypeError
def run_keyword(self, name, args, kwargs):
run_keyword_args = [name, args, kwargs] if kwargs else [name, args]
try:
return self._server.run_keyword(*run_keyword_args)
except xmlrpclib.Fault as err:
message = err.faultString
except socket.error as err:
message = 'Connection to remote server broken: %s' % err
except ExpatError as err:
message = ('Processing XML-RPC return value failed. '
'Most often this happens when the return value '
'contains characters that are not valid in XML. '
'Original error was: ExpatError: %s' % err)
raise RuntimeError(message)
# Custom XML-RPC timeouts based on
# http://stackoverflow.com/questions/2425799/timeout-for-xmlrpclib-client-requests
class TimeoutTransport(xmlrpclib.Transport):
def __init__(self, use_datetime=0, timeout=None):
xmlrpclib.Transport.__init__(self, use_datetime)
if not timeout:
timeout = socket._GLOBAL_DEFAULT_TIMEOUT
self.timeout = timeout
def make_connection(self, host):
if self._connection and host == self._connection[0]:
return self._connection[1]
chost, self._extra_headers, x509 = self.get_host_info(host)
self._connection = host, httplib.HTTPConnection(chost, timeout=self.timeout)
return self._connection[1]
if sys.version_info[:2] == (2, 6):
class TimeoutTransport(TimeoutTransport):
def make_connection(self, host):
host, extra_headers, x509 = self.get_host_info(host)
return TimeoutHTTP(host, timeout=self.timeout)
class TimeoutHTTP(httplib.HTTP):
def __init__(self, host='', port=None, strict=None, timeout=None):
if port == 0:
port = None
self._setup(self._connection_class(host, port, strict, timeout=timeout))
if IRONPYTHON:
class TimeoutTransport(xmlrpclib.Transport):
def __init__(self, use_datetime=0, timeout=None):
xmlrpclib.Transport.__init__(self, use_datetime)
if timeout:
raise RuntimeError('Timeouts are not supported on IronPython.')
© 2015 - 2025 Weber Informatics LLC | Privacy Policy