File: test_rake_file_utils.rb

package info (click to toggle)
rake 13.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 916 kB
  • sloc: ruby: 9,661; ansic: 19; sh: 19; makefile: 11
file content (484 lines) | stat: -rw-r--r-- 10,145 bytes parent folder | download
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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
# frozen_string_literal: true
require File.expand_path("../helper", __FILE__)
require "fileutils"
require "stringio"

class TestRakeFileUtils < Rake::TestCase # :nodoc:
  def setup
    super
    @rake_test_sh = ENV["RAKE_TEST_SH"]
  end

  def teardown
    FileUtils::LN_SUPPORTED[0] = true
    RakeFileUtils.verbose_flag = Rake::FileUtilsExt::DEFAULT
    ENV["RAKE_TEST_SH"] = @rake_test_sh

    super
  end

  def test_rm_one_file
    create_file("a")
    FileUtils.rm_rf "a"
    refute File.exist?("a")
  end

  def test_rm_two_files
    create_file("a")
    create_file("b")
    FileUtils.rm_rf ["a", "b"]
    refute File.exist?("a")
    refute File.exist?("b")
  end

  def test_rm_filelist
    list = Rake::FileList.new << "a" << "b"
    list.each { |fn| create_file(fn) }
    FileUtils.rm_r list
    refute File.exist?("a")
    refute File.exist?("b")
  end

  def test_rm_nowrite
    create_file("a")
    nowrite(true) {
      rm_rf "a"
    }
    assert File.exist?("a")
    nowrite(false) {
      rm_rf "a", noop: true
    }
    assert File.exist?("a")
    nowrite(true) {
      rm_rf "a", noop: false
    }
    refute File.exist?("a")
  end

  def test_ln
    open("a", "w") { |f| f.puts "TEST_LN" }

    Rake::FileUtilsExt.safe_ln("a", "b", verbose: false)

    assert_equal "TEST_LN\n", File.read("b")
  end

  class BadLink # :nodoc:
    include Rake::FileUtilsExt
    attr_reader :cp_args

    def initialize(klass)
      @failure_class = klass
    end

    def cp(*args)
      @cp_args = args
    end

    def ln(*args)
      fail @failure_class, "ln not supported"
    end

    public :safe_ln
  end

  def test_safe_ln_failover_to_cp_on_standard_error
    FileUtils::LN_SUPPORTED[0] = true
    c = BadLink.new(StandardError)
    c.safe_ln "a", "b"
    assert_equal ["a", "b"], c.cp_args
    c.safe_ln "x", "y"
    assert_equal ["x", "y"], c.cp_args
  end

  def test_safe_ln_failover_to_cp_on_not_implemented_error
    FileUtils::LN_SUPPORTED[0] = true
    c = BadLink.new(NotImplementedError)
    c.safe_ln "a", "b"
    assert_equal ["a", "b"], c.cp_args
  end

  def test_safe_ln_fails_on_script_error
    FileUtils::LN_SUPPORTED[0] = true
    c = BadLink.new(ScriptError)
    assert_raises(ScriptError) do c.safe_ln "a", "b" end
  end

  def test_verbose
    verbose true
    assert_equal true, verbose
    verbose false
    assert_equal false, verbose
    verbose(true) {
      assert_equal true, verbose
    }
    assert_equal false, verbose
  end

  def test_nowrite
    nowrite true
    assert_equal true, nowrite
    nowrite false
    assert_equal false, nowrite
    nowrite(true) {
      assert_equal true, nowrite
    }
    assert_equal false, nowrite
  end

  def test_file_utils_methods_are_available_at_top_level
    create_file("a")

    capture_output do
      rm_rf "a"
    end

    refute File.exist?("a")
  end

  def test_fileutils_methods_dont_leak
    obj = Object.new
    assert_raises(NoMethodError) { obj.copy } # from FileUtils
    assert_raises(NoMethodError) { obj.ruby "-v" } # from RubyFileUtils
  end

  def test_sh
    shellcommand

    verbose(false) { sh %{#{Rake::TestCase::RUBY} shellcommand.rb} }
    assert true, "should not fail"
  end

  def test_sh_with_a_single_string_argument
    check_expansion

    ENV["RAKE_TEST_SH"] = "someval"
    verbose(false) {
      sh %{#{RUBY} check_expansion.rb #{env_var} someval}
    }
  end

  def test_sh_with_env
    check_environment

    env = {
      "RAKE_TEST_SH" => "someval"
    }

    verbose(false) {
      sh env, RUBY, "check_environment.rb", "RAKE_TEST_SH", "someval"
    }
  end

  def test_sh_with_multiple_arguments
    omit if jruby9? # https://github.com/jruby/jruby/issues/3653

    check_no_expansion
    ENV["RAKE_TEST_SH"] = "someval"

    verbose(false) {
      sh RUBY, "check_no_expansion.rb", env_var, "someval"
    }
  end

  def test_sh_with_spawn_options
    omit "JRuby does not support spawn options" if jruby?

    echocommand

    r, w = IO.pipe

    verbose(false) {
      sh RUBY, "echocommand.rb", out: w
    }

    w.close

    assert_equal "echocommand.rb\n", r.read
  end

  def test_sh_with_hash_option
    omit "JRuby does not support spawn options" if jruby?
    check_expansion

    verbose(false) {
      sh "#{RUBY} check_expansion.rb", { chdir: "." }, verbose: false
    }
  end

  def test_sh_failure
    shellcommand

    assert_raises(RuntimeError) {
      verbose(false) { sh %{#{RUBY} shellcommand.rb 1} }
    }
  end

  def test_sh_special_handling
    shellcommand

    count = 0
    verbose(false) {
      sh(%{#{RUBY} shellcommand.rb}) do |ok, res|
        assert(ok)
        assert_equal 0, res.exitstatus
        count += 1
      end
      sh(%{#{RUBY} shellcommand.rb 1}) do |ok, res|
        assert(!ok)
        assert_equal 1, res.exitstatus
        count += 1
      end
    }
    assert_equal 2, count, "Block count should be 2"
  end

  def test_sh_noop
    shellcommand

    verbose(false) { sh %{shellcommand.rb 1}, noop: true }
    assert true, "should not fail"
  end

  def test_sh_bad_option
    # Skip on JRuby because option checking is performed by spawn via system
    # now.
    omit "JRuby does not support spawn options" if jruby?

    shellcommand

    ex = assert_raises(ArgumentError) {
      verbose(false) { sh %{shellcommand.rb}, bad_option: true }
    }
    assert_match(/bad_option/, ex.message)
  end

  def test_sh_verbose
    shellcommand

    _, err = capture_output do
      verbose(true) {
        sh %{shellcommand.rb}, noop: true
      }
    end

    assert_equal "shellcommand.rb\n", err
  end

  def test_sh_verbose_false
    shellcommand

    _, err = capture_output do
      verbose(false) {
        sh %{shellcommand.rb}, noop: true
      }
    end

    assert_equal "", err
  end

  def test_sh_verbose_flag_nil
    shellcommand

    RakeFileUtils.verbose_flag = nil

    out, _ = capture_output do
      sh %{shellcommand.rb}, noop: true
    end
    assert_empty out
  end

  def test_ruby_with_a_single_string_argument
    check_expansion

    ENV["RAKE_TEST_SH"] = "someval"

    verbose(false) {
      replace_ruby {
        ruby %{check_expansion.rb #{env_var} someval}
      }
    }
  end

  def test_sh_show_command
    env = {
      "RAKE_TEST_SH" => "someval"
    }

    cmd = [env, RUBY, "some_file.rb", "some argument"]

    show_cmd = send :sh_show_command, cmd

    expected_cmd = "RAKE_TEST_SH=someval #{RUBY} some_file.rb some argument"

    assert_equal expected_cmd, show_cmd
  end

  def test_sh_if_a_command_exits_with_error_status_its_full_output_is_printed
    verbose false do
      standard_output = "Some output"
      standard_error  = "Some error"
      shell_command = "ruby -e\"puts '#{standard_output}';STDERR.puts '#{standard_error}';exit false\""
      actual_both = capture_subprocess_io do
        begin
          sh shell_command
        rescue
        else
          flunk
        end
      end
      actual = actual_both.join
      assert_match standard_output, actual
      assert_match standard_error,  actual
    end
  end

  def test_sh_if_a_command_exits_with_error_status_sh_echoes_it_fully
    verbose true do
      assert_echoes_fully
    end
    verbose false do
      assert_echoes_fully
    end
  end

  # Originally copied from minitest/assertions.rb
  def capture_subprocess_io
    begin
      require "tempfile"

      captured_stdout = Tempfile.new("out")
      captured_stderr = Tempfile.new("err")

      orig_stdout = $stdout.dup
      orig_stderr = $stderr.dup
      $stdout.reopen captured_stdout
      $stderr.reopen captured_stderr

      yield

      $stdout.rewind
      $stderr.rewind

      [captured_stdout.read, captured_stderr.read]
    ensure
      $stdout.reopen orig_stdout
      $stderr.reopen orig_stderr

      orig_stdout.close
      orig_stderr.close
      captured_stdout.close!
      captured_stderr.close!
    end
  end

  def assert_echoes_fully
    long_string = "1234567890" * 10
    shell_command = "ruby -e\"'#{long_string}';exit false\""
    capture_subprocess_io do
      begin
        sh shell_command
      rescue => ex
        assert_match "Command failed with status", ex.message
        assert_match shell_command, ex.message
      else
        flunk
      end
    end
  end

  def test_ruby_with_multiple_arguments
    omit if jruby9? # https://github.com/jruby/jruby/issues/3653

    check_no_expansion

    ENV["RAKE_TEST_SH"] = "someval"
    verbose(false) {
      replace_ruby {
        ruby "check_no_expansion.rb", env_var, "someval"
      }
    }
  end

  def test_split_all
    assert_equal ["a"], Rake::FileUtilsExt.split_all("a")
    assert_equal [".."], Rake::FileUtilsExt.split_all("..")
    assert_equal ["/"], Rake::FileUtilsExt.split_all("/")
    assert_equal ["a", "b"], Rake::FileUtilsExt.split_all("a/b")
    assert_equal ["/", "a", "b"], Rake::FileUtilsExt.split_all("/a/b")
    assert_equal ["..", "a", "b"], Rake::FileUtilsExt.split_all("../a/b")
  end

  def command(name, text)
    open name, "w", 0750 do |io|
      io << text
    end
  end

  def check_no_expansion
    command "check_no_expansion.rb", <<-CHECK_EXPANSION
if ARGV[0] != ARGV[1]
  exit 0
else
  exit 1
end
    CHECK_EXPANSION
  end

  def check_environment
    command "check_environment.rb", <<-CHECK_ENVIRONMENT
if ENV[ARGV[0]] != ARGV[1]
  exit 1
else
  exit 0
end
    CHECK_ENVIRONMENT
  end

  def check_expansion
    command "check_expansion.rb", <<-CHECK_EXPANSION
if ARGV[0] != ARGV[1]
  exit 1
else
  exit 0
end
    CHECK_EXPANSION
  end

  def echocommand
    command "echocommand.rb", <<-ECHOCOMMAND
#!/usr/bin/env ruby

puts "echocommand.rb"

exit 0
    ECHOCOMMAND
  end

  def replace_ruby
    ruby = FileUtils::RUBY
    FileUtils.send :remove_const, :RUBY
    FileUtils.const_set :RUBY, RUBY
    yield
  ensure
    FileUtils.send :remove_const, :RUBY
    FileUtils.const_set:RUBY, ruby
  end

  def shellcommand
    command "shellcommand.rb", <<-SHELLCOMMAND
#!/usr/bin/env ruby

exit((ARGV[0] || "0").to_i)
    SHELLCOMMAND
  end

  def env_var
    windows? ? "%RAKE_TEST_SH%" : "$RAKE_TEST_SH"
  end

  def windows?
    ! File::ALT_SEPARATOR.nil?
  end

end