Class: Gem::TestCase

Inherits:
MiniTest::Unit::TestCase
  • Object
show all
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.

Tests are always run at a safe level of 1.

Direct Known Subclasses

InstallerTestCase, Package::TarTestCase

Defined Under Namespace

Classes: SpecFetcherSetup, StaticSet

Constant Summary collapse

PRIVATE_KEY_PASSPHRASE =

:stopdoc: only available in RubyGems tests

'Foo bar'
@@project_dir = 
Dir.pwd.untaint
@@initial_reset = 
false
@@ruby = 
rubybin
@@good_rake = 
"#{rubybin} #{File.expand_path('../../../test/rubygems/good_rake.rb', __FILE__)}"
@@bad_rake = 
"#{rubybin} #{File.expand_path('../../../test/rubygems/bad_rake.rb', __FILE__)}"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DefaultUserInteraction

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

Instance Attribute Details

#fetcher ⇒ Object

:nodoc:



89
90
91
 
# File 'lib/rubygems/test_case.rb', line 89

def fetcher
  @fetcher
end

#gem_repo ⇒ Object

:nodoc:



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

def gem_repo
  @gem_repo
end

#uri ⇒ Object

:nodoc:



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

def uri
  @uri
end

Class Method Details

.cert_path(cert_name) ⇒ Object

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



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/rubygems/test_case.rb', line 1309

def self.cert_path cert_name
  if 32 == (Time.at(2**32) rescue 32) then
    cert_file =
      File.expand_path "../../../test/rubygems/#{cert_name}_cert_32.pem",
                       __FILE__

    return cert_file if File.exist? cert_file
  end

  File.expand_path "../../../test/rubygems/#{cert_name}_cert.pem", __FILE__
end

.key_path(key_name) ⇒ Object

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



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

def self.key_path key_name
  File.expand_path "../../../test/rubygems/#{key_name}_key.pem", __FILE__
end

.load_cert(cert_name) ⇒ Object

Loads certificate named cert_name from test/rubygems/.



1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/rubygems/test_case.rb', line 1297

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/



1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/rubygems/test_case.rb', line 1324

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_command ⇒ Object

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’.



1048
1049
1050
 
# File 'lib/rubygems/test_case.rb', line 1048

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

.process_based_port ⇒ Object

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.



1081
1082
1083
 
# File 'lib/rubygems/test_case.rb', line 1081

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

.rubybin ⇒ Object

Finds the path to the Ruby executable



1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'lib/rubygems/test_case.rb', line 1114

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) 


1031
1032
1033
 
# File 'lib/rubygems/test_case.rb', line 1031

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

.win_platform? ⇒ Boolean

Is this test being run on a Windows platform?

Returns:

  • (Boolean) 


1016
1017
1018
 
# File 'lib/rubygems/test_case.rb', line 1016

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.



939
940
941
942
 
# File 'lib/rubygems/test_case.rb', line 939

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_names ⇒ Object 



532
533
534
 
# File 'lib/rubygems/test_case.rb', line 532

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

#assert_activate(expected, *specs) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/rubygems/test_case.rb', line 95

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 



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

def assert_contains_make_command(target, output, msg = nil)
  if output.match(/\n/)
    msg = message(msg) {
      'Expected output containing make command "%s": %s' % [
        ('%s %s' % [make_command, target]).rstrip,
        output.inspect
      ]
    }
  else
    msg = message(msg) {
      'Expected make command "%s": %s' % [
        ('%s %s' % [make_command, target]).rstrip,
        output.inspect
      ]
    }
  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_path_exists(path, msg = nil) ⇒ Object

TODO: move to minitest



113
114
115
116
 
# File 'lib/rubygems/test_case.rb', line 113

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

#build_rake_in(good = true) ⇒ Object

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



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/rubygems/test_case.rb', line 1095

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_setup ⇒ Object 



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

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_teardown ⇒ Object 



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/rubygems/test_case.rb', line 373

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

#create_tmpdir ⇒ Object

creates a temporary directory with hax TODO: deprecate and remove



483
484
485
486
487
488
489
 
# File 'lib/rubygems/test_case.rb', line 483

def create_tmpdir
  tmpdir = nil
  Dir.chdir Dir.tmpdir do tmpdir = Dir.pwd end # HACK OSX /private/tmp
  tmpdir = File.join tmpdir, "test_rubygems_#{$$}"
  FileUtils.mkdir_p tmpdir
  return tmpdir
