Robot Framework Metrics Report

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

• Sample Report link

• Whats new in v3.2.2 link

• Source Code used to parse output.xml in metrics report link

How it Works:

1. Read output.xml file using robotframework API

2. Get Suite, Test Case , Keyword , Status and Elapsed time values

3. Convert data to html report using Beautifulsoup

How to use in project:

Step 1 Install robotmetrics

Case 1: Using pip

pip install robotframework-metrics==3.2.2 (from RF4.0)
pip install robotframework-metrics==3.2.0 (below RF4.0)

Case 2: Using setup.py (clone project and run command within root)

python setup.py install

Case 3: For latest changes use following command (pre-release or changes in master)

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

Step 2 Execute robotmetrics command to generate report

Case 1: No change in output.xml, log.html file name's and user is in same folder

robotmetrics

Case 2: Change in output.xml, log.html file name's And .xml and .html files are under 'Result' folder

robotmetrics --inputpath ./Result/ --output output1.xml --log log1.html

robotframework-metrics can parse multiple xmls at a time. Following is the command

robotmetrics --inputpath ./Result/ --output "output1.xml,output2.xml" --log log1.html

For more info on command line options use:

robotmetrics --help

Step 3 RobotFramework Metrics Report metric-timestamp.html file will be created in current folder | -inputpath if specified

Note: From v3.1.6 users can specify custom_report_name instead of metrics-timestamp.html

robotmetrics -M regression_metrics.html

Customize Report

Specify Logo in Robotframework metrics:

• Custom Logo : Customize your logo by using --logo command line option

  --logo "https://mycompany/logo.jpg"
  

Exclude Keywords in Metrics Report

• From v3.1.6 users can exclude keywords in metrics report using --ignorekeywords or -k command

  robotmetrics -k True
  

  By default --ignorekeywords is False

Exclude Logs in Metrics Report

• From v3.1.7 users can exclude Logs tab in metrics report using --ignorelogs or -l command

  robotmetrics -l True
  

  By default --ignorelogs is False

Include Full Suite Name in Metrics Report

• From v3.1.7 users can include full suite name in metrics report using --fullsuitename or -s command

  robotmetrics -s True
  

  By default --fullsuitename is False

Generate robotframework-metrics after execution

Execute robotmetrics command after suite or test execution as follows:

• Create .bat (or) .sh file with following snippet

  robot test.robot &
  robotmetrics [:options]
  

  & is used to execute multiple command's in .bat file

• Modify robotmetrics command as required and execute .bat file

• Robotframework metrics will be created after execution

If you have any questions / suggestions / comments on the report, please feel free to reach me at

• Email: [email protected]

Special Thanks To:

Idea, Guidance and Support:

• Steve Fisher
• Goutham Duduka

Contributors:

1. Pekka Klarck [Author of robotframework]

   • Contributed source to get 'Test Case' name from keyword
   • Suggested to use robotframework api to parse output.xml content

2. Ruud Prijs

   • Contributed source to use command line options for report

3. Jesse Zacharias

   • Made robotmetrics installable (pip)
   • Contributed source to improve performance

4. Bassam Khouri

   • Contributed source to use ArgParser
   • Contributed source to provide a human readable error if output.xml does not exist

5. Francesco Spegni

   • Contributed source to parse multiple xml's
   • Fixed distorted image

6. Sreelesh Kunnath

   • Contributed source to specify custom metrics file name

Feedback:

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

⭐️ repo if you like it