rspec_pretty_html_reporter 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb778b6e59fc1d897dd91626bdc82f763f32010ec6e618d10536a24fa7137260
+  data.tar.gz: 28be25ab79d74a6f363700dde7a7af73953d79ce3289a4dc9a3795267b28c86b
+SHA512:
+  metadata.gz: c65d6d8a1f5fbe9086aa2b028b108e69503c813d8f827fc5646ef668d66e700c28a38b03e1720b2d5c18ca37eed9afec7243ac485f38e4b68be900f091a5e8b6
+  data.tar.gz: bc1ffcc7489649cab6466b0403059e258c0bb43114faa9b5e3cb9a4dff7bcb41b363f92547db592579ed8b8ce19712867e4bc6ca148f8dc68f705cde7bb5c019

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2022 Carlos Gutierrez
+Copyright (c) 2017 Vishal Banthia
+Copyright (c) 2014 Kingsley Hendrickse
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+
+[![Gem Version](https://badge.fury.io/rb/rspec_pretty_html_reporter.svg)](https://badge.fury.io/rb/rspec_pretty_html_reporter)
+
+# RSpec Pretty HTML Reporter
+
+Produce pretty [RSpec](http://rspec.info/) reports.
+
+This is a custom reporter for RSpec which generates pretty HTML reports showing the results of rspec tests. It has
+features to embed images and videos into the report providing better debugging information when a test fails.
+
+<img src="https://github.com/TheSpartan1980/rspec_pretty_html_reporter/blob/master/images/group_overview_report.png" width="80%"/>
+
+## Setup
+
+Add this to your Gemfile:
+
+```rb
+gem 'rspec-pretty-html-reporter'
+```
+
+## Generating the report
+
+Either add the below into your `.rspec` file
+
+```rb
+--format RspecPrettyHtmlReporter
+```
+
+or run RSpec with `--format RspecPrettyHtmlReporter` like below:
+
+```bash
+REPORT_PATH=reports/$(date +%s) bundle exec rspec --format RspecPrettyHtmlReporter spec
+```
+
+This will create the reports in the `reports` directory.
+
+## Usage
+
+Images and videos can be embed by adding their path into example's metadata. For an example of how to do this, please
+check out this [Sample Test](./spec/embed_graphics_spec.rb).
+
+## Credits
+
+This library is forked from [vbanthia/rspec_html_reporter](https://github.com/vbanthia/rspec_html_reporter). The
+original credit goes to *[kingsleyh](https://github.com/kingsleyh)*
+for [kingsleyh/rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter)

data/lib/rspec_pretty_html_reporter/example.rb

@@ -0,0 +1,78 @@
+require 'rspec_pretty_html_reporter/oopsy'
+
+class Example
+  def self.load_spec_comments!(examples)
+    examples.group_by(&:file_path).each do |file_path, file_examples|
+      lines = File.readlines(file_path)
+
+      file_examples.zip(file_examples.rotate).each do |ex, next_ex|
+        lexically_next = next_ex &&
+          next_ex.file_path == ex.file_path &&
+          next_ex.metadata[:line_number] > ex.metadata[:line_number]
+        start_line_idx = ex.metadata[:line_number] - 1
+        next_start_idx = (lexically_next ? next_ex.metadata[:line_number] : lines.size) - 1
+        spec_lines = lines[start_line_idx...next_start_idx].select { |l| l.match(/#->/) }
+        ex.set_spec(spec_lines.join) unless spec_lines.empty?
+      end
+    end
+  end
+
+  attr_reader :example_group, :description, :full_description, :run_time, :duration, :status, :exception, :file_path,
+              :metadata, :spec, :screenshots, :screenrecord, :failed_screenshot
+
+  def initialize(example)
+
+    @example_group = example.example_group.to_s
+    @description = example.description
+    @full_description = example.full_description
+    @execution_result = example.execution_result
+    @run_time = (@execution_result.run_time).round(5)
+    @duration = @execution_result.run_time.to_fs(:rounded, precision: 5)
+    @status = @execution_result.status.to_s
+    @metadata = example.metadata
+    @file_path = @metadata[:file_path]
+    @exception = Oopsy.new(example, @file_path)
+    @spec = nil
+    @screenshots = @metadata[:screenshots]
+    @screenrecord = @metadata[:screenrecord]
+    @failed_screenshot = @metadata[:failed_screenshot]
+  end
+
+  def example_title
+    title_arr = @example_group.to_s.split('::') - %w[RSpec ExampleGroups]
+    title_arr.push @description
+
+    title_arr.join(' → ')
+  end
+
+  def has_exception?
+    !@exception.klass.nil?
+  end
+
+  def has_spec?
+    !@spec.nil?
+  end
+
+  def has_screenshots?
+    !@screenshots.nil? && !@screenshots.empty?
+  end
+
+  def has_screenrecord?
+    !@screenrecord.nil?
+  end
+
+  def has_failed_screenshot?
+    !@failed_screenshot.nil?
+  end
+
+  def set_spec(spec_text)
+    formatter = Rouge::Formatters::HTMLLegacy.new(css_class: 'highlight')
+    lexer = Rouge::Lexers::Gherkin.new
+    @spec = formatter.format(lexer.lex(spec_text.gsub('#->', '')))
+  end
+
+  def klass(prefix = 'badge-')
+    class_map = { passed: "#{prefix}success", failed: "#{prefix}danger", pending: "#{prefix}warning" }
+    class_map[@status.to_sym]
+  end
+end

data/lib/rspec_pretty_html_reporter/oopsy.rb

@@ -0,0 +1,79 @@
+require 'rbconfig'
+require 'rspec/core/formatters/base_formatter'
+require 'rouge'
+
+class Oopsy
+  attr_reader :klass, :message, :backtrace, :highlighted_source, :explanation, :backtrace_message
+
+  def initialize(example, file_path)
+    @example = example
+    @exception = @example.exception
+    @file_path = file_path
+    unless @exception.nil?
+      @klass = @exception.class
+      @message = @exception.message.encode('utf-8')
+      @backtrace = @exception.backtrace
+      @backtrace_message = formatted_backtrace(@example, @exception)
+      @highlighted_source = process_source
+      @explanation = process_message
+    end
+  end
+
+  private
+
+  def os
+    @os ||= begin
+              host_os = RbConfig::CONFIG['host_os']
+              case host_os
+              when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                :windows
+              when /darwin|mac os/
+                :macosx
+              when /linux/
+                :linux
+              when /solaris|bsd/
+                :unix
+              else
+                raise StandardError, "unknown os: #{host_os.inspect}"
+              end
+            end
+  end
+
+  def formatted_backtrace(example, exception)
+    # To avoid an error in format_backtrace. RSpec's version below v3.5 will throw exception.
+    return [] unless example
+
+    formatter = RSpec.configuration.backtrace_formatter
+    formatter.format_backtrace(exception.backtrace, example.metadata)
+  end
+
+  def process_source
+
+    return '' if @backtrace_message.empty?
+
+    data = @backtrace_message.first.split(':')
+    unless data.empty?
+      if os == :windows
+        file_path = "#{data[0]}:#{data[1]}"
+        line_number = data[2].to_i
+      else
+        file_path = data.first
+        line_number = data[1].to_i
+      end
+      lines = File.readlines(file_path)
+      start_line = line_number - 2
+      end_line = line_number + 3
+      source = lines[start_line..end_line].join('').sub(lines[line_number - 1].chomp, "--->#{lines[line_number - 1].chomp}")
+      formatter = Rouge::Formatters::HTMLLegacy.new(css_class: 'highlight', line_numbers: true, start_line: start_line + 1)
+      lexer = Rouge::Lexers::Ruby.new
+      original_format = formatter.format(lexer.lex(source.encode('utf-8')))
+      original_format.gsub!(/<table class="rouge-table">/, '<table class="rouge-table" style="width:100%">')
+    end
+  end
+
+  def process_message
+    formatter = Rouge::Formatters::HTMLLegacy.new(css_class: 'highlight pl-3')
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(@message))
+  end
+end

data/lib/rspec_pretty_html_reporter.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/numeric'
+require 'active_support/inflector'
+require 'fileutils'
+require 'erb'
+require 'rspec_pretty_html_reporter/example'
+
+I18n.enforce_available_locales = false
+
+class RspecPrettyHtmlReporter < RSpec::Core::Formatters::BaseFormatter
+  DEFAULT_REPORT_PATH = File.join(Bundler.root, 'reports', Time.now.strftime('%Y%m%d-%H%M%S'))
+  REPORT_PATH = ENV['REPORT_PATH'] || DEFAULT_REPORT_PATH
+
+  SCREENRECORD_DIR = File.join(REPORT_PATH, 'screenrecords')
+  SCREENSHOT_DIR = File.join(REPORT_PATH, 'screenshots')
+  RESOURCE_DIR = File.join(REPORT_PATH, 'resources')
+
+  RSpec::Core::Formatters.register self, :example_started, :example_passed, :example_failed, :example_pending,
+                                   :example_group_finished
+
+  def initialize(_io_standard_out)
+    create_reports_dir
+    create_screenshots_dir
+    create_screenrecords_dir
+    copy_resources
+    @all_groups = {}
+
+    @group_level = 0
+  end
+
+  def example_group_started(_notification)
+    if @group_level.zero?
+      @example_group = {}
+      @examples = []
+      @group_example_count = 0
+      @group_example_success_count = 0
+      @group_example_failure_count = 0
+      @group_example_pending_count = 0
+    end
+
+    @group_level += 1
+  end
+
+  def example_started(_notification)
+    @group_example_count += 1
+  end
+
+  def example_passed(notification)
+    # require 'byebug'; byebug
+
+    @group_example_success_count += 1
+    @examples << Example.new(notification.example)
+  end
+
+  def example_failed(notification)
+    @group_example_failure_count += 1
+    @examples << Example.new(notification.example)
+  end
+
+  def example_pending(notification)
+    @group_example_pending_count += 1
+    @examples << Example.new(notification.example)
+  end
+
+  def example_group_finished(notification)
+    @group_level -= 1
+
+    if @group_level.zero?
+
+      File.open("#{REPORT_PATH}/#{notification.group.description.parameterize}.html", 'w') do |f|
+        @passed = @group_example_success_count
+        @failed = @group_example_failure_count
+        @pending = @group_example_pending_count
+
+        duration_values = @examples.map(&:run_time)
+
+        duration_keys = duration_values.size.times.to_a
+        if (duration_values.size < 2) && duration_values.size.positive?
+          duration_values.unshift(duration_values.first)
+          duration_keys = duration_keys << 1
+        end
+
+        @title = notification.group.description
+        @durations = duration_keys.zip(duration_values)
+
+        @summary_duration = duration_values.inject(0) { |sum, i| sum + i }.to_fs(:rounded, precision: 5)
+        Example.load_spec_comments!(@examples)
+
+        @total_group_examples = @passed + @failed + @pending
+
+
+        class_map = { passed: 'success', failed: 'danger', pending: 'warning' }
+        statuses = @examples.map(&:status)
+        @status = if statuses.include?('failed')
+                    'failed'
+                  else
+                    (statuses.include?('passed') ? 'passed' : 'pending')
+                  end
+        @all_groups[notification.group.description.parameterize] = {
+          group: notification.group.description,
+          examples: @examples.size,
+          status: @status,
+          klass: class_map[@status.to_sym],
+          passed: statuses.select { |s| s == 'passed' },
+          failed: statuses.select { |s| s == 'failed' },
+          pending: statuses.select { |s| s == 'pending' },
+          duration: @summary_duration
+        }
+
+        @example_status = @all_groups[notification.group.description.parameterize][:klass]
+
+        template_file = File.read("#{File.dirname(__FILE__)}/../templates/report.erb")
+
+        f.puts ERB.new(template_file).result(binding)
+      end
+    end
+  end
+
+  def close(notification)
+    File.open("#{REPORT_PATH}/overview.html", 'w') do |f|
+      @overview = @all_groups
+
+      @passed = @overview.values.map { |g| g[:passed].size }.inject(0) { |sum, i| sum + i }
+      @failed = @overview.values.map { |g| g[:failed].size }.inject(0) { |sum, i| sum + i }
+      @pending = @overview.values.map { |g| g[:pending].size }.inject(0) { |sum, i| sum + i }
+
+      duration_values = @overview.values.map { |e| e[:duration] }
+
+      duration_keys = duration_values.size.times.to_a
+      if duration_values.size < 2
+        duration_values.unshift(duration_values.first)
+        duration_keys = duration_keys << 1
+      end
+
+      @durations = duration_keys.zip(duration_values.map { |d| d.to_f.round(5) })
+      @summary_duration = duration_values.map do |d|
+        d.to_f.round(5)
+      end.inject(0) { |sum, i| sum + i }.to_fs(:rounded, precision: 5)
+      @total_examples = @passed + @failed + @pending
+      template_file = File.read("#{File.dirname(__FILE__)}/../templates/overview.erb")
+      f.puts ERB.new(template_file).result(binding)
+    end
+  end
+
+  private
+
+  def create_reports_dir
+    FileUtils.rm_rf(REPORT_PATH) if File.exist?(REPORT_PATH)
+    FileUtils.mkpath(REPORT_PATH)
+  end
+
+  def create_screenshots_dir
+    FileUtils.mkdir_p SCREENSHOT_DIR unless File.exist?(SCREENSHOT_DIR)
+  end
+
+  def create_screenrecords_dir
+    FileUtils.mkdir_p SCREENRECORD_DIR unless File.exist?(SCREENRECORD_DIR)
+  end
+
+  def copy_resources
+    FileUtils.cp_r("#{File.dirname(__FILE__)}/../resources", REPORT_PATH)
+  end
+end