report_builder 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ebd1b63e8ea95293e3708159f8401eab72b953a
-  data.tar.gz: 1df9c528aba72b1285173d413e1e127142dcf607
+  metadata.gz: 601a48967da3d12319d801c9febed718aa5a856a
+  data.tar.gz: 253cda6a5c4fc55185f11789ac6c8892296a0008
 SHA512:
-  metadata.gz: c0856b426115c4d2cf4bb996d6c0d593fd871db83b04d940975f2ce323aec4c77ad67e55bfadec240eccae3780a618e7d5ce3ccdcfd04a4c7452bd49748e3994
-  data.tar.gz: 6d0e4c722b9b02692b7c45503c669d89a0417547c41b24ec0cfa319b754ce06e1bf55f6dc59aaffddaa5ab846a8bb3c707b2a9a0fdadc410d6acc20c5b892fe2
+  metadata.gz: faa57482fbc784b5d48d30a64fd67b6533acff31077cd5d7e630d6a7689584871442f13b36061f531a6987a54471f6470d082bb78bde259e235ad6d48b3203e9
+  data.tar.gz: fcf99dddafcf2f6c177304bf4c52fde0197d4933e5c91bf5d3613eb992d70747ac41e4b21a46606227539d2c12a1aa3222ac420f11b096bb65f153aa77f20e48

data/README.md

@@ -1,4 +1,6 @@
 # ReportBuilder
