Module: Minitest

Defined in:
lib/spec.rb,
lib/minitest.rb,
lib/minitest/mock.rb,
lib/minitest/test.rb,
lib/minitest/unit.rb,
lib/minitest/parallel.rb,
lib/minitest/benchmark.rb,
lib/minitest/benchmark.rb,
lib/minitest/assertions.rb,
lib/minitest/pride_plugin.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Assertions, Expectations, Guard, Parallel Classes: AbstractReporter, Assertion, BacktraceFilter, BenchSpec, Benchmark, CompositeReporter, Mock, PrideIO, PrideLOL, ProgressReporter, Reporter, Runnable, Skip, Spec, StatisticsReporter, SummaryReporter, Test, UnexpectedError, Unit

Constant Summary collapse

VERSION =

:nodoc:

'5.3.4'
DATE =

:nodoc:

'2014-04-22'
@@after_run = 
[]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.__run(reporter, options) ⇒ Object

Internal run method. Responsible for telling all Runnable sub-classes to run.

NOTE: this method is redefined in parallel_each.rb, which is loaded if a Runnable calls parallelize_me!.



11
12
13
14
15
 
# File 'lib/spec.rb', line 11

def self.__run reporter, options
  Runnable.runnables.each do |runnable|
    runnable.run reporter, options
  end
end

.after_run(&block) ⇒ Object

A simple hook allowing you to run a block of code after everything is done running. Eg:

Minitest.after_run { p $debugging_info }



67
68
69
 
# File 'lib/minitest.rb', line 67

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

.autorun ⇒ Object

Registers Minitest to run at process exit



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/minitest.rb', line 45

def self.autorun
  at_exit {
    next if $! and not ($!.kind_of? SystemExit and $!.success?)

    exit_code = nil

    at_exit {
      @@after_run.reverse_each(&:call)
      exit exit_code || false
    }

    exit_code = Minitest.run ARGV
  } unless @@installed_at_exit
  @@installed_at_exit = true
end

.filter_backtrace(bt) ⇒ Object

:nodoc:



219
220
221
 
# File 'lib/minitest.rb', line 219

def self.filter_backtrace bt # :nodoc:
  backtrace_filter.filter bt
end

.init_plugins(options) ⇒ Object

:nodoc:



71
72
73
74
75
76
 
# File 'lib/minitest.rb', line 71

def self.init_plugins options # :nodoc:
  self.extensions.each do |name|
    msg = "plugin_#{name}_init"
    send msg, options if self.respond_to? msg
  end
end

.load_plugins ⇒ Object

:nodoc:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/minitest.rb', line 78

def self.load_plugins # :nodoc:
  return unless self.extensions.empty?

  seen = {}

  require "rubygems" unless defined? Gem

  Gem.find_files("minitest/*_plugin.rb").each do |plugin_path|
    name = File.basename plugin_path, "_plugin.rb"

    next if seen[name]
    seen[name] = true

    require plugin_path
    self.extensions << name
  end
end

.on_exit(exit_code) ⇒ Object 



63
64
65
66
 
# File 'lib/spec.rb', line 63

def self.on_exit exit_code
  @@after_run.reverse_each(&:call)
  exit exit_code || false
end

.plugin_pride_init(options) ⇒ Object

:nodoc:



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/minitest/pride_plugin.rb', line 10

def self.plugin_pride_init options # :nodoc:
  if PrideIO.pride? then
    klass = ENV["TERM"] =~ /^xterm|-256color$/ ? PrideLOL : PrideIO
    io    = klass.new options[:io]

    self.reporter.reporters.grep(Minitest::Reporter).each do |rep|
      rep.io = io
    end
  end
end

.plugin_pride_options(opts, options) ⇒ Object

:nodoc:



4
5
6
7
8
 
# File 'lib/minitest/pride_plugin.rb', line 4

def self.plugin_pride_options opts, options # :nodoc:
  opts.on "-p", "--pride", "Pride. Show your testing pride!" do
    PrideIO.pride!
  end
end

.process_args(args = []) ⇒ Object

:nodoc:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/minitest.rb', line 154

def self.process_args args = [] # :nodoc:
  options = {
             :io => $stdout,
            }
  orig_args = args.dup

  OptionParser.new do |opts|
    opts.banner  = "minitest options:"
    opts.version = Minitest::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 run on /pattern/ or string." do |a|
      options[:filter] = a
    end

    unless extensions.empty?
      opts.separator ""
      opts.separator "Known extensions: #{extensions.join(', ')}"

      extensions.each do |meth|
        msg = "plugin_#{meth}_options"
        send msg, opts, options if self.respond_to?(msg)
      end
    end

    begin
      opts.parse! args
    rescue OptionParser::InvalidOption => e
      puts
      puts e
      puts
      puts opts
      exit 1
    end

    orig_args -= args
  end

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

  srand options[:seed]

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

  options
end

.run(args = []) ⇒ Object

This is the top-level run method. Everything starts from here. It tells each Runnable sub-class to run, and each of those are responsible for doing whatever they do.

The overall structure of a run looks like this:

Minitest.autorun
  Minitest.run(args)
    Minitest.__run(reporter, options)
      Runnable.runnables.each
        runnable.run(reporter, options)
          self.runnable_methods.each
            self.run_one_method(self, runnable_method, reporter)
              Minitest.run_one_method(klass, runnable_method, reporter)
                klass.new(runnable_method).run



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/minitest.rb', line 113

def self.run args = []
  self.load_plugins

  options = process_args args

  reporter = CompositeReporter.new
  reporter << SummaryReporter.new(options[:io], options)
  reporter << ProgressReporter.new(options[:io], options)

  self.reporter = reporter # this makes it available to plugins
  self.init_plugins options
  self.reporter = nil # runnables shouldn't depend on the reporter, ever

  reporter.start
  __run reporter, options
  self.parallel_executor.shutdown
  reporter.report

  reporter.passed?
end

.run_one_method(klass, method_name) ⇒ Object

:nodoc:



759
760
761
762
763
 
# File 'lib/minitest.rb', line 759

def self.run_one_method klass, method_name # :nodoc:
  result = klass.new(method_name).run
  raise "#{klass}#run _must_ return self" unless klass === result
  result
end

.run_specs(spec_opts = {}) ⇒ Object

Run specs. Does not print dots (ProgressReporter)

spec_opts

Parameters:

  • :io (Array<String>) —

    defaults to $stdout

  • :trace (Array<String>) —

    files to trace



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/spec.rb', line 74

def self.run_specs spec_opts={}
  options  = { :io      => spec_opts.fetch(:io, $stdout),
               :verbose => spec_opts.fetch(:verbose, false) }
  reporter = Minitest::CompositeReporter.new
  reporter << Minitest::SummaryReporter.new(options[:io], options)
  reporter.start

  at_exit { on_exit reporter.passed? }
  # exit on ctrl+c to trigger at_exit
  trap('SIGINT') { exit }

  trace_specs spec_opts

  Minitest.__run reporter, options
  reporter.reporters.each { |r| r.report }
end

.trace_specs(spec_opts) ⇒ Object

Trace file source to :io (default $stdout)

spec_opts = {}

Parameters:

  • :trace (Array<String>) —

    the files to trace

  • :io (IO) —

    io to print to



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/spec.rb', line 24

def self.trace_specs spec_opts
  targets   = []
  files     = {}
  last_file = ''
  last_line = -1

  files_to_trace = spec_opts.fetch(:trace, []);
  io    = spec_opts.fetch(:io, $stdout)
  color = spec_opts.fetch(:color, "\e[32m") # ANSI.green default
  # target only existing readable files
  files_to_trace.each do |f|
    if File.exists?(f) && File.readable?(f)
      targets.push File.expand_path f
      targets.push File.basename f # sometimes the file is relative
    end
  end
  return if targets.empty?

  set_trace_func(lambda do |event, file, line, id, binding, classname|
    return unless targets.include?(file)

    # never repeat a line
    return if file == last_file && line == last_line

    file_sym        = file.intern
    files[file_sym] = IO.readlines(file) if files[file_sym].nil?
    lines           = files[file_sym]

    # arrays are 0 indexed and line numbers start at one.
    io.print color if color # ANSI code
    io.puts lines[line - 1]
    io.print "\e[0m" if color # ANSI.clear

    last_file = file
    last_line = line

  end)
end

Instance Method Details

#attr_accessor ⇒ Object

Names of known extension plugins.



22
 
# File 'lib/minitest.rb', line 22

mc.send :attr_accessor, :parallel_executor