Class: Gem::TestCase
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Deprecate
|
|
Instance Chain:
self,
DefaultUserInteraction ,
Text
|
|
Inherits: | Object |
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.
Constant Summary
-
PRIVATE_KEY_PASSPHRASE =
Internal use only
# File 'lib/rubygems/test_case.rb', line 1506'Foo bar'.freeze
-
SPECIFICATIONS =
# File 'lib/rubygems/test_case.rb', line 99File. (File.join(TEST_PATH, "specifications"), __FILE__)
-
TEST_PATH =
# File 'lib/rubygems/test_case.rb', line 97ENV.fetch('RUBYGEMS_TEST_PATH', File. ('../../../test/rubygems', __FILE__))
Class Attribute Summary
-
.java_platform? ⇒ Boolean
readonly
Is this test being run on a Java platform?
-
.vc_windows? ⇒ Boolean
readonly
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
-
.win_platform? ⇒ Boolean
readonly
Is this test being run on a Windows platform?
Class Method Summary
-
.cert_path(cert_name)
Returns the path to the certificate named
cert_name
fromtest/rubygems/
. -
.key_path(key_name)
Returns the path to the key named
key_name
fromtest/rubygems
. -
.load_cert(cert_name)
Loads certificate named
cert_name
fromtest/rubygems/
. -
.load_key(key_name, passphrase = nil)
Loads an RSA private key named
key_name
withpassphrase
intest/rubygems/
. -
.make_command
Returns the make command for the current platform.
-
.process_based_port
Allows tests to use a random (but controlled) port number instead of a hardcoded one.
-
.rubybin
Finds the path to the Ruby executable.
- .escape_path(*path) private
Deprecate
- Extended
deprecate | Simple deprecation method that deprecates |
skip_during | Temporarily turn off warnings. |
Instance Attribute Summary
-
#have_git? ⇒ Boolean
readonly
Skips this test unless you have a git executable.
-
#java_platform? ⇒ Boolean
readonly
Is this test being run on a Java platform?
-
#nmake_found? ⇒ Boolean
readonly
Returns whether or not the nmake command could be found.
-
#vc_windows? ⇒ Boolean
readonly
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
-
#win_platform? ⇒ Boolean
readonly
Is this test being run on a Windows platform?
- #fetcher rw Internal use only
- #gem_repo rw Internal use only
- #uri rw Internal use only
DefaultUserInteraction
- Included
Instance Method Summary
- #add_to_fetcher(spec, path = nil, repo = @gem_repo)
- #all_spec_names
- #assert_activate(expected, *specs)
- #assert_contains_make_command(target, output, msg = nil)
- #assert_directory_exists(path, msg = nil)
-
#assert_path_exists(path, msg = nil)
TODO: move to minitest.
-
#bindir(value)
Sets the bindir entry in
RbConfig::CONFIG
tovalue
and restores the original value when the block ends. -
#build_rake_in(good = true)
Allows the proper version of
rake
to be used for the test. - #common_installer_setup
- #common_installer_teardown
-
#dep(name, *requirements)
Construct a new
Dependency
. -
#dependency_request(dep, from_name, from_version, parent = nil)
Constructs a
Resolver::DependencyRequest
from aDependency
#dep, afrom_name
andfrom_version
requesting the dependency and aparent
DependencyRequest. -
#enable_shared(value)
Sets the ENABLE_SHARED entry in
RbConfig::CONFIG
tovalue
and restores the original value when the block ends. -
#exeext(value)
Sets the EXEEXT entry in
RbConfig::CONFIG
tovalue
and restores the original value when the block ends. -
#git_gem(name = 'a', version = 1)
A git_gem is used with a gem dependencies file.
-
#install_default_gems(*specs)
Installs the provided default specs including writing the spec file.
-
#install_default_specs(*specs)
Install the provided default specs.
-
#install_gem(spec, options = {})
Builds and installs the
Specification
#spec -
#install_gem_user(spec)
Builds and installs the
Specification
#spec into the user dir. -
#install_specs(*specs)
Install the provided specs.
- #loaded_spec_names
-
#make_command
Returns the make command for the current platform.
-
#mu_pp(obj)
Enables pretty-print for all tests.
- #new_default_spec(name, version, deps = nil, *files)
- #parse_make_command_line(line)
- #process_based_port
-
#quick_gem(name, version = '2')
Creates a
Specification
with a minimum of extra work. -
#read_binary(path)
Reads a binary file at path
-
#read_cache(path)
Reads a Marshal file at path
-
#refute_path_exists(path, msg = nil)
TODO: move to minitest.
-
#req(*requirements)
Constructs a new
Requirement
. -
#save_gemspec(name = 'a', version = 1, directory = '.')
create_gemspec creates gem specification in given
directory
or ‘.’ for the givenname
andversion
. - #save_loaded_features
- #scan_make_command_lines(output)
-
#setup
#setup prepares a sandboxed location to install gems.
-
#spec(name, version, &block)
Constructs a new
Specification
. -
#spec_fetcher(repository = @gem_repo)
Creates a
SpecFetcher
pre-filled with the gems or specs defined in the block. -
#teardown
#teardown restores the process to its original state and removes the tempdir.
-
#uninstall_gem(spec)
Uninstalls the
Specification
#spec - #unresolved_names
-
#util_build_gem(spec)
Builds a gem from #spec and places it in
File.join @gemhome, 'cache'
. -
#util_clear_gems
Removes all installed gems from @gemhome.
- #util_clear_RUBY_VERSION
-
#util_gem(name, version, deps = nil, &block)
Creates a gem with
name
,version
anddeps
. -
#util_gzip(data)
Gzips
data
. -
#util_make_gems(prerelease = false)
Creates several default gems which all have a lib/code.rb file.
- #util_remove_gem(spec)
- #util_restore_RUBY_VERSION
-
#util_set_arch(arch)
Set the platform to
arch
- #util_set_RUBY_VERSION(version, patchlevel = nil, revision = nil, description = nil, engine = "ruby", engine_version = nil)
-
#util_setup_spec_fetcher(*specs)
Sets up
SpecFetcher
to return information from the gems inspecs
. -
#util_spec(name, version = 2, deps = nil, *files)
Creates a spec with
name
,version
. -
#util_zip(data)
Deflates
data
-
#v(string)
Construct a new
Version
. -
#vendor_gem(name = 'a', version = 1)
A vendor_gem is used with a gem dependencies file.
-
#vendordir(value)
Sets the vendordir entry in
RbConfig::CONFIG
tovalue
and restores the original value when the block ends. -
#wait_for_child_process_to_exit
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). - #with_clean_path_to_ruby
-
#write_file(path)
Writes a binary file to path which is relative to @gemhome.
- #in_path?(executable) ⇒ Boolean Internal use only
DefaultUserInteraction
- Included
Text
- Included
#clean_text | Remove any non-printable characters and make the text suitable for printing. |
#format_text | Wraps |
#levenshtein_distance | This code is based directly on the |
#truncate_text, #min3 |
Class Attribute Details
.java_platform? ⇒ Boolean
(readonly)
Is this test being run on a Java platform?
# File 'lib/rubygems/test_case.rb', line 1133
def self.java_platform? Gem.java_platform? end
.vc_windows? ⇒ Boolean
(readonly)
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
# File 'lib/rubygems/test_case.rb', line 1148
def self.vc_windows? RUBY_PLATFORM.match('mswin') end
.win_platform? ⇒ Boolean
(readonly)
Is this test being run on a Windows platform?
# File 'lib/rubygems/test_case.rb', line 1119
def self.win_platform? Gem.win_platform? end
Class Method Details
.cert_path(cert_name)
Returns the path to the certificate named cert_name
from test/rubygems/
.
.escape_path(*path) (private)
[ GitHub ].key_path(key_name)
Returns the path to the key named key_name
from test/rubygems
# File 'lib/rubygems/test_case.rb', line 1499
def self.key_path(key_name) "#{TEST_PATH}/#{key_name}_key.pem" end
.load_cert(cert_name)
Loads certificate named cert_name
from test/rubygems/
.
# File 'lib/rubygems/test_case.rb', line 1463
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)
Loads an RSA private key named key_name
with passphrase
in test/rubygems/
# File 'lib/rubygems/test_case.rb', line 1488
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
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 'lib/rubygems/test_case.rb', line 1165
def self.make_command ENV["make"] || ENV["MAKE"] || (vc_windows? ? 'nmake' : 'make') end
.process_based_port
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 'lib/rubygems/test_case.rb', line 1198
def self.process_based_port @@process_based_port ||= 8000 + $$ % 1000 end
.rubybin
Finds the path to the Ruby executable
# File 'lib/rubygems/test_case.rb', line 1231
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
Instance Attribute Details
#fetcher (rw)
# File 'lib/rubygems/test_case.rb', line 91
attr_accessor :fetcher # :nodoc:
#gem_repo (rw)
# File 'lib/rubygems/test_case.rb', line 93
attr_accessor :gem_repo # :nodoc:
#have_git? ⇒ Boolean
(readonly)
Skips this test unless you have a git executable
# File 'lib/rubygems/test_case.rb', line 552
def have_git? return if in_path? @git skip 'cannot find git executable, use GIT environment variable to set' end
#java_platform? ⇒ Boolean
(readonly)
Is this test being run on a Java platform?
# File 'lib/rubygems/test_case.rb', line 1140
def java_platform? Gem.java_platform? end
#nmake_found? ⇒ Boolean
(readonly)
Returns whether or not the nmake command could be found.
# File 'lib/rubygems/test_case.rb', line 1181
def nmake_found? system('nmake /? 1>NUL 2>&1') end
#uri (rw)
# File 'lib/rubygems/test_case.rb', line 95
attr_accessor :uri # :nodoc:
#vc_windows? ⇒ Boolean
(readonly)
Returns whether or not we’re on a version of Ruby built with VC++ (or Borland) versus Cygwin, Mingw, etc.
# File 'lib/rubygems/test_case.rb', line 1156
def vc_windows? RUBY_PLATFORM.match('mswin') end
#win_platform? ⇒ Boolean
(readonly)
Is this test being run on a Windows platform?
# File 'lib/rubygems/test_case.rb', line 1126
def win_platform? Gem.win_platform? end
Instance Method Details
#add_to_fetcher(spec, path = nil, repo = @gem_repo)
#all_spec_names
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 647
def all_spec_names Gem::Specification.map(&:full_name) end
#assert_activate(expected, *specs)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 101
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)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 251
def assert_contains_make_command(target, output, msg = nil) if output.match(/\n/) msg = (msg) do 'Expected output containing make command "%s": %s' % [ ('%s %s' % [make_command, target]).rstrip, output.inspect ] end else msg = (msg) do 'Expected make command "%s": %s' % [ ('%s %s' % [make_command, target]).rstrip, output.inspect ] end end assert scan_make_command_lines(output).any? { |line| make = parse_make_command_line(line) if make[:targets].include?(target) yield make, line if block_given? true else false end }, msg end
#assert_directory_exists(path, msg = nil)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 124
def assert_directory_exists(path, msg = nil) msg = (msg) { "Expected path '#{path}' to be a directory" } assert_path_exists path assert File.directory?(path), msg end
#assert_path_exists(path, msg = nil)
TODO: move to minitest
#bindir(value)
Sets the bindir entry in RbConfig::CONFIG
to value
and restores the original value when the block ends
# File 'lib/rubygems/test_case.rb', line 173
def bindir(value) with_clean_path_to_ruby do bindir = RbConfig::CONFIG['bindir'] if value RbConfig::CONFIG['bindir'] = value else RbConfig::CONFIG.delete 'bindir' end begin yield ensure if bindir RbConfig::CONFIG['bindir'] = bindir else RbConfig::CONFIG.delete 'bindir' end end end end
#build_rake_in(good = true)
Allows the proper version of rake
to be used for the test.
# File 'lib/rubygems/test_case.rb', line 1212
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
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 471
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
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 497
def common_installer_teardown Gem.post_build_hooks.clear Gem.post_install_hooks.clear Gem.done_installing_hooks.clear Gem.post_reset_hooks.clear Gem.post_uninstall_hooks.clear Gem.pre_install_hooks.clear Gem.pre_reset_hooks.clear Gem.pre_uninstall_hooks.clear end
#dep(name, *requirements)
Construct a new Dependency
.
# File 'lib/rubygems/test_case.rb', line 1293
def dep(name, *requirements) Gem::Dependency.new name, *requirements end
#dependency_request(dep, from_name, from_version, parent = nil)
Constructs a Resolver::DependencyRequest
from a Dependency
#dep, a from_name
and from_version
requesting the dependency and a parent
DependencyRequest
# File 'lib/rubygems/test_case.rb', line 1302
def dependency_request(dep, from_name, from_version, parent = nil) remote = Gem::Source.new @uri unless parent parent_dep = dep from_name, from_version parent = Gem::Resolver::DependencyRequest.new parent_dep, nil end spec = Gem::Resolver::IndexSpecification.new \ nil, from_name, from_version, remote, Gem::Platform::RUBY activation = Gem::Resolver::ActivationRequest.new spec, parent Gem::Resolver::DependencyRequest.new dep, activation end
#exeext(value)
Sets the EXEEXT entry in RbConfig::CONFIG
to value
and restores the original value when the block ends
# File 'lib/rubygems/test_case.rb', line 199
def exeext(value) exeext = RbConfig::CONFIG['EXEEXT'] if value RbConfig::CONFIG['EXEEXT'] = value else RbConfig::CONFIG.delete 'EXEEXT' end yield ensure if exeext RbConfig::CONFIG['EXEEXT'] = exeext else RbConfig::CONFIG.delete 'EXEEXT' end end
#git_gem(name = 'a', version = 1)
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
# File 'lib/rubygems/test_case.rb', line 514
def git_gem(name = 'a', version = 1) have_git? directory = File.join 'git', name directory = File. directory git_spec = Gem::Specification.new name, version do |specification| yield specification if block_given? end FileUtils.mkdir_p directory gemspec = "#{name}.gemspec" File.open File.join(directory, gemspec), 'w' do |io| io.write git_spec.to_ruby end head = nil Dir.chdir directory do unless File.exist? '.git' system @git, 'init', '--quiet' system @git, 'config', 'user.name', 'RubyGems Tests' system @git, 'config', 'user.email', '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
#in_path?(executable) ⇒ Boolean
# File 'lib/rubygems/test_case.rb', line 558
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)
Installs the provided default specs including writing the spec file
# File 'lib/rubygems/test_case.rb', line 747
def install_default_gems(*specs) install_default_specs(*specs) specs.each do |spec| File.open spec.loaded_from, 'w' do |io| io.write spec.to_ruby_for_cache end end end
#install_default_specs(*specs)
Install the provided default specs
#install_gem(spec, options = {})
Builds and installs the Specification
#spec
# File 'lib/rubygems/test_case.rb', line 569
def install_gem(spec, = {}) require 'rubygems/installer' gem = File.join @tempdir, "gems", "#{spec.full_name}.gem" unless File.exist? gem use_ui Gem::MockGemUi.new do Dir.chdir @tempdir do Gem::Package.build spec end end gem = File.join(@tempdir, File.basename(spec.cache_file)).tap(&Gem::UNTAINT) end Gem::Installer.at(gem, .merge({:wrappers => true})).install end
#install_gem_user(spec)
Builds and installs the Specification
#spec into the user dir
# File 'lib/rubygems/test_case.rb', line 590
def install_gem_user(spec) install_gem spec, :user_install => true end
#install_specs(*specs)
Install the provided specs
#loaded_spec_names
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 768
def loaded_spec_names Gem.loaded_specs.values.map(&:full_name).sort end
#make_command
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 'lib/rubygems/test_case.rb', line 1174
def make_command ENV["make"] || ENV["MAKE"] || (vc_windows? ? 'nmake' : 'make') end
#mu_pp(obj)
Enables pretty-print for all tests
# File 'lib/rubygems/test_case.rb', line 609
def mu_pp(obj) s = String.new s = PP.pp obj, s s = s.force_encoding(Encoding.default_external) s.chomp end
#new_default_spec(name, version, deps = nil, *files)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 786
def new_default_spec(name, version, deps = nil, *files) spec = util_spec name, version, deps spec.loaded_from = File.join(@default_spec_dir, spec.spec_name) spec.files = files lib_dir = File.join(@tempdir, "default_gems", "lib") lib_dir.instance_variable_set(:@gem_prelude_index, lib_dir) $LOAD_PATH.unshift(lib_dir) files.each do |file| rb_path = File.join(lib_dir, file) FileUtils.mkdir_p(File.dirname(rb_path)) File.open(rb_path, "w") do |rb| rb << "# #{file}" end end spec end
#parse_make_command_line(line)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 227
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
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 1205
def process_based_port self.class.process_based_port end
#quick_gem(name, version = '2')
Creates a 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.
# File 'lib/rubygems/test_case.rb', line 661
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 = '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 = written_path Gem::Specification.reset return spec end
#read_binary(path)
Reads a binary file at Gem.path
# File 'lib/rubygems/test_case.rb', line 628
def read_binary(path) Gem.read_binary path end
#read_cache(path)
Reads a Marshal file at Gem.path
#refute_path_exists(path, msg = nil)
TODO: move to minitest
#req(*requirements)
Constructs a new Requirement
.
# File 'lib/rubygems/test_case.rb', line 1320
def req(*requirements) return requirements.first if Gem::Requirement === requirements.first Gem::Requirement.create requirements end
#save_gemspec(name = 'a', version = 1, directory = '.')
create_gemspec creates gem specification in given directory
or ‘.’ for the given name
and version
.
Yields the specification
to the block, if given
# File 'lib/rubygems/test_case.rb', line 1385
def save_gemspec(name = 'a', version = 1, directory = '.') vendor_spec = Gem::Specification.new name, version do |specification| yield specification if block_given? end File.open File.join(directory, "#{name}.gemspec"), 'w' do |io| io.write vendor_spec.to_ruby end return name, vendor_spec.version, directory end
#save_loaded_features
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 776
def save_loaded_features old_loaded_features = $LOADED_FEATURES.dup yield ensure prefix = File.dirname(__FILE__) + "/" new_features = ($LOADED_FEATURES - old_loaded_features) old_loaded_features.concat(new_features.select {|f| f.rindex(prefix, 0)}) $LOADED_FEATURES.replace old_loaded_features end
#scan_make_command_lines(output)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 223
def scan_make_command_lines(output) output.scan(/^#{Regexp.escape make_command}(?:[[:blank:]].*)?$/) end
#setup
#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.
# File 'lib/rubygems/test_case.rb', line 293
def setup super @orig_env = ENV.to_hash ENV['GEM_VENDOR'] = nil ENV['GEMRC'] = nil ENV['SOURCE_DATE_EPOCH'] = nil @current_dir = Dir.pwd @fetcher = nil @back_ui = Gem::DefaultUserInteraction.ui @ui = Gem::MockGemUi.new # This needs to be a new instance since we call use_ui(@ui) when we want to # capture output Gem::DefaultUserInteraction.ui = Gem::MockGemUi.new tmpdir = File.realpath Dir.tmpdir tmpdir.tap(&Gem::UNTAINT) @tempdir = File.join(tmpdir, "test_rubygems_#{$$}") @tempdir.tap(&Gem::UNTAINT) FileUtils.mkdir_p @tempdir # This makes the tempdir consistent on Windows. # Dir.tmpdir may return short path name, but Dir[Dir.tmpdir] returns long # path name. https://bugs.ruby-lang.org/issues/10819 # File.expand_path or File.realpath doesn't convert path name to long path # name. Only Dir[] (= Dir.glob) works. # Short and long path name is specific to Windows filesystem. if win_platform? @tempdir = Dir[@tempdir][0] @tempdir.tap(&Gem::UNTAINT) end @gemhome = File.join @tempdir, 'gemhome' @userhome = File.join @tempdir, 'userhome' ENV["GEM_SPEC_CACHE"] = File.join @tempdir, 'spec_cache' @orig_ruby = if ENV['RUBY'] ruby = Gem.ruby Gem.ruby = ENV['RUBY'] ruby end @git = ENV['GIT'] || 'git' Gem.ensure_gem_subdirectories @gemhome @orig_LOAD_PATH = $LOAD_PATH.dup $LOAD_PATH.map! do |s| = File.realpath(s) rescue File. (s) if != s .tap(&Gem::UNTAINT) if s.instance_variable_defined?(:@gem_prelude_index) .instance_variable_set(:@gem_prelude_index, ) end .freeze if s.frozen? s = end s end Dir.chdir @tempdir ENV['HOME'] = @userhome Gem.instance_variable_set :@user_home, nil Gem.instance_variable_set :@gemdeps, nil Gem.instance_variable_set :@env_requirements_by_name, nil Gem.send :remove_instance_variable, :@ruby_version if Gem.instance_variables.include? :@ruby_version FileUtils.mkdir_p @gemhome FileUtils.mkdir_p @userhome ENV['GEM_PRIVATE_KEY_PASSPHRASE'] = PRIVATE_KEY_PASSPHRASE @default_dir = File.join @tempdir, 'default' @default_spec_dir = File.join @default_dir, "specifications", "default" if Gem.java_platform? @orig_default_gem_home = RbConfig::CONFIG['default_gem_home'] RbConfig::CONFIG['default_gem_home'] = @default_dir else Gem.instance_variable_set(:@default_dir, @default_dir) end FileUtils.mkdir_p @default_spec_dir Gem::Specification.unresolved_deps.clear Gem.use_paths(@gemhome) Gem::Security.reset Gem.loaded_specs.clear Gem.instance_variable_set(:@activated_gem_paths, 0) Gem.clear_default_specs Bundler.reset! Gem.configuration.verbose = true Gem.configuration.update_sources = true Gem::RemoteFetcher.fetcher = Gem::FakeFetcher.new @gem_repo = "http://gems.example.com/" @uri = URI.parse @gem_repo Gem.sources.replace [@gem_repo] Gem.searcher = nil Gem::SpecFetcher.fetcher = nil @orig_arch = RbConfig::CONFIG['arch'] if win_platform? util_set_arch 'i386-mswin32' else util_set_arch 'i686-darwin8.10.1' end @orig_hooks = {} %w[post_install_hooks done_installing_hooks post_uninstall_hooks pre_uninstall_hooks pre_install_hooks pre_reset_hooks post_reset_hooks post_build_hooks].each do |name| @orig_hooks[name] = Gem.send(name).dup end @marshal_version = "#{Marshal::MAJOR_VERSION}.#{Marshal::MINOR_VERSION}" @orig_LOADED_FEATURES = $LOADED_FEATURES.dup end
#spec(name, version, &block)
Constructs a new Specification
.
# File 'lib/rubygems/test_case.rb', line 1328
def spec(name, version, &block) Gem::Specification.new name, v(version), &block end
#spec_fetcher(repository = @gem_repo)
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
# File 'lib/rubygems/test_case.rb', line 1352
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
#teardown
restores the process to its original state and removes the tempdir
# File 'lib/rubygems/test_case.rb', line 425
def teardown $LOAD_PATH.replace @orig_LOAD_PATH if @orig_LOAD_PATH if @orig_LOADED_FEATURES if @orig_LOAD_PATH paths = @orig_LOAD_PATH.map {|path| File.join(File. (path), "/")} ($LOADED_FEATURES - @orig_LOADED_FEATURES).each do |feat| unless paths.any? {|path| feat.start_with?(path)} $LOADED_FEATURES.delete(feat) end end else $LOADED_FEATURES.replace @orig_LOADED_FEATURES end end RbConfig::CONFIG['arch'] = @orig_arch if defined? Gem::RemoteFetcher Gem::RemoteFetcher.fetcher = nil end Dir.chdir @current_dir FileUtils.rm_rf @tempdir ENV.replace(@orig_env) Gem.ruby = @orig_ruby if @orig_ruby if Gem.java_platform? RbConfig::CONFIG['default_gem_home'] = @orig_default_gem_home else Gem.instance_variable_set :@default_dir, nil end Gem::Specification._clear_load_cache Gem::Specification.unresolved_deps.clear Gem::refresh @orig_hooks.each do |name, hooks| Gem.send(name).replace hooks end @back_ui.close end
#uninstall_gem(spec)
Uninstalls the Specification
#spec
# File 'lib/rubygems/test_case.rb', line 596
def uninstall_gem(spec) require 'rubygems/uninstaller' Class.new(Gem::Uninstaller) do def ask_if_ok(spec) true end end.new(spec.name, :executables => true, :user_install => true).uninstall end
#unresolved_names
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 772
def unresolved_names Gem::Specification.unresolved_deps.values.map(&:to_s).sort end
#util_build_gem(spec)
Builds a gem from #spec and places it in File.join @gemhome, 'cache'
. Automatically creates files based on spec.files
# File 'lib/rubygems/test_case.rb', line 694
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
Removes all installed gems from @gemhome.
# File 'lib/rubygems/test_case.rb', line 725
def util_clear_gems FileUtils.rm_rf File.join(@gemhome, "gems") FileUtils.mkdir File.join(@gemhome, "gems") FileUtils.rm_rf File.join(@gemhome, "specifications") FileUtils.mkdir File.join(@gemhome, "specifications") Gem::Specification.reset end
#util_clear_RUBY_VERSION
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 1107
def util_clear_RUBY_VERSION Object.send :remove_const, :RUBY_VERSION Object.send :remove_const, :RUBY_PATCHLEVEL if defined?(RUBY_PATCHLEVEL) Object.send :remove_const, :RUBY_REVISION if defined?(RUBY_REVISION) Object.send :remove_const, :RUBY_DESCRIPTION if defined?(RUBY_DESCRIPTION) Object.send :remove_const, :RUBY_ENGINE Object.send :remove_const, :RUBY_ENGINE_VERSION if defined?(RUBY_ENGINE_VERSION) end
#util_gem(name, version, deps = nil, &block)
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 'lib/rubygems/test_case.rb', line 858
def util_gem(name, version, deps = nil, &block) if deps block = proc do |s| # Since Hash#each is unordered in 1.8, sort # the keys and iterate that way so the tests are # deterministic on all implementations. deps.keys.sort.each do |n| s.add_dependency n, (deps[n] || '>= 0') end end end spec = quick_gem(name, version, &block) util_build_gem spec cache_file = File.join @tempdir, 'gems', "#{spec.original_name}.gem" FileUtils.mkdir_p File.dirname cache_file FileUtils.mv spec.cache_file, cache_file FileUtils.rm spec.spec_file spec.loaded_from = nil [spec, cache_file] end
#util_gzip(data)
Gzips data
.
# File 'lib/rubygems/test_case.rb', line 887
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)
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
# File 'lib/rubygems/test_case.rb', line 915
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. = %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)
[ GitHub ]#util_restore_RUBY_VERSION
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 1092
def util_restore_RUBY_VERSION util_clear_RUBY_VERSION Object.const_set :RUBY_VERSION, @RUBY_VERSION Object.const_set :RUBY_PATCHLEVEL, @RUBY_PATCHLEVEL if defined?(@RUBY_PATCHLEVEL) Object.const_set :RUBY_REVISION, @RUBY_REVISION if defined?(@RUBY_REVISION) Object.const_set :RUBY_DESCRIPTION, @RUBY_DESCRIPTION if defined?(@RUBY_DESCRIPTION) Object.const_set :RUBY_ENGINE, @RUBY_ENGINE Object.const_set :RUBY_ENGINE_VERSION, @RUBY_ENGINE_VERSION if defined?(@RUBY_ENGINE_VERSION) end
#util_set_arch(arch)
Set the platform to arch
#util_set_RUBY_VERSION(version, patchlevel = nil, revision = nil, description = nil, engine = "ruby", engine_version = nil)
[ GitHub ]# File 'lib/rubygems/test_case.rb', line 1070
def util_set_RUBY_VERSION(version, patchlevel = nil, revision = nil, description = nil, engine = "ruby", engine_version = nil) if Gem.instance_variables.include? :@ruby_version Gem.send :remove_instance_variable, :@ruby_version end @RUBY_VERSION = RUBY_VERSION @RUBY_PATCHLEVEL = RUBY_PATCHLEVEL if defined?(RUBY_PATCHLEVEL) @RUBY_REVISION = RUBY_REVISION if defined?(RUBY_REVISION) @RUBY_DESCRIPTION = RUBY_DESCRIPTION if defined?(RUBY_DESCRIPTION) @RUBY_ENGINE = RUBY_ENGINE @RUBY_ENGINE_VERSION = RUBY_ENGINE_VERSION if defined?(RUBY_ENGINE_VERSION) util_clear_RUBY_VERSION Object.const_set :RUBY_VERSION, version Object.const_set :RUBY_PATCHLEVEL, patchlevel if patchlevel Object.const_set :RUBY_REVISION, revision if revision Object.const_set :RUBY_DESCRIPTION, description if description Object.const_set :RUBY_ENGINE, engine Object.const_set :RUBY_ENGINE_VERSION, engine_version if engine_version end
#util_setup_spec_fetcher(*specs)
Sets up SpecFetcher
to return information from the gems in specs
.
# File 'lib/rubygems/test_case.rb', line 1006
def util_setup_spec_fetcher(*specs) all_specs = Gem::Specification.to_a + specs Gem::Specification._resort! all_specs spec_fetcher = Gem::SpecFetcher.fetcher prerelease, all = all_specs.partition { |spec| spec.version.prerelease? } latest = Gem::Specification._latest_specs all_specs spec_fetcher.specs[@uri] = [] all.each do |spec| spec_fetcher.specs[@uri] << spec.name_tuple end spec_fetcher.latest_specs[@uri] = [] latest.each do |spec| spec_fetcher.latest_specs[@uri] << spec.name_tuple end spec_fetcher.prerelease_specs[@uri] = [] prerelease.each do |spec| spec_fetcher.prerelease_specs[@uri] << spec.name_tuple end # HACK for test_download_to_cache unless Gem::RemoteFetcher === @fetcher v = Gem.marshal_version specs = all.map { |spec| spec.name_tuple } s_zip = util_gzip Marshal.dump Gem::NameTuple.to_basic specs latest_specs = latest.map do |spec| spec.name_tuple end l_zip = util_gzip Marshal.dump Gem::NameTuple.to_basic latest_specs prerelease_specs = prerelease.map { |spec| spec.name_tuple } p_zip = util_gzip Marshal.dump Gem::NameTuple.to_basic prerelease_specs @fetcher.data["#{@gem_repo}specs.#{v}.gz"] = s_zip @fetcher.data["#{@gem_repo}latest_specs.#{v}.gz"] = l_zip @fetcher.data["#{@gem_repo}prerelease_specs.#{v}.gz"] = p_zip v = Gem.marshal_version all_specs.each do |spec| path = "#{@gem_repo}quick/Marshal.#{v}/#{spec.original_name}.gemspec.rz" data = Marshal.dump spec data_deflate = Zlib::Deflate.deflate data @fetcher.data[path] = data_deflate end end nil # force errors end
#util_spec(name, version = 2, deps = nil, *files)
Creates a spec with name
, version
. deps
can specify the dependency or a block
can be given for full customization of the specification.
# File 'lib/rubygems/test_case.rb', line 810
def util_spec(name, version = 2, deps = nil, *files) # :yields: specification raise "deps or block, not both" if deps and block_given? spec = Gem::Specification.new do |s| s.platform = Gem::Platform::RUBY s.name = name s.version = version s. = '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" s.files.push(*files) unless files.empty? yield s if block_given? end if deps # Since Hash#each is unordered in 1.8, sort the keys and iterate that # way so the tests are deterministic on all implementations. deps.keys.sort.each do |n| spec.add_dependency n, (deps[n] || '>= 0') end end unless files.empty? write_file spec.spec_file do |io| io.write spec.to_ruby_for_cache end util_build_gem spec cache_file = File.join @tempdir, 'gems', "#{spec.full_name}.gem" FileUtils.mkdir_p File.dirname cache_file FileUtils.mv spec.cache_file, cache_file FileUtils.rm spec.spec_file end return spec end
#util_zip(data)
Deflates data
# File 'lib/rubygems/test_case.rb', line 1066
def util_zip(data) Zlib::Deflate.deflate data end
#v(string)
Construct a new Version
.
#vendor_gem(name = 'a', version = 1)
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
# File 'lib/rubygems/test_case.rb', line 1371
def vendor_gem(name = 'a', version = 1) directory = File.join 'vendor', name FileUtils.mkdir_p directory save_gemspec name, version, directory end
#vendordir(value)
Sets the vendordir entry in RbConfig::CONFIG
to value
and restores the original value when the block ends
# File 'lib/rubygems/test_case.rb', line 151
def vendordir(value) vendordir = RbConfig::CONFIG['vendordir'] if value RbConfig::CONFIG['vendordir'] = value else RbConfig::CONFIG.delete 'vendordir' end yield ensure if vendordir RbConfig::CONFIG['vendordir'] = vendordir else RbConfig::CONFIG.delete 'vendordir' end end
#wait_for_child_process_to_exit
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).
# File 'lib/rubygems/test_case.rb', line 1188
def wait_for_child_process_to_exit Process.wait if Process.respond_to?(:fork) rescue Errno::ECHILD end
#with_clean_path_to_ruby
[ GitHub ]#write_file(path)
Writes a binary file to Gem.path which is relative to @gemhome