report_builder 1.4 → 1.9

data/lib/report_builder/builder.rb

@@ -7,30 +7,26 @@ require 'ostruct'
 require 'report_builder/core-ext/hash'
 
 module ReportBuilder
+
   ##
   # ReportBuilder Main class
   #
   class Builder
 
-    attr_accessor :options
-
     ##
     # ReportBuilder Main method
     #
-    def build_report(opts = nil)
-      options = self.options || default_options.marshal_dump
-      options.merge! opts if opts.is_a? Hash
+    def build_report
+      options = ReportBuilder.options
 
-      fail 'Error:: Invalid report_types. Use: [:json, :html]' unless options[:report_types].is_a? Array
-      options[:report_types].map!(&:to_s).map!(&:upcase)
-
-      options[:input_path] ||= options[:json_path] || Dir.pwd
       groups = get_groups options[:input_path]
 
       json_report_path = options[:json_report_path] || options[:report_path]
-      File.open(json_report_path + '.json', 'w') do |file|
-        file.write JSON.pretty_generate(groups.size > 1 ? groups : groups.first['features'])
-      end if options[:report_types].include? 'JSON'
+      if options[:report_types].include? 'JSON'
+        File.open(json_report_path + '.json', 'w') do |file|
+          file.write JSON.pretty_generate(groups.size > 1 ? groups : groups.first['features'])
+        end
+      end
 
       if options[:additional_css] and Pathname.new(options[:additional_css]).file?
         options[:additional_css] = File.read(options[:additional_css])
@@ -41,42 +37,29 @@ module ReportBuilder
       end
 
       html_report_path = options[:html_report_path] || options[:report_path]
-      File.open(html_report_path + '.html', 'w') do |file|
-        file.write get(groups.size > 1 ? 'group_report' : 'report').result(binding).gsub('  ', '').gsub("\n\n", '')
-      end if options[:report_types].include? 'HTML'
+      if options[:report_types].include? 'HTML'
+        File.open(html_report_path + '.html', 'w') do |file|
+          file.write get(groups.size > 1 ? 'group_report' : 'report').result(binding)
+        end
+      end
 
       retry_report_path = options[:retry_report_path] || options[:report_path]
-      File.open(retry_report_path + '.retry', 'w') do |file|
-        groups.each do |group|
-          group['features'].each do |feature|
-            if feature['status'] == 'broken'
-              feature['elements'].each {|scenario| file.puts "#{feature['uri']}:#{scenario['line']}" if scenario['status'] == 'failed'}
+      if options[:report_types].include? 'RETRY'
+        File.open(retry_report_path + '.retry', 'w') do |file|
+          groups.each do |group|
+            group['features'].each do |feature|
+              if feature['status'] == 'broken'
+                feature['elements'].each do |scenario|
+                  file.puts "#{feature['uri']}:#{scenario['line']}" if scenario['status'] == 'failed'
+                end
+              end
             end
           end
         end
-      end if options[:report_types].include? 'RETRY'
+      end
       [json_report_path, html_report_path, retry_report_path]
     end
 
-    ##
-    # ReportBuilder default configuration
-    #
-    def default_options
-      OpenStruct.new(json_path: nil,
-                     input_path: nil,
-                     report_types: [:html],
-                     report_title: 'Test Results',
-                     include_images: true,
-                     additional_info: {},
-                     report_path: 'test_report',
-                     json_report_path: nil,
-                     html_report_path: nil,
-                     retry_report_path: nil,
-                     additional_css: nil,
-                     additional_js: nil
-      )
-    end
-
     private
 
     def get(template)
@@ -90,13 +73,17 @@ module ReportBuilder
         input_path.each do |group_name, group_path|
           files = get_files group_path
           puts "Error:: No file(s) found at #{group_path}" if files.empty?
-          groups << {'name' => group_name, 'features' => get_features(files)} rescue next
+          groups << {'name' => group_name, 'features' => get_features(files)}
         end
-        fail 'Error:: Invalid Input File(s). Please provide valid cucumber JSON output file(s)' if groups.empty?
       else
         files = get_files input_path
-        fail "Error:: No file(s) found at #{input_path}" if files.empty?
-        groups << {'features' => get_features(files)} rescue fail('Error:: Invalid Input File(s). Please provide valid cucumber JSON output file(s)')
+        raise "Error:: No file(s) found at #{input_path}" if files.empty?
+        groups << {'features' => get_features(files)}
+      end
+      groups.each do |this_group|
+        this_group['features'].each do |feature|
+          feature['elements'] = feature['elements'].sort_by { |v| v['line']}
+        end
       end
       groups
     end
@@ -126,63 +113,100 @@ module ReportBuilder
     end
 
     def get_features(files)
