https://github.com/robotframework/RemoteInterface

Introduction to the remote interface with a list of available remote servers
https://github.com/robotframework/RemoteInterface

Last synced: 3 months ago
JSON representation

Introduction to the remote interface with a list of available remote servers

• Host: GitHub
• URL: https://github.com/robotframework/RemoteInterface
• Owner: robotframework
• Created: 2016-01-27T23:05:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-11-28T11:13:08.000Z (almost 4 years ago)
• Last Synced: 2024-06-25T02:32:15.254Z (5 months ago)
• Size: 12.7 KB
• Stars: 33
• Watchers: 11
• Forks: 14
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

• awesome-robotframework - Remote Interface

README

        
========================

Remote library interface

========================

This project exists to give a high level introduction to `Robot Framework

`_ remote library interface and to list the

`available remote servers`_.

.. contents:: Table of contents:

   :local:

   :depth: 2

Introduction

============

The remote library interface allows `Robot Framework`_ test libraries to

be run as external processes. An important use case for this support is

running test libraries on different machines than where Robot Framework itself

is executed. This allows interesting possibilities for distributed testing.

Another big use case is implementing test libraries using other languages that

Robot Framework supports natively. In practice test libraries can be

implemented using any language that supports the `XML-RPC protocol

`_ that the remote interface uses for communication.

Many `languages and platforms`__ are supported already, and implementing

support for new languages or for new usages is pretty straightforward.

__ `Available remote servers`_

Architecture

============

The remote interface consists of the Remote library, remote servers and

actual test libraries running behind these servers. The high level architecture

is illustrated in the picture below.

.. image:: remote.png

The Remote library is one of Robot Framework's standard libraries and thus

automatically installed with the framework. It does not have any keywords of

its own, but instead works as a proxy between Robot Framework and remote

servers.

Remote servers expose the keywords provided by the actual test libraries

to the Remote library. The Remote library and remote servers communicate

using a simple remote protocol on top of an `XML-RPC `_

channel. The remote protocol and the whole remote library interface are

described in detail in the `Robot Framework User Guide

`_ in section `Remote

Library Interface

`_.

The default port used by the remote protocol is 8270 and it has been

`registered by IANA`__ for this purpose.

How remote servers interact with the actual test libraries depends on the

language and the remote server design. See the implementation of the

`available remote servers`_ below for concrete examples.

It is also possible to create solutions that combine a remote server and

one or more libraries together into a single distribution. For example,

`RemoteSwingLibrary `_

bundles `SwingLibrary `_,

jrobotremoteserver_ and also the Remote library itself, and its users do

not even need to know that they use the remote interface.

__ http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=8270

Available remote servers

========================

Following generic remote servers are available as separate projects. See

the project pages for installation and usage instructions.

===================  =============================

Language / Platform          Remote Server

===================  =============================

Python               `PythonRemoteServer `_

Java                 `jrobotremoteserver `_

Ruby                 `robot-remote-server-rb `_

.NET                 `nrobot-server `_

Clojure              `robot-remote-server-clj `_

Perl                 `plrobotremoteserver `_

node.js              `node-robotremoteserver `_

PHP                  `phrrs `_

===================  =============================

Please submit an issue and/or pull request to this project if you have

created a new remote server or existing information needs to be updated.