Class: MiniTest::Unit

Inherits:
Object show all
Defined in:
lib/minitest/benchmark.rb,
lib/minitest/unit.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Deprecated, Guard, LifecycleHooks Classes: TestCase

Constant Summary collapse

VERSION =

:nodoc:

"4.0.0"
@@out = 
$stdout
@@after_tests = 
[]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Unit

:nodoc:



934
935
936
937
938
939
 
# File 'lib/minitest/unit.rb', line 934

def initialize # :nodoc:
  @report = []
  @errors = @failures = @skips = 0
  @verbose = false
  self.last_error = nil
end

Instance Attribute Details

#assertion_count ⇒ Object

:nodoc:



700
701
702
 
# File 'lib/minitest/unit.rb', line 700

def assertion_count
  @assertion_count
end

#errors ⇒ Object

:nodoc:



699
700
701
 
# File 'lib/minitest/unit.rb', line 699

def errors
  @errors
end

#failures ⇒ Object

:nodoc:



699
700
701
 
# File 'lib/minitest/unit.rb', line 699

def failures
  @failures
end

#help ⇒ Object

:nodoc:



702
703
704
 
# File 'lib/minitest/unit.rb', line 702

def help
  @help
end

#last_error ⇒ Object

:nodoc:



705
706
707
 
# File 'lib/minitest/unit.rb', line 705

def last_error
  @last_error
end

#options ⇒ Object

Lazy accessor for options.



710
711
712
 
# File 'lib/minitest/unit.rb', line 710

def options
  @options ||= {}
end

#report ⇒ Object

:nodoc:



699
700
701
 
# File 'lib/minitest/unit.rb', line 699

def report
  @report
end

#skips ⇒ Object

:nodoc:



699
700
701
 
# File 'lib/minitest/unit.rb', line 699

def skips
  @skips
end

#start_time ⇒ Object

:nodoc:



701
702
703
 
# File 'lib/minitest/unit.rb', line 701

def start_time
  @start_time
end

#test_count ⇒ Object

:nodoc:



700
701
702
 
# File 'lib/minitest/unit.rb', line 700

def test_count
  @test_count
end

#verbose ⇒ Object

:nodoc:



703
704
705
 
# File 'lib/minitest/unit.rb', line 703

def verbose
  @verbose
end

Class Method Details

.after_tests(&block) ⇒ Object

A simple hook allowing you to run a block of code after all of the tests are done. Eg:

MiniTest::Unit.after_tests { p $debugging_info }



724
725
726
 
# File 'lib/minitest/unit.rb', line 724

def self.after_tests &block
  @@after_tests << block
end

.autorun ⇒ Object

Registers MiniTest::Unit to run tests at process exit



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/minitest/unit.rb', line 731

def self.autorun
  at_exit {
    next if $! # don't run if there was an exception

    # the order here is important. The at_exit handler must be
    # installed before anyone else gets a chance to install their
    # own, that way we can be assured that our exit will be last
    # to run (at_exit stacks).
    exit_code = nil

    at_exit {
      @@after_tests.reverse_each(&:call)
      exit false if exit_code && exit_code != 0
    }

    exit_code = MiniTest::Unit.new.run ARGV
  } unless @@installed_at_exit
  @@installed_at_exit = true
end

.output ⇒ Object

Returns the stream to use for output.



754
755
756
 
# File 'lib/minitest/unit.rb', line 754

def self.output
  @@out
end

.output=(stream) ⇒ Object

Sets MiniTest::Unit to write output to stream. $stdout is the default output



762
763
764
 
# File 'lib/minitest/unit.rb', line 762

def self.output= stream
  @@out = stream
end

.plugins ⇒ Object

Return all plugins’ run methods (methods that start with “run_”).



786
787
788
789
790
 
# File 'lib/minitest/unit.rb', line 786

def self.plugins
  @@plugins ||= (["run_tests"] +
                 public_instance_methods(false).
                 grep(/^run_/).map { |s| s.to_s }).uniq
end

.runner ⇒ Object

Returns the MiniTest::Unit subclass instance that will be used to run the tests. A MiniTest::Unit instance is the default runner.



779
780
781
 
# File 'lib/minitest/unit.rb', line 779

def self.runner
  @@runner ||= self.new
end

.runner=(runner) ⇒ Object

Tells MiniTest::Unit to delegate to runner, an instance of a MiniTest::Unit subclass, when MiniTest::Unit#run is called.



770
771
772
 
# File 'lib/minitest/unit.rb', line 770

def self.runner= runner
  @@runner = runner
end

Instance Method Details

#_run(args = []) ⇒ Object

Top level driver, controls all output and filtering.



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/minitest/unit.rb', line 994

def _run args = []
  self.options = process_args args

  puts "Run options: #{help}"

  self.class.plugins.each do |plugin|
    send plugin
    break unless report.empty?
  end

  return failures + errors if @test_count > 0 # or return nil...
rescue Interrupt
  abort 'Interrupted'
end

#_run_anything(type) ⇒ Object

Runner for a given type (eg, test vs bench).



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
 
# File 'lib/minitest/unit.rb', line 810

def _run_anything type
  suites = TestCase.send "#{type}_suites"
  return if suites.empty?

  start = Time.now

  puts
  puts "# Running #{type}s:"
  puts

  @test_count, @assertion_count = 0, 0
  sync = output.respond_to? :"sync=" # stupid emacs
  old_sync, output.sync = output.sync, true if sync

  results = _run_suites suites, type

  @test_count      = results.inject(0) { |sum, (tc, _)| sum + tc }
  @assertion_count = results.inject(0) { |sum, (_, ac)| sum + ac }

  output.sync = old_sync if sync

  t = Time.now - start

  puts
  puts
  puts "Finished #{type}s in %.6fs, %.4f tests/s, %.4f assertions/s." %
    [t, test_count / t, assertion_count / t]

  report.each_with_index do |msg, i|
    puts "\n%3d) %s" % [i + 1, msg]
  end

  puts

  status
end

#_run_suite(suite, type) ⇒ Object

Run a single suite for a given type.



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/minitest/unit.rb', line 857

def _run_suite suite, type
  header = "#{type}_suite_header"
  puts send(header, suite) if respond_to? header

  filter = options[:filter] || '/./'
  filter = Regexp.new $1 if filter =~ /\/(.*)\//

  assertions = suite.send("#{type}_methods").grep(filter).map { |method|
    inst = suite.new method
    inst._assertions = 0

    print "#{suite}##{method} = " if @verbose

    @start_time = Time.now
    self.last_error = nil
    result = inst.run self
    time = Time.now - @start_time

    record suite, method, inst._assertions, time, last_error

    print "%.2f s = " % time if @verbose
    print result
    puts if @verbose

    inst._assertions
  }

  return assertions.size, assertions.inject(0) { |sum, n| sum + n }
end

#_run_suites(suites, type) ⇒ Object

Runs all the suites for a given type.



850
851
852
 
# File 'lib/minitest/unit.rb', line 850

def _run_suites suites, type
  suites.map { |suite| _run_suite suite, type }
end

#benchmark_suite_header(suite) ⇒ Object

:nodoc:



9
10
11
 
# File 'lib/minitest/benchmark.rb', line 9

def benchmark_suite_header suite # :nodoc:
  "\n#{suite}\t#{suite.bench_range.join("\t")}"
end

#location(e) ⇒ Object

:nodoc:



902
903
904
905
906
907
908
909
 
# File 'lib/minitest/unit.rb', line 902

def location e # :nodoc:
  last_before_assertion = ""
  e.backtrace.reverse_each do |s|
    break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
    last_before_assertion = s
  end
  last_before_assertion.sub(/:in .*$/, '')
end

#output ⇒ Object

Return the IO for output.



795
796
797
 
# File 'lib/minitest/unit.rb', line 795

def output
  self.class.output
end

#print(*a) ⇒ Object

:nodoc:



803
804
805
 
# File 'lib/minitest/unit.rb', line 803

def print *a # :nodoc:
  output.print(*a)
end

#process_args(args = []) ⇒ Object

:nodoc:



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/minitest/unit.rb', line 941

def process_args args = [] # :nodoc:
  options = {}
  orig_args = args.dup

  OptionParser.new do |opts|
    opts.banner  = 'minitest options:'
    opts.version = MiniTest::Unit::VERSION

    opts.on '-h', '--help', 'Display this help.' do
      puts opts
      exit
    end

    opts.on '-s', '--seed SEED', Integer, "Sets random seed" do |m|
      options[:seed] = m.to_i
    end

    opts.on '-v', '--verbose', "Verbose. Show progress processing files." do
      options[:verbose] = true
    end

    opts.on '-n', '--name PATTERN', "Filter test names on pattern (e.g. /foo/)" do |a|
      options[:filter] = a
    end

    opts.parse! args
    orig_args -= args
  end

  unless options[:seed] then
    srand
    options[:seed] = srand % 0xFFFF
    orig_args << "--seed" << options[:seed].to_s
  end

  srand options[:seed]

  self.verbose = options[:verbose]
  @help = orig_args.map { |s| s =~ /[\s|&<>$()]/ ? s.inspect : s }.join " "

  options
end

#puke(klass, meth, e) ⇒ Object

Writes status for failed test meth in klass which finished with exception e



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/minitest/unit.rb', line 915

def puke klass, meth, e
  self.last_error = e
  e = case e
      when MiniTest::Skip then
        @skips += 1
        return "S" unless @verbose
        "Skipped:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
      when MiniTest::Assertion then
        @failures += 1
        "Failure:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
      else
        @errors += 1
        bt = MiniTest::filter_backtrace(e.backtrace).join "\n    "
        "Error:\n#{meth}(#{klass}):\n#{e.class}: #{e.message}\n    #{bt}\n"
      end
  @report << e
  e[0, 1]
end

#puts(*a) ⇒ Object

:nodoc:



799
800
801
 
# File 'lib/minitest/unit.rb', line 799

def puts *a  # :nodoc:
  output.puts(*a)
end

#record(suite, method, assertions, time, error) ⇒ Object

Record the result of a single run. Makes it very easy to gather information. Eg:

class StatisticsRecorder < MiniTest::Unit
  def record suite, method, assertions, time, error
    # ... record the results somewhere ...
  end
end

MiniTest::Unit.runner = StatisticsRecorder.new



899
900
 
# File 'lib/minitest/unit.rb', line 899

def record suite, method, assertions, time, error
end

#run(args = []) ⇒ Object

Begins the full test run. Delegates to runner‘s #_run method.



987
988
989
 
# File 'lib/minitest/unit.rb', line 987

def run args = []
  self.class.runner._run(args)
end

#run_benchmarks ⇒ Object

:nodoc:



5
6
7
 
# File 'lib/minitest/benchmark.rb', line 5

def run_benchmarks # :nodoc:
  _run_anything :benchmark
end

#run_tests ⇒ Object

Runs test suites matching filter.



1012
1013
1014
 
# File 'lib/minitest/unit.rb', line 1012

def run_tests
  _run_anything :test
end

#status(io = self.output) ⇒ Object

Writes status to io



1019
1020
1021
1022
 
# File 'lib/minitest/unit.rb', line 1019

def status io = self.output
  format = "%d tests, %d assertions, %d failures, %d errors, %d skips"
  io.puts format % [test_count, assertion_count, failures, errors, skips]
end