Permalink
Browse files

Initial version based on https://code.google.com/p/robotframework/wik…

  • Loading branch information...
0 parents commit 936c1ee77384ccc5e7515702d348ac76b7150920 @pekkaklarck pekkaklarck committed Jan 27, 2016
Showing with 75 additions and 0 deletions.
  1. +75 −0 README.rst
  2. BIN remote.png
@@ -0,0 +1,75 @@
+========================
+Remote library interface
+========================
+
+This project exists to give a high level introduction to `Robot Framework
+<http://robotframework.org>`_ 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
+<http://www.xmlrpc.com>`_ 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 it 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 <http://www.xmlrpc.com>`_
+channel. The remote protocol and the whole remote library interface is
+described in detail in the `Robot Framework User Guide
+<http://robotframework.org/robotframework/#user-guide>`_.
+
+How remote servers interact with the actual test libraries depends on the
+language and the remote server design. For custom usages it is possible to
+create remote servers that contain also all keywords themselves.
+
+Available remote servers
+========================
+
+Following remote servers are available as separate projects. See the project
+pages for installation and usage instructions.
+
+=================== =============================
+Language / Platform Remote Server
+=================== =============================
+Python `PythonRemoteServer <https://github.com/robotframework/PythonRemoteServer>`__
+Java `jrobotremoteserver <https://github.com/ombre42/jrobotremoteserver>`__
+Ruby `robot-remote-server-rb <https://github.com/semperos/robot-remote-server-rb>`__
+.NET `nrobotremote <https://github.com/claytonneal/nrobotremote>`__
+Clojure `robot-remote-server-clj <https://github.com/semperos/robot-remote-server-clj>`__
+Perl `plrobotremoteserver <https://github.com/daluu/plrobotremoteserver>`__
+node.js `node-robotremoteserver <https://github.com/comick/node-robotremoteserver>`__
+PHP `phrrs <https://github.com/daluu/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.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 936c1ee

Please sign in to comment.