# frozen_string_literal: true require 'rubygems/test_case' require 'rubygems' class TestGemRequire < Gem::TestCase class Latch def initialize(count = 1) @count = count @lock = Monitor.new @cv = @lock.new_cond end def release @lock.synchronize do @count -= 1 if @count > 0 @cv.broadcast if @count.zero? end end def await @lock.synchronize do @cv.wait_while { @count > 0 } end end end def setup super @old_loaded_features = $LOADED_FEATURES.dup assert_raises LoadError do require 'test_gem_require_a' end $LOADED_FEATURES.replace @old_loaded_features end def assert_require(path) assert require(path), "'#{path}' was already required" end def refute_require(path) refute require(path), "'#{path}' was not yet required" end # Providing -I on the commandline should always beat gems def test_dash_i_beats_gems a1 = util_spec "a", "1", {"b" => "= 1"}, "lib/test_gem_require_a.rb" b1 = util_spec "b", "1", {"c" => "> 0"}, "lib/b/c.rb" c1 = util_spec "c", "1", nil, "lib/c/c.rb" c2 = util_spec "c", "2", nil, "lib/c/c.rb" install_specs c1, c2, b1, a1 dir = Dir.mktmpdir("test_require", @tempdir) dash_i_arg = File.join dir, 'lib' c_rb = File.join dash_i_arg, 'b', 'c.rb' FileUtils.mkdir_p File.dirname c_rb File.open(c_rb, 'w') { |f| f.write "class Object; HELLO = 'world' end" } lp = $LOAD_PATH.dup # Pretend to provide a commandline argument that overrides a file in gem b $LOAD_PATH.unshift dash_i_arg assert_require 'test_gem_require_a' assert_require 'b/c' # this should be required from -I assert_equal "world", ::Object::HELLO assert_equal %w(a-1 b-1), loaded_spec_names ensure $LOAD_PATH.replace lp Object.send :remove_const, :HELLO if Object.const_defined? :HELLO end def create_sync_thread Thread.new do begin yield ensure FILE_ENTERED_LATCH.release FILE_EXIT_LATCH.await end end end # Providing -I on the commandline should always beat gems def test_dash_i_beats_default_gems a1 = new_default_spec "a", "1", {"b" => "= 1"}, "test_gem_require_a.rb" b1 = new_default_spec "b", "1", {"c" => "> 0"}, "b/c.rb" c1 = new_default_spec "c", "1", nil, "c/c.rb" c2 = new_default_spec "c", "2", nil, "c/c.rb" install_default_specs c1, c2, b1, a1 dir = Dir.mktmpdir("test_require", @tempdir) dash_i_arg = File.join dir, 'lib' c_rb = File.join dash_i_arg, 'c', 'c.rb' FileUtils.mkdir_p File.dirname c_rb File.open(c_rb, 'w') { |f| f.write "class Object; HELLO = 'world' end" } assert_require 'test_gem_require_a' lp = $LOAD_PATH.dup # Pretend to provide a commandline argument that overrides a file in gem b $LOAD_PATH.unshift dash_i_arg assert_require 'b/c' assert_require 'c/c' # this should be required from -I assert_equal "world", ::Object::HELLO assert_equal %w(a-1 b-1), loaded_spec_names ensure $LOAD_PATH.replace lp Object.send :remove_const, :HELLO if Object.const_defined? :HELLO end def test_concurrent_require Object.const_set :FILE_ENTERED_LATCH, Latch.new(2) Object.const_set :FILE_EXIT_LATCH, Latch.new(1) a1 = util_spec "a#{$$}", "1", nil, "lib/a#{$$}.rb" b1 = util_spec "b#{$$}", "1", nil, "lib/b#{$$}.rb" install_specs a1, b1 t1 = create_sync_thread{ assert_require "a#{$$}" } t2 = create_sync_thread{ assert_require "b#{$$}" } # wait until both files are waiting on the exit latch FILE_ENTERED_LATCH.await # now let them finish FILE_EXIT_LATCH.release assert t1.join, "thread 1 should exit" assert t2.join, "thread 2 should exit" ensure Object.send :remove_const, :FILE_ENTERED_LATCH if Object.const_defined? :FILE_ENTERED_LATCH Object.send :remove_const, :FILE_EXIT_LATCH if Object.const_defined? :FILE_EXIT_LATCH end def test_require_is_not_lazy_with_exact_req a1 = util_spec "a", "1", {"b" => "= 1"}, "lib/test_gem_require_a.rb" b1 = util_spec "b", "1", nil, "lib/b/c.rb" b2 = util_spec "b", "2", nil, "lib/b/c.rb" install_specs b1, b2, a1 assert_require 'test_gem_require_a' assert_equal %w(a-1 b-1), loaded_spec_names assert_equal unresolved_names, [] assert_require "b/c" assert_equal %w(a-1 b-1), loaded_spec_names end def test_require_is_lazy_with_inexact_req a1 = util_spec "a", "1", {"b" => ">= 1"}, "lib/test_gem_require_a.rb" b1 = util_spec "b", "1", nil, "lib/b/c.rb" b2 = util_spec "b", "2", nil, "lib/b/c.rb" install_specs b1, b2, a1 assert_require 'test_gem_require_a' assert_equal %w(a-1), loaded_spec_names assert_equal unresolved_names, ["b (>= 1)"] assert_require "b/c" assert_equal %w(a-1 b-2), loaded_spec_names end def test_require_is_not_lazy_with_one_possible a1 = util_spec "a", "1", {"b" => ">= 1"}, "lib/test_gem_require_a.rb" b1 = util_spec "b", "1", nil, "lib/b/c.rb" install_specs b1, a1 assert_require 'test_gem_require_a' assert_equal %w(a-1 b-1), loaded_spec_names assert_equal unresolved_names, [] assert_require "b/c" assert_equal %w(a-1 b-1), loaded_spec_names end def test_require_can_use_a_pathname_object a1 = util_spec "a", "1", nil, "lib/test_gem_require_a.rb" install_specs a1 assert_require Pathname.new 'test_gem_require_a' assert_equal %w(a-1), loaded_spec_names assert_equal unresolved_names, [] end def test_activate_via_require_respects_loaded_files skip "Not sure what's going on. If another spec creates a 'a' gem before this test, somehow require will load the benchmark in b, and ignore that the stdlib one is already in $LOADED_FEATURES?. Reproducible by running the spaceship_specific_file test before this one" if java_platform? lp = $LOAD_PATH.dup lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "../../lib")) if File.exist?(lib_dir) $LOAD_PATH.delete lib_dir $LOAD_PATH.push lib_dir end a1 = util_spec "a", "1", {"b" => ">= 1"}, "lib/test_gem_require_a.rb" b1 = util_spec "b", "1", nil, "lib/benchmark.rb" b2 = util_spec "b", "2", nil, "lib/benchmark.rb" install_specs b1, b2, a1 assert_require 'test_gem_require_a' assert_equal unresolved_names, ["b (>= 1)"] refute require('benchmark'), "benchmark should have already been loaded" # We detected that we should activate b-2, so we did so, but # then original_require decided "I've already got benchmark.rb" loaded. # This case is fine because our lazy loading is provided exactly # the same behavior as eager loading would have. assert_equal %w(a-1 b-2), loaded_spec_names ensure $LOAD_PATH.replace lp unless java_platform? end def test_already_activated_direct_conflict a1 = util_spec "a", "1", { "b" => "> 0" } b1 = util_spec "b", "1", { "c" => ">= 1" }, "lib/ib.rb" b2 = util_spec "b", "2", { "c" => ">= 2" }, "lib/ib.rb" c1 = util_spec "c", "1", nil, "lib/d.rb" c2 = util_spec("c", "2", nil, "lib/d.rb") install_specs c1, c2, b1, b2, a1 a1.activate c1.activate assert_equal %w(a-1 c-1), loaded_spec_names assert_equal ["b (> 0)"], unresolved_names assert require("ib") assert_equal %w(a-1 b-1 c-1), loaded_spec_names assert_equal [], unresolved_names end def test_multiple_gems_with_the_same_path a1 = util_spec "a", "1", { "b" => "> 0", "x" => "> 0" } b1 = util_spec "b", "1", { "c" => ">= 1" }, "lib/ib.rb" b2 = util_spec "b", "2", { "c" => ">= 2" }, "lib/ib.rb" x1 = util_spec "x", "1", nil, "lib/ib.rb" x2 = util_spec "x", "2", nil, "lib/ib.rb" c1 = util_spec "c", "1", nil, "lib/d.rb" c2 = util_spec("c", "2", nil, "lib/d.rb") install_specs c1, c2, x1, x2, b1, b2, a1 a1.activate c1.activate assert_equal %w(a-1 c-1), loaded_spec_names assert_equal ["b (> 0)", "x (> 0)"], unresolved_names e = assert_raises(Gem::LoadError) do require("ib") end assert_equal "ib found in multiple gems: b, x", e.message end def test_unable_to_find_good_unresolved_version a1 = util_spec "a", "1", { "b" => "> 0" } b1 = util_spec "b", "1", { "c" => ">= 2" }, "lib/ib.rb" b2 = util_spec "b", "2", { "c" => ">= 3" }, "lib/ib.rb" c1 = util_spec "c", "1", nil, "lib/d.rb" c2 = util_spec "c", "2", nil, "lib/d.rb" c3 = util_spec "c", "3", nil, "lib/d.rb" install_specs c1, c2, c3, b1, b2, a1 a1.activate c1.activate assert_equal %w(a-1 c-1), loaded_spec_names assert_equal ["b (> 0)"], unresolved_names e = assert_raises(Gem::LoadError) do require("ib") end assert_equal "unable to find a version of 'b' to activate", e.message end def test_require_works_after_cleanup a1 = new_default_spec "a", "1.0", nil, "a/b.rb" b1 = new_default_spec "b", "1.0", nil, "b/c.rb" b2 = new_default_spec "b", "2.0", nil, "b/d.rb" install_default_gems a1 install_default_gems b1 install_default_gems b2 # Load default ruby gems fresh as if we've just started a ruby script. Gem::Specification.reset require 'rubygems' Gem::Specification.stubs # Remove an old default gem version directly from disk as if someone ran # gem cleanup. FileUtils.rm_rf(File.join @default_dir, "#{b1.full_name}") FileUtils.rm_rf(File.join @default_spec_dir, "#{b1.full_name}.gemspec") # Require gems that have not been removed. assert_require 'a/b' assert_equal %w(a-1.0), loaded_spec_names assert_require 'b/d' assert_equal %w(a-1.0 b-2.0), loaded_spec_names end def test_require_doesnt_traverse_development_dependencies a = util_spec("a#{$$}", "1", nil, "lib/a#{$$}.rb") z = util_spec("z", "1", "w" => "> 0") w1 = util_spec("w", "1") { |s| s.add_development_dependency "non-existent" } w2 = util_spec("w", "2") { |s| s.add_development_dependency "non-existent" } install_specs a, w1, w2, z assert gem("z") assert_equal %w(z-1), loaded_spec_names assert_equal ["w (> 0)"], unresolved_names assert require("a#{$$}") end def test_default_gem_only default_gem_spec = new_default_spec("default", "2.0.0.0", nil, "default/gem.rb") install_default_specs(default_gem_spec) assert_require "default/gem" assert_equal %w(default-2.0.0.0), loaded_spec_names end def test_default_gem_require_activates_just_once default_gem_spec = new_default_spec("default", "2.0.0.0", nil, "default/gem.rb") install_default_specs(default_gem_spec) assert_require "default/gem" times_called = 0 Kernel.stub(:gem, ->(name, requirement) { times_called += 1 }) do refute_require "default/gem" end assert_equal 0, times_called end def test_realworld_default_gem testing_ruby_repo = !ENV["GEM_COMMAND"].nil? skip "this test can't work under ruby-core setup" if testing_ruby_repo || java_platform? cmd = <<-RUBY $stderr = $stdout require "json" puts Gem.loaded_specs["json"] RUBY output = Gem::Util.popen(Gem.ruby, "-e", cmd).strip refute_empty output end def test_default_gem_and_normal_gem default_gem_spec = new_default_spec("default", "2.0.0.0", nil, "default/gem.rb") install_default_specs(default_gem_spec) normal_gem_spec = util_spec("default", "3.0", nil, "lib/default/gem.rb") install_specs(normal_gem_spec) assert_require "default/gem" assert_equal %w(default-3.0), loaded_spec_names end def test_default_gem_prerelease default_gem_spec = new_default_spec("default", "2.0.0", nil, "default/gem.rb") install_default_specs(default_gem_spec) normal_gem_higher_prerelease_spec = util_spec("default", "3.0.0.rc2", nil, "lib/default/gem.rb") install_default_specs(normal_gem_higher_prerelease_spec) assert_require "default/gem" assert_equal %w(default-3.0.0.rc2), loaded_spec_names end def loaded_spec_names Gem.loaded_specs.values.map(&:full_name).sort end def unresolved_names Gem::Specification.unresolved_deps.values.map(&:to_s).sort end def test_try_activate_error_unlocks_require_monitor silence_warnings do class << ::Gem alias old_try_activate try_activate def try_activate(*); raise 'raised from try_activate'; end end end require 'does_not_exist_for_try_activate_test' rescue RuntimeError => e assert_match(/raised from try_activate/, e.message) assert Kernel::RUBYGEMS_ACTIVATION_MONITOR.try_enter, "require monitor was not unlocked when try_activate raised" ensure silence_warnings do class << ::Gem alias try_activate old_try_activate end end Kernel::RUBYGEMS_ACTIVATION_MONITOR.exit end def test_require_when_gem_defined default_gem_spec = new_default_spec("default", "2.0.0.0", nil, "default/gem.rb") install_default_specs(default_gem_spec) c = Class.new do def self.gem(*args) raise "received #gem with #{args.inspect}" end end assert c.send(:require, "default/gem") assert_equal %w(default-2.0.0.0), loaded_spec_names end def test_require_default_when_gem_defined a = util_spec("a#{$$}", "1", nil, "lib/a#{$$}.rb") install_specs a c = Class.new do def self.gem(*args) raise "received #gem with #{args.inspect}" end end assert c.send(:require, "a#{$$}") assert_equal %W(a#{$$}-1), loaded_spec_names end def test_require_bundler b1 = util_spec('bundler', '1', nil, "lib/bundler/setup.rb") b2a = util_spec('bundler', '2.a', nil, "lib/bundler/setup.rb") install_specs b1, b2a require "rubygems/bundler_version_finder" $:.clear assert_require 'bundler/setup' assert_equal %w[bundler-2.a], loaded_spec_names assert_empty unresolved_names end def test_require_bundler_missing_bundler_version Gem::BundlerVersionFinder.stub(:bundler_version_with_reason, ["55", "reason"]) do b1 = util_spec('bundler', '1.999999999', nil, "lib/bundler/setup.rb") b2a = util_spec('bundler', '2.a', nil, "lib/bundler/setup.rb") install_specs b1, b2a e = assert_raises Gem::MissingSpecVersionError do gem('bundler') end assert_match "Could not find 'bundler' (55) required by reason.", e.message end end def test_require_bundler_with_bundler_version Gem::BundlerVersionFinder.stub(:bundler_version_with_reason, ["1", "reason"]) do b1 = util_spec('bundler', '1.999999999', nil, "lib/bundler/setup.rb") b2 = util_spec('bundler', '2', nil, "lib/bundler/setup.rb") install_specs b1, b2 $:.clear assert_require 'bundler/setup' assert_equal %w[bundler-1.999999999], loaded_spec_names end end # uplevel is 2.5+ only if RUBY_VERSION >= "2.5" ["", "Kernel."].each do |prefix| define_method "test_no_kernel_require_in_#{prefix.tr(".", "_")}warn_with_uplevel" do lib = File.realpath("../../../lib", __FILE__) Dir.mktmpdir("warn_test") do |dir| File.write(dir + "/sub.rb", "#{prefix}warn 'uplevel', 'test', uplevel: 1\n") File.write(dir + "/main.rb", "require 'sub'\n") _, err = capture_subprocess_io do system(@@ruby, "-w", "--disable=gems", "-I", lib, "-C", dir, "-I.", "main.rb") end assert_match(/main\.rb:1: warning: uplevel\ntest\n$/, err) _, err = capture_subprocess_io do system(@@ruby, "-w", "--enable=gems", "-I", lib, "-C", dir, "-I.", "main.rb") end assert_match(/main\.rb:1: warning: uplevel\ntest\n$/, err) end end define_method "test_no_other_behavioral_changes_with_#{prefix.tr(".", "_")}warn" do lib = File.realpath("../../../lib", __FILE__) Dir.mktmpdir("warn_test") do |dir| File.write(dir + "/main.rb", "warn({x:1}, {y:2}, [])\n") _, err = capture_subprocess_io do system(@@ruby, "-w", "-rpp", "--disable=gems", "-I", lib, "-C", dir, "-I.", "main.rb") end assert_equal("{:x=>1}\n{:y=>2}\n", err) _, err = capture_subprocess_io do system(@@ruby, "-w", "-rpp", "--enable=gems", "-I", lib, "-C", dir, "-I.", "main.rb") end assert_equal("{:x=>1}\n{:y=>2}\n", err) end end end end def silence_warnings old_verbose, $VERBOSE = $VERBOSE, false yield ensure $VERBOSE = old_verbose end end