Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more
MiniTest::Unit::TestCase
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.
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’.
# File rubygems/test_case.rb, line 747
def self.make_command
ENV["make"] || (vc_windows? ? 'nmake' : 'make')
end
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.
# File rubygems/test_case.rb, line 772
def self.process_based_port
@@process_based_port ||= 8000 + $$ % 1000
end
Finds the path to the ruby executable
# File rubygems/test_case.rb, line 804
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
# File rubygems/test_case.rb, line 328
def all_spec_names
Gem::Specification.map(&:full_name)
end
TODO: move to minitest
# File rubygems/test_case.rb, line 84
def assert_path_exists path, msg = nil
msg = message(msg) { "Expected path '#{path}' to exist" }
assert File.exist?(path), msg
end
Allows the proper version of rake to be used for the test.
# File rubygems/test_case.rb, line 786
def build_rake_in
gem_ruby = Gem.ruby
Gem.ruby = @@ruby
env_rake = ENV["rake"]
ENV["rake"] = @@rake
yield @@rake
ensure
Gem.ruby = gem_ruby
if env_rake
ENV["rake"] = env_rake
else
ENV.delete("rake")
end
end
creates a temporary directory with hax
# File rubygems/test_case.rb, line 279
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
Construct a new Gem::Dependency.
# File rubygems/test_case.rb, line 844
def dep name, *requirements
Gem::Dependency.new name, *requirements
end
Builds and installs the Gem::Specification
spec
# File rubygems/test_case.rb, line 246
def install_gem spec, options = {}
require 'rubygems/installer'
use_ui Gem::MockGemUi.new do
Dir.chdir @tempdir do
Gem::Builder.new(spec).build
end
end
gem = File.join(@tempdir, File.basename(spec.cache_file)).untaint
Gem::Installer.new(gem, options.merge({:wrappers => true})).install
end
Builds and installs the Gem::Specification
spec into the user dir
# File rubygems/test_case.rb, line 263
def install_gem_user spec
install_gem spec, :user_install => true
end
Install the provided specs
# File rubygems/test_case.rb, line 432
def install_specs(*specs)
Gem::Specification.add_specs(*specs)
Gem.searcher = nil
end
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’.
# File rubygems/test_case.rb, line 756
def make_command
ENV["make"] || (vc_windows? ? 'nmake' : 'make')
end
Enables pretty-print for all tests
# File rubygems/test_case.rb, line 290
def mu_pp(obj)
s = ''
s = PP.pp obj, s
s = s.force_encoding(Encoding.default_external) if defined? Encoding
s.chomp
end
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.
# File rubygems/test_case.rb, line 441
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.author = 'A User'
s.email = 'example@example.com'
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
Returns whether or not the nmake command could be found.
# File rubygems/test_case.rb, line 763
def nmake_found?
system('nmake /? 1>NUL 2>&1')
end
# File rubygems/test_case.rb, line 779
def process_based_port
self.class.process_based_port
end
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 to the current source_index.
Use this with write_file to build an installed gem.
# File rubygems/test_case.rb, line 343
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 = 'example@example.com'
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
# File rubygems/test_case.rb, line 372
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.author = 'A User'
s.email = 'example@example.com'
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
Reads a binary file at path
# File rubygems/test_case.rb, line 309
def read_binary(path)
Gem.read_binary path
end
Reads a Marshal file at path
# File rubygems/test_case.rb, line 300
def read_cache(path)
open path.dup.untaint, 'rb' do |io|
Marshal.load io.read
end
end
TODO: move to minitest
# File rubygems/test_case.rb, line 90
def refute_path_exists path, msg = nil
msg = message(msg) { "Expected path '#{path}' to not exist" }
refute File.exist?(path), msg
end
Constructs a new Gem::Requirement.
# File rubygems/test_case.rb, line 851
def req *requirements
return requirements.first if Gem::Requirement === requirements.first
Gem::Requirement.create requirements
end
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}.
# File rubygems/test_case.rb, line 113
def setup
super
@orig_gem_home = ENV['GEM_HOME']
@orig_gem_path = ENV['GEM_PATH']
@current_dir = Dir.pwd
@ui = Gem::MockGemUi.new
tmpdir = nil
Dir.chdir Dir.tmpdir do tmpdir = Dir.pwd end # HACK OSX /private/tmp
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
@gemhome = File.join @tempdir, 'gemhome'
@userhome = File.join @tempdir, 'userhome'
@orig_ruby = if ruby = ENV['RUBY'] then
Gem.class_eval { ruby, @ruby = @ruby, ruby }
ruby
end
Gem.ensure_gem_subdirectories @gemhome
@orig_LOAD_PATH = $LOAD_PATH.dup
$LOAD_PATH.map! { |s| File.expand_path s }
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
Gem.use_paths(@gemhome)
Gem.loaded_specs.clear
Gem.unresolved_deps.clear
Gem.configuration.verbose = true
Gem.configuration.update_sources = true
@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.post_uninstall_hooks.clear
Gem.pre_install_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
Constructs a new Gem::Specification.
# File rubygems/test_case.rb, line 859
def spec name, version, &block
Gem::Specification.new name, v(version), &block
end
teardown restores the process
to its original state and removes the tempdir unless the
KEEP_FILES environment variable was set.
# File rubygems/test_case.rb, line 216
def teardown
$LOAD_PATH.replace @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.class_eval { @ruby = _ } if _
if @orig_ENV_HOME then
ENV['HOME'] = @orig_ENV_HOME
else
ENV.delete 'HOME'
end
end
Uninstalls the Gem::Specification
spec
# File rubygems/test_case.rb, line 269
def uninstall_gem spec
require 'rubygems/uninstaller'
Gem::Uninstaller.new(spec.name,
:executables => true, :user_install => true).uninstall
end
Builds a gem from spec and places it in File.join
@gemhome, 'cache'. Automatically creates files based on
spec.files
# File rubygems/test_case.rb, line 400
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::Builder.new(spec).build
end
cache = spec.cache_file
FileUtils.mv File.basename(cache), cache
end
end
Removes all installed gems from +@gemhome+.
# File rubygems/test_case.rb, line 423
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
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.
# File rubygems/test_case.rb, line 508
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
# deteriminstic 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
Gzips data.
# File rubygems/test_case.rb, line 540
def util_gzip(data)
out = StringIO.new
Zlib::GzipWriter.wrap out do |io|
io.write data
end
out.string
end
Creates several default gems which all have a lib/code.rb file. The gems are not installed but are available in the cache dir.
gem a version 1, this is the best-described gem.
gem a version 2
gem a version 3.a
gem a_evil version 9, use this to ensure similarly-named gems don’t collide with a.
gem b version 2
gem c version 1.2
gem pl version 1, this gem has a legacy platform of i386-linux.
Additional prerelease gems may also be created:
gem a version 2.a
TODO: nuke this and fix tests. this should speed up a lot
# File rubygems/test_case.rb, line 568
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[example@example.com example2@example.com]
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)
@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])
[@a1, @a2, @a3a, @a_evil9, @b2, @c1_2, @pl1].each do |spec|
util_build_gem spec
end
FileUtils.rm_r File.join(@gemhome, "gems", @pl1.original_name)
end
Set the platform to arch
# File rubygems/test_case.rb, line 626
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
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.
# File rubygems/test_case.rb, line 642
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
Sets up Gem::SpecFetcher to return
information from the gems in specs. Best used with +@all_gems+
from util_setup_fake_fetcher.
# File rubygems/test_case.rb, line 665
def util_setup_spec_fetcher(*specs)
specs -= Gem::Specification._all
Gem::Specification.add_specs(*specs)
spec_fetcher = Gem::SpecFetcher.fetcher
prerelease, _ = Gem::Specification.partition { |spec|
spec.version.prerelease?
}
spec_fetcher.specs[@uri] = []
Gem::Specification.each do |spec|
spec_tuple = [spec.name, spec.version, spec.original_platform]
spec_fetcher.specs[@uri] << spec_tuple
end
spec_fetcher.latest_specs[@uri] = []
Gem::Specification.latest_specs.each do |spec|
spec_tuple = [spec.name, spec.version, spec.original_platform]
spec_fetcher.latest_specs[@uri] << spec_tuple
end
spec_fetcher.prerelease_specs[@uri] = []
prerelease.each do |spec|
spec_tuple = [spec.name, spec.version, spec.original_platform]
spec_fetcher.prerelease_specs[@uri] << spec_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
Creates a spec with name, version and
deps.
# File rubygems/test_case.rb, line 484
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
Deflates data
# File rubygems/test_case.rb, line 708
def util_zip(data)
Zlib::Deflate.deflate data
end
Construct a new Gem::Version.
# File rubygems/test_case.rb, line 866
def v string
Gem::Version.create string
end
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
# File rubygems/test_case.rb, line 738
def vc_windows?
RUBY_PLATFORM.match('mswin')
end
Is this test being run on a Windows platform?
# File rubygems/test_case.rb, line 722
def win_platform?
Gem.win_platform?
end
Writes a binary file to path which is relative to +@gemhome+
# File rubygems/test_case.rb, line 316
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
Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.
If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.
If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.
If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.