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) |
| report_title | [String] | 'Test Results' | report and html title |
| compress_images | [Boolean] | false | true / false (If true, the size of HTML report is reduced but takes more time to build report) |
| additional_info | [Hash] | {} | additional info for report summary |
Code Examples:
require 'report_builder'
# Ex 1:
ReportBuilder.configure do |config|
config.json_path = 'cucumber_sample/logs'
config.report_path = 'my_test_report'
config.report_types = [:json, :html]
config.report_tabs = [:overview, :features, :scenarios, :errors]
config.report_title = 'My Test Results'
config.compress_images = false
config.additional_info = {browser: 'Chrome', environment: 'Stage 5'}
end
ReportBuilder.build_report
# Ex 2:
options = {
json_path: 'cucumber_sample/logs',
report_path: 'my_test_report',
report_types: ['json', 'html'],
report_tabs: [ 'overview', 'features', 'scenarios', 'errors'],
report_title: 'My Test Results',
compress_images: false,
additional_info: {'browser' => 'Chrome', 'environment' => 'Stage 5'}
}
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 | |
| -T, --title | TITLE | Report title |
| -I, --info | a:x,b:y,c:z | List of additional info about test - key:value |
| -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 my_report_file
report_builder -s 'path/of/json/files/dir' -o my_report_file -t overview,features,scenarios,errors
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.
Maintainer
License
Copyright (c) 2016 MIT LICENSE