https://github.com/vbanthia-zz/rspec_html_reporter

Rspec custom formatter to produce beautiful reports from rspec
https://github.com/vbanthia-zz/rspec_html_reporter

reporter rspec ruby

Last synced: 11 days ago
JSON representation

Rspec custom formatter to produce beautiful reports from rspec

• Host: GitHub
• URL: https://github.com/vbanthia-zz/rspec_html_reporter
• Owner: vbanthia-zz
• License: mit
• Fork: true (kingsleyh/rspec_reports_formatter)
• Created: 2017-06-20T22:30:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-15T11:06:59.000Z (12 months ago)
• Last Synced: 2024-10-18T08:36:05.121Z (4 months ago)
• Topics: reporter, rspec, ruby
• Language: Ruby
• Homepage: https://vbanthia.github.io/rspec_html_reporter/index.html
• Size: 2.78 MB
• Stars: 32
• Watchers: 2
• Forks: 15
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
**Not Actively maintained. Please fork it to make any new change**

---

# RSpec HTML Reporter

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_reporter/index.html).

## Setup

Add this in your Gemfile:

```rb

gem 'rspec_html_reporter'

```

## Running

Either add below in your `.rspec` file

```rb

--format RspecHtmlReporter

```

or run RSpec with `--format RspecHtmlReporter` like below:

```bash

REPORT_PATH=reports/$(date +%s) bundle exec rspec --format RspecHtmlReporter 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)*