Skip to content

AndersHogqvist/RobotRemoteServerCpp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Robot Remote Server C++

A small C++20 library that implements the Robot Framework Remote Library XML-RPC interface. It lets a host C++ application register keywords and expose them over XML-RPC.

Build

cmake -S . -B build
cmake --build build

To build a shared library instead of a static one:

cmake -S . -B build -DBUILD_SHARED_LIBS=ON
cmake --build build

To enable the integrated HTTP documentation page (keyword list, docs, and arguments):

cmake -S . -B build -DROBOT_REMOTE_ENABLE_HTTP_SERVER=ON
cmake --build build

Example

Run the sample host:

./build/robot_remote_example

Then use a Robot Framework test with the Remote library:

robot examples/tests.robot

Note: When built with ROBOT_REMOTE_ENABLE_HTTP_SERVER=ON, open http://127.0.0.1:8270/ in a browser to view the available keywords with their description and argument specification.

API Overview

  • RemoteServer hosts the XML-RPC server and dispatches keyword calls.
  • Register keywords with set_keywords, providing name, docs, argument spec, and a handler.

The XML-RPC interface methods implemented are:

  • get_keyword_names
  • get_keyword_arguments
  • get_keyword_documentation
  • get_library_information
  • run_keyword

Documentation

Generate API docs with Doxygen (if installed):

cmake -S . -B build
cmake --build build --target docs

HTML output will be in docs/html.

About

A small C++20 library that implements the Robot Framework Remote Library XML-RPC interface.

Topics

Resources

License

Stars

Watchers

Forks

Contributors