report_builder_fix 0.3 → 0.4

data/lib/report_builder.rb

@@ -0,0 +1,429 @@
+require_relative 'report_builder/builder'
+
+##
+# ReportBuilder Main module
+#
+module ReportBuilder
+
+  ##
+  # ReportBuilder options
+  #
+  def self.options
+    @options ||= {
+      input_path: Dir.pwd,
+      report_types: [:html],
+      report_title: 'Test Results',
+      include_images: true,
+      voice_commands: false,
+      additional_info: {},
+      report_path: 'test_report',
+      color: 'brown'
+    }
+  end
+
+  ##
+  # Configure ReportBuilder
+  #
+  # Example:
+  #
+  #     ReportBuilder.configure do |config|
+  #       config.input_path = 'cucumber_sample/logs'
+  #       config.report_path = 'my_test_report'
+  #       config.report_types = [:RETRY, :HTML]
+  #       config.report_title = 'My Test Results'
+  #       config.include_images = true
+  #       config.voice_commands = true
+  #       config.additional_info = {Browser: 'Chrome', Environment: 'Stage 5'}
+  #     end
+  #
+  def self.configure
+    options
+    more_options = OpenStruct.new
+    yield more_options if block_given?
+    @options.merge! more_options.marshal_dump
+  end
+
+  ##
+  # Build Report
+  #
+  # @param [Hash] more_options override the default and configured options.
+  #
+  # Example:
+  #
+  #     options = {
+  #       json_path:    'cucumber_sample/logs',
+  #       report_path:  'my_test_report',
+  #       report_types: ['retry', 'html'],
+  #       report_title: 'My Test Results',
+  #       include_images: true,
+  #       voice_commands: true,
+  #       color: 'deep-purple',
+  #       additional_info: {'browser' => 'Chrome', 'environment' => 'Stage 5'}
+  #     }
+  #
+  #     ReportBuilder.build_report options
+  #
+  def self.build_report(more_options = {})
+    options
+    if more_options.is_a? String
+      @options[:input_path] = more_options
+    elsif more_options.is_a? Hash
+      @options.merge! more_options
+    end
+    @options[:input_path] = @options[:json_path] if @options[:json_path]
+    @options[:report_types] = [@options[:report_types]] unless @options[:report_types].is_a? Array
+    @options[:report_types].map!(&:to_s).map!(&:upcase)
+    Builder.new.build_report
+  end
+
+  ##
+  # Set Report Builder input json files path / array of json files or path / hash of json files or path
+  #
+  # @param [String/Array/Hash] json_path input json files path / array of json files or path / hash of json files or path
+  #
+  # Example:
+  #
+  #     ReportBuilder.json_path = 'my_project/cucumber_json'
+  #
+  def self.json_path=(json_path)
+    options
+    @options[:input_path] = json_path
+  end
+
+  ##
+  # Returns Report Builder input json files path / array of json files or path / hash of json files or path
+  #
+  # @return [String/Array/Hash] json_path input json files path / array of json files or path / hash of json files or path
+  #
+  def self.json_path
+    options[:input_path]
+  end
+
+  ##
+  # Set Report Builder input json files path / array of json files or path / hash of json files or path
+  #
+  # @param [String/Array/Hash] input_path input json files path / array of json files or path / hash of json files or path
+  #
+  # Example:
+  #
+  #     ReportBuilder.input_path = 'my_project/cucumber_json'
+  #
+  def self.input_path=(input_path)
+    options
+    @options[:input_path] = input_path
+  end
+
+  ##
+  # Returns Report Builder input json files path / array of json files or path / hash of json files or path
+  #
+  # @return [String/Array/Hash] input_path input json files path / array of json files or path / hash of json files or path
+  #
+  def self.input_path
+    options[:input_path]
+  end
+
+  ##
+  # Set Report Builder report_types :json, :html, :retry (output file types)
+  #
+  # @param [Array] report_types :json, :html, :retry (output file types)
+  #
+  # Example:
+  #
+  #     ReportBuilder.report_types = [:html, :retry]
+  #
+  def self.report_types=(report_types)
+    options
+    @options[:report_types] = report_types.is_a? Array ? report_types : [report_types]
+  end
+
+  ##
+  # Returns Report Builder report_types :json, :html, :retry (output file types)
+  #
+  # @return [Array] report_types :json, :html, :retry (output file types)
+  #
+  def self.report_types
+    options[:report_types]
+  end
+
+  ##
+  # Set Report Builder HTML report title
+  #
+  # @param [String] report_title HTML report title
+  #
+  # Example:
+  #
+  #     ReportBuilder.report_title = 'My Report'
+  #
+  def self.report_title=(report_title)
+    options
+    @options[:report_title] = report_title if report_title.is_a? String
+  end
+
+  ##
+  # Returns Report Builder HTML report title
+  #
+  # @return [String] report_title HTML report title
+  #
+  def self.report_title
+    options[:report_title]
+  end
+
+  ##
+  # Set Report Builder include or excluding embedded images
+  #
+  # @param [Boolean] include_images include or excluding embedded images
+  #
+  # Example:
+  #
+  #     ReportBuilder.include_images = false
+  #
+  def self.include_images=(include_images)
+    options
+    @options[:include_images] = include_images if !!include_images == include_images
+  end
+
+  ##
+  # Returns Report Builder include or excluding embedded images
+  #
+  # @return [Boolean] include_images include or excluding embedded images
+  #
+  def self.include_images
+    options[:include_images]
+  end
+
+  ##
+  # Set Report Builder enable or disable voice commands
+  #
+  # @param [Boolean] voice_commands enable or disable voice commands
+  #
+  # Example:
+  #
+  #     ReportBuilder.voice_commands = true
+  #
+  def self.voice_commands=(voice_commands)
+    options
+    @options[:voice_commands] = voice_commands if !!voice_commands == voice_commands
+  end
+
+  ##
+  # Returns Report Builder enable or disable voice commands
+  #
+  # @return [Boolean] voice_commands enable or disable voice commands
+  #
+  def self.voice_commands
+    options[:voice_commands]
+  end
+
+  ##
+  # Set Report Builder additional info for report summary
+  #
+  # @param [Hash] additional_info additional info for report summary
+  #
+  # Example:
+  #
+  #     ReportBuilder.additional_info = {'Environment' => 'Abc Environment', 'Browser' => 'Chrome'}
+  #
+  def self.additional_info=(additional_info)
+    options
+    @options[:additional_info] = additional_info if additional_info.is_a? Hash
+  end
+
+  ##
+  # Returns Report Builder additional info for report summary
+  #
+  # @return [Hash] additional_info additional info for report summary
+  #
+  def self.additional_info
+    options[:additional_info]
+  end
+
+  ##
+  # Set Report Builder reports output file path with file name without extension
+  #
+  # @param [String] report_path reports output file path with file name without extension
+  #
+  # Example:
+  #
+  #     ReportBuilder.report_path = 'reports/report'
+  #
+  def self.report_path=(report_path)
+    options
+    options[:report_path] = report_path if report_path.is_a? String
+  end
+
+  ##
+  # Returns Report Builder reports output file path with file name without extension
+  #
+  # @return [String] report_path reports output file path with file name without extension
+  #
+  def self.report_path
+    options[:report_path]
+  end
+
+  ##
+  # Set Report Builder json report output file path with file name without extension
+  #
+  # @param [String] json_report_path json report output file path with file name without extension
+  #
+  # Example:
+  #
+  #     ReportBuilder.json_report_path = 'reports/report'
+  #
+  def self.json_report_path=(json_report_path)
+    options
+    @options[:json_report_path] = json_report_path if json_report_path.is_a? String
+  end
+
+  ##
+  # Returns Report Builder json report output file path with file name without extension
+  #
+  # @return [String] json_report_path json report output file path with file name without extension
+  #
+  def self.json_report_path
+    options[:json_report_path] || options[:report_path]
+  end
+
+  ##
+  # Set Report Builder html report output file path with file name without extension
+  #
+  # @param [String] html_report_path html report output file path with file name without extension
+  #
+  # Example:
+  #
+  #     ReportBuilder.html_report_path = 'reports/report'
+  #
+  def self.html_report_path=(html_report_path)
+    options
+    @options[:html_report_path] = html_report_path if html_report_path.is_a? String
+  end
+
+  ##
+  # Returns Report Builder html report output file path with file name without extension
+  #
+  # @return [String] html_report_path html report output file path with file name without extension
+  #
+  def self.html_report_path
+    options[:html_report_path] || options[:report_path]
+  end
+
+  ##
+  # Set Report Builder retry report output file path with file name without extension
+  #
+  # @param [String] retry_report_path retry report output file path with file name without extension
+  #
+  # Example:
+  #
+  #     ReportBuilder.retry_report_path = 'reports/report'
+  #
+  def self.retry_report_path=(retry_report_path)
+    options
+    @options[:retry_report_path] = retry_report_path if retry_report_path.is_a? String
+  end
+
+  ##
+  # Returns Report Builder retry report output file path with file name without extension
+  #
+  # @return [String] retry_report_path retry report output file path with file name without extension
+  #
+  def self.retry_report_path
+    options[:retry_report_path] || options[:report_path]
+  end
+
+  ##
+  # Set Report Builder additional CSS string or CSS file path or CSS file url for customizing html report
+  #
+  # @param [String] additional_css additional CSS string or CSS file path or CSS file url for customizing html report
+  #
+  # Example:
+  #
+  #     ReportBuilder.additional_css = 'css/style.css'
+  #
+  def self.additional_css=(additional_css)
+    options
+    @options[:additional_css] = additional_css if additional_css.is_a? String
+  end
+
+  ##
+  # Returns Report Builder additional CSS string or CSS file path or CSS file url for customizing html report
+  #
+  # @return [String] additional_css additional CSS string or CSS file path or CSS file url for customizing html report
+  #
+  def self.additional_css
+    options[:additional_css]
+  end
+
+  ##
+  # Set Report Builder additional JS string or JS file path or JS file url for customizing html report
+  #
+  # @param [String] additional_js additional JS string or JS file path or JS file url for customizing html report
+  #
+  # Example:
+  #
+  #     ReportBuilder.json_report_path = 'js/script.js'
+  #
+  def self.additional_js=(additional_js)
+    options
+    @options[:additional_js=] = additional_js if additional_js.is_a? String
+  end
+
+  ##
+  # Returns Report Builder additional JS string or JS file path or JS file url for customizing html report
+  #
+  # @return [String] additional_js additional JS string or JS file path or JS file url for customizing html report
+  #
+  def self.additional_js
+    options[:additional_js]
+  end
+
+  ##
+  # Set Report Builder report color, Ex: indigo, cyan, purple, grey, lime etc.
+  #
+  # @param [String] color report color, Ex: indigo, cyan, purple, grey, lime etc.
+  #
+  # Example:
+  #
+  #     ReportBuilder.color = 'purple'
+  #
+  def self.color=(color)
+    options
+    @options[:color] = color if color.is_a? String
+  end
+
+  ##
+  # Returns Report Builder report color, Ex: indigo, cyan, purple, grey, lime etc.
+  #
+  # @return [String] color report color, Ex: indigo, cyan, purple, grey, lime etc.
+  #
+  def self.color
+    options[:color]
+  end
+
+  ##
+  # Set Report Builder Options
+  #
+  # @param [String] option
+  # @param [String] value
+  #
+  # Example:
+  #
+  #     ReportBuilder.set('title', 'My Features')
+  #
+  def self.set_option(option, value)
+    options
+    @options[option.to_sym] = value
+  end
+
+  ##
+  # Set Report Builder Options
+  #
+  # @param [String] option
+  # @param [String] value
+  #
+  # Example:
+  #
+  #     ReportBuilder.set('title', 'My Features')
+  #
+  def self.set(option, value)
+    set_option(option, value)
+  end
+end

data/template/error.erb

@@ -0,0 +1,21 @@
+<li class="error">
+  <div class="collapsible-header red lighten-2 white-text waves-effect waves-light">
+    <i class="material-icons">bug_report</i><%= error %>
+  </div>
+
+  <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 %>
+                      <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 %>
+    </div>
+  </div>
+</li>

data/template/errors.erb

@@ -0,0 +1,5 @@
+<ul class="errorList collapsible popout" data-collapsible="expandable">
+  <% errors.uniq.each do |error| %>
+      <%= get('error').result(binding) %>
+  <% end %>
+</ul>

data/template/feature.erb

@@ -0,0 +1,16 @@
+<li class="feature <%= feature['status'] %>">
+  <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 <%= options[:color] %> lighten-4">
+    <div class="collection scenarioList <%= options[:color] %>">
+      <% feature['elements'].each_with_index do |scenario, s| %>
+        <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 %>
+    </div>
+  </div>
+</li>

data/template/features.erb

@@ -0,0 +1,6 @@
+<ul class="featureList collapsible popout" data-collapsible="expandable">
+  <% features.each_with_index do |feature, f| %>
+      <% fid = "#{gid}f#{f}" %>
+      <%= get('feature').result(binding) %>
+  <% end %>
+</ul>

data/template/footer.erb

