README.md

Robot Framework Historic

Custom HTML report that tracks historical Robot Framework test results using MySQL and Flask

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Features
  • How It Works
• Getting Started
  • Installation
• Usage
  • Continuous Integration (CI) Setup
• Contact
• Acknowledgements

🌟 About the Project

Robot Framework Historic is a comprehensive tool designed to help you visualize the historical results of your Robot Framework tests. By storing execution results in a MySQL database and generating HTML reports with Flask, it provides a detailed overview of your testing history, complete with charts and statistical insights.

📷 Screenshots

🛠️ Tech Stack

• Python
• MySQL Database
• Flask

🎯 Features

• Latest Results Overview
• Recent Execution Trends (5, 10, 30 Days)
• Flaky Test Identification
• Search Test History by Name
• Side-by-Side Execution Comparison
• Analysis & Comments on Test Executions

🛠️ How It Works

• Parse Execution Details: Parses the output.xml to extract detailed execution results
• Store Results: These results are then stored in either a local or remotely hosted MySQL database
• Generate Reports: Using Flask, the stored data is transformed into comprehensive HTML reports

🧰 Getting Started

⚙️ Installation

Setting up robotframework-historic is a one-time activity. Just follow these steps:

Step 1: Install MySQL

• MySQL Setup: Guide
• MySQL User Setup: Guide

Step 2: Install robotframework-historic

pip install git+https://github.com/adiralashiva8/robotframework-historic

Step 3: Set Up the Database

• CLI: rfhistoricsetup
• Manual: Guide

👀 Usage

Step 1: Create a New Project: Guide

Step 2: Push Test Results: Guide

Step 3: View Reports: Open in browser

Encountering MySQL issues? Try installing these dependencies:

pip install mysql-connector-python
pip install PyMySQL

For more options:

rfhistoric --help
rfhistoricparser --help
rfhistoricsetup --help
rfhistoricupdate --help

🧪 Continuous Integration (CI) Setup

To automate report generation in CI/CD pipelines, add the following steps to your pipeline configuration:

1. Run tests with Robot Framework
2. push results to dB

   robot test.robot &
   rfhistoricparser [:options]
   

   & is used to execute multiple command's in .bat file

🤝 Contact

For any questions, suggestions, or feedback, please contact:

• Email: [email protected]

💎 Acknowledgements

1. Robotframework community users

---

⭐ Star this repository if you find it useful! (it motivates)

---