-      files.each_with_object([]) {|file, features|
+      files.each_with_object([]) do |file, features|
         data = File.read(file)
         next if data.empty?
-        features << JSON.parse(data) rescue next
-      }.flatten.group_by {|feature|
-        feature['uri']+feature['id']+feature['line'].to_s
-      }.values.each_with_object([]) {|group, features|
+        begin
+          features << JSON.parse(data)
+        rescue StandardError
+          puts 'Warning:: Invalid Input File ' + file
+          puts 'JSON Error:: ' + $!.to_s
+          next
+        end
+      end.flatten.group_by do |feature|
+        feature['uri'] + feature['id'] + feature['line'].to_s
+      end.values.each_with_object([]) do |group, features|
         features << group.first.except('elements').merge('elements' => group.map {|feature| feature['elements']}.flatten)
-      }.sort_by! {|feature| feature['name']}.each {|feature|
+      end.sort_by! do |feature|
+        feature['name']
+      end.each do |feature|
+        feature['name'] = ERB::Util.html_escape feature['name']
         if feature['elements'][0]['type'] == 'background'
           (0..feature['elements'].size-1).step(2) do |i|
             feature['elements'][i]['steps'] ||= []
-            feature['elements'][i]['steps'].each {|step| step['name']+=(' ('+feature['elements'][i]['keyword']+')')}
+            feature['elements'][i]['steps'].each {|step| step['name'] += (' (' + feature['elements'][i]['keyword'] + ')')}
             if feature['elements'][i+1]
               feature['elements'][i+1]['steps'] = feature['elements'][i]['steps'] + feature['elements'][i+1]['steps']
               feature['elements'][i+1]['before'] = feature['elements'][i]['before'] if feature['elements'][i]['before']
             end
           end
-          feature['elements'].reject! {|element| element['type'] == 'background'}
+          feature['elements'].reject! do |element|
+            element['type'] == 'background'
+          end
         end
-        feature['elements'].each {|scenario|
+        feature['elements'].each do |scenario|
+          scenario['name'] = ERB::Util.html_escape scenario['name']
           scenario['before'] ||= []
-          scenario['before'].each {|before|
+          scenario['before'].each do |before|
             before['result']['duration'] ||= 0
+            if before['embeddings']
+              before['embeddings'].map! do |embedding|
+                decode_embedding(embedding)
+              end
+            end
             before.merge! 'status' => before['result']['status'], 'duration' => before['result']['duration']
-          }
+          end
           scenario['steps'] ||= []
-          scenario['steps'].each {|step|
+          scenario['steps'].each do |step|
+            step['name'] = ERB::Util.html_escape step['name']
             step['result']['duration'] ||= 0
             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['embeddings'].map! { |embedding|
+            if step['after']
+              step['after'].each do |after|
+                after['result']['duration'] ||= 0
+                duration += after['result']['duration']
+                status = 'failed' if after['result']['status'] == 'failed'
+                if after['embeddings']
+                  after['embeddings'].map! do |embedding|
+                    decode_embedding(embedding)
+                  end
+                end
+                after.merge! 'status' => after['result']['status'], 'duration' => after['result']['duration']
+              end
+            end
+            if step['embeddings']
+              step['embeddings'].map! do |embedding|
                 decode_embedding(embedding)
-              } if after['embeddings']
-              after.merge! 'status' => after['result']['status'], 'duration' => after['result']['duration']
-            } if step['after']
-            step['embeddings'].map! { |embedding|
-              decode_embedding(embedding)
-            } if step['embeddings']
+              end
+            end
             step.merge! 'status' => status, 'duration' => duration
-          }
+          end
           scenario['after'] ||= []
-          scenario['after'].each {|after|
+          scenario['after'].each do |after|
             after['result']['duration'] ||= 0
-            after['embeddings'].map! { |embedding|
-              decode_embedding(embedding)
-            } if after['embeddings']
+            if after['embeddings']
+              after['embeddings'].map! do |embedding|
+                decode_embedding(embedding)
+              end
+            end
             after.merge! 'status' => after['result']['status'], 'duration' => after['result']['duration']
-          }
+          end
           scenario.merge! 'status' => scenario_status(scenario), 'duration' => total_time(scenario['before']) + total_time(scenario['steps']) + total_time(scenario['after'])
-        }
+        end
+        feature['elements'] = feature['elements'].group_by do |scenario|
+          scenario['id'] + ':' + scenario['line'].to_s
+        end.values.map do |scenario_group|
+          the_scenario = scenario_group.find do |scenario|
+            scenario['status'] == 'passed'
+          end || scenario_group.last
+          if scenario_group.size > 1
+            the_scenario['name'] += " (x#{scenario_group.size})"
+          end
+          the_scenario
+        end
         feature.merge! 'status' => feature_status(feature), 'duration' => total_time(feature['elements'])
-      }
+      end
     end
 
     def feature_status(feature)
