Skip to content

Robotmk/example-rf-custom-library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rf-custom-library

This repository provides a working example to learn and test Robot Framework automation - the test scripting language used by Robotmk for Synthetic Monitoring in Checkmk.

How to Run the example

Run online in a VS Code Devcontainer (recommended)

This is the easiest way to run the example — no local installation needed. Just click the button below:

Run this Robot in GitHub Codespaces

How to run the example in Codespace

What is a GitHub Codespace?
A Codespace is a browser-based development environment (VS Code) hosted by GitHub — no local installation needed.

Manually with RCC

To run the example manually, refer to the blog post with the step-by-step instructions:
How to Run Robot Framework Examples with RCC
Troubleshooting RCC

About this Robot Framework test

Minimal example for extending Robot Framework with a custom Python library. Demonstrates how to write a simple Python class, expose its methods as keywords via the @keyword decorator, and import the library directly into a suite.

  • Writing a custom Robot Framework library as a plain Python class (CustomLibrary.py)
  • Exposing Python methods as RF keywords with @keyword from robot.api.deco
  • Importing a local .py file as a library in a suite (Library CustomLibrary.py)
  • Handling type conversion for keyword arguments (string → int)

Test Cases

Test Case Description
Test Hello Calls the Say Hello keyword and logs a greeting
Test Addition Calls Add Numbers with two integers and logs the result

Links

Recommended links for this example

General links & Documentation

Libraries and Versions used in this example

Library Version
Python 3.12
Robot Framework 7.4

About

Also try the other RF example suites, they all work in the Codespace environment.

🪲 Found a bug or have a suggestion?
Open an issue or submit a pull request — contributions are welcome.

📖 Want to go deeper? Want ot get a certified professional?
→ I offer Synthetic Monitoring Trainings or book a free call.

Simon Meggle — Founder of Robotmk, Product Manager Synthetic Monitoring at Checkmk


This repository is automatically synced from elabit/robotmk-starter. Do not edit files here directly — changes will be overwritten on the next sync. Last sync: b9e1a9b


About

Robot Framework example (synced from elabit/robotmk-starter)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors