rubygems-update 2.6.0 → 3.4.22

data/test/rubygems/test_gem_ext_cargo_builder.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+require "rubygems/ext"
+require "open3"
+
+class TestGemExtCargoBuilder < Gem::TestCase
+  def setup
+    super
+
+    @rust_envs = {
+      "CARGO_HOME" => ENV.fetch("CARGO_HOME", File.join(@orig_env["HOME"], ".cargo")),
+      "RUSTUP_HOME" => ENV.fetch("RUSTUP_HOME", File.join(@orig_env["HOME"], ".rustup")),
+    }
+  end
+
+  def setup_rust_gem(name)
+    @ext = File.join(@tempdir, "ext")
+    @dest_path = File.join(@tempdir, "prefix")
+    @fixture_dir = Pathname.new(File.expand_path("test_gem_ext_cargo_builder/#{name}/", __dir__))
+
+    FileUtils.mkdir_p @dest_path
+    FileUtils.cp_r(@fixture_dir.to_s, @ext)
+  end
+
+  def test_build_cdylib
+    skip_unsupported_platforms!
+    setup_rust_gem "rust_ruby_example"
+
+    output = []
+
+    Dir.chdir @ext do
+      ENV.update(@rust_envs)
+      builder = Gem::Ext::CargoBuilder.new
+      builder.build "Cargo.toml", @dest_path, output
+    end
+
+    output = output.join "\n"
+    bundle = File.join(@dest_path, "rust_ruby_example.#{RbConfig::CONFIG["DLEXT"]}")
+
+    assert_match(/Finished/, output)
+    assert_match(/release/, output)
+    assert_ffi_handle bundle, "Init_rust_ruby_example"
+  rescue Exception => e
+    pp output if output
+
+    raise(e)
+  end
+
+  def test_rubygems_cfg_passed_to_rustc
+    skip_unsupported_platforms!
+    setup_rust_gem "rust_ruby_example"
+    version_slug = Gem::VERSION.tr(".", "_")
+    output = []
+
+    replace_in_rust_file("src/lib.rs", "rubygems_x_x_x", "rubygems_#{version_slug}")
+
+    Dir.chdir @ext do
+      ENV.update(@rust_envs)
+      builder = Gem::Ext::CargoBuilder.new
+      builder.build "Cargo.toml", @dest_path, output
+    end
+
+    output = output.join "\n"
+    bundle = File.join(@dest_path, "rust_ruby_example.#{RbConfig::CONFIG["DLEXT"]}")
+
+    assert_ffi_handle bundle, "hello_from_rubygems"
+    assert_ffi_handle bundle, "hello_from_rubygems_version"
+    refute_ffi_handle bundle, "should_never_exist"
+  rescue Exception => e
+    pp output if output
+
+    raise(e)
+  end
+
+  def test_build_fail
+    skip_unsupported_platforms!
+    setup_rust_gem "rust_ruby_example"
+
+    FileUtils.rm(File.join(@ext, "src/lib.rs"))
+
+    error = assert_raise(Gem::InstallError) do
+      Dir.chdir @ext do
+        ENV.update(@rust_envs)
+        builder = Gem::Ext::CargoBuilder.new
+        builder.build "Cargo.toml", @dest_path, []
+      end
+    end
+
+    assert_match(/cargo\s.*\sfailed/, error.message)
+  end
+
+  def test_full_integration
+    skip_unsupported_platforms!
+    setup_rust_gem "rust_ruby_example"
+
+    require "open3"
+
+    Dir.chdir @ext do
+      require "tmpdir"
+
+      env_for_subprocess = @rust_envs.merge("GEM_HOME" => Gem.paths.home)
+      gem = [env_for_subprocess, *ruby_with_rubygems_in_load_path, File.expand_path("../../exe/gem", __dir__)]
+
+      Dir.mktmpdir("rust_ruby_example") do |dir|
+        built_gem = File.expand_path(File.join(dir, "rust_ruby_example.gem"))
+        Open3.capture2e(*gem, "build", "rust_ruby_example.gemspec", "--output", built_gem)
+        Open3.capture2e(*gem, "install", "--verbose", "--local", built_gem, *ARGV)
+
+        stdout_and_stderr_str, status = Open3.capture2e(env_for_subprocess, *ruby_with_rubygems_in_load_path, "-rrust_ruby_example", "-e", "puts 'Result: ' + RustRubyExample.reverse('hello world')")
+        assert status.success?, stdout_and_stderr_str
+        assert_match "Result: #{"hello world".reverse}", stdout_and_stderr_str
+      end
+    end
+  end
+
+  def test_custom_name
+    skip_unsupported_platforms!
+    setup_rust_gem "custom_name"
+
+    Dir.chdir @ext do
+      require "tmpdir"
+
+      env_for_subprocess = @rust_envs.merge("GEM_HOME" => Gem.paths.home)
+      gem = [env_for_subprocess, *ruby_with_rubygems_in_load_path, File.expand_path("../../exe/gem", __dir__)]
+
+      Dir.mktmpdir("custom_name") do |dir|
+        built_gem = File.expand_path(File.join(dir, "custom_name.gem"))
+        Open3.capture2e(*gem, "build", "custom_name.gemspec", "--output", built_gem)
+        Open3.capture2e(*gem, "install", "--verbose", "--local", built_gem, *ARGV)
+      end
+
+      stdout_and_stderr_str, status = Open3.capture2e(env_for_subprocess, *ruby_with_rubygems_in_load_path, "-rcustom_name", "-e", "puts 'Result: ' + CustomName.say_hello")
+
+      assert status.success?, stdout_and_stderr_str
+      assert_match "Result: Hello world!", stdout_and_stderr_str
+    end
+  end
+
+  private
+
+  def skip_unsupported_platforms!
+    pend "jruby not supported" if java_platform?
+    pend "truffleruby not supported (yet)" if RUBY_ENGINE == "truffleruby"
+    system(@rust_envs, "cargo", "-V", out: IO::NULL, err: [:child, :out])
+    pend "cargo not present" unless $?.success?
+    pend "ruby.h is not provided by ruby repo" if ruby_repo?
+    pend "rust toolchain of mingw is broken" if mingw_windows?
+  end
+
+  def assert_ffi_handle(bundle, name)
+    require "fiddle"
+    dylib_handle = Fiddle.dlopen bundle
+    assert_nothing_raised { dylib_handle[name] }
+  end
+
+  def refute_ffi_handle(bundle, name)
+    require "fiddle"
+    dylib_handle = Fiddle.dlopen bundle
+    assert_raise { dylib_handle[name] }
+  end
+
+  def replace_in_rust_file(name, from, to)
+    content = @fixture_dir.join(name).read.gsub(from, to)
+    File.write(File.join(@ext, name), content)
+  end
+end

data/test/rubygems/test_gem_ext_cargo_builder_link_flag_converter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+require "rubygems/ext"
+require "rubygems/ext/cargo_builder/link_flag_converter"
+
+class TestGemExtCargoBuilderLinkFlagConverter < Gem::TestCase
+  CASES = {
+    test_search_path_basic: ["-L/usr/local/lib", ["-L", "native=/usr/local/lib"]],
+    test_search_path_space: ["-L /usr/local/lib", ["-L", "native=/usr/local/lib"]],
+    test_search_path_space_in_path: ["-L/usr/local/my\ lib", ["-L", "native=/usr/local/my\ lib"]],
+    test_simple_lib: ["-lfoo", ["-l", "foo"]],
+    test_lib_with_nonascii: ["-lws2_32", ["-l", "ws2_32"]],
+    test_simple_lib_space: ["-l foo", ["-l", "foo"]],
+    test_verbose_lib_space: ["--library=foo", ["-l", "foo"]],
+    test_libstatic_with_colon: ["-l:libssp.a", ["-C", "link-args=-l:libssp.a"]],
+    test_libstatic_with_colon_space: ["-l :libssp.a", ["-C", "link-args=-l :libssp.a"]],
+    test_unconventional_lib_with_colon: ["-l:ssp.a", ["-C", "link-args=-l:ssp.a"]],
+    test_dylib_with_colon_space: ["-l :libssp.dylib", ["-C", "link-args=-l :libssp.dylib"]],
+    test_so_with_colon_space: ["-l :libssp.so", ["-C", "link-args=-l :libssp.so"]],
+    test_dll_with_colon_space: ["-l :libssp.dll", ["-C", "link-args=-l :libssp.dll"]],
+    test_framework: ["-F/some/path", ["-l", "framework=/some/path"]],
+    test_framework_space: ["-F /some/path", ["-l", "framework=/some/path"]],
+    test_non_lib_dash_l: ["test_rubygems_20220413-976-lemgf9/prefix", ["-C", "link-args=test_rubygems_20220413-976-lemgf9/prefix"]],
+  }.freeze
+
+  CASES.each do |test_name, (arg, expected)|
+    raise "duplicate test name" if instance_methods.include?(test_name)
+
+    define_method(test_name) do
+      assert_equal(expected, Gem::Ext::CargoBuilder::LinkFlagConverter.convert(arg))
+    end
+  end
+end

data/test/rubygems/test_gem_ext_cargo_builder_unit.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "helper"
+require "rubygems/ext"
+
+class TestGemExtCargoBuilderUnit < Gem::TestCase
+  def test_cargo_command_passes_args
+    skip_unsupported_platforms!
+    builder = Gem::Ext::CargoBuilder.new
+    command = builder.cargo_command(Dir.pwd, @tempdir, ["--all-features"])
+
+    assert_includes command, "--all-features"
+  end
+
+  def test_cargo_command_locks_in_release_profile
+    skip_unsupported_platforms!
+    builder = Gem::Ext::CargoBuilder.new
+    builder.profile = :release
+    command = builder.cargo_command(Dir.pwd, @tempdir)
+
+    assert_includes command, "--locked"
+  end
+
+  def test_cargo_command_passes_respects_cargo_env_var
+    skip_unsupported_platforms!
+    old_cargo = ENV["CARGO"]
+    ENV["CARGO"] = "mycargo"
+    builder = Gem::Ext::CargoBuilder.new
+    command = builder.cargo_command(Dir.pwd, @tempdir)
+
+    assert_includes command, "mycargo"
+  ensure
+    ENV["CARGO"] = old_cargo
+  end
+
+  def test_build_env_includes_rbconfig
+    skip_unsupported_platforms!
+    builder = Gem::Ext::CargoBuilder.new
+    env = builder.build_env
+
+    assert_equal env.fetch("RBCONFIG_RUBY_SO_NAME"), RbConfig::CONFIG["RUBY_SO_NAME"]
+  end
+
+  def test_cargo_command_passes_respects_cargo_build_target
+    skip_unsupported_platforms!
+    old_cargo = ENV["CARGO_BUILD_TARGET"]
+    ENV["CARGO_BUILD_TARGET"] = "x86_64-unknown-linux-gnu"
+    builder = Gem::Ext::CargoBuilder.new
+    command = builder.cargo_command(Dir.pwd, @tempdir, ["--locked"])
+
+    assert_includes command, "--target"
+    assert_includes command, "x86_64-unknown-linux-gnu"
+  ensure
+    ENV["CARGO_BUILD_TARGET"] = old_cargo
+  end
+
+  def skip_unsupported_platforms!
+    pend "jruby not supported" if java_platform?
+  end
+end

data/test/rubygems/test_gem_ext_cmake_builder.rb

@@ -1,87 +1,84 @@
 # frozen_string_literal: true
-require 'rubygems/test_case'
-require 'rubygems/ext'
 
-class TestGemExtCmakeBuilder < Gem::TestCase
+require_relative "helper"
+require "rubygems/ext"
 
+class TestGemExtCmakeBuilder < Gem::TestCase
   def setup
     super
 
     # Details: https://github.com/rubygems/rubygems/issues/1270#issuecomment-177368340
-    skip "CmakeBuilder doesn't work on Windows." if Gem.win_platform?
+    pend "CmakeBuilder doesn't work on Windows." if Gem.win_platform?
 
-    `cmake #{Gem::Ext::Builder.redirector}`
+    require "open3"
 
-    skip 'cmake not present' unless $?.success?
+    begin
+      _, status = Open3.capture2e("cmake")
+      pend "cmake not present" unless status.success?
+    rescue Errno::ENOENT
+      pend "cmake not present"
+    end
 