@@ -204,9 +228,9 @@ module ReportBuilder
     end
 
     def decode_image(data)
-      base64 = /^([A-Za-z0-9+\/]{4})*([A-Za-z0-9+\/]{4}|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)$/
+      base64 = %r{^([A-Za-z0-9+\/]{4})*([A-Za-z0-9+\/]{4}|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)$}
       if data =~ base64
-        data_base64 = Base64.decode64(data).gsub(/^data:image\/(png|gif|jpg|jpeg)\;base64,/, '')
+        data_base64 = Base64.urlsafe_decode64(data).gsub(%r{^data:image\/(png|gif|jpg|jpeg)\;base64,}, '') rescue data
         if data_base64 =~ base64
           data_base64
         else
@@ -218,13 +242,13 @@ module ReportBuilder
     end
 
     def decode_text(data)
-      Base64.decode64 data
+      Base64.urlsafe_decode64 data rescue ''
     end
 
     def decode_embedding(embedding)
       if embedding['mime_type'] =~ /^image\/(png|gif|jpg|jpeg)/
         embedding['data'] = decode_image(embedding['data'])
-      elsif embedding['mime_type'] =~ /^text\/plain/
+      elsif embedding['mime_type'] =~ /^text\/(plain|html)/
         embedding['data'] = decode_text(embedding['data'])
       end
       embedding

data/report_builder.gemspec

@@ -1,22 +1,22 @@
 Gem::Specification.new do |s|
   s.name        = 'report_builder'
-  s.version     = '1.4'
+  s.version     = '1.9'
   s.bindir      = 'bin'
   s.summary     = 'ReportBuilder'
   s.description = 'Ruby gem to merge Cucumber JSON reports and build mobile-friendly HTML Test Report, JSON report and retry file.'
   s.post_install_message = 'Happy reporting!'
   s.authors     = ['Rajat Thareja']
   s.email       = 'rajat.thareja.1990@gmail.com'
-  s.homepage    = 'http://reportbuilder.rajatthareja.com'
+  s.homepage    = 'https://reportbuilder.rajatthareja.com'
   s.license     = 'MIT'
-  s.required_ruby_version = '>= 1.9.1'
+  s.required_ruby_version = '>= 2.0.0'
   s.requirements << 'Cucumber >= 2.1.0 test results in JSON format'
 
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(sample/|css/|js/|pkg/|testing/|coverage/|CNAME|.gitignore|appveyor.yml|.travis.yml|_config.yml|Gemfile|Rakefile|rb.ico)}) }
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files  = s.files.grep(%r{^(testing)/})
 
-  s.add_runtime_dependency 'json', '>= 1.8.1'
+  s.add_runtime_dependency 'json', '>= 2.3.0'
 
   s.add_development_dependency 'rake', '< 13.0'
   s.add_development_dependency 'rspec', '< 4.0'

data/template/error.erb

@@ -3,19 +3,19 @@
     <i class="material-icons">bug_report</i><%= error %>
   </div>
 
-  <div class="collapsible-body brown lighten-4">
-    <ul class="collection failedScenarioList">
+  <div class="collapsible-body <%= options[:color] %> lighten-4">
+    <div class="collection failedScenarioList">
       <% features.each_with_index do |feature, f| %>
           <% feature['elements'].each_with_index do |scenario, s| %>
               <% if scenario['error'] %>
                   <% if scenario['error'] == error %>
-                      <li class="collection-item failedScenario brown lighten-5 red-text">
-                        <i class="material-icons">highlight_off</i>&nbsp;<a class="modal-trigger red-text" href="#<%= "#{gid}f#{f}s#{s}" %>"><%= scenario['name'] %></a>
-                      </li>
+                      <a class="collection-item failedScenario <%= options[:color] %> lighten-5 red-text modal-trigger waves-effect waves-light" href="#<%= "#{gid}f#{f}s#{s}" %>">
+                        <i class="material-icons">highlight_off</i>&nbsp;<%= scenario['name'] %>
+                      </a>
                   <% end %>
               <% end %>
           <% end %>
       <% end %>
-    </ul>
+    </div>
   </div>
 </li>

data/template/feature.erb

@@ -1,18 +1,16 @@
 <li class="feature <%= feature['status'] %>">
-  <div class="collapsible-header brown lighten-1 waves-effect waves-light">
+  <div class="collapsible-header <%= options[:color] %> lighten-1 waves-effect waves-light">
     <i class="material-icons">featured_play_list</i>
     <b><%= feature['keyword'] %></b>&nbsp;<%= feature['name'] %>&nbsp;(<%= duration(feature['duration']) %>)
   </div>
 
-  <div class="collapsible-body brown lighten-4">
-    <ul class="collection scenarioList">
+  <div class="collapsible-body <%= options[:color] %> lighten-4">
+    <div class="collection scenarioList <%= options[:color] %>">
       <% feature['elements'].each_with_index do |scenario, s| %>
