Created
February 27, 2009 07:54
-
-
Save nz/71340 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Copyright (c) 2008 Nicholas A. Evans | |
# http://ekenosen.net/nick/devblog/2008/12/better-progress-bar-for-rspec/ | |
# | |
# With some tweaks (slow spec profiler, growl support) | |
# By Nick Zadrozny | |
# | |
# | |
# 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. | |
require 'spec/runner/formatter/base_text_formatter' | |
require "rubygems" | |
require 'progressbar' | |
module Spec | |
module Runner | |
module Formatter | |
class CompactProgressBarFormatter < BaseTextFormatter | |
# Threshold for slow specs, in seconds. | |
# Anything that takes longer than this will be printed out | |
# It would be great to get this down to 0.5 or less... | |
SLOW_SPEC_THRESHOLD = 2.0 | |
# Keep track the slowest specs and print a report at the end | |
SLOW_SPEC_REPORT = 3 | |
attr_reader :total, :current | |
def start(example_count) | |
@current = 0 | |
@total = example_count | |
@error_state = :all_passing | |
@slow_specs = [] | |
@pbar = ProgressBar.new("#{example_count} examples", example_count, output) | |
end | |
def example_started(example) | |
super | |
@start_time = Time.now | |
end | |
def example_passed(example) | |
elapsed = Time.now - @start_time | |
profile_example(example_group.description, example.description, elapsed) | |
increment | |
end | |
# third param is optional, because earlier versions of rspec sent only two args | |
def example_pending(example, message, pending_caller=nil) | |
immediately_dump_pending(example.description, message, pending_caller) | |
mark_error_state_pending | |
increment | |
end | |
def example_failed(example, counter, failure) | |
immediately_dump_failure(counter, failure) | |
notify_failure(counter, failure) | |
mark_error_state_failed | |
increment | |
end | |
def start_dump | |
with_color do | |
@pbar.finish | |
output.puts | |
end | |
report_slow_specs | |
output.flush | |
end | |
def dump_failure(*args) | |
# no-op; we summarized failures as we were running | |
end | |
def method_missing(sym, *args) | |
# ignore | |
end | |
def notify(title, message, priority) | |
title = title.gsub(/\s+/, ' ').gsub(/"/,'\"').gsub(/'/, "\'") | |
message = message.gsub(/\s+/, ' ').gsub(/"/,'\"').gsub(/'/, "\'").gsub(/`/,'\`') | |
notify_command = case RUBY_PLATFORM | |
when /darwin/ | |
"which growlnotify && test -x `which growlnotify` && growlnotify -n autotest -p #{priority} -m \"#{message}\" \"#{title}\"" | |
when /linux/ | |
"which notify-send && test -x `which notify-send` && notify-send \"#{title}\" \"#{message}\"" | |
end | |
# puts notify_command # use this for debugging purposes | |
system notify_command if notify_command | |
end | |
def notify_failure(counter, failure) | |
notify failure.header, failure.exception.message, 2 | |
end | |
# stolen and slightly modified from BaseTextFormatter#dump_failure | |
def immediately_dump_failure(counter, failure) | |
erase_current_line | |
output.print "#{counter.to_s}) " | |
output.puts colorize_failure("#{failure.header}\n#{failure.exception.message}", failure) | |
output.puts format_backtrace(failure.exception.backtrace) | |
output.puts | |
end | |
# stolen and modified from BaseTextFormatter#dump_pending | |
def immediately_dump_pending(desc, msg, called_from) | |
erase_current_line | |
output.puts yellow("PENDING SPEC:") + " #{desc} (#{msg})" | |
# output.puts " Called from #{called_from}" if called_from | |
output.puts | |
end | |
def increment | |
with_color do | |
@current += 1 | |
# HACK: need to make sure the progress is printed, even when the bar hasn't changed | |
@pbar.instance_variable_set("@previous", 0) | |
@pbar.instance_variable_set("@title", "#{current}/#{total}") | |
@pbar.inc | |
end | |
output.flush | |
end | |
ERROR_STATE_COLORS = { | |
:all_passing => "\e[32m", # green | |
:some_pending => "\e[33m", # yellow | |
:some_failed => "\e[31m", # red | |
} | |
def with_color | |
use_color = colour? && output_to_tty? | |
output.print ERROR_STATE_COLORS[@error_state] if use_color | |
yield | |
output.print "\e[0m" if use_color | |
end | |
def mark_error_state_failed | |
@error_state = :some_failed | |
end | |
def mark_error_state_pending | |
@error_state = :some_pending unless @error_state == :some_failed | |
end | |
def erase_current_line | |
output.print "\e[K" | |
end | |
def profile_example(group, example, elapsed) | |
@slow_specs = (@slow_specs + [[elapsed, group, example]]).sort.reverse[0, SLOW_SPEC_REPORT] | |
print_warning_if_really_slow(group, example, elapsed) | |
end | |
def print_warning_if_really_slow(group, example, elapsed) | |
if elapsed > SLOW_SPEC_THRESHOLD | |
#mark_error_state(:pending) | |
erase_current_line | |
output.puts "\n" | |
output.print yellow("SLOW SPEC (#{sprintf("%.4f", elapsed)}): ") | |
output.print "#{group} #{example}" | |
output.puts "\n" | |
end | |
end | |
def report_slow_specs | |
output.puts yellow("Top #{@slow_specs.size} slowest specs:") | |
@slow_specs.each do |elapsed, group, example| | |
output.puts " #{yellow(sprintf('%.4f', elapsed))} #{group} #{example}" | |
end | |
output.flush | |
end | |
end | |
end | |
end | |
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--colour | |
--require spec/compact_progress_bar_formatter.rb | |
--format Spec::Runner::Formatter::CompactProgressBarFormatter | |
--loadby mtime | |
--reverse |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment