Class: Gem::TestCase
- Inherits:
-
MiniTest::Unit::TestCase
- Object
- MiniTest::Unit::TestCase
- Gem::TestCase
- 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
Defined Under Namespace
Classes: StaticSet
Constant Summary collapse
- @@project_dir =
Dir.pwd.untaint
- @@initial_reset =
false
- @@ruby =
rubybin
- @@good_rake =
"#{rubybin} #{File.('../../../test/rubygems/good_rake.rb', __FILE__)}"
- @@bad_rake =
"#{rubybin} #{File.('../../../test/rubygems/bad_rake.rb', __FILE__)}"
Class Method Summary collapse
-
.cert_path(cert_name) ⇒ Object
Returns the path to the certificate named
cert_name
fromtest/rubygems/
. -
.key_path(key_name) ⇒ Object
Returns the path tot he key named
key_name
fromtest/rubygems
. -
.load_cert(cert_name) ⇒ Object
Loads certificate named
cert_name
fromtest/rubygems/
. -
.load_key(key_name) ⇒ Object
Loads an RSA private key named
key_name
intest/rubygems/
. -
.make_command ⇒ Object
Returns the make command for the current platform.
-
.process_based_port ⇒ Object
Allows tests to use a random (but controlled) port number instead of a hardcoded one.
-
.rubybin ⇒ Object
Finds the path to the ruby executable.
-
.vc_windows? ⇒ Boolean
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
-
.win_platform? ⇒ Boolean
Is this test being run on a Windows platform?.
Instance Method Summary collapse
-
#add_to_fetcher(spec, path = nil, repo = @gem_repo) ⇒ Object
Add
spec
to @fetcher serving the data in the filepath
. - #all_spec_names ⇒ Object
-
#assert_path_exists(path, msg = nil) ⇒ Object
TODO: move to minitest.
-
#build_rake_in(good = true) ⇒ Object
Allows the proper version of
rake
to be used for the test. -
#create_tmpdir ⇒ Object
creates a temporary directory with hax TODO: deprecate and remove.
-
#dep(name, *requirements) ⇒ Object
Construct a new Gem::Dependency.
-
#install_default_gems(*specs) ⇒ Object
Installs the provided default specs including writing the spec file.
-
#install_default_specs(*specs) ⇒ Object
Install the provided default specs.
-
#install_gem(spec, options = {}) ⇒ Object
Builds and installs the Gem::Specification
spec
. -
#install_gem_user(spec) ⇒ Object
Builds and installs the Gem::Specification
spec
into the user dir. -
#install_specs(*specs) ⇒ Object
Install the provided specs.
-
#make_command ⇒ Object
Returns the make command for the current platform.
-
#mu_pp(obj) ⇒ Object
Enables pretty-print for all tests.
- #new_default_spec(name, version, deps = nil, *files) ⇒ Object
-
#new_spec(name, version, deps = nil, *files) ⇒ Object
Create a new spec (or gem if passed an array of files) and set it up properly.
-
#nmake_found? ⇒ Boolean
Returns whether or not the nmake command could be found.
-
#process_based_port ⇒ Object
See ::process_based_port.
-
#quick_gem(name, version = '2') ⇒ Object
Creates a Gem::Specification with a minimum of extra work.
- #quick_spec(name, version = '2') ⇒ Object
-
#read_binary(path) ⇒ Object
Reads a binary file at
path
. -
#read_cache(path) ⇒ Object
Reads a Marshal file at
path
. -
#refute_path_exists(path, msg = nil) ⇒ Object
TODO: move to minitest.
-
#req(*requirements) ⇒ Object
Constructs a new Gem::Requirement.
-
#setup ⇒ Object
#setup prepares a sandboxed location to install gems.
-
#spec(name, version, &block) ⇒ Object
Constructs a new Gem::Specification.
-
#teardown ⇒ Object
#teardown restores the process to its original state and removes the tempdir unless the
KEEP_FILES
environment variable was set. -
#uninstall_gem(spec) ⇒ Object
Uninstalls the Gem::Specification
spec
. -
#util_build_gem(spec) ⇒ Object
Builds a gem from
spec
and places it inFile.join @gemhome, 'cache'
. -
#util_clear_gems ⇒ Object
Removes all installed gems from @gemhome.
-
#util_gem(name, version, deps = nil, &block) ⇒ Object
Creates a gem with
name
,version
anddeps
. -
#util_gzip(data) ⇒ Object
Gzips
data
. -
#util_make_gems(prerelease = false) ⇒ Object
Creates several default gems which all have a lib/code.rb file.
- #util_remove_gem(spec) ⇒ Object
-
#util_set_arch(arch) ⇒ Object
Set the platform to
arch
. -
#util_setup_fake_fetcher(prerelease = false) ⇒ Object
Sets up a fake fetcher using the gems from #util_make_gems.
-
#util_setup_spec_fetcher(*specs) ⇒ Object
Sets up Gem::SpecFetcher to return information from the gems in
specs
. -
#util_spec(name, version, deps = nil, &block) ⇒ Object
Creates a spec with
name
,version
anddeps
. -
#util_zip(data) ⇒ Object
Deflates
data
. -
#v(string) ⇒ Object
Construct a new Gem::Version.
-
#vc_windows? ⇒ Boolean
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
-
#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).
-
#win_platform? ⇒ Boolean
Is this test being run on a Windows platform?.
-
#write_file(path) ⇒ Object
Writes a binary file to
path
which is relative to @gemhome.
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Class Method Details
.cert_path(cert_name) ⇒ Object
Returns the path to the certificate named cert_name
from test/rubygems/
.
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 |
# File 'lib/rubygems/test_case.rb', line 1006 def self.cert_path cert_name if 32 == (Time.at(2**32) rescue 32) then cert_file = File. "../../../test/rubygems/#{cert_name}_cert_32.pem", __FILE__ return cert_file if File.exist? cert_file end File. "../../../test/rubygems/#{cert_name}_cert.pem", __FILE__ end |
.key_path(key_name) ⇒ Object
Returns the path tot he key named key_name
from test/rubygems
1032 1033 1034 |
# File 'lib/rubygems/test_case.rb', line 1032 def self.key_path key_name File. "../../../test/rubygems/#{key_name}_key.pem", __FILE__ end |
.load_cert(cert_name) ⇒ Object
Loads certificate named cert_name
from test/rubygems/
.
994 995 996 997 998 999 1000 |
# File 'lib/rubygems/test_case.rb', line 994 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) ⇒ Object
Loads an RSA private key named key_name
in test/rubygems/
1021 1022 1023 1024 1025 1026 1027 |
# File 'lib/rubygems/test_case.rb', line 1021 def self.load_key key_name key_file = key_path key_name key = File.read key_file OpenSSL::PKey::RSA.new key 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’.
847 848 849 |
# File 'lib/rubygems/test_case.rb', line 847 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.
880 881 882 |
# File 'lib/rubygems/test_case.rb', line 880 def self.process_based_port @@process_based_port ||= 8000 + $$ % 1000 end |
.rubybin ⇒ Object
Finds the path to the ruby executable
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 |
# File 'lib/rubygems/test_case.rb', line 913 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.(ruby) end if File.exist? rubyexe and File.executable? rubyexe return File.(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.
830 831 832 |
# File 'lib/rubygems/test_case.rb', line 830 def self.vc_windows? RUBY_PLATFORM.match('mswin') end |
.win_platform? ⇒ Boolean
Is this test being run on a Windows platform?
815 816 817 |
# File 'lib/rubygems/test_case.rb', line 815 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.
759 760 761 762 |
# File 'lib/rubygems/test_case.rb', line 759 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
369 370 371 |
# File 'lib/rubygems/test_case.rb', line 369 def all_spec_names Gem::Specification.map(&:full_name) end |
#assert_path_exists(path, msg = nil) ⇒ Object
TODO: move to minitest
81 82 83 84 |
# File 'lib/rubygems/test_case.rb', line 81 def assert_path_exists path, msg = nil msg = (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.
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 |
# File 'lib/rubygems/test_case.rb', line 894 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 |
#create_tmpdir ⇒ Object
creates a temporary directory with hax TODO: deprecate and remove
320 321 322 323 324 325 326 |
# File 'lib/rubygems/test_case.rb', line 320 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.
946 947 948 |
# File 'lib/rubygems/test_case.rb', line 946 def dep name, *requirements Gem::Dependency.new name, *requirements end |
#install_default_gems(*specs) ⇒ Object
Installs the provided default specs including writing the spec file
485 486 487 488 489 490 491 492 493 |
# File 'lib/rubygems/test_case.rb', line 485 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
498 499 500 501 502 503 |
# File 'lib/rubygems/test_case.rb', line 498 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
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 |
# File 'lib/rubygems/test_case.rb', line 282 def install_gem spec, = {} require 'rubygems/installer' gem = File.join @tempdir, "gems", "#{spec.full_name}.gem" unless File.exists? 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)).untaint end Gem::Installer.new(gem, .merge({:wrappers => true})).install end |
#install_gem_user(spec) ⇒ Object
Builds and installs the Gem::Specification spec
into the user dir
303 304 305 |
# File 'lib/rubygems/test_case.rb', line 303 def install_gem_user spec install_gem spec, :user_install => true end |
#install_specs(*specs) ⇒ Object
Install the provided specs
477 478 479 480 |
# File 'lib/rubygems/test_case.rb', line 477 def install_specs(*specs) Gem::Specification.add_specs(*specs) Gem.searcher = nil 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’.
856 857 858 |
# File 'lib/rubygems/test_case.rb', line 856 def make_command ENV["make"] || (vc_windows? ? 'nmake' : 'make') end |
#mu_pp(obj) ⇒ Object
Enables pretty-print for all tests
331 332 333 334 335 336 |
# File 'lib/rubygems/test_case.rb', line 331 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
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'lib/rubygems/test_case.rb', line 549 def new_default_spec(name, version, deps = nil, *files) spec = new_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
Create a new spec (or gem if passed an array of files) and set it up properly. Use this instead of util_spec and util_gem.
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 541 542 543 544 545 546 547 |
# File 'lib/rubygems/test_case.rb', line 509 def new_spec name, version, deps = nil, *files require 'rubygems/specification' spec = Gem::Specification.new do |s| s.platform = Gem::Platform::RUBY s.name = name s.version = version s. = '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.
863 864 865 |
# File 'lib/rubygems/test_case.rb', line 863 def nmake_found? system('nmake /? 1>NUL 2>&1') end |
#process_based_port ⇒ Object
See ::process_based_port
887 888 889 |
# File 'lib/rubygems/test_case.rb', line 887 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.
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 |
# File 'lib/rubygems/test_case.rb', line 383 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. = '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
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/rubygems/test_case.rb', line 412 def quick_spec name, version = '2' # TODO: deprecate require 'rubygems/specification' spec = Gem::Specification.new do |s| s.platform = Gem::Platform::RUBY s.name = name s.version = version s. = '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 spec.loaded_from = spec.spec_file Gem::Specification.add_spec spec return spec end |
#read_binary(path) ⇒ Object
Reads a binary file at path
350 351 352 |
# File 'lib/rubygems/test_case.rb', line 350 def read_binary(path) Gem.read_binary path end |
#read_cache(path) ⇒ Object
Reads a Marshal file at path
341 342 343 344 345 |
# File 'lib/rubygems/test_case.rb', line 341 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
87 88 89 90 |
# File 'lib/rubygems/test_case.rb', line 87 def refute_path_exists path, msg = nil msg = (msg) { "Expected path '#{path}' to not exist" } refute File.exist?(path), msg end |
#req(*requirements) ⇒ Object
Constructs a new Gem::Requirement.
953 954 955 956 |
# File 'lib/rubygems/test_case.rb', line 953 def req *requirements return requirements.first if Gem::Requirement === requirements.first Gem::Requirement.create requirements 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}
.
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 |
# File 'lib/rubygems/test_case.rb', line 112 def setup super @orig_gem_home = ENV['GEM_HOME'] @orig_gem_path = ENV['GEM_PATH'] @current_dir = Dir.pwd @ui = Gem::MockGemUi.new tmpdir = File. 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. '.' @tempdir.untaint end @gemhome = File.join @tempdir, 'gemhome' @userhome = File.join @tempdir, 'userhome' @orig_ruby = if ENV['RUBY'] then ruby = Gem.instance_variable_get :@ruby Gem.instance_variable_set :@ruby, ENV['RUBY'] ruby end Gem.ensure_gem_subdirectories @gemhome @orig_LOAD_PATH = $LOAD_PATH.dup $LOAD_PATH.map! { |s| File.(s).untaint } Dir.chdir @tempdir @orig_ENV_HOME = ENV['HOME'] ENV['HOME'] = @userhome Gem.instance_variable_set :@user_home, nil FileUtils.mkdir_p @gemhome FileUtils.mkdir_p @userhome @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}" # TODO: move to installer test cases 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 # TODO: move to installer test cases 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 |
#spec(name, version, &block) ⇒ Object
Constructs a new Gem::Specification.
961 962 963 |
# File 'lib/rubygems/test_case.rb', line 961 def spec name, version, &block Gem::Specification.new name, v(version), &block end |
#teardown ⇒ Object
#teardown restores the process to its original state and removes the tempdir unless the KEEP_FILES
environment variable was set.
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 |
# File 'lib/rubygems/test_case.rb', line 250 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 _ = @orig_ruby Gem.instance_variable_set :@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 end |
#uninstall_gem(spec) ⇒ Object
Uninstalls the Gem::Specification spec
309 310 311 312 313 314 |
# File 'lib/rubygems/test_case.rb', line 309 def uninstall_gem spec require 'rubygems/uninstaller' Gem::Uninstaller.new(spec.name, :executables => true, :user_install => true).uninstall 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
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 |
# File 'lib/rubygems/test_case.rb', line 440 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.
468 469 470 471 472 |
# File 'lib/rubygems/test_case.rb', line 468 def util_clear_gems FileUtils.rm_rf File.join(@gemhome, "gems") # TODO: use Gem::Dirs FileUtils.rm_rf 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.
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 |
# File 'lib/rubygems/test_case.rb', line 594 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
.
626 627 628 629 630 631 632 633 634 |
# File 'lib/rubygems/test_case.rb', line 626 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
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 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 712 713 714 715 |
# File 'lib/rubygems/test_case.rb', line 654 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. = %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 #{@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
460 461 462 463 |
# File 'lib/rubygems/test_case.rb', line 460 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
720 721 722 723 724 725 726 727 728 |
# File 'lib/rubygems/test_case.rb', line 720 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.
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 |
# File 'lib/rubygems/test_case.rb', line 736 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.
768 769 770 771 772 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 801 802 803 |
# File 'lib/rubygems/test_case.rb', line 768 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 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 unless Gem::RemoteFetcher === @fetcher # HACK for test_download_to_cache nil # force errors end |
#util_spec(name, version, deps = nil, &block) ⇒ Object
Creates a spec with name
, version
and deps
.
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/rubygems/test_case.rb', line 570 def util_spec(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 # deteriminstic on all implementations. deps.keys.sort.each do |n| s.add_dependency n, (deps[n] || '>= 0') end end end quick_spec(name, version, &block) end |
#util_zip(data) ⇒ Object
Deflates data
808 809 810 |
# File 'lib/rubygems/test_case.rb', line 808 def util_zip(data) Zlib::Deflate.deflate data end |
#v(string) ⇒ Object
Construct a new Gem::Version.
968 969 970 |
# File 'lib/rubygems/test_case.rb', line 968 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.
838 839 840 |
# File 'lib/rubygems/test_case.rb', line 838 def vc_windows? RUBY_PLATFORM.match('mswin') 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).
870 871 872 873 |
# File 'lib/rubygems/test_case.rb', line 870 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?
822 823 824 |
# File 'lib/rubygems/test_case.rb', line 822 def win_platform? Gem.win_platform? end |
#write_file(path) ⇒ Object
Writes a binary file to path
which is relative to @gemhome
357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/rubygems/test_case.rb', line 357 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 |