+[![Gem Version](https://badge.fury.io/rb/report_builder.svg)](https://badge.fury.io/rb/report_builder)
+
 Ruby gem to merge Cucumber JSON reports and build single HTML Test Report
 
 ## Installation
@@ -23,10 +25,14 @@ gem install report_builder
     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', 'my_test_report')
+    ReportBuilder.build_report('path/of/json/cucumber.json')
 
    # 3
     ReportBuilder.build_report([
@@ -36,30 +42,38 @@ gem install report_builder
             ])
 
    # 4
-    ReportBuilder.build_report()
-
-   # 5
     ReportBuilder::COLOR[:passed] = '#ffffff'
+    ReportBuilder::COLOR[:failed] = '#000000'
     ReportBuilder.build_report()
 ```
 
 ### Command Example:
 
 ```bash
+     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
 ```ruby
-   # Add in Rakefile
       require 'report_builder'
       load 'report_builder.rake'
-   # Then run rake task report_builder
 ```
+Then run rake task report_builder
 
 ```bash
+   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

data/bin/report_builder

@@ -3,5 +3,6 @@
 require 'report_builder'
 
 ARGV[1] ||= 'test_report'
+ARGV[2] ||= 'html'
 
-ReportBuilder.build_report(ARGV[0], ARGV[1])
+ReportBuilder.build_report(ARGV[0], ARGV[1], ARGV[2])

data/lib/report_builder.rake

@@ -1,6 +1,5 @@
 desc 'Rake task to build report'
-task :report_builder, [:file_or_dir, :output_file_name] do |t, args|
-  args.with_defaults(:file_or_dir => nil, :output_file_name => 'test_report')
-  require 'report_builder.rake'
-  ReportBuilder.build_report args.file_or_dir, args.output_file_name
+task :report_builder, [:file_or_dir, :output_file_name, :output_file_type] do |t, args|
+  args.with_defaults(:file_or_dir => nil, :output_file_name => 'test_report', :output_file_type => 'html')
+  ReportBuilder.build_report args.file_or_dir, args.output_file_name, args.output_file_type
 end

data/lib/report_builder.rb

@@ -43,10 +43,21 @@ class ReportBuilder
 
 # @param [Object] file_or_dir  json file, array of json files or path, json files path
 # @param [String] output_file_name Output file name, by default test_report
-  def self.build_report(file_or_dir = nil, output_file_name = 'test_report')
+# @param [String] output_file_type Output file type, by default html, other options json and json_html
+  def self.build_report(file_or_dir = nil, output_file_name = 'test_report', output_file_type = 'html')
 
     input = files file_or_dir
     all_features = features input rescue (raise 'ReportBuilderParsingError')
+
+    if output_file_type.include? 'json'
+      File.open(output_file_name + '.json', "w") do |file|
+        file.write JSON.pretty_generate all_features
+      end
+      puts "JSON test report generated: '#{output_file_name}.json'"
+    end
+
+    return unless output_file_type.include? 'html'
+
     all_scenarios = scenarios all_features
     all_steps = steps all_scenarios
     total_time = total_time all_features
@@ -129,7 +140,7 @@ class ReportBuilder
           all_features.each_with_index do |feature, n|
             builder.h3 do
               builder.span(:class => feature['status']) do
-                builder << "<strong>#{feature['keyword']}</strong> #{feature['name']} (#{feature['status']}) #{duration(feature['duration'])}"
+                builder << "<strong>#{feature['keyword']}</strong> #{feature['name']} (#{duration(feature['duration'])})"
               end
             end
             builder.div do
@@ -137,16 +148,31 @@ class ReportBuilder
                 feature['elements'].each do |scenario|
                   builder.h3 do
                     builder.span(:class => scenario['status']) do
-                      builder << "<strong>#{scenario['keyword']}</strong> #{scenario['name']} (#{scenario['status']})  #{duration(scenario['duration'])}"
+                      builder << "<strong>#{scenario['keyword']}</strong> #{scenario['name']} (#{duration(scenario['duration'])})"
                     end
                   end
                   builder.div do
+                    scenario['before'].each do |before|
+                      if before['status'] == 'failed'
+                        builder << "<strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                        error = before['result']['error_message'].split("\n")
+                        builder.span(:style => "color:#{COLOR[:failed]}") do
+                          error[0..-2].each do |line|
+                            builder << line + '<br/>'
+                          end
+                        end
+                        builder << "<strong>Hook: </strong>#{error[-1]} <br/>"
+                      end
+                    end
                     scenario['steps'].each do |step|
                       builder.span(:class => step['status']) do
-                        builder << "<strong>#{step['keyword']}</strong> #{step['name']} (#{step['status']})  #{duration(step['duration'])}"
+                        builder << "<strong>#{step['keyword']}</strong> #{step['name']} (#{duration(step['duration'])})"
                       end
-                      if step['status'] == 'failed'
-                        builder << "<br><strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                      step['output'].each do |output|
+                        builder << "<br/> <span style='color:#{COLOR[:skipped]}'>#{output}</span>"
+                      end if step['output'] && step['output'].is_a?(Array)
+                      if step['status'] == 'failed' && step['result']['error_message']
+                        builder << "<br/><strong style=color:#{COLOR[:failed]}>Error: </strong>"
                         error = step['result']['error_message'].split("\n")
                         builder.span(:style => "color:#{COLOR[:failed]}") do
                           error[0..-3].each do |line|
@@ -156,8 +182,39 @@ class ReportBuilder
                         builder << "<strong>SD: </strong>#{error[-2]} <br/>"
                         builder << "<strong>FF: </strong>#{error[-1]}"
                       end
+                      step['after'].each do |after|
+                        after['output'].each do |output|
+                          builder << "<br/> <span style='color:#{COLOR[:skipped]}'>#{output}</span>"
+                        end if after['output'] && after['output'].is_a?(Array)
+                        if after['result']['error_message']
+                          builder << "<br/><strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                          error = after['result']['error_message'].split("\n")
+                          builder.span(:style => "color:#{COLOR[:failed]}") do
+                            (scenario['keyword'] == 'Scenario Outline' ? error[0..-6] : error[0..-4]).each do |line|
+                              builder << line + '<br/>'
+                            end
+                          end
+                          builder << "<strong>Hook: </strong>#{scenario['keyword'] == 'Scenario Outline' ? error[-5] : error[-3]} <br/>"
+                          builder << "<strong>FF: </strong>#{error[-2]} <br/>"
+                        end
+                      end if step['after']
                       builder << '<br/>'
                     end
+                    scenario['after'].each do |after|
+                      after['output'].each do |output|
+                        builder << "<br/> <span style='color:#{COLOR[:skipped]}'>#{output}</span>"
+                      end if after['output'] && after['output'].is_a?(Array)
+                      if after['status'] == 'failed'
+                        builder << "<br/><strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                        error = after['result']['error_message'].split("\n")
+                        builder.span(:style => "color:#{COLOR[:failed]}") do
+                          error[0..-2].each do |line|
+                            builder << line + '<br/>'
+                          end
+                        end
+                        builder << "<strong>Hook: </strong>#{error[-1]}"
+                      end
+                    end
                   end
                 end
               end
@@ -180,16 +237,31 @@ class ReportBuilder
                 data[1].each do |scenario|
                   builder.h3 do
                     builder.span(:class => data[0]) do
-                      builder << "<strong>#{scenario['keyword']}</strong> #{scenario['name']} (#{data[0]}) #{duration(scenario['duration'])}"
+                      builder << "<strong>#{scenario['keyword']}</strong> #{scenario['name']} (#{duration(scenario['duration'])})"
                     end
                   end
                   builder.div do
+                    scenario['before'].each do |before|
+                      if before['status'] == 'failed'
+                        builder << "<strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                        error = before['result']['error_message'].split("\n")
+                        builder.span(:style => "color:#{COLOR[:failed]}") do
+                          error[0..-2].each do |line|
+                            builder << line + '<br/>'
+                          end
+                        end
+                        builder << "<strong>Hook: </strong>#{error[-1]} <br/>"
+                      end
+                    end
                     scenario['steps'].each do |step|
                       builder.span(:class => step['status']) do
-                        builder << "<strong>#{step['keyword']}</strong> #{step['name']} (#{step['status']}) #{duration(step['duration'])}"
+                        builder << "<strong>#{step['keyword']}</strong> #{step['name']} (#{duration(step['duration'])})"
                       end
-                      if step['status'] == 'failed'
-                        builder << "<br><strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                      step['output'].each do |output|
+                        builder << "<br/> <span style='color:#{COLOR[:skipped]}'>#{output}</span>"
+                      end if step['output'] && step['output'].is_a?(Array)
+                      if step['status'] == 'failed' && step['result']['error_message']
+                        builder << "<br/><strong style=color:#{COLOR[:failed]}>Error: </strong>"
                         error = step['result']['error_message'].split("\n")
                         builder.span(:style => "color:#{COLOR[:failed]}") do
                           error[0..-3].each do |line|
@@ -199,8 +271,39 @@ class ReportBuilder
                         builder << "<strong>SD: </strong>#{error[-2]} <br/>"
                         builder << "<strong>FF: </strong>#{error[-1]}"
                       end
+                      step['after'].each do |after|
+                        after['output'].each do |output|
+                          builder << "<br/> <span style='color:#{COLOR[:skipped]}'>#{output}</span>"
+                        end if after['output'] && after['output'].is_a?(Array)
+                        if after['result']['error_message']
+                          builder << "<br/><strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                          error = after['result']['error_message'].split("\n")
+                          builder.span(:style => "color:#{COLOR[:failed]}") do
+                            (scenario['keyword'] == 'Scenario Outline' ? error[0..-6] : error[0..-4]).each do |line|
+                              builder << line + '<br/>'
+                            end
+                          end
+                          builder << "<strong>Hook: </strong>#{scenario['keyword'] == 'Scenario Outline' ? error[-5] : error[-3]} <br/>"
+                          builder << "<strong>FF: </strong>#{error[-2]} <br/>"
+                        end
+                      end if step['after']
                       builder << '<br>'
                     end
+                    scenario['after'].each do |after|
+                      after['output'].each do |output|
+                        builder << "<br/> <span style='color:#{COLOR[:skipped]}'>#{output}</span>"
+                      end if after['output'] && after['output'].is_a?(Array)
+                      if after['status'] == 'failed'
+                        builder << "<br/><strong style=color:#{COLOR[:failed]}>Error: </strong>"
+                        error = after['result']['error_message'].split("\n")
+                        builder.span(:style => "color:#{COLOR[:failed]}") do
+                          error[0..-2].each do |line|
+                            builder << line + '<br/>'
+                          end
+                        end
+                        builder << "<strong>Hook: </strong>#{error[-1]}"
+                      end
+                    end
                   end
                 end
               end
@@ -212,17 +315,58 @@ class ReportBuilder
 
       builder.div(:id => 'errorsTab') do
         builder.ol do
-          all_steps.each do |step|
-            next unless step['status'] == 'failed'
-            builder.li do
-              error = step['result']['error_message'].split("\n")
-              builder.span(:style => "color:#{COLOR[:failed]}") do
-                error[0..-3].each do |line|
-                  builder << line + '<br/>'
+          all_scenarios.each do |scenario|
+            scenario['before'].each do |before|
+              next unless before['status'] == 'failed'
+              builder.li do
+                error = before['result']['error_message'].split("\n")
+                builder.span(:style => "color:#{COLOR[:failed]}") do
+                  error[0..-2].each do |line|
+                    builder << line + '<br/>'
+                  end
                 end
+                builder << "<strong>Hook: </strong>#{error[-1]} <br/>"
+                builder << "<strong>Scenario: </strong>#{scenario['name']}"
+              end
+            end
+            scenario['steps'].each do |step|
+              step['after'].each do |after|
+                next unless after['status'] == 'failed'
+                builder.li do
+                  error = after['result']['error_message'].split("\n")
+                  builder.span(:style => "color:#{COLOR[:failed]}") do
+                    (scenario['keyword'] == 'Scenario Outline' ? error[0..-6] : error[0..-4]).each do |line|
+                      builder << line + '<br/>'
+                    end
+                  end
+                  builder << "<strong>Hook: </strong>#{scenario['keyword'] == 'Scenario Outline' ? error[-5] : error[-3]} <br/>"
+                  builder << "<strong>FF: </strong>#{error[-2]} <br/>"
+                end
+              end if step['after']
+              next unless step['status'] == 'failed' && step['result']['error_message']
+              builder.li do
+                error = step['result']['error_message'].split("\n")
+                builder.span(:style => "color:#{COLOR[:failed]}") do
+                  error[0..-3].each do |line|
+                    builder << line + '<br/>'
+                  end
+                end
+                builder << "<strong>SD: </strong>#{error[-2]} <br/>"
+                builder << "<strong>FF: </strong>#{error[-1]}"
+              end
+            end
+            scenario['after'].each do |after|
+              next unless after['status'] == 'failed'
+              builder.li do
+                error = after['result']['error_message'].split("\n")
+                builder.span(:style => "color:#{COLOR[:failed]}") do
+                  error[0..-2].each do |line|
+                    builder << line + '<br/>'
+                  end
+                end
+                builder << "<strong>Hook: </strong>#{error[-1]} <br/>"
+                builder << "<strong>Scenario: </strong>#{scenario['name']}"
               end
-              builder << "<strong>SD: </strong>#{error[-2]} <br/>"
-              builder << "<strong>FF: </strong>#{error[-1]}"
             end
           end
         end
@@ -242,7 +386,8 @@ class ReportBuilder
 
     file.close
 
-    puts "Test report generated: '#{output_file_name}.html'"
+    puts "HTML test report generated: '#{output_file_name}.html'"
+    [total_time, feature_data, scenario_data, step_data]
   end
 
   def self.features(files)
@@ -254,11 +399,29 @@ class ReportBuilder
       features << group.first.except('elements').merge('elements' => group.map{|feature| feature['elements']}.flatten)
     }.each{|feature|
       feature['elements'].each { |scenario|
+        scenario['before'] ||= []
+        scenario['before'].each { |before|
+          before['result']['duration'] ||= 0
+          before.merge! 'status' => before['result']['status'], 'duration' => before['result']['duration']
+        }
         scenario['steps'].each { |step|
           step['result']['duration'] ||= 0
-          step.merge! 'status' => step['result']['status'], 'duration' => step['result']['duration']
+          duration = step['result']['duration']
+          status = step['result']['status']
+          step['after'].each { |after|
+            after['result']['duration'] ||= 0
+            duration += after['result']['duration']
+            status = 'failed' if after['result']['status'] == 'failed'
+            after.merge! 'status' => after['result']['status'], 'duration' => after['result']['duration']
+          } if step['after']
+          step.merge! 'status' => status, 'duration' => duration
+        }
+        scenario['after'] ||= []
+        scenario['after'].each { |after|
+          after['result']['duration'] ||= 0
+          after.merge! 'status' => after['result']['status'], 'duration' => after['result']['duration']
         }
-        scenario.merge! 'status' => scenario_status(scenario), 'duration' => total_time(scenario['steps'])
+        scenario.merge! 'status' => scenario_status(scenario), 'duration' => total_time(scenario['before']) + total_time(scenario['steps']) + total_time(scenario['after'])
       }
       feature.merge! 'status' => feature_status(feature), 'duration' => total_time(feature['elements'])
     }
@@ -281,7 +444,7 @@ class ReportBuilder
   end
 
   def self.scenario_status(scenario)
-    scenario['steps'].each do |step|
+    (scenario['before'] + scenario['steps'] + scenario['after']).each do |step|
       status = step['status']
       return status unless status == 'passed'
     end
@@ -312,9 +475,9 @@ class ReportBuilder
 
   def self.data(all_data)
     all_data.group_by{|db| db['status']}.map do |data|
-          {name: data[0],
-          count: data[1].size,
-          color: COLOR[data[0].to_sym]}
+      {name: data[0],
+       count: data[1].size,
+       color: COLOR[data[0].to_sym]}
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: report_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Rajat Thareja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder