Class: Test::Unit::AutoRunner
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/test/unit/autorunner.rb |
Constant Summary
-
ADDITIONAL_OPTIONS =
# File 'lib/test/unit/autorunner.rb', line 11[]
-
COLLECTORS =
# File 'lib/test/unit/autorunner.rb', line 10{}
-
PREPARE_HOOKS =
# File 'lib/test/unit/autorunner.rb', line 12[]
-
RUNNERS =
# File 'lib/test/unit/autorunner.rb', line 9{}
Class Attribute Summary
Class Method Summary
- .collector(id)
- .new(standalone) {|_self| ... } ⇒ AutoRunner constructor
- .prepare(hook = Proc.new)
- .register_collector(id, collector_builder = Proc.new)
- .register_color_scheme(id, scheme)
- .register_runner(id, runner_builder = Proc.new)
- .run(force_standalone = false, default_dir = nil, argv = ARGV, &block)
- .runner(id)
- .setup_option(option_builder = Proc.new)
Instance Attribute Summary
- #base rw
- #color_scheme rw
- #exclude rw
- #filters rw
- #listeners rw
- #pattern rw
- #to_run rw
- #workdir rw
- #runner_options readonly
- #suite readonly
- #collector=(value) writeonly
- #runner=(value) writeonly
Instance Method Summary
- #keyword_display(keywords)
- #load_config(file)
- #options
- #prepare
- #process_args(args = ARGV)
- #run
- #change_work_directory(&block) private
- #default_collector private
- #default_runner private
- #global_config_file private
- #load_global_config private
- #match_test_case_name(test, pattern) private
Constructor Details
.new(standalone) {|_self| ... } ⇒ AutoRunner
# File 'lib/test/unit/autorunner.rb', line 138
def initialize(standalone) @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
Class Attribute Details
.default_runner (rw)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 25
def default_runner runner(@@default_runner) end
.default_runner=(id) (rw)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 29
def default_runner=(id) @@default_runner = id end
.need_auto_run=(need) (rw)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 75
def need_auto_run=(need) @@need_auto_run = need end
.need_auto_run? ⇒ Boolean
(rw)
[ GitHub ]
# File 'lib/test/unit/autorunner.rb', line 71
def need_auto_run? @@need_auto_run end
.standalone? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/test/unit/autorunner.rb', line 62
def standalone? return false unless("-e" == $0) ObjectSpace.each_object(Class) do |klass| return false if(klass < TestCase) end true end
Class Method Details
.collector(id)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 38
def collector(id) COLLECTORS[id.to_s] end
.prepare(hook = Proc.new)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 50
def prepare(hook=Proc.new) PREPARE_HOOKS << hook end
.register_collector(id, collector_builder = Proc.new)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 33
def register_collector(id, collector_builder=Proc.new) COLLECTORS[id] = collector_builder COLLECTORS[id.to_s] = collector_builder end
.register_color_scheme(id, scheme)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 42
def register_color_scheme(id, scheme) ColorScheme[id] = scheme end
.register_runner(id, runner_builder = Proc.new)
[ GitHub ].run(force_standalone = false, default_dir = nil, argv = ARGV, &block)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 54
def 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)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 20
def runner(id) RUNNERS[id.to_s] end
.setup_option(option_builder = Proc.new)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 46
def setup_option(option_builder=Proc.new) ADDITIONAL_OPTIONS << option_builder end
Instance Attribute Details
#base (rw)
[ GitHub ]#collector=(value) (writeonly)
[ GitHub ]#color_scheme (rw)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 135
attr_accessor :color_scheme, :listeners
#exclude (rw)
[ GitHub ]#filters (rw)
[ GitHub ]#listeners (rw)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 135
attr_accessor :color_scheme, :listeners
#pattern (rw)
[ GitHub ]#runner=(value) (writeonly)
[ GitHub ]#runner_options (readonly)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 133
attr_reader :suite, :
#suite (readonly)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 133
attr_reader :suite, :
#to_run (rw)
[ GitHub ]#workdir (rw)
[ GitHub ]Instance Method Details
#change_work_directory(&block) (private)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 463
def change_work_directory(&block) if @workdir Dir.chdir(@workdir, &block) else yield end end
#default_collector (private)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 448
def default_collector self.class.collector(@standalone ? :load : :descendant) end
#default_runner (private)
[ GitHub ]#global_config_file (private)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 452
def global_config_file File. ("~/.test-unit.yml") rescue ArgumentError nil end
#keyword_display(keywords)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 382
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)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 415
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, | ColorScheme[name] = end = {} (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 [key.to_sym] = value end end @runner_options = @runner_options.merge( ) end
#load_global_config (private)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 458
def load_global_config file = global_config_file load_config(file) if file and File.exist?(file) end
#match_test_case_name(test, pattern) (private)
[ GitHub ]#options
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 176
def @options ||= OptionParser.new do |o| o. = "Test::Unit automatic runner." o. << "\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.", "Use '/PATTERN/' for NAME to use regular expression.") do |name| name = (%r{\A/(.*)/\Z} =~ name ? Regexp.new($1) : name) @filters << lambda do |test| return true if name === test.method_name test_name_without_class_name = test.name.gsub(/\(.+?\)\z/, "") if test_name_without_class_name != test.method_name return true if name === test_name_without_class_name end false end end o.on('--ignore-name=NAME', String, "Ignores tests matching NAME.", "Use '/PATTERN/' for NAME to use regular expression.") 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.", "Use '/PATTERN/' for TESTCASE to use regular expression.") do |n| n = (%r{\A/(.*)/\Z} =~ n ? Regexp.new($1) : n) @filters << lambda do |test| match_test_case_name(test, n) end end o.on('--ignore-testcase=TESTCASE', String, "Ignores tests in TestCases matching TESTCASE.", "Use '/PATTERN/' for TESTCASE to use regular expression.") do |n| n = (%r{\A/(.*)/\Z} =~ n ? Regexp.new($1) : n) @filters << lambda do |test| not match_test_case_name(test, n) end end o.on('--location=LOCATION', String, "Runs tests that defined in LOCATION.", "LOCATION is one of PATH:LINE, PATH or LINE") do |location| if /\A\d+\z/ =~ location path = nil line = location.to_i else path, line, = location.split(/:(\d+)/, 2) line = line.to_i unless line.nil? end @filters << lambda do |test| test.class.test_defined?(:path => path, :line => line, :method_name => test.method_name) end end o.on('--attribute=EXPRESSION', String, "Runs tests that matches EXPRESSION.", "EXPRESSION is evaluated as Ruby's expression.", "Test attribute name can be used with no receiver in EXPRESSION.", "EXPRESSION examples:", " !slow", " tag == 'important' and !slow") do |expression| @filters << lambda do |test| matcher = AttributeMatcher.new(test) matcher.match?(expression) 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 = Test::Unit::Assertions::AssertionMessage o.on("--max-diff-target-string-size=SIZE", Integer, "Shows diff if both expected result string size and " + "actual result string size are " + "less than or equal SIZE in bytes.", "(#{ .max_diff_target_string_size})") do |size| .max_diff_target_string_size = size 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
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 158
def prepare PREPARE_HOOKS.each do |handler| handler.call(self) end end
#process_args(args = ARGV)
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 164
def process_args(args=ARGV) begin args.unshift(*@default_arguments) .order!(args) {|arg| @to_run << arg} rescue OptionParser::ParseError => e puts e puts exit(false) end not @to_run.empty? end
#run
[ GitHub ]# File 'lib/test/unit/autorunner.rb', line 400
def run self.class.need_auto_run = false suite = @collector[self] return false if suite.nil? return true if suite.empty? runner = @runner[self] return false if runner.nil? @runner_options[:color_scheme] ||= @color_scheme @runner_options[:listeners] ||= [] @runner_options[:listeners].concat(@listeners) change_work_directory do runner.run(suite, @runner_options).passed? end end