end

#dep(name, *requirements) ⇒ Object

Construct a new Gem::Dependency.



1147
1148
1149
 
# File 'lib/rubygems/test_case.rb', line 1147

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



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/rubygems/test_case.rb', line 1156

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

  unless parent then
    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

#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



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

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"

  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' then
      system @git, 'init', '--quiet'
      system @git, 'config', 'user.name',  'RubyGems Tests'
      system @git, 'config', 'user.email', 'rubygems@example'
    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) 


428
429
430
431
432
 
# File 'lib/rubygems/test_case.rb', line 428

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) 


434
435
436
437
438
439
440
 
# File 'lib/rubygems/test_case.rb', line 434

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



633
634
635
636
637
638
639
640
641
 
# File 'lib/rubygems/test_case.rb', line 633

def install_default_gems(*specs)
  install_default_specs(*specs)

  specs.each do |spec|
    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



646
647
648
649
650
651
 
# File 'lib/rubygems/test_case.rb', line 646

def install_default_specs(*specs)
  install_specs(*specs)
  specs.each do |spec|
    Gem.register_default_spec(spec)
  end
end

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

Builds and installs the Gem::Specification spec



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/rubygems/test_case.rb', line 445

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

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

  unless File.exist? gem then
    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)).untaint
  end

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

#install_gem_user(spec) ⇒ Object

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



466
467
468
 
# File 'lib/rubygems/test_case.rb', line 466

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

#install_specs(*specs) ⇒ Object

Install the provided specs



625
626
627
628
 
# File 'lib/rubygems/test_case.rb', line 625

def install_specs(*specs)
  Gem::Specification.add_specs(*specs)
  Gem.searcher = nil
end

#loaded_spec_names ⇒ Object 



653
654
655
 
# File 'lib/rubygems/test_case.rb', line 653

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

#make_command ⇒ Object

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’.



1057
1058
1059
 
# File 'lib/rubygems/test_case.rb', line 1057

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

#mu_pp(obj) ⇒ Object

Enables pretty-print for all tests



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

def mu_pp(obj)
  s = ''
  s = PP.pp obj, s
  s = s.force_encoding(Encoding.default_external) if defined? Encoding
  s.chomp
end

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



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/rubygems/test_case.rb', line 713

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")
  $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

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

new_spec is deprecated as it is never used.

TODO: remove in RubyGems 3.0



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/rubygems/test_case.rb', line 673

def new_spec name, version, deps = nil, *files # :nodoc:
  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"

    Array(deps).each do |n, req|
      s.add_dependency n, (req || '>= 0')
    end

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

    yield s if block_given?
  end

  spec.loaded_from = spec.spec_file

  unless files.empty? then
    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

  spec
end

#nmake_found? ⇒ Boolean

Returns whether or not the nmake command could be found.

Returns:

  • (Boolean) 


1064
1065
1066
 
# File 'lib/rubygems/test_case.rb', line 1064

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

#parse_make_command_line(line) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rubygems/test_case.rb', line 128

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_port ⇒ Object

See ::process_based_port



1088
1089
1090
 
# File 'lib/rubygems/test_case.rb', line 1088

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.



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/rubygems/test_case.rb', line 546

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 = spec.loaded_from = written_path

  Gem::Specification.add_spec spec.for_cache

  return spec
end

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

TODO: remove in RubyGems 3.0



578
579
580
 
# File 'lib/rubygems/test_case.rb', line 578

def quick_spec name, version = '2' # :nodoc:
  util_spec name, version
end

#read_binary(path) ⇒ Object

Reads a binary file at path



513
514
515
 
# File 'lib/rubygems/test_case.rb', line 513

def read_binary(path)
  Gem.read_binary path
end

#read_cache(path) ⇒ Object

Reads a Marshal file at path



504
505
506
507
508
 
# File 'lib/rubygems/test_case.rb', line 504

def read_cache(path)
  open path.dup.untaint, 'rb' do |io|
    Marshal.load io.read
  end
end

#refute_path_exists(path, msg = nil) ⇒ Object

TODO: move to minitest



119
120
121
122
 
# File 'lib/rubygems/test_case.rb', line 119

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.



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

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

#save_loaded_features ⇒ Object 



661
662
663
664
665
666
 
# File 'lib/rubygems/test_case.rb', line 661

def save_loaded_features
  old_loaded_features = $LOADED_FEATURES.dup
  yield
