Class: Gem::TestCase

Inherits:
Object
  • Object
show all
Extended by:
Deprecate
Includes:
DefaultUserInteraction
Defined in:
lib/rubygems/test_case.rb

Overview

RubyGemTestCase provides a variety of methods for testing rubygems and gem-related behavior in a sandbox. Through RubyGemTestCase you can install and uninstall gems, fetch remote gems through a stub fetcher and be assured your normal set of gems is not affected.

Direct Known Subclasses

InstallerTestCase, Package::TarTestCase

Defined Under Namespace

Classes: SpecFetcherSetup, StaticSet

Constant Summary collapse

TEST_PATH =
ENV.fetch('RUBYGEMS_TEST_PATH', File.expand_path('../../../test/rubygems', __FILE__))
PRIVATE_KEY_PASSPHRASE =

:stopdoc: only available in RubyGems tests

'Foo bar'.freeze
@@ruby =
rubybin
@@good_rake =
"#{rubybin} #{escape_path(TEST_PATH, 'good_rake.rb')}"
@@bad_rake =
"#{rubybin} #{escape_path(TEST_PATH, 'bad_rake.rb')}"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Deprecate

deprecate, skip, skip=, skip_during

Methods included from DefaultUserInteraction

ui, #ui, #ui=, ui=, use_ui, #use_ui

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Instance Attribute Details

#fetcherObject

:nodoc:


91
92
93
# File 'lib/rubygems/test_case.rb', line 91

def fetcher
  @fetcher
end

#gem_repoObject

:nodoc:


93
94
95
# File 'lib/rubygems/test_case.rb', line 93

def gem_repo
  @gem_repo
end

#uriObject

:nodoc:


95
96
97
# File 'lib/rubygems/test_case.rb', line 95

def uri
  @uri
end

Class Method Details

.cert_path(cert_name) ⇒ Object

Returns the path to the certificate named cert_name from test/rubygems/.


1458
1459
1460
1461
1462
1463
1464
1465
1466
# File 'lib/rubygems/test_case.rb', line 1458

def self.cert_path(cert_name)
  if 32 == (Time.at(2**32) rescue 32)
    cert_file = "#{TEST_PATH}/#{cert_name}_cert_32.pem"

    return cert_file if File.exist? cert_file
  end

  "#{TEST_PATH}/#{cert_name}_cert.pem"
end

.java_platform?Boolean

Is this test being run on a Java platform?

Returns:

  • (Boolean)

1126
1127
1128
# File 'lib/rubygems/test_case.rb', line 1126

def self.java_platform?
  Gem.java_platform?
end

.key_path(key_name) ⇒ Object

Returns the path to the key named key_name from test/rubygems


1482
1483
1484
# File 'lib/rubygems/test_case.rb', line 1482

def self.key_path(key_name)
  "#{TEST_PATH}/#{key_name}_key.pem"
end

.load_cert(cert_name) ⇒ Object

Loads certificate named cert_name from test/rubygems/.


1446
1447
1448
1449
1450
1451
1452
# File 'lib/rubygems/test_case.rb', line 1446

def self.load_cert(cert_name)
  cert_file = cert_path cert_name

  cert = File.read cert_file

  OpenSSL::X509::Certificate.new cert
end

.load_key(key_name, passphrase = nil) ⇒ Object

Loads an RSA private key named key_name with passphrase in test/rubygems/


1471
1472
1473
1474
1475
1476
1477
# File 'lib/rubygems/test_case.rb', line 1471

def self.load_key(key_name, passphrase = nil)
  key_file = key_path key_name

  key = File.read key_file

  OpenSSL::PKey::RSA.new key, passphrase
end

.make_commandObject

Returns the make command for the current platform. For versions of Ruby built on MS Windows with VC++ or Borland it will return 'nmake'. On all other platforms, including Cygwin, it will return 'make'.


1158
1159
1160
# File 'lib/rubygems/test_case.rb', line 1158

def self.make_command
  ENV["make"] || ENV["MAKE"] || (vc_windows? ? 'nmake' : 'make')
end

.process_based_portObject

Allows tests to use a random (but controlled) port number instead of a hardcoded one. This helps CI tools when running parallels builds on the same builder slave.


1191
1192
1193
# File 'lib/rubygems/test_case.rb', line 1191

def self.process_based_port
  @@process_based_port ||= 8000 + $$ % 1000
end

.rubybinObject

Finds the path to the Ruby executable


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
# File 'lib/rubygems/test_case.rb', line 1224

def self.rubybin
  ruby = ENV["RUBY"]
  return ruby if ruby
  ruby = "ruby"
  rubyexe = "#{ruby}.exe"

  3.times do
    if File.exist? ruby and File.executable? ruby and !File.directory? ruby
      return File.expand_path(ruby)
    end
    if File.exist? rubyexe and File.executable? rubyexe
      return File.expand_path(rubyexe)
    end
    ruby = File.join("..", ruby)
  end

  begin
    require "rbconfig"
    File.join(RbConfig::CONFIG["bindir"],
              RbConfig::CONFIG["ruby_install_name"] +
              RbConfig::CONFIG["EXEEXT"])
  rescue LoadError
    "ruby"
  end
end

.vc_windows?Boolean

Returns whether or not we're on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.

Returns:

  • (Boolean)

1141
1142
1143
# File 'lib/rubygems/test_case.rb', line 1141

def self.vc_windows?
  RUBY_PLATFORM.match('mswin')
end

.win_platform?Boolean

Is this test being run on a Windows platform?

Returns:

  • (Boolean)

1112
1113
1114
# File 'lib/rubygems/test_case.rb', line 1112

def self.win_platform?
  Gem.win_platform?
end

Instance Method Details

#add_to_fetcher(spec, path = nil, repo = @gem_repo) ⇒ Object

Add spec to @fetcher serving the data in the file path. repo indicates which repo to make spec appear to be in.


991
992
993
994
# File 'lib/rubygems/test_case.rb', line 991

def add_to_fetcher(spec, path=nil, repo=@gem_repo)
  path ||= spec.cache_file
  @fetcher.data["#{@gem_repo}gems/#{spec.file_name}"] = read_binary(path)
end

#all_spec_namesObject


640
641
642
# File 'lib/rubygems/test_case.rb', line 640

def all_spec_names
  Gem::Specification.map(&:full_name)
end

#assert_activate(expected, *specs) ⇒ Object


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/rubygems/test_case.rb', line 99

def assert_activate(expected, *specs)
  specs.each do |spec|
    case spec
    when String then
      Gem::Specification.find_by_name(spec).activate
    when Gem::Specification then
      spec.activate
    else
      flunk spec.inspect
    end
  end

  loaded = Gem.loaded_specs.values.map(&:full_name)

  assert_equal expected.sort, loaded.sort if expected
end

#assert_contains_make_command(target, output, msg = nil) ⇒ Object


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
# File 'lib/rubygems/test_case.rb', line 245

def assert_contains_make_command(target, output, msg = nil)
  if output.match(/\n/)
    msg = message(msg) do
      'Expected output containing make command "%s": %s' % [
        ('%s %s' % [make_command, target]).rstrip,
        output.inspect
      ]
    end
  else
    msg = message(msg) do
      'Expected make command "%s": %s' % [
        ('%s %s' % [make_command, target]).rstrip,
        output.inspect
      ]
    end
  end

  assert scan_make_command_lines(output).any? { |line|
    make = parse_make_command_line(line)

    if make[:targets].include?(target)
      yield make, line if block_given?
      true
    else
      false
    end
  }, msg
end

#assert_directory_exists(path, msg = nil) ⇒ Object


122
123
124
125
126
# File 'lib/rubygems/test_case.rb', line 122

def assert_directory_exists(path, msg = nil)
  msg = message(msg) { "Expected path '#{path}' to be a directory" }
  assert_path_exists path
  assert File.directory?(path), msg
end

#assert_path_exists(path, msg = nil) ⇒ Object

TODO: move to minitest


117
118
119
120
# File 'lib/rubygems/test_case.rb', line 117

def assert_path_exists(path, msg = nil)
  msg = message(msg) { "Expected path '#{path}' to exist" }
  assert File.exist?(path), msg
end

#bindir(value) ⇒ Object

Sets the bindir entry in RbConfig::CONFIG to value and restores the original value when the block ends


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/rubygems/test_case.rb', line 171

def bindir(value)
  bindir = RbConfig::CONFIG['bindir']

  if value
    RbConfig::CONFIG['bindir'] = value
  else
    RbConfig::CONFIG.delete 'bindir'
  end

  yield
ensure
  if bindir
    RbConfig::CONFIG['bindir'] = bindir
  else
    RbConfig::CONFIG.delete 'bindir'
  end
end

#build_rake_in(good = true) ⇒ Object

Allows the proper version of rake to be used for the test.


1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'lib/rubygems/test_case.rb', line 1205

def build_rake_in(good=true)
  gem_ruby = Gem.ruby
  Gem.ruby = @@ruby
  env_rake = ENV["rake"]
  rake = (good ? @@good_rake : @@bad_rake)
  ENV["rake"] = rake
  yield rake
ensure
  Gem.ruby = gem_ruby
  if env_rake
    ENV["rake"] = env_rake
  else
    ENV.delete("rake")
  end
end

#common_installer_setupObject


464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'lib/rubygems/test_case.rb', line 464

def common_installer_setup
  common_installer_teardown

  Gem.post_build do |installer|
    @post_build_hook_arg = installer
    true
  end

  Gem.post_install do |installer|
    @post_install_hook_arg = installer
  end

  Gem.post_uninstall do |uninstaller|
    @post_uninstall_hook_arg = uninstaller
  end

  Gem.pre_install do |installer|
    @pre_install_hook_arg = installer
    true
  end

  Gem.pre_uninstall do |uninstaller|
    @pre_uninstall_hook_arg = uninstaller
  end
end

#common_installer_teardownObject


490
491
492
493
494
495
496
497
498
499
# File 'lib/rubygems/test_case.rb', line 490

def common_installer_teardown
  Gem.post_build_hooks.clear
  Gem.post_install_hooks.clear
  Gem.done_installing_hooks.clear
  Gem.post_reset_hooks.clear
  Gem.post_uninstall_hooks.clear
  Gem.pre_install_hooks.clear
  Gem.pre_reset_hooks.clear
  Gem.pre_uninstall_hooks.clear
end

#dep(name, *requirements) ⇒ Object

Construct a new Gem::Dependency.


1276
1277
1278
# File 'lib/rubygems/test_case.rb', line 1276

def dep(name, *requirements)
  Gem::Dependency.new name, *requirements
end

#dependency_request(dep, from_name, from_version, parent = nil) ⇒ Object

Constructs a Gem::Resolver::DependencyRequest from a Gem::Dependency dep, a from_name and from_version requesting the dependency and a parent DependencyRequest


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
# File 'lib/rubygems/test_case.rb', line 1285

def dependency_request(dep, from_name, from_version, parent = nil)
  remote = Gem::Source.new @uri

  unless parent
    parent_dep = dep from_name, from_version
    parent = Gem::Resolver::DependencyRequest.new parent_dep, nil
  end

  spec = Gem::Resolver::IndexSpecification.new \
    nil, from_name, from_version, remote, Gem::Platform::RUBY
  activation = Gem::Resolver::ActivationRequest.new spec, parent

  Gem::Resolver::DependencyRequest.new dep, activation
end

#enable_shared(value) ⇒ Object

Sets the ENABLE_SHARED entry in RbConfig::CONFIG to value and restores the original value when the block ends


132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/rubygems/test_case.rb', line 132

def enable_shared(value)
  enable_shared = RbConfig::CONFIG['ENABLE_SHARED']
  RbConfig::CONFIG['ENABLE_SHARED'] = value

  yield
ensure
  if enable_shared
    RbConfig::CONFIG['enable_shared'] = enable_shared
  else
    RbConfig::CONFIG.delete 'enable_shared'
  end
end

#exeext(value) ⇒ Object

Sets the EXEEXT entry in RbConfig::CONFIG to value and restores the original value when the block ends


193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/rubygems/test_case.rb', line 193

def exeext(value)
  exeext = RbConfig::CONFIG['EXEEXT']

  if value
    RbConfig::CONFIG['EXEEXT'] = value
  else
    RbConfig::CONFIG.delete 'EXEEXT'
  end

  yield
ensure
  if exeext
    RbConfig::CONFIG['EXEEXT'] = exeext
  else
    RbConfig::CONFIG.delete 'EXEEXT'
  end
end

#git_gem(name = 'a', version = 1) ⇒ Object

A git_gem is used with a gem dependencies file. The gem created here has no files, just a gem specification for the given name and version.

Yields the specification to the block, if given


507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/rubygems/test_case.rb', line 507

def git_gem(name = 'a', version = 1)
  have_git?

  directory = File.join 'git', name
  directory = File.expand_path directory

  git_spec = Gem::Specification.new name, version do |specification|
    yield specification if block_given?
  end

  FileUtils.mkdir_p directory

  gemspec = "#{name}.gemspec"

  File.open File.join(directory, gemspec), 'w' do |io|
    io.write git_spec.to_ruby
  end

  head = nil

  Dir.chdir directory do
    unless File.exist? '.git'
      system @git, 'init', '--quiet'
      system @git, 'config', 'user.name',  'RubyGems Tests'
      system @git, 'config', 'user.email', '[email protected]'
    end

    system @git, 'add', gemspec
    system @git, 'commit', '-a', '-m', 'a non-empty commit message', '--quiet'
    head = Gem::Util.popen(@git, 'rev-parse', 'master').strip
  end

  return name, git_spec.version, directory, head
end

#have_git?Boolean

Skips this test unless you have a git executable

Returns:

  • (Boolean)

545
546
547
548
549
# File 'lib/rubygems/test_case.rb', line 545

def have_git?
  return if in_path? @git

  skip 'cannot find git executable, use GIT environment variable to set'
end

#in_path?(executable) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

551
552
553
554
555
556
557
# File 'lib/rubygems/test_case.rb', line 551

def in_path?(executable) # :nodoc:
  return true if %r%\A([A-Z]:|/)% =~ executable and File.exist? executable

  ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
    File.exist? File.join directory, executable
  end
end

#install_default_gems(*specs) ⇒ Object

Installs the provided default specs including writing the spec file


740
741
742
743
744
745
746
747
748
# File 'lib/rubygems/test_case.rb', line 740

def install_default_gems(*specs)
  install_default_specs(*specs)

  specs.each do |spec|
    File.open spec.loaded_from, 'w' do |io|
      io.write spec.to_ruby_for_cache
    end
  end
end

#install_default_specs(*specs) ⇒ Object

Install the provided default specs


753
754
755
756
757
758
759
# File 'lib/rubygems/test_case.rb', line 753

def install_default_specs(*specs)
  specs.each do |spec|
    installer = Gem::Installer.for_spec(spec, :install_as_default => true)
    installer.install
    Gem.register_default_spec(spec)
  end
end

#install_gem(spec, options = {}) ⇒ Object

Builds and installs the Gem::Specification spec


562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/rubygems/test_case.rb', line 562

def install_gem(spec, options = {})
  require 'rubygems/installer'

  gem = File.join @tempdir, "gems", "#{spec.full_name}.gem"

  unless File.exist? gem
    use_ui Gem::MockGemUi.new do
      Dir.chdir @tempdir do
        Gem::Package.build spec
      end
    end

    gem = File.join(@tempdir, File.basename(spec.cache_file)).tap(&Gem::UNTAINT)
  end

  Gem::Installer.at(gem, options.merge({:wrappers => true})).install
end

#install_gem_user(spec) ⇒ Object

Builds and installs the Gem::Specification spec into the user dir


583
584
585
# File 'lib/rubygems/test_case.rb', line 583

def install_gem_user(spec)
  install_gem spec, :user_install => true
end

#install_specs(*specs) ⇒ Object

Install the provided specs


729
730
731
732
733
734
735
# File 'lib/rubygems/test_case.rb', line 729

def install_specs(*specs)
  specs.each do |spec|
    Gem::Installer.for_spec(spec).install
  end

  Gem.searcher = nil
end

#java_platform?Boolean

Is this test being run on a Java platform?

Returns:

  • (Boolean)

1133
1134
1135
# File 'lib/rubygems/test_case.rb', line 1133

def java_platform?
  Gem.java_platform?
end

#loaded_spec_namesObject


761
762
763
# File 'lib/rubygems/test_case.rb', line 761

def loaded_spec_names
  Gem.loaded_specs.values.map(&:full_name).sort
end

#make_commandObject

Returns the make command for the current platform. For versions of Ruby built on MS Windows with VC++ or Borland it will return 'nmake'. On all other platforms, including Cygwin, it will return 'make'.


1167
1168
1169
# File 'lib/rubygems/test_case.rb', line 1167

def make_command
  ENV["make"] || ENV["MAKE"] || (vc_windows? ? 'nmake' : 'make')
end

#mu_pp(obj) ⇒ Object

Enables pretty-print for all tests


602
603
604
605
606
607
# File 'lib/rubygems/test_case.rb', line 602

def mu_pp(obj)
  s = String.new
  s = PP.pp obj, s
  s = s.force_encoding(Encoding.default_external)
  s.chomp
end

#new_default_spec(name, version, deps = nil, *files) ⇒ Object


779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
# File 'lib/rubygems/test_case.rb', line 779

def new_default_spec(name, version, deps = nil, *files)
  spec = util_spec name, version, deps

  spec.loaded_from = File.join(@default_spec_dir, spec.spec_name)
  spec.files = files

  lib_dir = File.join(@tempdir, "default_gems", "lib")
  lib_dir.instance_variable_set(:@gem_prelude_index, lib_dir)
  $LOAD_PATH.unshift(lib_dir)
  files.each do |file|
    rb_path = File.join(lib_dir, file)
    FileUtils.mkdir_p(File.dirname(rb_path))
    File.open(rb_path, "w") do |rb|
      rb << "# #{file}"
    end
  end

  spec
end

#nmake_found?Boolean

Returns whether or not the nmake command could be found.

Returns:

  • (Boolean)

1174
1175
1176
# File 'lib/rubygems/test_case.rb', line 1174

def nmake_found?
  system('nmake /? 1>NUL 2>&1')
end

#parse_make_command_line(line) ⇒ Object


221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/rubygems/test_case.rb', line 221

def parse_make_command_line(line)
  command, *args = line.shellsplit

  targets = []
  macros = {}

  args.each do |arg|
    case arg
    when /\A(\w+)=/
      macros[$1] = $'
    else
      targets << arg
    end
  end

  targets << '' if targets.empty?

  {
    :command => command,
    :targets => targets,
    :macros => macros,
  }
end

#process_based_portObject

See ::process_based_port


1198
1199
1200
# File 'lib/rubygems/test_case.rb', line 1198

def process_based_port
  self.class.process_based_port
end

#quick_gem(name, version = '2') ⇒ Object

Creates a Gem::Specification with a minimum of extra work. name and version are the gem's name and version, platform, author, email, homepage, summary and description are defaulted. The specification is yielded for customization.

The gem is added to the installed gems in @gemhome and the runtime.

Use this with #write_file to build an installed gem.


654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
# File 'lib/rubygems/test_case.rb', line 654

def quick_gem(name, version='2')
  require 'rubygems/specification'

  spec = Gem::Specification.new do |s|
    s.platform    = Gem::Platform::RUBY
    s.name        = name
    s.version     = version
    s.author      = 'A User'
    s.email       = '[email protected]'
    s.homepage    = 'http://example.com'
    s.summary     = "this is a summary"
    s.description = "This is a test description"

    yield(s) if block_given?
  end

  Gem::Specification.map # HACK: force specs to (re-)load before we write

  written_path = write_file spec.spec_file do |io|
    io.write spec.to_ruby_for_cache
  end

  spec.loaded_from = written_path

  Gem::Specification.reset

  return spec
end

#read_binary(path) ⇒ Object

Reads a binary file at path


621
622
623
# File 'lib/rubygems/test_case.rb', line 621

def read_binary(path)
  Gem.read_binary path
end

#read_cache(path) ⇒ Object

Reads a Marshal file at path


612
613
614
615
616
# File 'lib/rubygems/test_case.rb', line 612

def read_cache(path)
  File.open path.dup.tap(&Gem::UNTAINT), 'rb' do |io|
    Marshal.load io.read
  end
end

#refute_path_exists(path, msg = nil) ⇒ Object

TODO: move to minitest


212
213
214
215
# File 'lib/rubygems/test_case.rb', line 212

def refute_path_exists(path, msg = nil)
  msg = message(msg) { "Expected path '#{path}' to not exist" }
  refute File.exist?(path), msg
end

#req(*requirements) ⇒ Object

Constructs a new Gem::Requirement.


1303
1304
1305
1306
# File 'lib/rubygems/test_case.rb', line 1303

def req(*requirements)
  return requirements.first if Gem::Requirement === requirements.first
  Gem::Requirement.create requirements
end

#save_gemspec(name = 'a', version = 1, directory = '.') ⇒ Object

create_gemspec creates gem specification in given directory or '.' for the given name and version.

Yields the specification to the block, if given


1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/rubygems/test_case.rb', line 1368

def save_gemspec(name = 'a', version = 1, directory = '.')
  vendor_spec = Gem::Specification.new name, version do |specification|
    yield specification if block_given?
  end

  File.open File.join(directory, "#{name}.gemspec"), 'w' do |io|
    io.write vendor_spec.to_ruby
  end

  return name, vendor_spec.version, directory
end

#save_loaded_featuresObject


769
770
771
772
773
774
775
776
777
# File 'lib/rubygems/test_case.rb', line 769

def save_loaded_features
  old_loaded_features = $LOADED_FEATURES.dup
  yield
ensure
  prefix = File.dirname(__FILE__) + "/"
  new_features = ($LOADED_FEATURES - old_loaded_features)
  old_loaded_features.concat(new_features.select {|f| f.rindex(prefix, 0)})
  $LOADED_FEATURES.replace old_loaded_features
end

#scan_make_command_lines(output) ⇒ Object


217
218
219
# File 'lib/rubygems/test_case.rb', line 217

