Class: Test::Unit::AutoRunner

Inherits:
Object
  • Object
show all
Defined in:
lib/test/unit/autorunner.rb

Constant Summary collapse

RUNNERS = 
{}
COLLECTORS = 
{}
ADDITIONAL_OPTIONS = 
[]
PREPARE_HOOKS = 
[]
@@default_runner = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(standalone) {|_self| ... } ⇒ AutoRunner

Returns a new instance of AutoRunner.

Yields:

  • (_self)

Yield Parameters:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/test/unit/autorunner.rb', line 119

def initialize(standalone)
  Unit.run = true
  @standalone = standalone
  @runner = default_runner
  @collector = default_collector
  @filters = []
  @to_run = []
  @color_scheme = ColorScheme.default
  @runner_options = {}
  @default_arguments = []
  @workdir = nil
  @listeners = []
  config_file = "test-unit.yml"
  if File.exist?(config_file)
    load_config(config_file)
  else
    load_global_config
  end
  yield(self) if block_given?
end

Instance Attribute Details

#base ⇒ Object

Returns the value of attribute base.



115
116
117
 
# File 'lib/test/unit/autorunner.rb', line 115

def base
  @base
end

#collector=(value) ⇒ Object (writeonly)

Sets the attribute collector

Parameters:

  • value —

    the value to set the attribute collector to.



117
118
119
 
# File 'lib/test/unit/autorunner.rb', line 117

def collector=(value)
  @collector = value
end

#color_scheme ⇒ Object

Returns the value of attribute color_scheme.



116
117
118
 
# File 'lib/test/unit/autorunner.rb', line 116

def color_scheme
  @color_scheme
end

#exclude ⇒ Object

Returns the value of attribute exclude.



115
116
117
 
# File 'lib/test/unit/autorunner.rb', line 115

def exclude
  @exclude
end

#filters ⇒ Object

Returns the value of attribute filters.



115
116
117
 
# File 'lib/test/unit/autorunner.rb', line 115

def filters
  @filters
end

#listeners ⇒ Object

Returns the value of attribute listeners.



116
117
118
 
# File 'lib/test/unit/autorunner.rb', line 116

def listeners
  @listeners
end

#pattern ⇒ Object

Returns the value of attribute pattern.



115
116
117
 
# File 'lib/test/unit/autorunner.rb', line 115

def pattern
  @pattern
end

#runner=(value) ⇒ Object (writeonly)

Sets the attribute runner

Parameters:

  • value —

    the value to set the attribute runner to.



117
118
119
 
# File 'lib/test/unit/autorunner.rb', line 117

def runner=(value)
  @runner = value
end

#runner_options ⇒ Object (readonly)

Returns the value of attribute runner_options.



114
115
116
 
# File 'lib/test/unit/autorunner.rb', line 114

def runner_options
  @runner_options
end

#suite ⇒ Object (readonly)

Returns the value of attribute suite.



114
115
116
 
# File 'lib/test/unit/autorunner.rb', line 114

def suite
  @suite
end

#to_run ⇒ Object

Returns the value of attribute to_run.



115
116
117
 
# File 'lib/test/unit/autorunner.rb', line 115

def to_run
  @to_run
end

#workdir ⇒ Object

Returns the value of attribute workdir.



115
116
117
 
# File 'lib/test/unit/autorunner.rb', line 115

def workdir
  @workdir
end

Class Method Details

.collector(id) ⇒ Object 



36
37
38
 
# File 'lib/test/unit/autorunner.rb', line 36

def collector(id)
  COLLECTORS[id.to_s]
end

.default_runner ⇒ Object 



23
24
25
 
# File 'lib/test/unit/autorunner.rb', line 23

def default_runner
  runner(@@default_runner)
end

.default_runner=(id) ⇒ Object 



27
28
29
 
# File 'lib/test/unit/autorunner.rb', line 27

def default_runner=(id)
  @@default_runner = id
end

.prepare(hook = Proc.new) ⇒ Object 



48
49
50
 
# File 'lib/test/unit/autorunner.rb', line 48

def prepare(hook=Proc.new)
  PREPARE_HOOKS << hook
end

.register_collector(id, collector_builder = Proc.new) ⇒ Object 



31
32
33
34
 
# File 'lib/test/unit/autorunner.rb', line 31

def register_collector(id, collector_builder=Proc.new)
  COLLECTORS[id] = collector_builder
  COLLECTORS[id.to_s] = collector_builder
end

.register_color_scheme(id, scheme) ⇒ Object 



40
41
42
 
# File 'lib/test/unit/autorunner.rb', line 40

def register_color_scheme(id, scheme)
  ColorScheme[id] = scheme
end

.register_runner(id, runner_builder = Proc.new) ⇒ Object 



13
14
15
16
 
# File 'lib/test/unit/autorunner.rb', line 13

def register_runner(id, runner_builder=Proc.new)
  RUNNERS[id] = runner_builder
  RUNNERS[id.to_s] = runner_builder
end

.run(force_standalone = false, default_dir = nil, argv = ARGV, &block) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/test/unit/autorunner.rb', line 53

def self.run(force_standalone=false, default_dir=nil, argv=ARGV, &block)
  r = new(force_standalone || standalone?, &block)
  r.base = default_dir
  r.prepare
  r.process_args(argv)
  r.run
end

.runner(id) ⇒ Object 



18
19
20
 
# File 'lib/test/unit/autorunner.rb', line 18

def runner(id)
  RUNNERS[id.to_s]
end

.setup_option(option_builder = Proc.new) ⇒ Object 



44
45
46
 
# File 'lib/test/unit/autorunner.rb', line 44

def setup_option(option_builder=Proc.new)
  ADDITIONAL_OPTIONS << option_builder
end

.standalone? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
64
65
66
67
 
# File 'lib/test/unit/autorunner.rb', line 61

def self.standalone?
  return false unless("-e" == $0)
  ObjectSpace.each_object(Class) do |klass|
    return false if(klass < TestCase)
  end
  true
end

Instance Method Details

#keyword_display(keywords) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/test/unit/autorunner.rb', line 329

def keyword_display(keywords)
  keywords = keywords.collect do |keyword, _|
    keyword.to_s
  end.uniq.sort

  i = 0
  keywords.collect do |keyword|
    if (i > 0 and keyword[0] == keywords[i - 1][0]) or
        ((i < keywords.size - 1) and (keyword[0] == keywords[i + 1][0]))
      n = 2
    else
      n = 1
    end
    i += 1
    keyword.sub(/^(.{#{n}})([A-Za-z]+)(?=\w*$)/, '\\1[\\2]')
  end.join(", ")
end

#load_config(file) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/test/unit/autorunner.rb', line 359

def load_config(file)
  require 'yaml'
  config = YAML.load(File.read(file))
  runner_name = config["runner"]
  @runner = self.class.runner(runner_name) || @runner
  @collector = self.class.collector(config["collector"]) || @collector
  (config["color_schemes"] || {}).each do |name, options|
    ColorScheme[name] = options
  end
  runner_options = {}
  (config["#{runner_name}_options"] || {}).each do |key, value|
    key = key.to_sym
    value = ColorScheme[value] if key == :color_scheme
    if key == :arguments
      @default_arguments.concat(value.split)
    else
      runner_options[key.to_sym] = value
    end
  end
  @runner_options = @runner_options.merge(runner_options)
end

#options ⇒ Object 



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/test/unit/autorunner.rb', line 158

def options
  @options ||= OptionParser.new do |o|
    o.banner = "Test::Unit automatic runner."
    o.banner << "\nUsage: #{$0} [options] [-- untouched arguments]"

    o.on('-r', '--runner=RUNNER', RUNNERS,
         "Use the given RUNNER.",
         "(" + keyword_display(RUNNERS) + ")") do |r|
      @runner = r
    end

    o.on('--collector=COLLECTOR', COLLECTORS,
         "Use the given COLLECTOR.",
         "(" + keyword_display(COLLECTORS) + ")") do |collector|
      @collector = collector
    end

    if (@standalone)
      o.on('-b', '--basedir=DIR', "Base directory of test suites.") do |b|
        @base = b
      end

      o.on('-w', '--workdir=DIR', "Working directory to run tests.") do |w|
        @workdir = w
      end

      o.on('-a', '--add=TORUN', Array,
           "Add TORUN to the list of things to run;",
           "can be a file or a directory.") do |a|
        @to_run.concat(a)
      end

      @pattern = []
      o.on('-p', '--pattern=PATTERN', Regexp,
           "Match files to collect against PATTERN.") do |e|
        @pattern << e
      end

      @exclude = []
      o.on('-x', '--exclude=PATTERN', Regexp,
           "Ignore files to collect against PATTERN.") do |e|
        @exclude << e
      end
    end

    o.on('-n', '--name=NAME', String,
         "Runs tests matching NAME.",
         "(patterns may be used).") do |n|
      n = (%r{\A/(.*)/\Z} =~ n ? Regexp.new($1) : n)
      case n
      when Regexp
        @filters << proc{|t| n =~ t.method_name ? true : false}
      else
        @filters << proc{|t| n == t.method_name}
      end
    end

    o.on('--ignore-name=NAME', String,
         "Ignores tests matching NAME.",
         "(patterns may be used).") do |n|
      n = (%r{\A/(.*)/\Z} =~ n ? Regexp.new($1) : n)
      case n
      when Regexp
        @filters << proc {|t| n =~ t.method_name ? false : true}
      else
        @filters << proc {|t| n != t.method_name}
      end
    end

    o.on('-t', '--testcase=TESTCASE', String,
         "Runs tests in TestCases matching TESTCASE.",
         "(patterns may be used).") do |n|
      n = (%r{\A/(.*)/\Z} =~ n ? Regexp.new($1) : n)
      case n
      when Regexp
        @filters << proc{|t| n =~ t.class.name ? true : false}
      else
        @filters << proc{|t| n == t.class.name}
      end
    end

    o.on('--ignore-testcase=TESTCASE', String,
         "Ignores tests in TestCases matching TESTCASE.",
         "(patterns may be used).") do |n|
      n = (%r{\A/(.*)/\Z} =~ n ? Regexp.new($1) : n)
      case n
      when Regexp
        @filters << proc {|t| n =~ t.class.name ? false : true}
      else
        @filters << proc {|t| n != t.class.name}
      end
    end

    priority_filter = Proc.new do |test|
      if @filters == [priority_filter]
        Priority::Checker.new(test).need_to_run?
      else
        nil
      end
    end
    o.on("--[no-]priority-mode",
         "Runs some tests based on their priority.") do |priority_mode|
      if priority_mode
        Priority.enable
        @filters |= [priority_filter]
      else
        Priority.disable
        @filters -= [priority_filter]
      end
    end

    o.on("--default-priority=PRIORITY",
         Priority.available_values,
         "Uses PRIORITY as default priority",
         "(#{keyword_display(Priority.available_values)})") do |priority|
      Priority.default = priority
    end

    o.on('-I', "--load-path=DIR[#{File::PATH_SEPARATOR}DIR...]",
         "Appends directory list to $LOAD_PATH.") do |dirs|
      $LOAD_PATH.concat(dirs.split(File::PATH_SEPARATOR))
    end

    color_schemes = ColorScheme.all
    o.on("--color-scheme=SCHEME", color_schemes,
         "Use SCHEME as color scheme.",
         "(#{keyword_display(color_schemes)})") do |scheme|
      @color_scheme = scheme
    end

    o.on("--config=FILE",
         "Use YAML fomat FILE content as configuration file.") do |file|
      load_config(file)
    end

    o.on("--order=ORDER", TestCase::AVAILABLE_ORDERS,
         "Run tests in a test case in ORDER order.",
         "(#{keyword_display(TestCase::AVAILABLE_ORDERS)})") do |order|
      TestCase.test_order = order
    end

    ADDITIONAL_OPTIONS.each do |option_builder|
      option_builder.call(self, o)
    end

    o.on('--',
         "Stop processing options so that the",
         "remaining options will be passed to the",
         "test."){o.terminate}

    o.on('-h', '--help', 'Display this help.'){puts o; exit}

    o.on_tail
    o.on_tail('Deprecated options:')

    o.on_tail('--console', 'Console runner (use --runner).') do
      warn("Deprecated option (--console).")
      @runner = self.class.runner(:console)
    end

    if RUNNERS[:fox]
      o.on_tail('--fox', 'Fox runner (use --runner).') do
        warn("Deprecated option (--fox).")
        @runner = self.class.runner(:fox)
      end
    end

    o.on_tail
  end
end

#prepare ⇒ Object 



140
141
142
143
144
 
# File 'lib/test/unit/autorunner.rb', line 140

def prepare
  PREPARE_HOOKS.each do |handler|
    handler.call(self)
  end
end

#process_args(args = ARGV) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/test/unit/autorunner.rb', line 146

def process_args(args = ARGV)
  begin
    args.unshift(*@default_arguments)
    options.order!(args) {|arg| @to_run << arg}
  rescue OptionParser::ParseError => e
    puts e
    puts options
    exit(false)
  end
  not @to_run.empty?
end

#run ⇒ Object 



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/test/unit/autorunner.rb', line 347

def run
  suite = @collector[self]
  return false if suite.nil?
  runner = @runner[self]
  return false if runner.nil?
  @runner_options[:color_scheme] ||= @color_scheme
  @runner_options[:listeners] ||= []
  @runner_options[:listeners].concat(@listeners)
  Dir.chdir(@workdir) if @workdir
  runner.run(suite, @runner_options).passed?
end