ReportBuilder

Ruby gem to merge Cucumber JSON reports and build single HTML Test Report

Installation

gem install report_builder

Information

RDoc documentation available on RubyDoc.info
Source code available on GitHub
Sample report available here

Usage

Note: Works with cucumber(>= 2.1.0) test results in JSON format.

Config Options:

Option	Type	Default	Values
json_path	[String] / [Array]	(current directory)	json files path / array of json files or path
report_path	[String]	'test_report'	output file path with file name without extension
report_types	[Array]	[:html]	:json, :html (output file types)
report_tabs	[Array]	[:overview, :features]	:overview, :features, :scenarios, :errors (tabs to build)
compress_images	[Boolean]	false	true / false (If true, the size of HTML report is reduced but takes more time to build report)

Code Examples:


     require 'report_builder'

    # Ex 1:
    ReportBuilder.configure do |config|
      config.json_path = 'cucumber_sample/logs'
      config.report_path = 'sample_report'
      config.report_types = [:json, :html]
      config.report_tabs = [:overview, :features, :scenarios, :errors]
      config.compress_images = false
    end

    ReportBuilder.build_report

    # Ex 2:
    options = {
       json_path:    'cucumber_sample/logs',
       report_path:  'sample_report',
       report_types: ['json', 'html'],
       report_tabs:  [ 'overview', 'features', 'scenarios', 'errors']
       compress_images: false
     }

    ReportBuilder.build_report options

CLI Options:

Option	Values	Explanation
-s, --source	x,y,z	List of json path or files
-o, --out	[PATH]NAME	Report path with name without extension
-f, --format	x,y,z	List of report format - html,json
-t, --tabs	x,y,z	List of report tabs - overview,features,scenarios,errors
-c, --compress		Reduce report size if embedding images
-h, --help		Show available command line switches
-v, --version		Show gem version

CLI Example:

     report_builder
     report_builder -s 'path/of/json/files/dir'
     report_builder -s 'path/of/json/files/dir' -o 'report_file'

Rake Example:

Add in Rakefile

      require 'report_builder'
      load 'report_builder.rake'

Then run rake task report_builder

   rake report_builder
   rake report_builder['path/of/json/files/dir']
   rake report_builder['path/of/json/files/dir','report_file']

Contributing

We're open to any contribution. It has to be tested properly though.