Skip to content

Latest commit

 

History

History
181 lines (142 loc) · 6.02 KB

README.md

File metadata and controls

181 lines (142 loc) · 6.02 KB
Raw

Robot Framework Metrics

Custom HTML report (dashboard view) by parsing robotframework output.xml file

contributors last update forks stars open issues license

View Demo · Documentation · Report Bug · Request Feature


📔 Table of Contents

🌟 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

screenshot

🛠️ 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: Using pip (Recommended)

pip install robotframework-metrics==3.3.3

Method 2: 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

Method 3: Latest Development Version (for the latest features and RF7 support)

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

👀 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:

💎 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 [Author of robotframework]
  2. Ruud Prijs
  3. Jesse Zacharias
  4. Bassam Khouri
  5. Francesco Spegni
  6. Sreelesh Kunnath

Feedback:

  1. Mantri Sri
  2. Prasad Ozarkar
  3. Suresh Parimi
  4. Amit Lohar
  5. Robotframework community users

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