def scan_make_command_lines(output)
  output.scan(/^#{Regexp.escape make_command}(?:[[:blank:]].*)?$/)
end

#setupObject

#setup prepares a sandboxed location to install gems. All installs are directed to a temporary directory. All install plugins are removed.

If the RUBY environment variable is set the given path is used for Gem::ruby. The local platform is set to i386-mswin32 for Windows or i686-darwin8.10.1 otherwise.


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
# File 'lib/rubygems/test_case.rb', line 287

def setup
  super

  @orig_env = ENV.to_hash

  ENV['GEM_VENDOR'] = nil
  ENV['GEMRC'] = nil
  ENV['SOURCE_DATE_EPOCH'] = nil

  @current_dir = Dir.pwd
  @fetcher     = nil

  @back_ui                       = Gem::DefaultUserInteraction.ui
  @ui                            = Gem::MockGemUi.new
  # This needs to be a new instance since we call use_ui(@ui) when we want to
  # capture output
  Gem::DefaultUserInteraction.ui = Gem::MockGemUi.new

  tmpdir = File.realpath Dir.tmpdir
  tmpdir.tap(&Gem::UNTAINT)

  @tempdir = File.join(tmpdir, "test_rubygems_#{$$}")
  @tempdir.tap(&Gem::UNTAINT)

  FileUtils.mkdir_p @tempdir

  # This makes the tempdir consistent on Windows.
  # Dir.tmpdir may return short path name, but Dir[Dir.tmpdir] returns long
  # path name. https://bugs.ruby-lang.org/issues/10819
  # File.expand_path or File.realpath doesn't convert path name to long path
  # name. Only Dir[] (= Dir.glob) works.
  # Short and long path name is specific to Windows filesystem.
  if win_platform?
    @tempdir = Dir[@tempdir][0]
    @tempdir.tap(&Gem::UNTAINT)
  end

  @gemhome  = File.join @tempdir, 'gemhome'
  @userhome = File.join @tempdir, 'userhome'
  ENV["GEM_SPEC_CACHE"] = File.join @tempdir, 'spec_cache'

  @orig_ruby = if ENV['RUBY']
                 ruby = Gem.ruby
                 Gem.ruby = ENV['RUBY']
                 ruby
               end

  @git = ENV['GIT'] || 'git'

  Gem.ensure_gem_subdirectories @gemhome

  @orig_LOAD_PATH = $LOAD_PATH.dup
  $LOAD_PATH.map! do |s|
    expand_path = File.realpath(s) rescue File.expand_path(s)
    if expand_path != s
      expand_path.tap(&Gem::UNTAINT)
      if s.instance_variable_defined?(:@gem_prelude_index)
        expand_path.instance_variable_set(:@gem_prelude_index, expand_path)
      end
      expand_path.freeze if s.frozen?
      s = expand_path
    end
    s
  end

  Dir.chdir @tempdir

  ENV['HOME'] = @userhome
  Gem.instance_variable_set :@user_home, nil
  Gem.instance_variable_set :@gemdeps, nil
  Gem.instance_variable_set :@env_requirements_by_name, nil
  Gem.send :remove_instance_variable, :@ruby_version if
    Gem.instance_variables.include? :@ruby_version

  FileUtils.mkdir_p @gemhome
  FileUtils.mkdir_p @userhome

  ENV['GEM_PRIVATE_KEY_PASSPHRASE'] = PRIVATE_KEY_PASSPHRASE

  @default_dir = File.join @tempdir, 'default'
  @default_spec_dir = File.join @default_dir, "specifications", "default"
  if Gem.java_platform?
    @orig_default_gem_home = RbConfig::CONFIG['default_gem_home']
    RbConfig::CONFIG['default_gem_home'] = @default_dir
  else
    Gem.instance_variable_set(:@default_dir, @default_dir)
  end
  FileUtils.mkdir_p @default_spec_dir

  Gem::Specification.unresolved_deps.clear
  Gem.use_paths(@gemhome)

  Gem::Security.reset

  Gem.loaded_specs.clear
  Gem.clear_default_specs
  Bundler.reset!

  Gem.configuration.verbose = true
  Gem.configuration.update_sources = true

  Gem::RemoteFetcher.fetcher = Gem::FakeFetcher.new

  @gem_repo = "http://gems.example.com/"
  @uri = URI.parse @gem_repo
  Gem.sources.replace [@gem_repo]

  Gem.searcher = nil
  Gem::SpecFetcher.fetcher = nil

  @orig_arch = RbConfig::CONFIG['arch']

  if win_platform?
    util_set_arch 'i386-mswin32'
  else
    util_set_arch 'i686-darwin8.10.1'
  end

  @orig_hooks = {}
  %w[post_install_hooks done_installing_hooks post_uninstall_hooks pre_uninstall_hooks pre_install_hooks pre_reset_hooks post_reset_hooks post_build_hooks].each do |name|
    @orig_hooks[name] = Gem.send(name).dup
  end

  @marshal_version = "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
  @orig_LOADED_FEATURES = $LOADED_FEATURES.dup
end

#spec(name, version, &block) ⇒ Object

Constructs a new Gem::Specification.


1311
1312
1313
# File 'lib/rubygems/test_case.rb', line 1311

def spec(name, version, &block)
  Gem::Specification.new name, v(version), &block
end

#spec_fetcher(repository = @gem_repo) ⇒ Object

Creates a SpecFetcher pre-filled with the gems or specs defined in the block.

Yields a fetcher object that responds to spec and gem. spec adds a specification to the SpecFetcher while gem adds both a specification and the gem data to the RemoteFetcher so the built gem can be downloaded.

If only the a-3 gem is supposed to be downloaded you can save setup time by creating only specs for the other versions:

spec_fetcher do |fetcher|
  fetcher.spec 'a', 1
  fetcher.spec 'a', 2, 'b' => 3 # dependency on b = 3
  fetcher.gem 'a', 3 do |spec|
    # spec is a Gem::Specification
    # ...
  end
end

1335
1336
1337
1338
1339
# File 'lib/rubygems/test_case.rb', line 1335

def spec_fetcher(repository = @gem_repo)
  Gem::TestCase::SpecFetcherSetup.declare self, repository do |spec_fetcher_setup|
    yield spec_fetcher_setup if block_given?
  end
end

#teardownObject

#teardown restores the process to its original state and removes the tempdir


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
# File 'lib/rubygems/test_case.rb', line 418

def teardown
  $LOAD_PATH.replace @orig_LOAD_PATH if @orig_LOAD_PATH
  if @orig_LOADED_FEATURES
    if @orig_LOAD_PATH
      paths = @orig_LOAD_PATH.map {|path| File.join(File.expand_path(path), "/")}
      ($LOADED_FEATURES - @orig_LOADED_FEATURES).each do |feat|
        unless paths.any? {|path| feat.start_with?(path)}
          $LOADED_FEATURES.delete(feat)
        end
      end
    else
      $LOADED_FEATURES.replace @orig_LOADED_FEATURES
    end
  end

  RbConfig::CONFIG['arch'] = @orig_arch

  if defined? Gem::RemoteFetcher
    Gem::RemoteFetcher.fetcher = nil
  end

  Dir.chdir @current_dir

  FileUtils.rm_rf @tempdir

  ENV.replace(@orig_env)

  Gem.ruby = @orig_ruby if @orig_ruby

  if Gem.java_platform?
    RbConfig::CONFIG['default_gem_home'] = @orig_default_gem_home
  else
    Gem.instance_variable_set :@default_dir, nil
  end

  Gem::Specification._clear_load_cache
  Gem::Specification.unresolved_deps.clear
  Gem::refresh

  @orig_hooks.each do |name, hooks|
    Gem.send(name).replace hooks
  end

  @back_ui.close
end

#uninstall_gem(spec) ⇒ Object

Uninstalls the Gem::Specification spec


589
590
591
592
593
594
595
596
597
# File 'lib/rubygems/test_case.rb', line 589

def uninstall_gem(spec)
  require 'rubygems/uninstaller'

  Class.new(Gem::Uninstaller) do
    def ask_if_ok(spec)
      true
    end
  end.new(spec.name, :executables => true, :user_install => true).uninstall
end

#unresolved_namesObject


765
766
767
# File 'lib/rubygems/test_case.rb', line 765

def unresolved_names
  Gem::Specification.unresolved_deps.values.map(&:to_s).sort
end

#util_build_gem(spec) ⇒ Object

Builds a gem from spec and places it in File.join @gemhome, 'cache'. Automatically creates files based on spec.files


687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
# File 'lib/rubygems/test_case.rb', line 687

def util_build_gem(spec)
  dir = spec.gem_dir
  FileUtils.mkdir_p dir

  Dir.chdir dir do
    spec.files.each do |file|
      next if File.exist? file
      FileUtils.mkdir_p File.dirname(file)

      File.open file, 'w' do |fp|
        fp.puts "# #{file}"
      end
    end

    use_ui Gem::MockGemUi.new do
      Gem::Package.build spec
    end

    cache = spec.cache_file
    FileUtils.mv File.basename(cache), cache
  end
end

#util_clear_gemsObject

Removes all installed gems from @gemhome.


718
719
720
721
722
723
724
# File 'lib/rubygems/test_case.rb', line 718

def util_clear_gems
  FileUtils.rm_rf File.join(@gemhome, "gems")
  FileUtils.mkdir File.join(@gemhome, "gems")
  FileUtils.rm_rf File.join(@gemhome, "specifications")
  FileUtils.mkdir File.join(@gemhome, "specifications")
  Gem::Specification.reset
end

#util_clear_RUBY_VERSIONObject


1100
1101
1102
1103
1104
1105
1106
1107
# File 'lib/rubygems/test_case.rb', line 1100

def util_clear_RUBY_VERSION
  Object.send :remove_const, :RUBY_VERSION
  Object.send :remove_const, :RUBY_PATCHLEVEL     if defined?(RUBY_PATCHLEVEL)
  Object.send :remove_const, :RUBY_REVISION       if defined?(RUBY_REVISION)
  Object.send :remove_const, :RUBY_DESCRIPTION    if defined?(RUBY_DESCRIPTION)
  Object.send :remove_const, :RUBY_ENGINE
  Object.send :remove_const, :RUBY_ENGINE_VERSION if defined?(RUBY_ENGINE_VERSION)
end

#util_gem(name, version, deps = nil, &block) ⇒ Object

Creates a gem with name, version and deps. The specification will be yielded before gem creation for customization. The gem will be placed in File.join @tempdir, 'gems'. The specification and .gem file location are returned.


851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
# File 'lib/rubygems/test_case.rb', line 851

def util_gem(name, version, deps = nil, &block)
  if deps
    block = proc do |s|
      # Since Hash#each is unordered in 1.8, sort
      # the keys and iterate that way so the tests are
      # deterministic on all implementations.
      deps.keys.sort.each do |n|
        s.add_dependency n, (deps[n] || '>= 0')
      end
    end
  end

  spec = quick_gem(name, version, &block)

  util_build_gem spec

  cache_file = File.join @tempdir, 'gems', "#{spec.original_name}.gem"
  FileUtils.mkdir_p File.dirname cache_file
  FileUtils.mv spec.cache_file, cache_file
  FileUtils.rm spec.spec_file

  spec.loaded_from = nil

  [spec, cache_file]
end

#util_gzip(data) ⇒ Object

Gzips data.


880
881
882
883
884
885
886
887
888
# File 'lib/rubygems/test_case.rb', line 880

def util_gzip(data)
  out = StringIO.new

  Zlib::GzipWriter.wrap out do |io|
    io.write data
  end

  out.string
end

#util_make_gems(prerelease = false) ⇒ Object

Creates several default gems which all have a lib/code.rb file. The gems are not installed but are available in the cache dir.

@a1

gem a version 1, this is the best-described gem.

@a2

gem a version 2

[email protected]

gem a version 3.a

@a_evil9

gem a_evil version 9, use this to ensure similarly-named gems don't collide with a.

@b2

gem b version 2

@c1_2

gem c version 1.2

@pl1

gem pl version 1, this gem has a legacy platform of i386-linux.

Additional prerelease gems may also be created:

@a2_pre

gem a version 2.a

TODO: nuke this and fix tests. this should speed up a lot


908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'lib/rubygems/test_case.rb', line 908

def util_make_gems(prerelease = false)
  @a1 = quick_gem 'a', '1' do |s|
    s.files = %w[lib/code.rb]
    s.require_paths = %w[lib]
    s.date = Gem::Specification::TODAY - 86400
    s.homepage = 'http://a.example.com'
    s.email = %w[[email protected] [email protected]]
    s.authors = %w[Example Example2]
    s.description = <<-DESC
This line is really, really long.  So long, in fact, that it is more than eighty characters long!  The purpose of this line is for testing wrapping behavior because sometimes people don't wrap their text to eighty characters.  Without the wrapping, the text might not look good in the RSS feed.

Also, a list:
* An entry that\'s actually kind of sort
* an entry that\'s really long, which will probably get wrapped funny.  That's ok, somebody wasn't thinking straight when they made it more than eighty characters.
    DESC
  end

  init = proc do |s|
    s.files = %w[lib/code.rb]
    s.require_paths = %w[lib]
  end

  @a2      = quick_gem('a', '2',      &init)
  @a3a     = quick_gem('a', '3.a',    &init)
  @a_evil9 = quick_gem('a_evil', '9', &init)
  @b2      = quick_gem('b', '2',      &init)
  @c1_2    = quick_gem('c', '1.2',    &init)
  @x       = quick_gem('x', '1',      &init)
  @dep_x   = quick_gem('dep_x', '1') do |s|
    s.files = %w[lib/code.rb]
    s.require_paths = %w[lib]
    s.add_dependency 'x', '>= 1'
  end

  @pl1 = quick_gem 'pl', '1' do |s| # l for legacy
    s.files = %w[lib/code.rb]
    s.require_paths = %w[lib]
    s.platform = Gem::Platform.new 'i386-linux'
    s.instance_variable_set :@original_platform, 'i386-linux'
  end

  if prerelease
    @a2_pre = quick_gem('a', '2.a', &init)
    write_file File.join(*%W[gems #{@a2_pre.original_name} lib code.rb])
    util_build_gem @a2_pre
  end

  write_file File.join(*%W[gems #{@a1.original_name}      lib code.rb])
  write_file File.join(*%W[gems #{@a2.original_name}      lib code.rb])
  write_file File.join(*%W[gems #{@a3a.original_name}     lib code.rb])
  write_file File.join(*%W[gems #{@a_evil9.original_name} lib code.rb])
  write_file File.join(*%W[gems #{@b2.original_name}      lib code.rb])
  write_file File.join(*%W[gems #{@c1_2.original_name}    lib code.rb])
  write_file File.join(*%W[gems #{@pl1.original_name}     lib code.rb])
  write_file File.join(*%W[gems #{@x.original_name}       lib code.rb])
  write_file File.join(*%W[gems #{@dep_x.original_name}   lib code.rb])

  [@a1, @a2, @a3a, @a_evil9, @b2, @c1_2, @pl1, @x, @dep_x].each do |spec|
    util_build_gem spec
  end

  FileUtils.rm_r File.join(@gemhome, "gems", @pl1.original_name)
end

#util_remove_gem(spec) ⇒ Object


710
711
712
713
# File 'lib/rubygems/test_case.rb', line 710

def util_remove_gem(spec)
  FileUtils.rm_rf spec.cache_file
  FileUtils.rm_rf spec.spec_file
end

#util_restore_RUBY_VERSIONObject


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# File 'lib/rubygems/test_case.rb', line 1085

def util_restore_RUBY_VERSION
  util_clear_RUBY_VERSION

  Object.const_set :RUBY_VERSION,        @RUBY_VERSION
  Object.const_set :RUBY_PATCHLEVEL,     @RUBY_PATCHLEVEL  if
    defined?(@RUBY_PATCHLEVEL)
  Object.const_set :RUBY_REVISION,       @RUBY_REVISION    if
    defined?(@RUBY_REVISION)
  Object.const_set :RUBY_DESCRIPTION,    @RUBY_DESCRIPTION if
    defined?(@RUBY_DESCRIPTION)
  Object.const_set :RUBY_ENGINE,         @RUBY_ENGINE
  Object.const_set :RUBY_ENGINE_VERSION, @RUBY_ENGINE_VERSION if
    defined?(@RUBY_ENGINE_VERSION)
end

#util_set_arch(arch) ⇒ Object

Set the platform to arch


975
976
977
978
979
980
981
982
983
984
985
# File 'lib/rubygems/test_case.rb', line 975

def util_set_arch(arch)
  RbConfig::CONFIG['arch'] = arch
  platform = Gem::Platform.new arch

  Gem.instance_variable_set :@platforms, nil
  Gem::Platform.instance_variable_set :@local, nil

  yield if block_given?

  platform
end

#util_set_RUBY_VERSION(version, patchlevel = nil, revision = nil, description = nil, engine = "ruby", engine_version = nil) ⇒ Object


1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
# File 'lib/rubygems/test_case.rb', line 1063

def util_set_RUBY_VERSION(version, patchlevel = nil, revision = nil, description = nil, engine = "ruby", engine_version = nil)
  if Gem.instance_variables.include? :@ruby_version
    Gem.send :remove_instance_variable, :@ruby_version
  end

  @RUBY_VERSION        = RUBY_VERSION
  @RUBY_PATCHLEVEL     = RUBY_PATCHLEVEL     if defined?(RUBY_PATCHLEVEL)
  @RUBY_REVISION       = RUBY_REVISION       if defined?(RUBY_REVISION)
  @RUBY_DESCRIPTION    = RUBY_DESCRIPTION    if defined?(RUBY_DESCRIPTION)
  @RUBY_ENGINE         = RUBY_ENGINE
  @RUBY_ENGINE_VERSION = RUBY_ENGINE_VERSION if defined?(RUBY_ENGINE_VERSION)

  util_clear_RUBY_VERSION

  Object.const_set :RUBY_VERSION,        version
  Object.const_set :RUBY_PATCHLEVEL,     patchlevel     if patchlevel
  Object.const_set :RUBY_REVISION,       revision       if revision
  Object.const_set :RUBY_DESCRIPTION,    description    if description
  Object.const_set :RUBY_ENGINE,         engine
  Object.const_set :RUBY_ENGINE_VERSION, engine_version if engine_version
end

#util_setup_spec_fetcher(*specs) ⇒ Object

Sets up Gem::SpecFetcher to return information from the gems in specs.


999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
# File 'lib/rubygems/test_case.rb', line 999

def util_setup_spec_fetcher(*specs)
  all_specs = Gem::Specification.to_a + specs
  Gem::Specification._resort! all_specs

  spec_fetcher = Gem::SpecFetcher.fetcher

  prerelease, all = all_specs.partition { |spec| spec.version.prerelease?  }
  latest = Gem::Specification._latest_specs all_specs

  spec_fetcher.specs[@uri] = []
  all.each do |spec|
    spec_fetcher.specs[@uri] << spec.name_tuple
  end

  spec_fetcher.latest_specs[@uri] = []
  latest.each do |spec|
    spec_fetcher.latest_specs[@uri] << spec.name_tuple
  end

  spec_fetcher.prerelease_specs[@uri] = []
  prerelease.each do |spec|
    spec_fetcher.prerelease_specs[@uri] << spec.name_tuple
  end

  # HACK for test_download_to_cache
  unless Gem::RemoteFetcher === @fetcher
    v = Gem.marshal_version

    specs = all.map { |spec| spec.name_tuple }
    s_zip = util_gzip Marshal.dump Gem::NameTuple.to_basic specs

    latest_specs = latest.map do |spec|
      spec.name_tuple
    end

    l_zip = util_gzip Marshal.dump Gem::NameTuple.to_basic latest_specs

    prerelease_specs = prerelease.map { |spec| spec.name_tuple }
    p_zip = util_gzip Marshal.dump Gem::NameTuple.to_basic prerelease_specs

    @fetcher.data["#{@gem_repo}specs.#{v}.gz"]            = s_zip
    @fetcher.data["#{@gem_repo}latest_specs.#{v}.gz"]     = l_zip
    @fetcher.data["#{@gem_repo}prerelease_specs.#{v}.gz"] = p_zip

    v = Gem.marshal_version

    all_specs.each do |spec|
      path = "#{@gem_repo}quick/Marshal.#{v}/#{spec.original_name}.gemspec.rz"
      data = Marshal.dump spec
      data_deflate = Zlib::Deflate.deflate data
      @fetcher.data[path] = data_deflate
    end
  end

  nil # force errors
end

#util_spec(name, version = 2, deps = nil, *files) ⇒ Object

Creates a spec with name, version. deps can specify the dependency or a block can be given for full customization of the specification.


803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
# File 'lib/rubygems/test_case.rb', line 803

def util_spec(name, version = 2, deps = nil, *files) # :yields: specification
  raise "deps or block, not both" if deps and block_given?

  spec = Gem::Specification.new do |s|
    s.platform    = Gem::Platform::RUBY
    s.name        = name
    s.version     = version
    s.author      = 'A User'
    s.email       = '[email protected]'
    s.homepage    = 'http://example.com'
    s.summary     = "this is a summary"
    s.description = "This is a test description"

    s.files.push(*files) unless files.empty?

    yield s if block_given?
  end

  if deps
    # Since Hash#each is unordered in 1.8, sort the keys and iterate that
    # way so the tests are deterministic on all implementations.
    deps.keys.sort.each do |n|
      spec.add_dependency n, (deps[n] || '>= 0')
    end
  end

  unless files.empty?
    write_file spec.spec_file do |io|
      io.write spec.to_ruby_for_cache
    end

    util_build_gem spec

    cache_file = File.join @tempdir, 'gems', "#{spec.full_name}.gem"
    FileUtils.mkdir_p File.dirname cache_file
    FileUtils.mv spec.cache_file, cache_file
    FileUtils.rm spec.spec_file
  end

  return spec
end

#util_zip(data) ⇒ Object

Deflates data


1059
1060
1061
# File 'lib/rubygems/test_case.rb', line 1059

def util_zip(data)
  Zlib::Deflate.deflate data
end

#v(string) ⇒ Object

Construct a new Gem::Version.


1344
1345
1346
# File 'lib/rubygems/test_case.rb', line 1344

def v(string)
  Gem::Version.create string
end

#vc_windows?Boolean

Returns whether or not we're on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.

Returns:

  • (Boolean)

1149
1150
1151
# File 'lib/rubygems/test_case.rb', line 1149

def vc_windows?
  RUBY_PLATFORM.match('mswin')
end

#vendor_gem(name = 'a', version = 1) ⇒ Object

A vendor_gem is used with a gem dependencies file. The gem created here has no files, just a gem specification for the given name and version.

Yields the specification to the block, if given


1354
1355
1356
1357
1358
1359
1360
# File 'lib/rubygems/test_case.rb', line 1354

def vendor_gem(name = 'a', version = 1)
  directory = File.join 'vendor', name

  FileUtils.mkdir_p directory

  save_gemspec name, version, directory
end

#vendordir(value) ⇒ Object

Sets the vendordir entry in RbConfig::CONFIG to value and restores the original value when the block ends


149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/rubygems/test_case.rb', line 149

def vendordir(value)
  vendordir = RbConfig::CONFIG['vendordir']

  if value
    RbConfig::CONFIG['vendordir'] = value
  else
    RbConfig::CONFIG.delete 'vendordir'
  end

  yield
ensure
  if vendordir
    RbConfig::CONFIG['vendordir'] = vendordir
  else
    RbConfig::CONFIG.delete 'vendordir'
  end
end

#wait_for_child_process_to_exitObject

In case we're building docs in a background process, this method waits for that process to exit (or if it's already been reaped, or never happened, swallows the Errno::ECHILD error).


1181
1182
1183
1184
# File 'lib/rubygems/test_case.rb', line 1181

def wait_for_child_process_to_exit
  Process.wait if Process.respond_to?(:fork)
rescue Errno::ECHILD
end

#win_platform?Boolean

Is this test being run on a Windows platform?

Returns:

  • (Boolean)

1119
1120
1121
# File 'lib/rubygems/test_case.rb', line 1119

def win_platform?
  Gem.win_platform?
end

#write_file(path) ⇒ Object

Writes a binary file to path which is relative to @gemhome


628
629
630
631
632
633
634
635
636
637
638
# File 'lib/rubygems/test_case.rb', line 628

def write_file(path)
  path = File.join @gemhome, path unless Pathname.new(path).absolute?
  dir = File.dirname path
  FileUtils.mkdir_p dir unless File.directory? dir

  File.open path, 'wb' do |io|
    yield io if block_given?
  end

  path
end