-          <li class="collection-item scenario <%= scenario['status'] %>">
-            <a class="waves-effect waves-light modal-trigger white-text" href="#<%= "#{fid}s#{s}" %>">
-              <b><%= scenario['keyword'] %></b> <%= scenario['name'] %>&nbsp;(<%= duration(scenario['duration']) %>)
-            </a>
-          </li>
+        <a class="collection-item scenario modal-trigger waves-effect waves-light white-text <%= scenario['status'] %>" href="#<%= "#{fid}s#{s}" %>">
+          <b><%= scenario['keyword'] %></b> <%= scenario['name'] %>&nbsp;(<%= duration(scenario['duration']) %>)
+        </a>
       <% end %>
-    </ul>
+    </div>
   </div>
 </li>

data/template/footer.erb

@@ -1,13 +1,39 @@
-<footer class="page-footer brown lighten-4">
-  <div class="footer-copyright brown lighten-1">
+<footer class="page-footer <%= options[:color] %> lighten-4">
+  <div class="footer-copyright <%= options[:color] %> lighten-1">
     <div class="container">
       Happy Reporting!
-      <a class="white-text text-lighten-4 right" href="http://reportbuilder.rajatthareja.com">Generated by Report Builder</a>
+      <a class="white-text text-lighten-4 right" href="https://reportbuilder.rajatthareja.com">Generated by Report Builder</a>
     </div>
   </div>
 </footer>
 
-<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.4/js/report.builder.min.js"></script>
+<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.9/js/report.builder.min.js"></script>
+
+<% if options[:voice_commands] %>
+<script src="//cdnjs.cloudflare.com/ajax/libs/annyang/2.6.0/annyang.min.js"></script>
+<script>
+    var commands = {
+        'show :tab': function(tab) {
+            if (tab === "overview") {
+                $("a[data-tooltip='Results Overview']").click();
+            } else if (tab === "features" || tab === "feature") {
+                $("a[data-tooltip='Scenarios by Features']").click();
+            } else if (tab === "summary") {
+                $("a[data-tooltip='Scenarios Summary Table']").click();
+            } else if (tab === "errors" || tab === "error" || tab === "failed" || tab === "bugs") {
+                $("a[data-tooltip='Failed Scenarios']").click();
+            }
+        },
+        'search *search': function (search) {
+            $("a[data-tooltip='Scenarios Summary Table']").click();
+            $("input[type='search']").val(search);
+            $('table#summaryTable').DataTable().search(search).draw();
+        }
+    };
+    annyang.addCommands(commands);
+    annyang.start();
+</script>
+<% end %>
 
 <% if options[:additional_js] %>
     <% if options[:additional_js] =~ /^http(|s):\/\/.*\.js$/ %>

data/template/group_errors.erb

@@ -10,7 +10,7 @@
             <b><%= group['name'] %></b>
           </div>
 
-          <div class="collapsible-body brown lighten-4">
+          <div class="collapsible-body <%= options[:color] %> lighten-4">
             <%= get('errors').result(binding) %>
           </div>
       </li>

data/template/group_features.erb

@@ -5,12 +5,12 @@
       <% features = group['features'] %>
       <li class="group">
 
-        <div class="collapsible-header brown lighten-1 waves-effect waves-light">
+        <div class="collapsible-header <%= options[:color] %> lighten-1 waves-effect waves-light">
           <i class="material-icons">group_work</i>
           <b><%= group['name'] %></b>&nbsp;(<%= duration(total_time(features)) %>)
         </div>
 
-        <div class="collapsible-body brown lighten-4">
+        <div class="collapsible-body <%= options[:color] %> lighten-4">
           <%= get('features').result(binding) %>
         </div>
       </li>

data/template/group_report.erb

@@ -12,21 +12,21 @@
   <%= get('scenarios').result(binding) %>
 <% end %>
 
-<main class="brown lighten-5">
+<main class="<%= options[:color] %> lighten-5">
   <div class="row">
-    <div id="overview" class="col s12 brown lighten-5">
+    <div id="overview" class="col s12 <%= options[:color] %> lighten-5">
       <%= get('group_overview').result(binding) %>
     </div>
 
-    <div id="features" class="col s12 brown lighten-5 white-text">
+    <div id="features" class="col s12 <%= options[:color] %> lighten-5 white-text">
       <%= get('group_features').result(binding) %>
     </div>
 
-    <div id="summary" class="col s12 brown lighten-5">
+    <div id="summary" class="col s12 <%= options[:color] %> lighten-5">
       <%= get('group_summary').result(binding) %>
     </div>
 
-    <div id="errors" class="col s12 brown lighten-5">
+    <div id="errors" class="col s12 <%= options[:color] %> lighten-5">
       <%= get('group_errors').result(binding) %>
     </div>
   </div>