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.

Code Examples:

    require 'report_builder'

   # 1
    ReportBuilder.build_report()
    ReportBuilder.build_report('path/of/json/files/dir')
    ReportBuilder.build_report('path/of/json/files/dir','my_test_report_name','json_html')
    ReportBuilder.build_report('path/of/json/files/dir','my_test_report_name','json')
    ReportBuilder.build_report('path/of/json/files/dir','my_test_report_name','html')

   # 2
    ReportBuilder.build_report('path/of/json/cucumber.json')

   # 3
    ReportBuilder.build_report([
            'path/of/json/cucumber1.json',
            'path/of/json/cucumber2.json',
            'path/of/json/files/dir/'
            ])

   # 4
    ReportBuilder::COLOR[:passed] = '#ffffff'
    ReportBuilder::COLOR[:failed] = '#000000'
    ReportBuilder.build_report()

Command Example:

     report_builder
     report_builder 'path/of/json/files/dir'
     report_builder 'path/of/json/files/dir' 'report_file'
     report_builder 'path/of/json/files/dir' 'report_file' 'json_html'
     report_builder 'path/of/json/files/dir' 'report_file' 'json'
     report_builder 'path/of/json/files/dir' 'report_file' 'html'

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']
   rake report_builder ['path/of/json/files/dir','report_file','json_html']
   rake report_builder ['path/of/json/files/dir','report_file','json']
   rake report_builder ['path/of/json/files/dir','report_file','html']

Contributing

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

Maintainer

Rajat Thareja

License

Copyright (c) 2016 MIT LICENSE