ensure
  $LOADED_FEATURES.replace old_loaded_features
end

#scan_make_command_lines(output) ⇒ Object 



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

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

#setup ⇒ Object

#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.

If the KEEP_FILES environment variable is set the files will not be removed from /tmp/test_rubygems_#{$$}.#{Time.now.to_i}.



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

def setup
  super

  @orig_gem_home = ENV['GEM_HOME']
  @orig_gem_path = ENV['GEM_PATH']

  @current_dir = Dir.pwd
  @fetcher     = nil
  @ui          = Gem::MockGemUi.new

  tmpdir = File.expand_path Dir.tmpdir
  tmpdir.untaint

  if ENV['KEEP_FILES'] then
    @tempdir = File.join(tmpdir, "test_rubygems_#{$$}.#{Time.now.to_i}")
  else
    @tempdir = File.join(tmpdir, "test_rubygems_#{$$}")
  end
  @tempdir.untaint

  FileUtils.mkdir_p @tempdir

  # This makes the tempdir consistent on OS X.
  # File.expand_path Dir.tmpdir                      #=> "/var/..."
  # Dir.chdir Dir.tmpdir do File.expand_path '.' end #=> "/private/var/..."
  # TODO use File#realpath above instead of #expand_path once 1.8 support is
  # dropped.
  Dir.chdir @tempdir do
    @tempdir = File.expand_path '.'
    @tempdir.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'] then
                 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! { |s| File.expand_path(s).untaint }

  Dir.chdir @tempdir

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

  FileUtils.mkdir_p @gemhome
  FileUtils.mkdir_p @userhome

  @orig_gem_private_key_passphrase = ENV['GEM_PRIVATE_KEY_PASSPHRASE']
  ENV['GEM_PRIVATE_KEY_PASSPHRASE'] = PRIVATE_KEY_PASSPHRASE

  @default_dir = File.join @tempdir, 'default'
  @default_spec_dir = File.join @default_dir, "specifications", "default"
  Gem.instance_variable_set :@default_dir, @default_dir
  FileUtils.mkdir_p @default_spec_dir

  # We use Gem::Specification.reset the first time only so that if there
  # are unresolved deps that leak into the whole test suite, they're at least
  # reported once.
  if @@initial_reset
    Gem::Specification.unresolved_deps.clear # done to avoid cross-test warnings
  else
    @@initial_reset = true
    Gem::Specification.reset
  end
  Gem.use_paths(@gemhome)

  Gem::Security.reset

  Gem.loaded_specs.clear
  Gem.clear_default_specs
  Gem::Specification.unresolved_deps.clear

  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_BASERUBY = Gem::ConfigMap[:BASERUBY]
  Gem::ConfigMap[:BASERUBY] = Gem::ConfigMap[:ruby_install_name]

  @orig_arch = Gem::ConfigMap[:arch]

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

  @marshal_version = "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}"
end

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

Constructs a new Gem::Specification.



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

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



1206
1207
1208
1209
1210
 
# File 'lib/rubygems/test_case.rb', line 1206

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

#teardown ⇒ Object

#teardown restores the process to its original state and removes the tempdir unless the KEEP_FILES environment variable was set.



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

def teardown
  $LOAD_PATH.replace @orig_LOAD_PATH if @orig_LOAD_PATH

  Gem::ConfigMap[:BASERUBY] = @orig_BASERUBY
  Gem::ConfigMap[:arch] = @orig_arch

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

  Dir.chdir @current_dir

  FileUtils.rm_rf @tempdir unless ENV['KEEP_FILES']

  ENV['GEM_HOME'] = @orig_gem_home
  ENV['GEM_PATH'] = @orig_gem_path

  Gem.ruby = @orig_ruby if @orig_ruby

  if @orig_ENV_HOME then
    ENV['HOME'] = @orig_ENV_HOME
  else
    ENV.delete 'HOME'
  end

  Gem.instance_variable_set :@default_dir, nil

  ENV['GEM_PRIVATE_KEY_PASSPHRASE'] = @orig_gem_private_key_passphrase

  Gem::Specification._clear_load_cache
end

#uninstall_gem(spec) ⇒ Object

Uninstalls the Gem::Specification spec



472
473
474
475
476
477
 
# File 'lib/rubygems/test_case.rb', line 472

def uninstall_gem spec
  require 'rubygems/uninstaller'

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

#unresolved_names ⇒ Object 



657
658
659
 
# File 'lib/rubygems/test_case.rb', line 657

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



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/rubygems/test_case.rb', line 586

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_gems ⇒ Object

Removes all installed gems from @gemhome.



614
615
616
617
618
619
620
 
# File 'lib/rubygems/test_case.rb', line 614

def util_clear_gems
  FileUtils.rm_rf File.join(@gemhome, "gems") # TODO: use Gem::Dirs
  FileUtils.mkdir File.join(@gemhome, "gems")
  FileUtils.rm_rf File.join(@gemhome, "specifications")
  FileUtils.mkdir File.join(@gemhome, "specifications")
  Gem::Specification.reset
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.



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
 
# File 'lib/rubygems/test_case.rb', line 773

def util_gem(name, version, deps = nil, &block)
  # TODO: deprecate
  raise "deps or block, not both" if deps and block

  if deps then
    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.



805
806
807
808
809
810
811
812
813
 
# File 'lib/rubygems/test_case.rb', line 805

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

+@a3a

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



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
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
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/rubygems/test_case.rb', line 833

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 



606
607
608
609
 
# File 'lib/rubygems/test_case.rb', line 606

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

#util_set_arch(arch) ⇒ Object

Set the platform to arch



900
901
902
903
904
905
906
907
908
 
# File 'lib/rubygems/test_case.rb', line 900

def util_set_arch(arch)
  Gem::ConfigMap[:arch] = arch
  platform = Gem::Platform.new arch

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

  platform
end

#util_setup_fake_fetcher(prerelease = false) ⇒ Object

Sets up a fake fetcher using the gems from #util_make_gems. Optionally additional prerelease gems may be included.

Gems created by this method may be fetched using Gem::RemoteFetcher.



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/rubygems/test_case.rb', line 916

def util_setup_fake_fetcher(prerelease = false)
  require 'zlib'
  require 'socket'
  require 'rubygems/remote_fetcher'

  @fetcher = Gem::FakeFetcher.new

  util_make_gems(prerelease)
  Gem::Specification.reset

  @all_gems = [@a1, @a2, @a3a, @a_evil9, @b2, @c1_2].sort
  @all_gem_names = @all_gems.map { |gem| gem.full_name }

  gem_names = [@a1.full_name, @a2.full_name, @a3a.full_name, @b2.full_name]
  @gem_names = gem_names.sort.join("\n")

  Gem::RemoteFetcher.fetcher = @fetcher
end

#util_setup_spec_fetcher(*specs) ⇒ Object

Sets up Gem::SpecFetcher to return information from the gems in specs. Best used with @all_gems from #util_setup_fake_fetcher.



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/rubygems/test_case.rb', line 948

def util_setup_spec_fetcher(*specs)
  specs -= Gem::Specification._all
  Gem::Specification.add_specs(*specs)

  spec_fetcher = Gem::SpecFetcher.fetcher

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

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

  spec_fetcher.latest_specs[@uri] = []
  Gem::Specification.latest_specs.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 then
    v = Gem.marshal_version

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

    latest_specs = Gem::Specification.latest_specs.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

    Gem::Specification.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) ⇒ Object

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



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/rubygems/test_case.rb', line 736

def util_spec name, version = 2, deps = nil # :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"

    yield s if block_given?
  end

  if deps then
    # 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

  spec.loaded_from = spec.spec_file

  Gem::Specification.add_spec spec

  return spec
end

#util_zip(data) ⇒ Object

Deflates data



1009
1010
1011
 
# File 'lib/rubygems/test_case.rb', line 1009

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

#v(string) ⇒ Object

Construct a new Gem::Version.



1215
1216
1217
 
# File 'lib/rubygems/test_case.rb', line 1215

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) 


1039
1040
1041
 
# File 'lib/rubygems/test_case.rb', line 1039

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



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/rubygems/test_case.rb', line 1225

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

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

  FileUtils.mkdir_p directory

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

  return name, vendor_spec.version, directory
end

#wait_for_child_process_to_exit ⇒ Object

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).



1071
1072
1073
1074
 
# File 'lib/rubygems/test_case.rb', line 1071

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) 


1023
1024
1025
 
# File 'lib/rubygems/test_case.rb', line 1023

def win_platform?
  Gem.win_platform?
end

#write_file(path) ⇒ Object

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



520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/rubygems/test_case.rb', line 520

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

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

  path
end