Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marketsquare/robotframework-webservice
Webservice for running Robot Framework test cases.
https://github.com/marketsquare/robotframework-webservice
fastapi python robotframework
Last synced: 13 days ago
JSON representation
Webservice for running Robot Framework test cases.
- Host: GitHub
- URL: https://github.com/marketsquare/robotframework-webservice
- Owner: MarketSquare
- License: apache-2.0
- Created: 2021-05-10T12:44:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T14:24:18.000Z (6 months ago)
- Last Synced: 2025-01-23T07:33:53.296Z (14 days ago)
- Topics: fastapi, python, robotframework
- Language: Python
- Homepage:
- Size: 173 KB
- Stars: 23
- Watchers: 5
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pypi.com/project/robotframework-webservice/) [](https://pypi.python.org/pypi/robotframework-webservice/) [](https://pypi.python.org/pypi/robotframework-webservice/)
# Robot Task Webservice
A web service managing Robot Framework tasks/tests.
# Goal
This web service shall start Robot Framework tasks/tests and return and cache the according reports.
# Installation and Execution
## Docker
You can run the image and map your test cases into the webservice with a volume :
```
docker run --rm --publish 5003:5003 \
--volume :/robot/tests \
--env SUITE_FOLDER=tests \
ghcr.io/marketsquare/robotframework-webservice:master
```
You can also run the image and map your test cases and your variable files (separated by spaces) into the webservice with volumes :
```
docker run --rm --publish 5003:5003 \
--volume :/robot/tests \
--volume :/robot/variables \
--env SUITE_FOLDER=tests \
--env "VARIABLE_FILES=variables/variables.py variables/variables2.py" \
ghcr.io/marketsquare/robotframework-webservice:master
```
## Podman
Almost as Docker, but you might need to attach the webservice to the host network:
```
podman run --network host -v ./examples:/robot/tasks --env SUITE_FOLDER=tasks rf-webservice:latest
```
## Local
```
pip install robotframework-webservice
```
and execute from command line:
```
python -m RobotFrameworkService.main -p 5003 -t path_to_my_taskfolder
```
# Usage
There are 2 types of endpoints:
1. Execution
2. Reporting
## Execution
Endpoints that trigger execution of a robot task/test, for instance:
Call robot task/test:
http://localhost:5003/robotframework/run/mytask
Call robot task/test with variables:
http://localhost:5003/robotframework/run/mytask?myVariable1=42&anotherVariable=Mustermann
Response contains a header field `x-request-id` that can be used to retrieve logs and reports of this execution asynchronously (see reporting endpoints)
There are endpoints for synchronous and asynchronous request:
```
# connection remains open for duration of my task/test
http://localhost:5003/robotframework/run/mytask
# connection closes immediately - result must be requested with the x-request-id
http://localhost:5003/robotframework/run/mytask/async
```
There is also the all-in-one endpoint `POST http://localhost:5003/robotframework/run` which trigger execution of a robot files, test, task or suite.
It can be customized with options in JSON payload.
All available options are documented in Swagger schema and examples.
Response contains a header field `x-request-id` that can be used to retrieve logs and reports.
By default, execution is asynchronous, but it can be changed with **sync** option.
**There is no limitation on executed Robot processes! It is easy to push the webservice in DOS with too many requests at once**
### Call robot test
```
curl -X 'POST' \
'http://localhost:5003/robotframework/run' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"paths": [
"examples"
],
"test": "Demonstration Test"
}'
```
### Call robot task
```
curl -X 'POST' \
'http://localhost:5003/robotframework/run' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"paths": [
"examples"
],
"task": "Demonstration Task"
}'
```
### Call robot task with variables
```
curl -X 'POST' \
'http://localhost:5003/robotframework/run' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"paths": [
"examples"
],
"task": "Task with more variables",
"variables": {
"firstname": "Max",
"lastname": "Mustermann"
}
}'
```
## Reporting
Endpoints that provide `log.html` and `report.html` for a specific task execution. You require the `x-request-id` from a previous response that triggered the execution.
# Start web service
The web service starts automatically with uvicorn inside. Simply call:
python -m RobotFrameworkService.main
You can check available options with
python -m RobotFrameworkService.main --help
## Example:
python -m RobotFrameworkService.main -p 5003 -t path_to_my_taskfolder
## Example - Variablefiles:
You can provide variable files that are passed to all robot suites on execution:
python -m RobotFrameworkService.main -p 5003 -t path_to_my_taskfolder --variablefiles config/env/test.py
# Custom WSGI server
You can start RobotFrameworkService with bare WSGI servers:
uvicorn RobotFrameworkService.main:app --port 5003
Or start web service with other WSGI server, i.e waitress:
waitress-serve --port 5003 RotbotFrameworkService.main:app
# SwaggerUi
Swagger-UI is available under `http://localhost:5003/docs`
# Demo-Tasks
This project contains some tasks, tests and variables for demonstration. They are located in ``examples`` folder. You may add
your own task/test suites in that directory, if you like.
# Task name with spaces in URL
Tasks may contain spaces, URL must not. Luckily, Robot Framework supports CamelCase as well as snake_case syntax.
Meaning: "Another Task" can be trigger in url with parameter `AnotherTask` or ``another_task``