Skip to content

A curated list of Robot Framework recipes to help beginner and intermediate engineers create test automation scripts faster.

License

Notifications You must be signed in to change notification settings

adrianyorke/robotframework-cookbook

Repository files navigation


robotframework-cookbook

All Contributors

Actions Status License: MIT code style: black Maintenance

A curated list of delicious Robot Framework recipes that will help accelerate the development of test automation scripts, especially for beginner or intermediate level engineers.

If you need help writing Robot Framework scripts or wish to update older scripts to use newer syntax then you have come to the right place. Here we will compile and maintain recipes of working Robot Framework scripts that can be used in your domain.

In the first part of the cookbook there are many simple recipes showing how to use builtin keywords and additional keywords from both internal and external Robot Framework libraries. Towards the back of the cookbook there are complete case studies demonstrating whole projects and test automation solutions.

Other useful resources

Star History

Notes for contributors

Contributions from the wider community are most welcome! Contributions can be either single recipes or whole case studies.

We recommend using Robotidy to help standardise the format of the Robot Framework code.

We also recommend using the Robot Framework Robocop static analysis tool to check your scripts are clean before submission. Robocop can be installed using pip:

$ python -m pip install -U robotframework-robocop

Issues are welcome and you can use them to post ideas for new recipes or report bugs and other observations for exisiting recipes.

For larger submissions simply clone this repository, create a feature branch (or work directly on master) and submit a pull request to merge your branch. If you are not comfortable with Git workflow then simply post your submission on the #cookbook Slack channel and I will help you publish your recipe or case study.

Installation and Usage

Python and Robot Framework must be installed prior to using Robot Framework Cookbook. Download Python and add to PATH during installation, then, use a command-line interpreter of your choice and run the following to install Robot Framework:

$ python -m pip install -U robotframework

You can check if the installation was succesful by running the following command:

$ robot --version

After confirming Robot Framework installation was a success, clone the Robot Framework Cookbook repository by running the following command:

$ git clone https://github.com/adrianyorke/robotframework-cookbook.git

Once the repository has been cloned, you can install relevant libraries by navigating to the tests folder and running:

$ python -m pip install -U -r ./tests/requirements-[version].txt

Table of contents

  1. Standard Library - BuiltIn
  2. Standard Library - Collections
  3. Standard Library - DateTime
  4. Standard Library - OperatingSystem
  5. Standard Library - Process
  6. Standard Library - Remote
  7. Standard Library - String
  8. Standard Library - XML
  9. External Library - REST API
  10. External Library - Databases
  11. External Library - SSH
  12. External Library - Parallel executor for Robot Framework test cases (pabot)
  13. External Library - SeleniumLibrary and SeleniumTestability
  14. External Library - AWSLibrary - for interacting with Amazon Web Services (AWS) Cloud Computing Services
  15. External Library - Robot Framework Browser library powered by Playwright.
  16. Robot Framework 4
  17. Case Studies

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Adrian Yorke
Adrian Yorke

💻 📖 🚧 👀
Tom Purl
Tom Purl

💻 📖
Szabolcs Tóth
Szabolcs Tóth

💻 📖
Jani Mikkonen
Jani Mikkonen

💻 📖
Bartłomiej Hirsz
Bartłomiej Hirsz

💻 📖 🚧 👀
Christoph
Christoph

💻 📖
Mikko Korpela
Mikko Korpela

💻 📖
ericbjones
ericbjones

🎨 💻 📖
Emna Ayadi
Emna Ayadi

📓 💻
Joonas Venäläinen
Joonas Venäläinen

💻
Aleksandra Kowalczyk
Aleksandra Kowalczyk

💻
Martin Škopek
Martin Škopek

💻
sarafurd
sarafurd

📖 🚧
Jeff Choi
Jeff Choi

📖 🚧
ChinoUkaegbu
ChinoUkaegbu

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

A curated list of Robot Framework recipes to help beginner and intermediate engineers create test automation scripts faster.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks