robotframework-historic

Robotframework-historic is a free, custom html report which provides historical robotframework execution results by storing execution results info in MySQL database and generate's html reports (charts / statistics) from database using Flask.

MIT License

Downloads
247
Stars
81
Committers
4

๐Ÿ“” Table of Contents

๐ŸŒŸ 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

๐ŸŽฏ 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

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:

๐Ÿ’Ž Acknowledgements

  1. Robotframework community users

โญ Star this repository if you find it useful! (it motivates)


Package Rankings
Top 14.66% on Pypi.org