rspec_html_formatter2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13b1438fa46dd3c7163b1d795a6898385199b3ba
+  data.tar.gz: d11829308cb7083429f0cf93a85ddda7165f7ec1
+SHA512:
+  metadata.gz: 2f19743c993bf015d0fca55e1f65a7d1ab95d1a5a85eb5c02322efb3cb858db286b2edb1c96992d0f20b8a8b06ee2442127b8cba0d1aed2e7db04c1af8576553
+  data.tar.gz: 636188e07d5ba5318582c4ed0a75fb55b43eece98d35093d4a20cf445343ba1d7776fcc32cbb9faadaa179eca7cc9a15ac2ce5e766310f4efce8d897ad79d3c0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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,37 @@
+# RSpec HTML Formatter2
+
+Publish pretty [rspec](http://rspec.info/) reports
+
+This is a ruby RSpec custom formatter which generates pretty html reports showing the results of rspec tests. It has features to embed images and videos into report providing better debugging information in case test is failed. Check this [Sample Report](https://vbanthia.github.io/rspec_html_formatter2/index.html).
+
+## Setup
+
+Add this in your Gemfile:
+
+```rb
+gem 'rspec_html_formatter2', git: 'https://github.com/vbanthia/rspec_html_formatter2'
+```
+**Note:** Will publish it soon.
+
+## Running
+
+Either add below in your `.rspec` file
+
+```rb
+--format RspecHtmlFormatter
+```
+
+or run RSpec with `--format RspecHtmlFormatter` like below:
+
+```bash
+REPORT_PATH=reports/$(date +%s) bundle exec rspec --format RspecHtmlFormatter spec
+```
+
+Above will create reports in `reports` directory.
+
+## Usage
+Images and videos can be embed by adding their path into example's metadata. Check this [Sample Test](./spec/embed_graphics_spec.rb).
+
+
+## Credits
+This library is forked from [kingsleyh/rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter). Original Credits goes to *[kingsleyh](https://github.com/kingsleyh)*

data/lib/rspec_html_formatter.rb

@@ -0,0 +1,300 @@
+require 'rspec/core/formatters/base_formatter'
+require 'active_support'
+require 'active_support/core_ext/numeric'
+require 'active_support/inflector'
+require 'fileutils'
+require 'rouge'
+require 'erb'
+require 'rbconfig'
+
+I18n.enforce_available_locales = false
+
+class Oopsy
+  attr_reader :klass, :message, :backtrace, :highlighted_source, :explanation, :backtrace_message
+
+  def initialize(exception, file_path)
+    @exception = exception
+    @file_path = file_path
+    unless @exception.nil?
+      @klass = @exception.class
+      @message = @exception.message.encode('utf-8')
+      @backtrace = @exception.backtrace
+      @backtrace_message = @backtrace.nil? ? '' : @backtrace.select { |r| r.match(@file_path) }.join('').encode('utf-8')
+      @highlighted_source = process_source
+      @explanation = process_message
+    end
+  end
+
+  private
+
+  def os
+    @os ||= (
+      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 Exception, "unknown os: #{host_os.inspect}"
+      end
+    )
+  end
+
+  def process_source
+    data = @backtrace_message.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::HTML.new(css_class: 'highlight', line_numbers: true, start_line: start_line+1)
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(source.encode('utf-8')))
+    end
+  end
+
+  def process_message
+    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
+    lexer = Rouge::Lexers::Ruby.new
+    formatter.format(lexer.lex(@message))
+  end
+
+end
+
+class Example
+
+  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_s(:rounded, precision: 5)
+    @status = @execution_result.status.to_s
+    @metadata = example.metadata
+    @file_path = @metadata[:file_path]
+    @exception = Oopsy.new(example.exception, @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('::') - ['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)
+    @spec = spec
+  end
+
+  def klass(prefix='label-')
+    class_map = {passed: "#{prefix}success", failed: "#{prefix}danger", pending: "#{prefix}warning"}
+    class_map[@status.to_sym]
+  end
+
+end
+
+class Specify
+
+  def initialize(examples)
+    @examples = examples
+  end
+
+  def process
+    lines = File.readlines(@examples.first.file_path)
+    @examples.each_with_index do |e, i|
+      start_line = e.metadata[:line_number]
+      end_line = @examples[i+1].nil? ? lines.size : @examples[i+1].metadata[:line_number] - 1
+      code_block = lines[start_line..end_line]
+      spec = code_block.select { |l| l.match(/#->/) }.join('')
+      if !spec.split.empty?
+        formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
+        lexer = Rouge::Lexers::Gherkin.new
+        formatted_spec = formatter.format(lexer.lex(spec.gsub('#->', '')))
+        e.set_spec(formatted_spec)
+      end
+    end
+    @examples
+  end
+end
+
+class RspecHtmlFormatter < 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 == 0
+      @example_group = {}
+      @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)
+    @group_example_success_count += 1
+    @group_examples << Example.new(notification.example)
+  end
+
+  def example_failed(notification)
+    @group_example_failure_count += 1
+    @group_examples << Example.new(notification.example)
+  end
+
+  def example_pending(notification)
+    @group_example_pending_count += 1
+    @group_examples << Example.new(notification.example)
+  end
+
+  def example_group_finished(notification)
+    @group_level -= 1
+
+    if @group_level == 0
+      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 = @group_examples.map { |e| e.run_time }
+
+        duration_keys = duration_values.size.times.to_a
+        if duration_values.size < 2 and duration_values.size > 0
+          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_s(:rounded, precision: 5)
+        @examples = Specify.new(@group_examples).process
+
+        class_map = {passed: 'success', failed: 'danger', pending: 'warning'}
+        statuses = @examples.map { |e| e.status }
+        status = statuses.include?('failed') ? 'failed' : (statuses.include?('passed') ? 'passed' : 'pending')
+        @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
+        }
+
+        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{|d| d.to_f.round(5)}.inject(0) { |sum, i| sum + i }.to_s(: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.exists?(REPORT_PATH)
+    FileUtils.mkpath(REPORT_PATH)
+  end
+
+  def create_screenshots_dir
+    FileUtils.mkdir_p SCREENSHOT_DIR unless File.exists?(SCREENSHOT_DIR)
+  end
+
+  def create_screenrecords_dir
+    FileUtils.mkdir_p SCREENRECORD_DIR unless File.exists?(SCREENRECORD_DIR)
+  end
+
+  def copy_resources
+    FileUtils.cp_r(File.dirname(__FILE__) + '/../resources', REPORT_PATH)
+  end
+
+end