Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adiralashiva8/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.
https://github.com/adiralashiva8/robotframework-historic
flask-application historical-data listener mysql report robotframework
Last synced: 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/adiralashiva8/robotframework-historic
- Owner: adiralashiva8
- License: mit
- Created: 2020-01-20T17:15:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T08:34:33.000Z (3 months ago)
- Last Synced: 2024-09-26T20:51:53.489Z (3 months ago)
- Topics: flask-application, historical-data, listener, mysql, report, robotframework
- Language: JavaScript
- Homepage:
- Size: 3.12 MB
- Stars: 81
- Watchers: 9
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-robotframework - robotframework-historic
README
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](#-about-the-project)
* [Screenshots](#-screenshots)
* [Tech Stack](#-tech-stack)
* [Features](#-features)
* [How It Works](#-works)
- [Getting Started](#-getting-started)
* [Installation](#-installation)
- [Usage](#-usage)
* [Continuous Integration (CI) Setup](#-cisetup)
- [Contact](#-contact)
- [Acknowledgements](#-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
### 🎯 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](https://github.com/adiralashiva8/robotframework-historic/wiki/1.-MySQL-Setup-Guide)
- MySQL User Setup: [Guide](https://github.com/adiralashiva8/robotframework-historic/wiki/2.1-Create-MySQL-User)
__Step 2:__ Install robotframework-historic
```
pip install git+https://github.com/adiralashiva8/robotframework-historic
```
__Step 3:__ Set Up the Database
- CLI: `rfhistoricsetup`
- Manual: [Guide](https://github.com/adiralashiva8/robotframework-historic/wiki/2.2-Create-robothistoric-table)
## 👀 Usage
__Step 1:__ Create a New Project: [Guide](https://github.com/adiralashiva8/robotframework-historic/wiki/3.-Create-Project-In-RF-Historic)
__Step 2:__ Push Test Results: [Guide](https://github.com/adiralashiva8/robotframework-historic/wiki/4.-Push-robotframework-execution-results-to-MySQL)
__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](https://groups.google.com/forum/#!forum/robotframework-users)
---
⭐ Star this repository if you find it useful! (it motivates)
---