Description
RSpec TAP Formatters provides four different TAP 13 format style with a proper nested display of example groups and includes stats for the total number of passed, failed, and pending tests per example group. The supported formats are:
1. RSpec::TAP::Formatters::Default
2. RSpec::TAP::Formatters::Compact
3. RSpec::TAP::Formatters::Flat
4. RSpec::TAP::Formatters::FlatCompact
Each formatter respects the color configuration for the execution and only
prints colored output when enabled. However, writing to a file will never use
colors. When writing the report to a file, each formatter will print progress status
on the standard output:
rspec-tap-formatters alternatives and similar gems
Based on the "Formatters" category.
Alternatively, view rspec-tap-formatters alternatives based on common mentions on social networks and blogs.
-
Spork
A DRb server for testing frameworks (RSpec / Cucumber currently) that forks before each run to ensure a clean testing state. -
RR
RR is a test double framework that features a rich selection of double techniques and a terse syntax. ⛺
Scout Monitoring - Performance metrics and, now, Logs Management Monitoring with Scout Monitoring
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of rspec-tap-formatters or a related project?
README
RSpec TAP Formatters
RSpec TAP Formatters produces TAP 13 output with a proper nested display of example groups and includes stats for the total number of passed, failed, and pending tests per example group.
Why use TAP Formatter
With TAP format, it is easier to view failure reason immediately without waiting for the failure dumps at the end. Also, TAP is a universal format, so one can:
- Leverage other tools to parse the output.
- Mix in different types of tests with consistent output.
Formatters Behavior
RSpec TAP Formatters supports four variants:
RSpec::TAP::Formatters::Default
RSpec::TAP::Formatters::Compact
RSpec::TAP::Formatters::Flat
RSpec::TAP::Formatters::FlatCompact
Each formatter respects the color configuration for the execution and only prints colored output when enabled. However, writing to a file will never use colors. When writing the report to a file, each formatter will print progress status on the standard output:
.
for passingF
for failing*
for pending
Sample Report
Sample report for [string_spec.rb](resources/string_spec.rb) using
RSpec::TAP::Formatters::Default
format:
TAP version 13
# test: String {
# group: #present? {
# group: when whitespaces and other characters {
ok 1 - returns true
1..1
# tests: 1, passed: 1
}
# group: when nil {
not ok 1 - returns false
---
location: "./resources/string_spec.rb:8"
error: |-
Failure/Error: expect(string.present?).to eq(false)
NoMethodError:
undefined method `present?' for nil:NilClass
backtrace: "./resources/string_spec.rb:9:in `block (4 levels) in <top (required)>'"
...
1..1
# tests: 1, failed: 1
}
# group: when whitespaces only {
ok 1 - returns false
1..1
# tests: 1, passed: 1
}
1..3
# tests: 3, passed: 2, failed: 1
}
1..3
# tests: 3, passed: 2, failed: 1
}
1..3
# tests: 3, passed: 2, failed: 1
# duration: 0.026471 seconds
# seed: 27428
You can check the reports for other formats [here](resources/reports).
Installation
Installation is pretty standard:
gem install rspec-tap-formatters
You can install using bundler
also but do not require it in Gemfile
.
Make sure to use it as a test dependency:
group :test do
# other gems
gem 'rspec-tap-formatters', '~> 0.1.0', require: false
end
You can also install using the GitHub package registry:
source 'https://rubygems.pkg.github.com/avmnu-sng' do
gem 'rspec-tap-formatters', '~> 0.1.0', require: false
end
Usage
You can specify the format as the command argument:
rspec --format RSpec::TAP::Formatters::Default
To write to file, provide the --out
argument:
rspec --format RSpec::TAP::Formatters::Default --out report.tap
You can also configure the .rspec
file:
# other configurations
--format RSpec::TAP::Formatters::Default
--out report.tap
Documentation
Read more about TAP specifications and supported formats in the official docs.
Source Code Documentation
Read the source code documentation here.
Compatibility
RSpec TAP Formatters supports MRI 2.3+
and RSpec 3
.
Changelog
The changelog is available [here](CHANGELOG.md).
Copyright
Copyright (c) 2019 Abhimanyu Singh. See [LICENSE.md](LICENSE.md) for further details.
*Note that all licence references and agreements mentioned in the rspec-tap-formatters README section above
are relevant to that project's source code only.