forked from grosser/parallel_tests
/
cli_spec.rb
396 lines (330 loc) · 14.7 KB
/
cli_spec.rb
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
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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# frozen_string_literal: true
require "spec_helper"
require "parallel_tests/cli"
require "parallel_tests/rspec/runner"
describe ParallelTests::CLI do
subject { ParallelTests::CLI.new }
describe "#parse_options" do
let(:defaults) { { files: ["test"] } }
def call(*args)
subject.send(:parse_options!, *args)
end
it "does not fail without file" do
expect(subject).not_to receive(:abort)
call(["-n3", "-t", "rspec"])
end
it "cleanups file paths" do
expect(call(["./test"])).to eq(defaults)
end
it "parses execute" do
expect(call(["--exec", "echo"])).to eq(execute: "echo")
end
it "parses excludes pattern" do
expect(call(["test", "--exclude-pattern", "spec/"])).to eq(defaults.merge(exclude_pattern: /spec\//))
end
it "parses regular count" do
expect(call(["test", "-n3"])).to eq(defaults.merge(count: 3))
end
it "parses count 0 as non-parallel" do
expect(call(["test", "-n0"])).to eq(defaults.merge(non_parallel: true))
end
it "parses non-parallel as non-parallel" do
expect(call(["test", "--non-parallel"])).to eq(defaults.merge(non_parallel: true))
end
it "finds the correct type when multiple are given" do
call(["test", "--type", "test", "-t", "rspec"])
expect(subject.instance_variable_get(:@runner)).to eq(ParallelTests::RSpec::Runner)
end
it "parses nice as nice" do
expect(call(["test", "--nice"])).to eq(defaults.merge(nice: true))
end
it "parses --verbose" do
expect(call(["test", "--verbose"])).to eq(defaults.merge(verbose: true))
end
it "parses --verbose-process-command" do
expect(call(['test', '--verbose-process-command'])).to eq(
defaults.merge(verbose_process_command: true)
)
end
it "parses --verbose-rerun-command" do
expect(call(['test', '--verbose-rerun-command'])).to eq(
defaults.merge(verbose_rerun_command: true)
)
end
it "parses --quiet" do
expect(call(["test", "--quiet"])).to eq(defaults.merge(quiet: true))
end
it "fails if both --verbose and --quiet are present" do
expect { call(["test", "--verbose", "--quiet"]) }.to raise_error(RuntimeError)
end
it "parses --suffix" do
expect(call(["test", "--suffix", "_(test|spec).rb$"])).to eq(defaults.merge(suffix: /_(test|spec).rb$/))
end
it "parses --first-is-1" do
expect(call(["test", "--first-is-1"]))
.to eq(defaults.merge(first_is_1: true))
end
context "parse only-group" do
it "group_by should be set to filesize" do
expect(call(["test", "--only-group", '1'])).to eq(defaults.merge(only_group: [1], group_by: :filesize))
end
it "allows runtime" do
expect(call(["test", "--only-group", '1', '--group-by', 'runtime'])).to eq(defaults.merge(only_group: [1], group_by: :runtime))
end
it "raise error when group_by isn't filesize" do
expect do
call(["test", "--only-group", '1', '--group-by', 'steps'])
end.to raise_error(RuntimeError)
end
it "with multiple groups" do
expect(call(["test", "--only-group", '4,5'])).to eq(defaults.merge(only_group: [4, 5], group_by: :filesize))
end
it "with a single group" do
expect(call(["test", "--only-group", '4'])).to eq(defaults.merge(only_group: [4], group_by: :filesize))
end
end
context "single and isolate" do
it "single_process should be an array of patterns" do
expect(call(["test", "--single", '1'])).to eq(defaults.merge(single_process: [/1/]))
end
it "single_process should be an array of patterns" do
expect(call(["test", "--single", '1', "--single", '2'])).to eq(defaults.merge(single_process: [/1/, /2/]))
end
it "isolate should set isolate_count defaults" do
expect(call(["test", "--single", '1', "--isolate"])).to eq(defaults.merge(single_process: [/1/], isolate: true))
end
it "isolate_n should set isolate_count and turn on isolate" do
expect(call(["test", "-n", "3", "--single", '1', "--isolate-n", "2"])).to eq(
defaults.merge(count: 3, single_process: [/1/], isolate_count: 2)
)
end
end
context "specify groups" do
it "groups can be just one string" do
expect(call(["test", "--specify-groups", 'test'])).to eq(defaults.merge(specify_groups: 'test'))
end
it "groups can be a string separated by commas and pipes" do
expect(call(["test", "--specify-groups", 'test1,test2|test3'])).to eq(defaults.merge(specify_groups: 'test1,test2|test3'))
end
end
context "when the -- option separator is used" do
it "interprets arguments as files/directories" do
expect(call(['--', 'test'])).to eq(files: ['test'])
expect(call(['--', './test'])).to eq(files: ['test'])
expect(call(['--', 'test', 'test2'])).to eq(files: ['test', 'test2'])
expect(call(['--', '--foo', 'test'])).to eq(files: ['--foo', 'test'])
expect(call(['--', 'test', '--foo', 'test2'])).to eq(files: ['test', '--foo', 'test2'])
end
it "corectly handles arguments with spaces" do
expect(call(['--', 'file name with space'])).to eq(files: ['file name with space'])
end
context "when the -o options has also been given" do
it "merges the options together" do
expect(call(['-o', "'-f'", '--', 'test', '--foo', 'test2'])).to eq(files: ['test', '--foo', 'test2'], test_options: "'-f'")
end
end
context "when a second -- option separator is used" do
it "interprets the first set as test_options" do
expect(call(['--', '-r', 'foo', '--', 'test'])).to eq(files: ['test'], test_options: '-r foo')
expect(call(['--', '-r', 'foo', '--', 'test', 'test2'])).to eq(files: ['test', 'test2'], test_options: '-r foo')
expect(call(['--', '-r', 'foo', '-o', 'out.log', '--', 'test', 'test2'])).to eq(files: ['test', 'test2'], test_options: '-r foo -o out.log')
end
context "when existing test_options have previously been given" do
it "appends the new options" do
expect(call(['-o', "'-f'", '--', '-r', 'foo.rb', '--', 'test'])).to eq(files: ['test'], test_options: "'-f' -r foo.rb")
end
it "corectly handles argument values with spaces" do
argv = ["-o 'path with spaces1'", '--', '--out', 'path with spaces2', '--', 'foo']
expected_test_options = "'path with spaces1' --out path\\ with\\ spaces2"
expect(call(argv)).to eq(files: ['foo'], test_options: expected_test_options)
end
end
end
end
end
describe "#load_runner" do
it "requires and loads default runner" do
expect(subject).to receive(:require).with("parallel_tests/test/runner")
expect(subject.send(:load_runner, "test")).to eq(ParallelTests::Test::Runner)
end
it "requires and loads rspec runner" do
expect(subject).to receive(:require).with("parallel_tests/rspec/runner")
expect(subject.send(:load_runner, "rspec")).to eq(ParallelTests::RSpec::Runner)
end
it "requires and loads runner with underscores" do
expect(subject).to receive(:require).with("parallel_tests/my_test_runner/runner")
expect(subject.send(:load_runner, "my_test_runner")).to eq(ParallelTests::MyTestRunner::Runner)
end
it "fails to load unfindable runner" do
expect do
expect(subject.send(:load_runner, "foo")).to eq(ParallelTests::RSpec::Runner)
end.to raise_error(LoadError)
end
end
describe ".report_failure_rerun_commmand" do
let(:single_failed_command) { [{ exit_status: 1, command: 'foo', seed: nil, output: 'blah' }] }
it "prints nothing if there are no failures" do
expect($stdout).not_to receive(:puts)
subject.send(
:report_failure_rerun_commmand,
[
{ exit_status: 0, command: 'foo', seed: nil, output: 'blah' }
],
{ verbose: true }
)
end
def self.it_prints_nothing_about_rerun_commands(options)
it 'prints nothing about rerun commands' do
expect do
subject.send(:report_failure_rerun_commmand, single_failed_command, options)
end.to_not output(/Use the following command to run the group again/).to_stdout
end
end
describe "failure" do
context 'without options' do
it_prints_nothing_about_rerun_commands({})
end
context 'with verbose disabled' do
it_prints_nothing_about_rerun_commands(verbose: false)
end
context "with verbose rerun" do
it "prints command if there is a failure" do
expect do
subject.send(:report_failure_rerun_commmand, single_failed_command, verbose_rerun_command: true)
end.to output("\n\nTests have failed for a parallel_test group. Use the following command to run the group again:\n\nfoo\n").to_stdout
end
end
context 'with verbose' do
it "prints a message and the command if there is a failure" do
expect do
subject.send(:report_failure_rerun_commmand, single_failed_command, verbose: true)
end.to output("\n\nTests have failed for a parallel_test group. Use the following command to run the group again:\n\nfoo\n").to_stdout
end
it "prints multiple commands if there are multiple failures" do
expect do
subject.send(
:report_failure_rerun_commmand,
[
{ exit_status: 1, command: 'foo', seed: nil, output: 'blah' },
{ exit_status: 1, command: 'bar', seed: nil, output: 'blah' },
{ exit_status: 1, command: 'baz', seed: nil, output: 'blah' }
],
{ verbose: true }
)
end.to output(/foo\nbar\nbaz/).to_stdout
end
it "only includes failures" do
expect do
subject.send(
:report_failure_rerun_commmand,
[
{ exit_status: 1, command: 'foo --color', seed: nil, output: 'blah' },
{ exit_status: 0, command: 'bar', seed: nil, output: 'blah' },
{ exit_status: 1, command: 'baz', seed: nil, output: 'blah' }
],
{ verbose: true }
)
end.to output(/foo --color\nbaz/).to_stdout
end
it "prints the command with the seed added by the runner" do
command = 'rspec --color spec/foo_spec.rb'
seed = 555
subject.instance_variable_set(:@runner, ParallelTests::Test::Runner)
expect(ParallelTests::Test::Runner).to receive(:command_with_seed).with(command, seed)
.and_return("my seeded command result --seed #{seed}")
single_failed_command[0].merge!(seed: seed, command: command)
expect do
subject.send(:report_failure_rerun_commmand, single_failed_command, verbose: true)
end.to output(/my seeded command result --seed 555/).to_stdout
end
end
end
end
describe "#final_fail_message" do
before do
subject.instance_variable_set(:@runner, ParallelTests::Test::Runner)
end
it 'returns a plain fail message if colors are nor supported' do
expect(subject).to receive(:use_colors?).and_return(false)
expect(subject.send(:final_fail_message)).to eq("Tests Failed")
end
it 'returns a colorized fail message if colors are supported' do
expect(subject).to receive(:use_colors?).and_return(true)
expect(subject.send(:final_fail_message)).to eq("\e[31mTests Failed\e[0m")
end
end
describe "#run_tests_in_parallel" do
context "specific groups to run" do
let(:results) { { stdout: "", exit_status: 0 } }
let(:common_options) do
{ files: ["test"], group_by: :filesize, first_is_1: false }
end
before do
allow(subject).to receive(:puts)
expect(subject).to receive(:load_runner).with("my_test_runner").and_return(ParallelTests::MyTestRunner::Runner)
allow(ParallelTests::MyTestRunner::Runner).to receive(:test_file_name).and_return("test")
expect(ParallelTests::MyTestRunner::Runner).to receive(:tests_in_groups).and_return(
[
['aaa', 'bbb'],
['ccc', 'ddd'],
['eee', 'fff']
]
)
expect(subject).to receive(:report_results).and_return(nil)
end
it "calls run_tests once when one group specified" do
expect(subject).to receive(:run_tests).once.and_return(results)
subject.run(['test', '-n', '3', '--only-group', '1', '-t', 'my_test_runner'])
end
it "calls run_tests twice when two groups are specified" do
expect(subject).to receive(:run_tests).twice.and_return(results)
subject.run(['test', '-n', '3', '--only-group', '1,2', '-t', 'my_test_runner'])
end
it "run only one group specified" do
options = common_options.merge(count: 3, only_group: [2])
expect(subject).to receive(:run_tests).once.with(['ccc', 'ddd'], 0, 1, options).and_return(results)
subject.run(['test', '-n', '3', '--only-group', '2', '-t', 'my_test_runner'])
end
it "run last group when passing a group that is not filled" do
count = 3
options = common_options.merge(count: count, only_group: [count])
expect(subject).to receive(:run_tests).once.with(['eee', 'fff'], 0, 1, options).and_return(results)
subject.run(['test', '-n', count.to_s, '--only-group', count.to_s, '-t', 'my_test_runner'])
end
it "run twice with multiple groups" do
skip "fails on jruby" if RUBY_PLATFORM == "java"
options = common_options.merge(count: 3, only_group: [2, 3])
expect(subject).to receive(:run_tests).once.with(['ccc', 'ddd'], 0, 1, options).and_return(results)
expect(subject).to receive(:run_tests).once.with(['eee', 'fff'], 1, 1, options).and_return(results)
subject.run(['test', '-n', '3', '--only-group', '2,3', '-t', 'my_test_runner'])
end
end
end
describe "#display_duration" do
def call(*args)
subject.send(:detailed_duration, *args)
end
it "displays for durations near one minute" do
expect(call(59)).to eq(nil)
expect(call(60)).to eq(" (1:00)")
expect(call(61)).to eq(" (1:01)")
end
it "displays for durations near one hour" do
expect(call(3599)).to eq(" (59:59)")
expect(call(3600)).to eq(" (1:00:00)")
expect(call(3601)).to eq(" (1:00:01)")
end
it "displays the correct string for miscellaneous durations" do
expect(call(9296)).to eq(" (2:34:56)")
expect(call(45296)).to eq(" (12:34:56)")
expect(call(2756601)).to eq(" (765:43:21)") # hours into three digits? Buy more CI hardware...
expect(call(0)).to eq(nil)
end
end
end
module ParallelTests
module MyTestRunner
class Runner
end
end
end