Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adiralashiva8/robotframework-metrics
Custom HTML report (dashboard view) by parsing robotframework output.xml file
https://github.com/adiralashiva8/robotframework-metrics
html-report metrics-reported reports robot-framework robotframework robotframework-metrics
Last synced: 7 days ago
JSON representation
Custom HTML report (dashboard view) by parsing robotframework output.xml file
- Host: GitHub
- URL: https://github.com/adiralashiva8/robotframework-metrics
- Owner: adiralashiva8
- License: mit
- Created: 2018-07-31T17:21:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-01T08:39:46.000Z (about 1 month ago)
- Last Synced: 2024-11-29T07:04:10.146Z (14 days ago)
- Topics: html-report, metrics-reported, reports, robot-framework, robotframework, robotframework-metrics
- Language: HTML
- Homepage:
- Size: 2.73 MB
- Stars: 218
- Watchers: 36
- Forks: 67
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-robotframework - robotframework-metrics
README
Robot Framework Metrics
Custom HTML report (dashboard view) by parsing robotframework output.xml file
View Demo
·
Documentation
·
Report Bug
·
Request Feature
# 📔 Table of Contents
- [About the Project](#-about-the-project)
* [Screenshots](#-screenshots)
* [Tech Stack](#-tech-stack)
* [Features](#-features)
- [Getting Started](#-getting-started)
* [Installation](#-installation)
- [Usage](#usage)
* [Continuous Integration (CI) Setup](#-cisetup)
- [Contact](#-contact)
- [Acknowledgements](#-acknowledgements)
## 🌟 About the Project
`Robot Framework Metrics` is a tool designed to generate comprehensive `HTML reports` from Robot Framework's `output.xml` files. These reports provide a __dashboard view__, offering detailed insights into your test executions, including __suite__ statistics, __test case__ results, and __keyword__ performance.
### 📷 Screenshots
### 🛠️ Tech Stack
### 🎯 Features
- *Custom HTML Report:* Create visually appealing and informative dashboard.
- *Detailed Metrics:* Access suite, test case, keyword statistics, status, and elapsed time.
- *Support for RF7:* Fully compatible with Robot Framework 7 (from v3.5.0 onwards).
- *Command-Line Interface:* Easy-to-use CLI for report generation.
## 🧰 Getting Started
### ⚙️ Installation
You can install `robotframework-metrics` using one of the following methods:
__Method 1__: Latest Development Version (**Recommended**) (for the latest features and RF7 support)
```
pip install git+https://github.com/adiralashiva8/robotframework-metrics
```
__Method 2__: Using pip
```
pip install robotframework-metrics==3.7.0
```
__Method 3__: From Source (clone the repository and install using setup.py)
```
git clone https://github.com/adiralashiva8/robotframework-metrics.git
cd robotframework-metrics
python setup.py install
```
## 👀 Usage
After executing your Robot Framework tests, you can generate a metrics report by running:
__Default Configuration__: If `output.xml` is in the current directory
```
robotmetrics
```
__Custom Path__: If `output.xml` is located in a different directory
```
robotmetrics --inputpath ./Result/ --output output1.xml
```
For more options:
```
robotmetrics --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. Generate the metrics report
```
robot test.robot &
robotmetrics [:options]
```
> & is used to execute multiple command's in .bat file
## 🤝 Contact
For any questions, suggestions, or feedback, please contact:
- Email: `[email protected]`
## 💎 Acknowledgements
Special thanks to the following individuals for their guidance, contributions, and feedback:
*Idea, Guidance and Support:*
- Steve Fisher
- Goutham Duduka
*Contributors:*
1. [Pekka Klarck](https://www.linkedin.com/in/pekkaklarck/) [Author of robotframework]
2. [Ruud Prijs](https://www.linkedin.com/in/ruudprijs/)
3. [Jesse Zacharias](https://www.linkedin.com/in/jesse-zacharias-7926ba50/)
4. [Bassam Khouri](https://www.linkedin.com/in/bassamkhouri/)
5. [Francesco Spegni](https://www.linkedin.com/in/francesco-spegni-34b39b61/)
6. [Sreelesh Kunnath](https://www.linkedin.com/in/kunnathsree/)
*Feedback:*
1. [Mantri Sri](https://www.linkedin.com/in/mantri-sri-4a0196133/)
2. [Prasad Ozarkar](https://www.linkedin.com/in/prasad-ozarkar-b4a61017/)
3. [Suresh Parimi](https://www.linkedin.com/in/sparimi/)
4. [Amit Lohar](https://github.com/amitlohar)
5. [Robotframework community users](https://groups.google.com/forum/#!forum/robotframework-users)
---
⭐ Star this repository if you find it useful! (it motivates)
---