THIS REPO IS DEPRECATED. IT WAS MOVED HERE
Qase TMS Robot Framework Listener
pip install qase-robotframework
You must add Qase case IDs to robot framework tests.
They should be added as a tags in form like Q-<case id without project code>
. Examples:
*** Test Cases ***
Push button
[Tags] Q-2
Push button 1
Result should be 1
Push multiple buttons
[Tags] Q-3
Push button 1
Push button 2
Result should be 12
*** Test Cases *** Expression Expected
Addition 12 + 2 + 2 16
2 + -3 -1
[Tags] Q-7
Subtraction 12 - 2 - 2 8
2 - -3 5
[Tags] Q-8
After adding new tags and configuring listener - you could simply use it like this:
robot --listener qaseio.robotframework.Listener keyword_driven.robot data_driven.robot
Listener supports loading configuration both from environment variables and from tox.ini
file.
ENV variables:
QASE_API_TOKEN
- API token to access Qase TMSQASE_PROJECT
- Project code from Qase TMSQASE_RUN_ID
- Run ID if you want to add results to existing runQASE_RUN_NAME
- Set custom run name when no run ID is providedQASE_DEBUG
- If passed something - will enable debug logging for listener
Usage:
QASE_API_TOKEN=<API TOKEN> QASE_PROJECT=PRJCODE robot --listener qaseio.robotframework.Listener keyword_driven.robot data_driven.robot
tox.ini
configuration:
[qase]
qase_api_token=<API TOKEN>
qase_project=PROJECTCODE
qase_run_id=14
qase_run_name=New Robot Framework Run
qase_debug=True
Listener supports reporting steps results: But in order to use it, you should follow some rules:
- Steps name in Qase TMS should match to the steps in Robot Framework
- If step in RF has some parameters (e.g. Push Button
12
) parameter would be ignored and the comparison to step in TMS will be made like: step in TMS should start with step name in RF. So if your step in RF isOpen page
it will be matched to stepOpen page https://qase.io
in TMS. - You should preserve the order of steps. You can skip steps in RF, but you shouldn't mix them or so on - Qase does not support creating steps on the fly yet.
Install project locally:
python3 -m venv .venv
source .venv/bin/activate
pip install -e .[testing]
Install dev requirements:
pip install pre-commit
pre-commit install
Test project:
tox