1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
218
219
220
221
222
223
224
225
226
227
228
229
|
require "shellwords"
require "rbconfig"
require "rake/tasklib"
module Minitest # :nodoc:
##
# Minitest::TestTask is a rake helper that generates several rake
# tasks under the main test task's name-space.
#
# task <name> :: the main test task
# task <name>:cmd :: prints the command to use
# task <name>:deps :: runs each test file by itself to find dependency errors
# task <name>:slow :: runs the tests and reports the slowest 25 tests.
#
# Examples:
#
# Minitest::TestTask.create
#
# The most basic and default setup.
#
# Minitest::TestTask.create :do_the_thing
#
# The most basic/default setup, but with a custom name
#
# Minitest::TestTask.create :spec do |t|
# t.test_globs = ["spec/**/*_spec.rb"]
# t.libs << "../dependency/lib"
# end
#
# Customize the name, dependencies, and use a spec directory instead
# of test.
class TestTask < Rake::TaskLib
WINDOWS = RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ # :nodoc: # TODO: verify
##
# Create several test-oriented tasks under +name+. Takes an
# optional block to customize variables.
def self.create name = :test, &block
task = new name
task.instance_eval(&block) if block
task.process_env
task.define
task
end
##
# Extra arguments to pass to the tests. Defaults empty but gets
# populated by a number of enviroment variables:
#
# + N (-n flag) a string or regexp of tests to run.
# + X (-e flag) a string or regexp of tests to exclude.
# + TESTOPTS - extra stuff. For compatibility? I guess?
# + A (arg) - quick way to inject an arbitrary argument (eg A=--help)
attr_accessor :extra_args
##
# The code to load the framework. Defaults to requiring
# minitest/autorun...
#
# Why do I have this as an option?
attr_accessor :framework
##
# Extra library directories to include. Defaults to %w[lib test
# .]. Also uses $MT_LIB_EXTRAS allowing you to dynamically
# override/inject directories for custom runs.
attr_accessor :libs
##
# The name of the task and base name for the other tasks generated.
attr_accessor :name
##
# File globs to find test files. Defaults to something sensible to
# find test files under the test directory.
attr_accessor :test_globs
##
# Turn on ruby warnings (-w flag). Defaults to true.
attr_accessor :warning
##
# Optional: Additional ruby to run before the test framework is loaded.
attr_accessor :test_prelude
##
# Print out commands as they run. Defaults to Rake's trace (-t
# flag) option.
attr_accessor :verbose
def initialize name = :test # :nodoc:
self.extra_args = []
self.framework = %(require "minitest/autorun")
self.libs = %w[lib test .]
self.name = name
self.test_globs = ["test/**/{test,spec}_*.rb",
"test/**/*_{test,spec}.rb"]
self.test_prelude = nil
self.verbose = Rake.application.options.trace
self.warning = true
end
##
# Extract variables from the environment and convert them to
# command line arguments. See +extra_args+.
#
# Environment Variables:
#
# + MT_LIB_EXTRAS - Extra libs to dynamically override/inject for custom runs.
# + N - Tests to run (string or /regexp/)
# + X - Tests to exclude (string or /regexp/)
# + A - Any extra arguments. Honors shell quoting.
#
# Deprecated:
#
# + TESTOPTS - for argument passing, use A
# + N - for parallel testing, use MT_CPU
# + FILTER - same as TESTOPTS
def process_env
warn "TESTOPTS is deprecated in Minitest::TestTask. Use A instead" if
ENV["TESTOPTS"]
warn "FILTER is deprecated in Minitest::TestTask. Use A instead" if
ENV["FILTER"]
warn "N is deprecated in Minitest::TestTask. Use MT_CPU instead" if
ENV["N"] && ENV["N"].to_i > 0
lib_extras = (ENV["MT_LIB_EXTRAS"] || "").split File::PATH_SEPARATOR
self.libs[0,0] = lib_extras
extra_args << "-n" << ENV["N"] if ENV["N"]
extra_args << "-e" << ENV["X"] if ENV["X"]
extra_args.concat Shellwords.split(ENV["TESTOPTS"]) if ENV["TESTOPTS"]
extra_args.concat Shellwords.split(ENV["FILTER"]) if ENV["FILTER"]
extra_args.concat Shellwords.split(ENV["A"]) if ENV["A"]
ENV.delete "N" if ENV["N"]
# TODO? RUBY_DEBUG = ENV["RUBY_DEBUG"]
# TODO? ENV["RUBY_FLAGS"]
extra_args.compact!
end
##
# Create the tasks.
def define
default_tasks = []
desc "Run the test suite. Use N, X, A, and TESTOPTS to add flags/args."
task name do
ruby make_test_cmd, verbose:verbose
end
desc "Print out the test command. Good for profiling and other tools."
task "#{name}:cmd" do
puts "ruby #{make_test_cmd}"
end
desc "Show which test files fail when run alone."
task "#{name}:deps" do
tests = Dir[*self.test_globs].uniq
null_dev = WINDOWS ? "> NUL 2>&1" : "> /dev/null 2>&1"
tests.each do |test|
cmd = make_test_cmd test
if system "ruby #{cmd} #{null_dev}" then
puts "# good: #{test}"
else
puts "# bad: #{test}"
puts " ruby #{cmd}"
end
end
end
desc "Show bottom 25 tests wrt time."
task "#{name}:slow" do
sh ["rake #{name} TESTOPTS=-v",
"egrep '#test_.* s = .'",
"sort -n -k2 -t=",
"tail -25"].join " | "
end
default_tasks << name
desc "Run the default task(s)."
task :default => default_tasks
end
##
# Generate the test command-line.
def make_test_cmd globs = test_globs
tests = []
tests.concat Dir[*globs].sort.shuffle # TODO: SEED -> srand first?
tests.map! { |f| %(require "#{f}") }
runner = []
runner << framework
runner << test_prelude if test_prelude
runner.concat tests
runner = runner.join "; "
args = []
args << "-I#{libs.join(File::PATH_SEPARATOR)}" unless libs.empty?
args << "-w" if warning
args << '-e'
args << "'#{runner}'"
args << '--'
args << extra_args.map(&:shellescape)
args.join " "
end
end
end
|
