vbanthia-zz / rspec_html_reporter Goto Github PK

I am trying to change the ui as per my project requirements.Please let me know what to edit or more specifically how it reads the tests and creates reports.

Hey @vbanthia, I really appreciate you forking/maintaining rspec_html_reporter, because I really like it and think it's easy to use!

I'd love to contribute if you're open to it. I think allowing reports to be generated in parallel would be a good contribution. What do you think? I didn't see a CONTRIBUTING.md so asking here

If a project has 2 tests with the same top level description, the html reports will overwrite one another.
In which case, the html report can show all tests passing, even though some tests are failing.
Additionally, it will show incorrect test counts.

I have an example project here:
https://github.com/micahtessler/example_rspec_reporting

if you run bundle exec rspec spec
You will see 2 tests, with 1 failure

if you run bundle exec rspec spec --format RspecHtmlReporter and look at overview.html, then it will show only one test having been run, whichever ran second.

Given:

# spec/shared_example_spec.rb
RSpec.describe "Example Group Including Examples" do
  include_examples "from another file", :should_pass
  include_examples "from another file", :should_fail
end

# spec/support/shared_examples/from_another_file.rb
RSpec.shared_examples "from another file" do |expected|
  it "works" do
    #-> Given a shared example with spec
    expect(expected).to eq(:should_pass)
  end
end

Behavior:

Expected:

Triage:
The v1.0.0 implementation for parsing example specs from sourcecode assumes:

1. all examples in an example group are from the same file (Addressed in v1.0.1)
2. examples in an example group will be lexically ordered in that same file

My PR to address this bug: #8.

It includes a test case that demonstrates that the second assumption fails when using the same shared example twice in a row. (There are other failure modes, but this one is the simplest.)

rspec_html_reporter.rb at line 60

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

I ran on windows, and using rspec with version 3.8.0, found that get file_path & line_number should be same with other OS, like:

file_path = data.first
line_number = data[1].to_i

Otherwise, it will throw exception : No such file Error at line 67: lines = File.readlines(file_path)

Please kindly confirm it, thanks.

Hi, I am wondering if you could release a version (can be patch release) for 124be31.

I am running into the Multiple Exception Error that that commit fixes, and it would be nice to be able to pull it as a stable version from the gem.

Thanks!

Hello,

With the recent change to how backtrace is shown on report page it looks like escaping < and > was missed:

<li>./spec/admin/basic/new_admin_spec.rb:10:in `block (2 levels) in <top (required)>'</li>

< not being escaped causes the report to render incompletely.

Generating a report fails when shared_examples are coming from a separate file and context has its own it, the reporter fails with:

NoMethodError: private method `select' called for nil:NilClass
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:148:in `block in process'
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:144:in `each'
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:144:in `each_with_index'
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:144:in `process'
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:235:in `block in example_group_finished'
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:217:in `open'
  /home/nelchael/.gem/ruby/gems/rspec_html_reporter-1.0.0/lib/rspec_html_reporter.rb:217:in `example_group_finished'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/reporter.rb:201:in `block in notify'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/reporter.rb:200:in `each'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/reporter.rb:200:in `notify'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/reporter.rb:115:in `example_group_finished'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/example_group.rb:603:in `run'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:116:in `block (3 levels) in run_specs'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:116:in `map'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:116:in `block (2 levels) in run_specs'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/configuration.rb:1989:in `with_suite_hooks'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:111:in `block in run_specs'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/reporter.rb:74:in `report'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:110:in `run_specs'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:87:in `run'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:71:in `run'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/lib/rspec/core/runner.rb:45:in `invoke'
  /home/nelchael/.gem/ruby/gems/rspec-core-3.8.0/exe/rspec:4:in `<top (required)>'
  /home/nelchael/.gem/ruby/bin/rspec:23:in `load'
  /home/nelchael/.gem/ruby/bin/rspec:23:in `<top (required)>'

Steps to reproduce:

1. Create Gemfile:

source "https://rubygems.org"
gem "rspec", "~> 3.8.0"
gem "rspec_html_reporter", ">= 1.0.0"

2. Create context.rb:

#!/usr/bin/ruby

RSpec.shared_examples "foo" do |arg|
  it "works" do
    expect("foo-bar-baz").to eq(arg)
  end
end

3. Create spec.rb:

#!/usr/bin/ruby

require_relative "context"

RSpec.describe "an example group" do
  include_examples "foo", "foo-bar-baz"

  it "works again" do
    expect("foo").to eq("foo")
  end
end

4. bundle install
5. bundle exec rspec --format d --format RspecHtmlReporter ./spec.rb

Moving the shared_examples block into spec.rb seems to fix this, but obviously is not a solution for sharing code between multiple spec files.

Hello,
instead of saving the reports locally, where the test scripts are located, is it possible to provide a URL to another machine/server to save the reports there?