-    @ext = File.join @tempdir, 'ext'
-    @dest_path = File.join @tempdir, 'prefix'
+    @ext = File.join @tempdir, "ext"
+    @dest_path = File.join @tempdir, "prefix"
 
     FileUtils.mkdir_p @ext
     FileUtils.mkdir_p @dest_path
   end
 
   def test_self_build
-    File.open File.join(@ext, 'CMakeLists.txt'), 'w' do |cmakelists|
-      cmakelists.write <<-eo_cmake
+    File.open File.join(@ext, "CMakeLists.txt"), "w" do |cmakelists|
+      cmakelists.write <<-EO_CMAKE
 cmake_minimum_required(VERSION 2.6)
+project(self_build NONE)
 install (FILES test.txt DESTINATION bin)
-      eo_cmake
+      EO_CMAKE
     end
 
-    FileUtils.touch File.join(@ext, 'test.txt')
+    FileUtils.touch File.join(@ext, "test.txt")
 
     output = []
 
-    Dir.chdir @ext do
-      Gem::Ext::CmakeBuilder.build nil, nil, @dest_path, output
-    end
+    Gem::Ext::CmakeBuilder.build nil, @dest_path, output, [], nil, @ext
 
     output = output.join "\n"
 
-    assert_match \
-      %r%^cmake \. -DCMAKE_INSTALL_PREFIX=#{Regexp.escape @dest_path}%, output
-    assert_match %r%#{Regexp.escape @ext}%, output
-    assert_contains_make_command '', output
-    assert_contains_make_command 'install', output
-    assert_match %r%test\.txt%, output
+    assert_match %r{^cmake \. -DCMAKE_INSTALL_PREFIX\\=#{Regexp.escape @dest_path}}, output
+    assert_match %r{#{Regexp.escape @ext}}, output
+    assert_contains_make_command "", output
+    assert_contains_make_command "install", output
+    assert_match %r{test\.txt}, output
   end
 
   def test_self_build_fail
     output = []
 
-    error = assert_raises Gem::InstallError do
-      Dir.chdir @ext do
-        Gem::Ext::CmakeBuilder.build nil, nil, @dest_path, output
-      end
+    error = assert_raise Gem::InstallError do
+      Gem::Ext::CmakeBuilder.build nil, @dest_path, output, [], nil, @ext
     end
 
     output = output.join "\n"
 
     shell_error_msg = %r{(CMake Error: .*)}
-    sh_prefix_cmake = "cmake . -DCMAKE_INSTALL_PREFIX="
 
-    assert_match 'cmake failed', error.message
+    assert_match "cmake failed", error.message
 
-    assert_match %r%^#{sh_prefix_cmake}#{Regexp.escape @dest_path}%, output
-    assert_match %r%#{shell_error_msg}%, output
+    assert_match %r{^cmake . -DCMAKE_INSTALL_PREFIX\\=#{Regexp.escape @dest_path}}, output
+    assert_match %r{#{shell_error_msg}}, output
   end
 
   def test_self_build_has_makefile
-    File.open File.join(@ext, 'Makefile'), 'w' do |makefile|
+    File.open File.join(@ext, "Makefile"), "w" do |makefile|
       makefile.puts "all:\n\t@echo ok\ninstall:\n\t@echo ok"
     end
 
     output = []
 
-    Dir.chdir @ext do
-      Gem::Ext::CmakeBuilder.build nil, nil, @dest_path, output
-    end
+    Gem::Ext::CmakeBuilder.build nil, @dest_path, output, [], nil, @ext
 
     output = output.join "\n"
 
-    assert_contains_make_command '', output
-    assert_contains_make_command 'install', output
+    assert_contains_make_command "", output
+    assert_contains_make_command "install", output
   end
-
 end

data/test/rubygems/test_gem_ext_configure_builder.rb

@@ -1,87 +1,80 @@
 # frozen_string_literal: true
-require 'rubygems/test_case'
-require 'rubygems/ext'
 
-class TestGemExtConfigureBuilder < Gem::TestCase
+require_relative "helper"
+require "rubygems/ext"
 
+class TestGemExtConfigureBuilder < Gem::TestCase
   def setup
     super
 
     @makefile_body =
       "clean:\n\t@echo ok\nall:\n\t@echo ok\ninstall:\n\t@echo ok"
 
-    @ext = File.join @tempdir, 'ext'
-    @dest_path = File.join @tempdir, 'prefix'
+    @ext = File.join @tempdir, "ext"
+    @dest_path = File.join @tempdir, "prefix"
 
     FileUtils.mkdir_p @ext
     FileUtils.mkdir_p @dest_path
   end
 
   def test_self_build
-    skip("test_self_build skipped on MS Windows (VC++)") if vc_windows?
+    pend("test_self_build skipped on MS Windows (VC++)") if vc_windows?
 
-    File.open File.join(@ext, './configure'), 'w' do |configure|
+    File.open File.join(@ext, "./configure"), "w" do |configure|
       configure.puts "#!/bin/sh\necho \"#{@makefile_body}\" > Makefile"
     end
 
     output = []
 
-    Dir.chdir @ext do
-      Gem::Ext::ConfigureBuilder.build nil, nil, @dest_path, output
-    end
+    Gem::Ext::ConfigureBuilder.build nil, @dest_path, output, [], nil, @ext
 
     assert_match(/^current directory:/, output.shift)
-    assert_equal "sh ./configure --prefix=#{@dest_path}", output.shift
+    assert_equal "sh ./configure --prefix\\=#{@dest_path}", output.shift
     assert_equal "", output.shift
     assert_match(/^current directory:/, output.shift)
-    assert_contains_make_command 'clean', output.shift
+    assert_contains_make_command "clean", output.shift
     assert_match(/^ok$/m, output.shift)
     assert_match(/^current directory:/, output.shift)
-    assert_contains_make_command '', output.shift
+    assert_contains_make_command "", output.shift
     assert_match(/^ok$/m, output.shift)
     assert_match(/^current directory:/, output.shift)
-    assert_contains_make_command 'install', output.shift
+    assert_contains_make_command "install", output.shift
     assert_match(/^ok$/m, output.shift)
   end
 
   def test_self_build_fail
-    skip("test_self_build_fail skipped on MS Windows (VC++)") if vc_windows?
+    pend("test_self_build_fail skipped on MS Windows (VC++)") if vc_windows?
     output = []
 
-    error = assert_raises Gem::InstallError do
-      Dir.chdir @ext do
-        Gem::Ext::ConfigureBuilder.build nil, nil, @dest_path, output
-      end
+    error = assert_raise Gem::InstallError do
+      Gem::Ext::ConfigureBuilder.build nil, @dest_path, output, [], nil, @ext
     end
 
-    shell_error_msg = %r{(\./configure: .*)|((?:Can't|cannot) open \./configure(?:: No such file or directory)?)}
-    sh_prefix_configure = "sh ./configure --prefix="
+    shell_error_msg = %r{(\./configure: .*)|((?:[Cc]an't|cannot) open '?\./configure'?(?:: No such file or directory)?)}
+    sh_prefix_configure = "sh ./configure --prefix\\="
 
-    assert_match 'configure failed', error.message
+    assert_match "configure failed", error.message
 
     assert_match(/^current directory:/, output.shift)
     assert_equal "#{sh_prefix_configure}#{@dest_path}", output.shift
-    assert_match %r(#{shell_error_msg}), output.shift
+    assert_match %r{#{shell_error_msg}}, output.shift
     assert_equal true, output.empty?
   end
 
   def test_self_build_has_makefile
     if vc_windows? && !nmake_found?
-      skip("test_self_build_has_makefile skipped - nmake not found")
+      pend("test_self_build_has_makefile skipped - nmake not found")
     end
 
-    File.open File.join(@ext, 'Makefile'), 'w' do |makefile|
+    File.open File.join(@ext, "Makefile"), "w" do |makefile|
       makefile.puts @makefile_body
     end
 
     output = []
-    Dir.chdir @ext do
-      Gem::Ext::ConfigureBuilder.build nil, nil, @dest_path, output
-    end
+    Gem::Ext::ConfigureBuilder.build nil, @dest_path, output, [], nil, @ext
 
-    assert_contains_make_command 'clean', output[1]
-    assert_contains_make_command '', output[4]
-    assert_contains_make_command 'install', output[7]
+    assert_contains_make_command "clean", output[1]
+    assert_contains_make_command "", output[4]
+    assert_contains_make_command "install", output[7]
   end
-
 end