robotframework-metrics

Custom report for robot framework


Keywords
robotframework, report, html-report, metrics-reported, reports, robot-framework, robotframework-metrics
License
MIT
Install
pip install robotframework-metrics==3.3.3

Documentation

Robot Framework Metrics

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

contributors last update forks stars downloads open issues license


๐Ÿ“” 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

Metrics Report

๐Ÿ› ๏ธ 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.3.3

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:

๐Ÿ’Ž 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)