# Robot Framework Dashboard
## Overview
The Robot Framework Dashboard is a tool for [Robot Framework](https://robotframework.org/) that provides insight of your test results across multiple runs. The tool makes use of the built in Robot Framework [Result Visitor API](https://robot-framework.readthedocs.io/en/stable/_modules/robot/result/visitor.html) to analyse output.xml files, stores these in a simple sqlite3 database and finally creates a HTML dashboard that makes use of [Chart.js](https://www.chartjs.org/docs/latest/) and [Datatables](https://datatables.net/) for the graphs and tables and makes use of [Bootstrap](https://getbootstrap.com/) for styling.
If you need help, have suggestions or want to discuss anything, feel free to contact through the [Slack Channel](https://robotframework.slack.com/archives/C07SPR6N9AB).
## Command Line Features
When running the tool the following steps will be executed
1. Database preparation creates robot_results.db or specified database if it does not yet exist and connects to it
2. Optionally reads test execution result from 1 or more output XML file(s) and uploads to the database
3. Optionally lists all runs currently available in the database, ordered by the time they were entered
4. Optionally removes run(s) specified by run_date or index of being added
5. Optionally generates a dashboard HTML file that can be used to look at the stored results
## Dashboard HTML Features
The Robot Framework Dashboard HTML will provide information across your runs across all levels.
Currently available features:
- Global filters: run, run tag, run date
- Runs
- Statistics: pass, fail, skip
- Duration: total elapsed time
- Overview: table overview of runs
- Suites
- - Filter: suite
- Statistics: pass, fail, skip
- Duration: total elapsed time
- Most failed: top 10 failing suites
- Overview: table overview of suites
- Tests
- Filter: suite, test
- Statistics: pass, fail, skip
- Duration: total elapsed time
- Most failed: top 10 failing tests
- Fail messages: top 10 fail messages
- Overview: table overview of tests
- Keywords
- Filter: keywords
- Keyword statistics: pass, fail, skip
- Keyword times run
- Keyword total duration
- Keyword average duration
- Keyword min duration
- Keyword max duration
- Overview: table overview of keywords
## Installation
1. Install Robot Framework 6.0 or higher (if not already installed):
2. Install Robot Framework Dashboard
```
pip install robotframework-dashboard
```
Version details:
- Tested robot versions: 6.0, 6.0.1, 6.0.2, 6.1, 6.1.1, 7.0, 7.0.1, 7.1, 7.1.1
- When running robotdashboard with robot 6.x installed, output files that are generated by robot 7.x will have no duration fields when processed, this is caused by changes in the Result Visitor model
- When running robotdashboard with robot 7.x installed every output generated by any version above should be processed correctly
## Usage
Run robotdashboard through the command line to initialize your database and generate the report:
```
robotdashboard -o output.xml
```
For detailed command line options take a look at:
```
robotdashboard -h
```
or
```
robotdashboard --help
```
Advanced examples:
- Generate the report without adding new outputs
```
robotdashboard
```
- Add tags to your output.xmls
```
robotdashboard -o output1.xml:tag1 -o reports/output2.xml:tag1:tag2
```
- Add all \*output\*.xml in an entire folder tree to the database and provide all these runs with tags
```
robotdashboard -f ./reports
robotdashboard -f ../../some_folder/sub_folder/logs
robotdashboard -f C:/nightly_runs:tag1:tag2:tag3
```
- Do not list runs and/or do not create the dashboard HTML
```
robotdashboard -l false -g false
```
- Custom path/file name for your dashboard HTML
```
robotdashboard -n results/result_robot_dashboard.html
```
- Custom database path/file location
```
robotdashboard -d result_data/robot_result_database.db
```
- Remove data from the database, can be based on run number (index) or run start time
```
robotdashboard -r 0
robotdashboard -r -1 -r "2024-10-17 15:05:04.563559"
```
## Example usage output
This is an example after running robotdashboard for the first time. 3 outputs are added, stored and processed in the dashboard HTML.
Input:
```
robotdashboard -o output1.xml -o output2.xml -o output3.xml
```
Results:
```
==============================================================================
1. Database preparation
created database connection: './robot_results.db'
==============================================================================
2. Processing output XML(s)
Processing output XML 'output1.xml'
Processed output XML 'output1.xml' in 0.04 seconds
Processing output XML 'output2.xml'
Processed output XML 'output2.xml' in 0.05 seconds
Processing output XML 'output3.xml'
Processed output XML 'output3.xml' in 0.05 seconds
==============================================================================
3. Listing all available runs in the database
Run 0 | 2024-10-17 15:05:04.563559 | RobotFramework-Project1
Run 1 | 2024-10-18 16:43:12.772757 | Robotframework-Project2
Run 2 | 2024-10-21 10:54:25.663094 | Robotframework-Project1
==============================================================================
4. Removing runs from the database
skipping step
==============================================================================
5. Creating dashboard HTML
created dashboard './robot_dashboard_20241021-150726.html' in 0.01 seconds
```
## Contributing
Contributions are welcome! If you encounter any issues, have suggestions for improvements, or would like to add new features, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License.
Note: This project is not officially affiliated with or endorsed by robotframework.
Raw data
{
"_id": null,
"home_page": "https://github.com/timdegroot1996/robotframework-dashboard",
"name": "robotframework-dashboard",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "robotframework dashboard reporting database",
"author": "Tim de Groot",
"author_email": "tim-degroot@live.nl",
"download_url": "https://files.pythonhosted.org/packages/6f/d3/4ef5738046739b87347e53d22fa9c12ddaa11b318508ceba9c17bf808e07/robotframework_dashboard-0.4.1.tar.gz",
"platform": null,
"description": "# Robot Framework Dashboard\r\n\r\n## Overview\r\n\r\nThe Robot Framework Dashboard is a tool for [Robot Framework](https://robotframework.org/) that provides insight of your test results across multiple runs. The tool makes use of the built in Robot Framework [Result Visitor API](https://robot-framework.readthedocs.io/en/stable/_modules/robot/result/visitor.html) to analyse output.xml files, stores these in a simple sqlite3 database and finally creates a HTML dashboard that makes use of [Chart.js](https://www.chartjs.org/docs/latest/) and [Datatables](https://datatables.net/) for the graphs and tables and makes use of [Bootstrap](https://getbootstrap.com/) for styling.\r\n\r\nIf you need help, have suggestions or want to discuss anything, feel free to contact through the [Slack Channel](https://robotframework.slack.com/archives/C07SPR6N9AB).\r\n\r\n## Command Line Features\r\n\r\nWhen running the tool the following steps will be executed\r\n\r\n1. Database preparation creates robot_results.db or specified database if it does not yet exist and connects to it\r\n2. Optionally reads test execution result from 1 or more output XML file(s) and uploads to the database\r\n3. Optionally lists all runs currently available in the database, ordered by the time they were entered\r\n4. Optionally removes run(s) specified by run_date or index of being added\r\n5. Optionally generates a dashboard HTML file that can be used to look at the stored results\r\n\r\n## Dashboard HTML Features\r\n\r\nThe Robot Framework Dashboard HTML will provide information across your runs across all levels.\r\nCurrently available features:\r\n\r\n- Global filters: run, run tag, run date\r\n- Runs\r\n - Statistics: pass, fail, skip\r\n - Duration: total elapsed time\r\n - Overview: table overview of runs\r\n- Suites\r\n- - Filter: suite\r\n - Statistics: pass, fail, skip\r\n - Duration: total elapsed time\r\n - Most failed: top 10 failing suites\r\n - Overview: table overview of suites\r\n- Tests\r\n - Filter: suite, test\r\n - Statistics: pass, fail, skip\r\n - Duration: total elapsed time\r\n - Most failed: top 10 failing tests\r\n - Fail messages: top 10 fail messages\r\n - Overview: table overview of tests\r\n- Keywords\r\n - Filter: keywords\r\n - Keyword statistics: pass, fail, skip\r\n - Keyword times run\r\n - Keyword total duration\r\n - Keyword average duration\r\n - Keyword min duration\r\n - Keyword max duration\r\n - Overview: table overview of keywords\r\n\r\n## Installation\r\n\r\n1. Install Robot Framework 6.0 or higher (if not already installed):\r\n2. Install Robot Framework Dashboard\r\n\r\n```\r\npip install robotframework-dashboard\r\n```\r\n\r\nVersion details:\r\n - Tested robot versions: 6.0, 6.0.1, 6.0.2, 6.1, 6.1.1, 7.0, 7.0.1, 7.1, 7.1.1\r\n - When running robotdashboard with robot 6.x installed, output files that are generated by robot 7.x will have no duration fields when processed, this is caused by changes in the Result Visitor model\r\n - When running robotdashboard with robot 7.x installed every output generated by any version above should be processed correctly\r\n\r\n## Usage\r\n\r\nRun robotdashboard through the command line to initialize your database and generate the report:\r\n```\r\nrobotdashboard -o output.xml\r\n```\r\nFor detailed command line options take a look at:\r\n```\r\nrobotdashboard -h\r\n```\r\nor\r\n```\r\nrobotdashboard --help\r\n```\r\nAdvanced examples:\r\n- Generate the report without adding new outputs\r\n```\r\nrobotdashboard\r\n```\r\n- Add tags to your output.xmls\r\n```\r\nrobotdashboard -o output1.xml:tag1 -o reports/output2.xml:tag1:tag2\r\n```\r\n- Add all \\*output\\*.xml in an entire folder tree to the database and provide all these runs with tags\r\n```\r\nrobotdashboard -f ./reports\r\nrobotdashboard -f ../../some_folder/sub_folder/logs\r\nrobotdashboard -f C:/nightly_runs:tag1:tag2:tag3\r\n```\r\n- Do not list runs and/or do not create the dashboard HTML\r\n```\r\nrobotdashboard -l false -g false\r\n```\r\n- Custom path/file name for your dashboard HTML\r\n```\r\nrobotdashboard -n results/result_robot_dashboard.html\r\n```\r\n- Custom database path/file location\r\n```\r\nrobotdashboard -d result_data/robot_result_database.db\r\n```\r\n- Remove data from the database, can be based on run number (index) or run start time\r\n```\r\nrobotdashboard -r 0\r\nrobotdashboard -r -1 -r \"2024-10-17 15:05:04.563559\"\r\n```\r\n\r\n## Example usage output\r\nThis is an example after running robotdashboard for the first time. 3 outputs are added, stored and processed in the dashboard HTML.\r\n\r\nInput:\r\n```\r\nrobotdashboard -o output1.xml -o output2.xml -o output3.xml\r\n```\r\nResults:\r\n```\r\n==============================================================================\r\n 1. Database preparation\r\n created database connection: './robot_results.db'\r\n==============================================================================\r\n 2. Processing output XML(s)\r\n Processing output XML 'output1.xml'\r\n Processed output XML 'output1.xml' in 0.04 seconds\r\n Processing output XML 'output2.xml'\r\n Processed output XML 'output2.xml' in 0.05 seconds\r\n Processing output XML 'output3.xml'\r\n Processed output XML 'output3.xml' in 0.05 seconds\r\n==============================================================================\r\n 3. Listing all available runs in the database\r\n Run 0 | 2024-10-17 15:05:04.563559 | RobotFramework-Project1\r\n Run 1 | 2024-10-18 16:43:12.772757 | Robotframework-Project2\r\n Run 2 | 2024-10-21 10:54:25.663094 | Robotframework-Project1\r\n==============================================================================\r\n 4. Removing runs from the database\r\n skipping step\r\n==============================================================================\r\n 5. Creating dashboard HTML\r\n created dashboard './robot_dashboard_20241021-150726.html' in 0.01 seconds\r\n```\r\n\r\n## Contributing\r\nContributions are welcome! If you encounter any issues, have suggestions for improvements, or would like to add new features, feel free to open an issue or submit a pull request.\r\n\r\n## License\r\nThis project is licensed under the MIT License.\r\n\r\nNote: This project is not officially affiliated with or endorsed by robotframework.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Output processor and dashboard generator for Robot Framework output files",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://github.com/timdegroot1996/robotframework-dashboard"
},
"split_keywords": [
"robotframework",
"dashboard",
"reporting",
"database"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b668562bc93b886b79b4de560a18cdfb44103259c4fc4e981d32fe04d0e8a33",
"md5": "1fa60def5b05e5ac9db738c0428b7421",
"sha256": "8f05cd55b1ea0536ca28ec9fceaf2493567a35d3211771bac1d2d6ff058a0d8f"
},
"downloads": -1,
"filename": "robotframework_dashboard-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1fa60def5b05e5ac9db738c0428b7421",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23693,
"upload_time": "2024-11-15T16:10:28",
"upload_time_iso_8601": "2024-11-15T16:10:28.768921Z",
"url": "https://files.pythonhosted.org/packages/3b/66/8562bc93b886b79b4de560a18cdfb44103259c4fc4e981d32fe04d0e8a33/robotframework_dashboard-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6fd34ef5738046739b87347e53d22fa9c12ddaa11b318508ceba9c17bf808e07",
"md5": "d3b1a5efd72ff6e7541b66d2b5e9f1f5",
"sha256": "b5822768296a0f1702717a48aac001e1564bf2c3cadf8eec5b95932c920d010e"
},
"downloads": -1,
"filename": "robotframework_dashboard-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "d3b1a5efd72ff6e7541b66d2b5e9f1f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23916,
"upload_time": "2024-11-15T16:10:30",
"upload_time_iso_8601": "2024-11-15T16:10:30.468860Z",
"url": "https://files.pythonhosted.org/packages/6f/d3/4ef5738046739b87347e53d22fa9c12ddaa11b318508ceba9c17bf808e07/robotframework_dashboard-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 16:10:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "timdegroot1996",
"github_project": "robotframework-dashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "robotframework-dashboard"
}
JSON
