robotframework-dashboard 2.1.0

Output processor and dashboard generator for Robot Framework output files

📊 Robot Framework Dashboard

Before reading anything else here is a Fully Functioning Dashboard you can checkout right away!

🎯 Overview

Robot Framework Dashboard is a tool for Robot Framework that provides insight of your test results across multiple runs. The tool makes use of the built in Robot Framework Result Visitor API to analyse output.xml files, stores these in a simple sqlite3 database and finally creates a HTML dashboard that makes use of Chart.js and Datatables for the graphs and tables and makes use of Bootstrap for styling. Additionally GridStack is used for the interactive layout grids.

🚀 Getting Started

Installation

Install Robot Framework 6.0 or higher (if not already installed):

pip install robotframework

Install Robot Framework Dashboard:

pip install robotframework-dashboard

Install Robot Framework Dashboard with Server:

pip install robotframework-dashboard[server]
# or use
pip install robotframework-dashboard[all]

Basic Usage

Example 1 — Add a single output file and generate a dashboard:

robotdashboard -o output.xml

This adds output.xml to the default database (robot_results.db) and generates a self-contained HTML dashboard file you can open directly in any browser.

Example 2 — Add multiple output files with a custom database and dashboard name:

robotdashboard -o output1.xml -o output2.xml -d my_results.db -n my_dashboard.html

This processes two output XML files, stores results in my_results.db, and writes the dashboard to my_dashboard.html.

For all available CLI options see the Basic CLI docs and Advanced CLI & Examples.

🔍 Key Features

• 🏃 Multi-run Analysis - Compare and track results across multiple Robot Framework test runs.
• 🌐 Interactive HTML Dashboard - Fully interactive dashboard using Chart.js, Datatables, and GridStack.
• 🗄️ SQLite Database Storage - Lightweight database for easy querying and persistent storage.
• 📄 Dashboard Pages - Overview, Dashboard, and Compare pages for multi-level insights.
• 🎛️ Customizable Layouts - Drag-and-drop sections with adjustable size and order.
• 📊 Graph Customization - Toggle legends, axis titles, labels, and control animations.
• 🔎 Global Filters - Filter runs by name, tags, date, metadata, or quantity.
• ⚖️ Comparison Mode - Compare up to 4 runs side by side with visual statistics.
• 🔗 Automatic Log Linking - Open Robot Framework logs directly from the dashboard.
• 🛠️ Custom Database Classes - Extend or replace the database processor for custom backends.
• 🖥️ Server Mode - Host your dashboard for multi-user access and automatic updates.
• 🎧 Listener Integration - Automatically updates dashboard after every test run.
• 📝 Message Config Support - Group similar test failures using regex-based patterns.
• ⚙️ Configurable Defaults - Preload dashboard settings via JSON for consistent appearance.

…and many more advanced features to help you visualize, analyze, and manage your Robot Framework test results with ease!

📖 Read the Docs

For detailed usage instructions, advanced examples, and full documentation, visit the official robotdashboard docs!

Quick Links

• 🚀 Getting Started - Quick setup instructions to install Robot Framework and RobotFramework Dashboard, and verify it is working.
• 📦 Installation & Version Info - Install the dashboard via pip, check Python and Robot Framework requirements, and view version information.
• 💻 Basic Command Line Interface (CLI) - Manage your test results database, add output XML files, remove runs, and generate dashboards directly from the command line.
• ⚡ Advanced CLI & Examples - Advanced usage examples including combined commands, tagging strategies, aliases, batch imports, message configuration, and performance tips.
• 🗂️ Tabs / Pages - Explore the dashboard's interactive pages including Overview, Dashboard, Compare, and detailed suite/test/keyword views.
• 📊 Graphs & Tables - View and filter detailed statistics for runs, suites, tests, and keywords using charts, tables, and summary visualizations.
• 🔍 Filtering - Apply filters to analyze trends in your test data and highlight specific tags, amounts or datetime ranges.
• 🎨 Customization - Customize dashboard sections, graph layouts, and visualizations to suit your workflow.
• ⚙️ Settings - Configure dashboard preferences including themes, default views, graph options, and save your settings for consistent team-wide use.
• 🖥️ Dashboard Server - Host the dashboard for multi-user access, programmatic updates, and remote server integration.
• 🗄️ Custom Database Class - Extend or replace the default database backend to suit your storage needs, including SQLite, MySQL, or custom implementations.
• 🔔 Listener Integration - Use a listener to automatically push test results to the dashboard for every executed run, integrating seamlessly into CI/CD pipelines.
• 📂 Log Linking - Enable clickable log navigation from dashboard graphs, covering file naming conventions, local and server usage, and remote log uploads.

🛠️ Contributions

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. Additional information can be found here in Contributing

📋 License

This project is licensed under the MIT License.

Note: This project is not officially affiliated with or endorsed by Robot Framework.