robotframework-jsonrpcremote 0.2.0

A client implementation for Robot Framework JSON-RPC remote protocol.

robotframework-jsonrpcremote

A Robot Framework Remote Library implementation using JSON-RPC 2.0.

This project enables running Robot Framework keywords on a remote server using the standard JSON-RPC 2.0 protocol. It serves as an alternative to the standard Remote Library.

Features

• JSON-RPC 2.0: Built on the lightweight and widely supported standard protocol.
• Language Agnostic: Servers can be implemented in any language that supports JSON-RPC 2.0 (e.g., Node.js, Java, C#, Go, Rust, ...).
• Transport: Uses persistent connections. Currently TCP is supported. WebSockets, Named Pipes, Unix Domain Sockets, Standard I/O (stdio), Streamable HTTP, and SSL/TLS encryption are in development.
• Multiplexing: The architecture supports sharing a single physical connection for multiple library instances (Connection Multiplexing), reducing resource usage.
• Asynchronous: Built on Python's asyncio.
• Bidirectional Communication: Allows the server to send log messages and progress updates to the client during keyword execution.
• Dependency Isolation: Enables running libraries in separate processes or containers.
• Multi-Library Support: A single server instance can host multiple Robot Framework libraries.
• Robot Framework Integration:
  • Support for argument conversion and custom converters.
  • Dynamic Initialization of libraries with arguments.
  • Error Handling with traceback support and failure modes (Fatal, Continuable, Skip).

Architecture

The project is organized as a monorepo managed by uv:

• packages/protocol: Defines the JSON-RPC 2.0 protocol messages, data structures, and types.
• packages/jsonrpcpeer: An asynchronous JSON-RPC 2.0 peer implementation using asyncio.
• packages/server: Server runtime components to host library code.
• src/JsonRpcRemote: The Robot Framework Client Library (Proxy).
• examples/: Runnable usage examples (e.g. a minimal server).
• tests/: Unit tests (tests/unit, pytest) and Robot Framework integration tests (tests/robot).

Requirements

• Python >= 3.10
• Robot Framework >= 7.0

Installation

You can install the client library using pip:

pip install robotframework-jsonrpcremote

Usage

Client (Robot Framework)

Import the JsonRpcRemote library in your Robot Framework test suite and specify the URI of the running JSON-RPC server.

*** Settings ***
Library    JsonRpcRemote    uri=tcp://127.0.0.1:8271    library_name=MyLibrary

*** Test Cases ***
Example Test
    ${result}=    My Keyword    Hello World
    Should Be Equal    ${result}    Hello World

Arguments:

• uri: The address of the remote server (default: tcp://127.0.0.1:8271).
• library_name: The name of the library to initialize on the remote server (optional).
• rpc_timeout: Connection timeout in seconds (default: 10.0).
• rpc_scope: The scope of the remote session (TEST, SUITE, GLOBAL). Default is SUITE.
• *args: Positional arguments passed to the remote library initialization.
• **kwargs: Keyword arguments for the remote library initialization (sent as Robot name=value arguments and converted server-side via the library's __init__ signature).

Server

The simplest option is the ready-made server package, which hosts your existing Robot Framework libraries without code changes:

pip install robotframework-jsonrpcremote-server
robot-jsonrpcremote-server --port 8271 MyLibrary

See packages/server for all CLI options. For a hand-written server, check the examples/simple-robot-jsonrpcserver directory in this repository.

License

This project is licensed under the Apache-2.0 License.