RobotFramework-Zoomba
What is RobotFramework-Zoomba?
Robotframework-Zoomba is a collection of libraries spanning GUI, REST API, and SOAP API automation using Robot Framework. These libraries are extensions of existing libraries SeleniumLibrary, Requests, and SudsLibrary.
Zoomba adds a significant amount of data validation support for REST and SOAP API and extends functionality for typical Web GUI automation.
As a team beginning the journey of automation with Robot Framework - we found that there was some time spent ramping up our libraries and Robotframework-Zoomba aims to make that process easier for new projects.
See the Keyword Documentation for the API, SOAP, or GUI library for more specific information about the functionality.
Example tests can be found in the samples directory.
Some Features of the Library
GUI Library:
When working with web pages of varying load times you probably find yourself running a lot of calls like so:
Wait Until Page Contains Element locator
Click Element locator
For ease of use we have combined a lot of these into simple one line keywords:
Wait For And Click Element locator
Wait For And Click Text text
Wait For And Select From List list_locator target_locator
Another keyword that is particularly useful is for when you are waiting for javascript to complete on a page before proceeding:
Wait For And Click Element locator that leads to a new page with javascript
Wait Until Javascript Is Complete
Wait For And Click Element locator
API Library:
This library wraps the requests library so we have created a set of keywords to easily allow users to make requests in a single keyword:
Call Get Request ${headers_dictionary} endpoint query_string
Call Post Request ${headers_dictionary} endpoint query_string ${data_payload}
After receiving your data we made it incredibly easy to validate it. Validate Response Contains Expected Response takes your received request and compares it to your expected data. If there are any errors found it will report line by line what they are.
Validate Response Contains Expected Response ${json_actual_response} ${json_expected_response}
If there is any mismatched data it will look something like this:
Key(s) Did Not Match:
------------------
Key: pear
Expected: fish
Actual: bird
------------------
Full List Breakdown:
Expected: [{'apple': 'cat', 'banana': 'dog', 'pear': 'fish'}, {'apple': 'cat', 'banana': 'mice', 'pear': 'bird'}, {'apple': 'dog', 'banana': 'mice', 'pear': 'cat'}]
Actual: [{'apple': 'cat', 'banana': 'dog', 'pear': 'bird'}]
Please see differing value(s)
If you wanted to ignore a key such as the 'update_date' you would simply set the 'ignored_keys' variable to that key or a list of keys:
Validate Response Contains Expected Response ${json_actual_response} ${json_expected_response} ignored_keys=update_date
Validate Response Contains Expected Response ${json_actual_response} ${json_expected_response} ignored_keys=${list_of_keys}
Getting Started
The Zoomba library is easily installed using the setup.py file in the home directory.
Simply run the following command to install Zoomba and it's dependencies:
pip install robotframework-zoomba
If you decide to pull the repo locally to make contributions or just want to play around with the code you can install Zoomba by running the following from the root directory:
pip install .
or if you intend to run unit tests:
pip install .[testing]
To access the keywords in the library simply add the following to your robot file settings (depending on what you need):
*** Settings ***
Library Zoomba.APILibrary
Library Zoomba.GUILibrary
Library Zoomba.SOAPLibrary
Examples
Example tests can be found in the samples directory.
The test directory may also contain tests but be aware that these are used for testing releases and may not be as straight forward to use as the ones in the samples directory.
Contributing
To make contributions please refer to the CONTRIBUTING guidelines.
See the .githooks directory for scripts to help in development.
Support
General Robot Framework questions should be directed to the community forum.
For questions and issues specific to Zoomba please create an issue here on Github.
6 maintainers
Metadata
6 maintainers
Release files for robotframework-zoomba 4.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| robotframework_zoomba-4.6.1.tar.gz | 25.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| robotframework_zoomba-4.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.4 kB
Release files / robotframework_zoomba-4.6.1.tar.gz
| Download URL | robotframework_zoomba-4.6.1.tar.gz |
|---|---|
| Size | 25.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
323fa7cc3d9b7107d53ec8882b96bc7b9bd87ca4caab9936c1900d074c4717ca
|
|
BLAKE2b-256 checksum How to use checksums |
4a8e90162652d6e9d44363f0af97f8c0a346873c8e48404b4eee7377593a0ca1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / robotframework_zoomba-4.6.1-py3-none-any.whl
| Download URL | robotframework_zoomba-4.6.1-py3-none-any.whl |
|---|---|
| Size | 24.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0e02b046154520015e45984851083fcb769a1613b11e8bb6288dae4db5a26d67
|
|
BLAKE2b-256 checksum How to use checksums |
4e4245785c234ccd3e7413ede4c6942cbb903b5b94ef0a0d211128bcf6858d58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
