diff --git a/website/docs/reporting_alternatives.md b/website/docs/reporting_alternatives.md deleted file mode 100644 index cff36cb0..00000000 --- a/website/docs/reporting_alternatives.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_label: Reporting Test Results -title: Reporting Test Results ---- - -## Other Reporting Tools and Dashboards - -### Report Portal -[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) - - - - -### Allure -[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/ - -### Grafana -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 - -### Robot Framework Metrics - -[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) diff --git a/website/docs/reporting_test_results/_category_.json b/website/docs/reporting_test_results/_category_.json new file mode 100644 index 00000000..0dd97f50 --- /dev/null +++ b/website/docs/reporting_test_results/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Reporting Test Results" +} diff --git a/website/docs/reporting_test_results/allure.md b/website/docs/reporting_test_results/allure.md new file mode 100644 index 00000000..b85f9673 --- /dev/null +++ b/website/docs/reporting_test_results/allure.md @@ -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/ \ No newline at end of file diff --git a/website/docs/reporting_test_results/grafana.md b/website/docs/reporting_test_results/grafana.md new file mode 100644 index 00000000..37a6ca3d --- /dev/null +++ b/website/docs/reporting_test_results/grafana.md @@ -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 \ No newline at end of file diff --git a/website/docs/reporting_test_results/report_portal.md b/website/docs/reporting_test_results/report_portal.md new file mode 100644 index 00000000..a787725c --- /dev/null +++ b/website/docs/reporting_test_results/report_portal.md @@ -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) + + \ No newline at end of file diff --git a/website/docs/reporting_test_results/robot_framework_dashboard.md b/website/docs/reporting_test_results/robot_framework_dashboard.md new file mode 100644 index 00000000..6c4dadd9 --- /dev/null +++ b/website/docs/reporting_test_results/robot_framework_dashboard.md @@ -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. \ No newline at end of file diff --git a/website/docs/reporting_test_results/robot_framework_metrics.md b/website/docs/reporting_test_results/robot_framework_metrics.md new file mode 100644 index 00000000..23bf26c3 --- /dev/null +++ b/website/docs/reporting_test_results/robot_framework_metrics.md @@ -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) \ No newline at end of file diff --git a/website/static/img/robotdashboard.png b/website/static/img/robotdashboard.png new file mode 100644 index 00000000..9c877532 Binary files /dev/null and b/website/static/img/robotdashboard.png differ