@@ -0,0 +1,46 @@
+<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="https://reportbuilder.rajatthareja.com">Generated by Report Builder</a>
+    </div>
+  </div>
+</footer>
+
+<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$/ %>
+        <script src="<%= options[:additional_js] %>"></script>
+    <% else %>
+        <script type="text/javascript">
+            <%= options[:additional_js]%>
+        </script>
+    <% end %>
+<% end %>

data/template/group_errors.erb

@@ -0,0 +1,18 @@
+<ul class="groupErrorList collapsible popout" data-collapsible="expandable">
+  <% groups.each_with_index do |group, g| %>
+
+      <% gid = "g#{g}" %>
+      <% features = group['features'] %>
+      <li class="groupError">
+
+          <div class="collapsible-header red lighten-2 white-text waves-effect waves-light">
+            <i class="material-icons">group_work</i>
+            <b><%= group['name'] %></b>
+          </div>
+
+          <div class="collapsible-body <%= options[:color] %> lighten-4">
+            <%= get('errors').result(binding) %>
+          </div>
+      </li>
+  <% end %>
+</ul>

data/template/group_features.erb

@@ -0,0 +1,18 @@
+<ul class="groupList collapsible popout" data-collapsible="expandable">
+  <% groups.each_with_index do |group, g| %>
+
+      <% gid = "g#{g}" %>
+      <% features = group['features'] %>
+      <li class="group">
+
+        <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 <%= options[:color] %> lighten-4">
+          <%= get('features').result(binding) %>
+        </div>
+      </li>
+  <% end %>
+</ul>

