Skip to content

Commit

Permalink
Merge pull request #82 from timdegroot1996/main
Browse files Browse the repository at this point in the history
feat: Added Robot Framework Dashboard to Reporting Test Results
  • Loading branch information
MobyNL authored Feb 16, 2025
2 parents 47290ed + c1ae999 commit d863514
Show file tree
Hide file tree
Showing 8 changed files with 83 additions and 43 deletions.
43 changes: 0 additions & 43 deletions website/docs/reporting_alternatives.md

This file was deleted.

3 changes: 3 additions & 0 deletions website/docs/reporting_test_results/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Reporting Test Results"
}
11 changes: 11 additions & 0 deletions website/docs/reporting_test_results/allure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 2
sidebar_label: Allure
title: Allure
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

[Allure Report](https://allurereport.org/) is a flexible lightweight multi-language test report tool that not only shows a very concise representation of what have been tested in a neat web report form, but allows everyone participating in the development process to extract maximum of useful information from everyday execution of tests.

It is integrated with Robot Framework via a listener [robotframework-allure](https://github.com/allure-framework/allure-python). A detailed integration guide is available on the official website: https://allurereport.org/docs/robotframework/
22 changes: 22 additions & 0 deletions website/docs/reporting_test_results/grafana.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 3
sidebar_label: Grafana
title: Grafana
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Grafana can be used to visualize test results in a dashboard.
https://grafana.com/grafana/dashboards/11541-robot-framework-grafana-dashboard-part-1/

Images
![Grafana Dashboard](https://cognitiveqe.com/wp-content/uploads/2019/12/Robot_Framework_Granfana_Dashboard_Final.png)

Example with Robot Framework Testarchiver, PostgreSQL and Grafana
https://cognitiveqe.com/robot-framework-test-results-in-grafana-postgresql/

Example with Robot Framework DBbot, MySQL and Grafana
https://cognitiveqe.com/robot-framework-grafana-dashboard/

Blog post about Robot Framework, Jenkins Plugin, InfluxDB and Grafana
https://www.eficode.com/blog/rf-jenkins-grafana
14 changes: 14 additions & 0 deletions website/docs/reporting_test_results/report_portal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 1
sidebar_label: Report Portal
title: Report Portal
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

[Report Portal](https://reportportal.io/) is an AI-powered Test Automation Dashboard to acquire, aggregate and analyze test reports
to ascertain release health.

It is integrated with Robot Framework via a listener [robotframework-reportportal](https://github.com/reportportal/agent-Python-RobotFramework) or via a [python script](https://github.com/reportportal/agent-Python-RobotFramework/blob/master/robotframework_reportportal/post_report.py)

<iframe width="560" height="315" src="https://www.youtube.com/embed/Xci19TAiO50" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
21 changes: 21 additions & 0 deletions website/docs/reporting_test_results/robot_framework_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 5
sidebar_label: Robot Framework Dashboard
title: Robot Framework Dashboard
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

[Robot Framework Dashboard](https://github.com/timdegroot1996/robotframework-dashboard) is a powerful tool for analyzing and visualizing test results across multiple Robot Framework runs. It processes output XML files, stores test execution data in a SQLite database, and generates an interactive HTML dashboard. The dashboard utilizes Chart.js, Datatables, and Bootstrap for clear and structured visual representation.

![Dashboard](/img/robotdashboard.png)

Key Features:
- Command-Line Interface: Provides options to upload runs, list runs, remove runs, and generate dashboards.
- Customization: Supports specifying custom database locations, dashboard filenames, and output tagging.
- Test Result Analysis: Parses Robot Framework output XML files and extracts key metrics.
- HTML Dashboard Generation: Creates an interactive dashboard with graphs and tables for detailed insights.
- Filtering and Sorting: Allows filtering by run, suite, test, keyword, and tags for precise analysis.
- Statistics & Trends: Displays pass/fail rates, durations, most failed tests, and failure messages.

The tool supports Robot Framework 6.x and 7.x, ensuring compatibility with various output formats.
12 changes: 12 additions & 0 deletions website/docs/reporting_test_results/robot_framework_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 4
sidebar_label: Robot Framework Metrics
title: Robot Framework Metrics
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

[Robot Framework Metrics](https://github.com/adiralashiva8/robotframework-metrics) creates custom HTML report (dashboard view) by parsing robotframework output.xml file

Images
![Metrics Report](https://adiralashiva8.github.io/robotframework-metrics/metrics.png)
Binary file added website/static/img/robotdashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d863514

Please sign in to comment.