data/template/group_overview.erb

@@ -0,0 +1,33 @@
+<div class="row">
+  <div class="col m4 s12">
+    <canvas id="featuresDoughnut" width="400" height="400"></canvas>
+    <table id="metaDataFeatures" class="bordered">
+      <tbody></tbody>
+    </table>
+  </div>
+
+  <div class="col m4 s12">
+    <canvas id="scenariosDoughnut" width="400" height="400"></canvas>
+    <table id="metaDataScenarios" class="bordered">
+      <tbody></tbody>
+    </table>
+  </div>
+
+  <div class="col m4 s12">
+    <table id="metaData" class="bordered">
+      <tbody>
+      <tr><th>Total Time</th><td><%= duration(total_time(groups.map{|g| g['features']}.flatten)) %></td></tr>
+      <% options[:additional_info].each do |key, value| %>
+          <tr>
+            <th><%= key %></th>
+            <td><%= value %></td>
+          </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+
+  <div class="col s12">
+    <canvas id="groupBarChart"></canvas>
+  </div>
+</div>

data/template/group_report.erb

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+<%= get('head').result(binding) %>
+<body>
+<%= get('header').result(binding) %>
+
+<% errors = [] %>
+
+<% groups.each_with_index do |group, g| %>
+  <% gid = "g#{g}" %>
+  <% features = group['features'] %>
+  <%= get('scenarios').result(binding) %>
+<% end %>
+
+<main class="<%= options[:color] %> lighten-5">
+  <div class="row">
+    <div id="overview" class="col s12 <%= options[:color] %> lighten-5">
+      <%= get('group_overview').result(binding) %>
+    </div>
+
+    <div id="features" class="col s12 <%= options[:color] %> lighten-5 white-text">
+      <%= get('group_features').result(binding) %>
+    </div>
+
+    <div id="summary" class="col s12 <%= options[:color] %> lighten-5">
+      <%= get('group_summary').result(binding) %>
+    </div>
+
+    <div id="errors" class="col s12 <%= options[:color] %> lighten-5">
+      <%= get('group_errors').result(binding) %>
+    </div>
+  </div>
+</main>
+
+<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.4/js/group.report.builder.min.js"></script>
+
+<%= get('footer').result(binding) %>
+</body>
+</html>

data/template/group_summary.erb

@@ -0,0 +1,25 @@
+<table id="summaryTable" class="bordered <%= options[:color] %> lighten-1 white-text" width="100%">
+  <thead>
+  <tr>
+    <th class="hide-on-small-only">Group</th>
+    <th class="hide-on-small-only">Feature</th>
+    <th>Scenario</th>
+    <th class="hide">Tags</th>
+    <th>Status</th>
+    <th class="hide-on-small-only">Error</th>
+  </tr>
+  </thead>
+  <tbody>
+  <% groups.each_with_index do |group, g| %>
+    <% group['features'].each_with_index do |feature, f| %>
+        <% feature['elements'].each_with_index do |scenario, s| %>
+            <% sid = "g#{g}f#{f}s#{s}" %>
+            <tr class="<%= scenario['status'] %>">
+              <td class="hide-on-small-only"><%= group['name'] %></td>
+              <%= get('summary_row').result(binding) %>
+            </tr>
+        <% end %>
+    <% end %>
+  <% end %>
+  </tbody>
+</table>

data/template/head.erb

@@ -0,0 +1,22 @@
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+
+  <title><%= options[:report_title] %></title>
+
+  <link rel="icon" href="https://reportbuilder.rajatthareja.com/rb.ico">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+  <link href="https://cdn.datatables.net/1.10.16/css/jquery.dataTables.min.css" rel="stylesheet">
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/materialize/0.100.2/css/materialize.min.css" media="screen,projection"/>
+  <link href="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.9/css/report.builder.min.css" rel="stylesheet">
+
+  <% if options[:additional_css] %>
+      <% if options[:additional_css] =~ /^http(|s):\/\/.*\.css$/ %>
+          <link rel="stylesheet" href="<%= options[:additional_css] %>" media="all"/>
+      <% else %>
+          <style type="text/css">
+            <%= options[:additional_css]%>
+          </style>
+      <% end %>
+  <% end %>
+</head>