ruby/test/rubygems/test_gem_commands_setup_command.rb

# frozen_string_literal: true

require_relative "helper"
require "rubygems/commands/setup_command"

class TestGemCommandsSetupCommand < Gem::TestCase
  def setup
    super

    @cmd = Gem::Commands::SetupCommand.new
    @cmd.options[:document] = []

    filelist = %w[
      exe/gem
      lib/rubygems.rb
      lib/rubygems/requirement.rb
      lib/rubygems/ssl_certs/rubygems.org/foo.pem
      bundler/exe/bundle
      bundler/exe/bundler
      bundler/lib/bundler.rb
      bundler/lib/bundler/b.rb
      bundler/bin/bundler/man/bundle-b.1
      bundler/lib/bundler/man/bundle-b.1.ronn
      bundler/lib/bundler/man/gemfile.5
      bundler/lib/bundler/man/gemfile.5.ronn
      bundler/lib/bundler/templates/.circleci/config.yml
    ]

    create_dummy_files(filelist)

    gemspec = util_spec "bundler", "9.9.9" do |s|
      s.bindir = "exe"
      s.executables = ["bundle", "bundler"]
    end

    File.open "bundler/bundler.gemspec", "w" do |io|
      io.puts gemspec.to_ruby
    end

    File.open(File.join(Gem.default_specifications_dir, "bundler-1.15.4.gemspec"), "w") do |io|
      gemspec.version = "1.15.4"
      io.puts gemspec.to_ruby
    end

    spec_fetcher do |fetcher|
      fetcher.download "bundler", "1.15.4"

      fetcher.gem "bundler", bundler_version

      fetcher.gem "bundler-audit", "1.0.0"
    end
  end

  def test_execute_regenerate_binstubs
    gem_bin_path = gem_install "a"
    write_file gem_bin_path do |io|
      io.puts "I changed it!"
    end

    @cmd.execute

    assert_match(/\A#!/, File.read(gem_bin_path))
  end

  def test_execute_no_regenerate_binstubs
    gem_bin_path = gem_install "a"
    write_file gem_bin_path do |io|
      io.puts "I changed it!"
    end

    @cmd.options[:regenerate_binstubs] = false
    @cmd.execute

    assert_equal "I changed it!\n", File.read(gem_bin_path)
  end

  def test_execute_regenerate_plugins
    gem_plugin_path = gem_install_with_plugin "a"
    write_file gem_plugin_path do |io|
      io.puts "I changed it!"
    end

    @cmd.execute

    assert_match(/\Arequire/, File.read(gem_plugin_path))
  end

  def test_execute_no_regenerate_plugins
    gem_plugin_path = gem_install_with_plugin "a"
    write_file gem_plugin_path do |io|
      io.puts "I changed it!"
    end

    @cmd.options[:regenerate_plugins] = false
    @cmd.execute

    assert_equal "I changed it!\n", File.read(gem_plugin_path)
  end

  def test_execute_regenerate_plugins_creates_plugins_dir_if_not_there
    gem_plugin_path = gem_install_with_plugin "a"

    # Simulate gem installed with an older rubygems without a plugins layout
    FileUtils.rm_rf Gem.plugindir

    @cmd.execute

    assert_match(/\Arequire/, File.read(gem_plugin_path))
  end

  def test_execute_informs_about_installed_executables
    use_ui @ui do
      @cmd.execute
    end

    out = @ui.output.split "\n"

    exec_line = out.shift until exec_line == "RubyGems installed the following executables:"
    assert_equal "\t#{default_gem_bin_path}", out.shift
    assert_equal "\t#{default_bundle_bin_path}", out.shift
    assert_equal "\t#{default_bundler_bin_path}", out.shift
  end

  def test_env_shebang_flag
    gem_bin_path = gem_install "a"
    write_file gem_bin_path do |io|
      io.puts "I changed it!"
    end

    @cmd.options[:env_shebang] = true
    @cmd.execute

    ruby_exec = format Gem.default_exec_format, "ruby"

    bin_env = Gem.win_platform? ? "" : %w[/usr/bin/env /bin/env].find {|f| File.executable?(f) } + " "
    assert_match(/\A#!\s*#{bin_env}#{ruby_exec}/, File.read(default_gem_bin_path))
    assert_match(/\A#!\s*#{bin_env}#{ruby_exec}/, File.read(default_bundle_bin_path))
    assert_match(/\A#!\s*#{bin_env}#{ruby_exec}/, File.read(default_bundler_bin_path))
    assert_match(/\A#!\s*#{bin_env}#{ruby_exec}/, File.read(gem_bin_path))
  end

  def test_destdir_flag_does_not_try_to_write_to_the_default_gem_home
    FileUtils.chmod "-w", File.join(@gemhome, "plugins")

    destdir = File.join(@tempdir, "foo")

    @cmd.options[:destdir] = destdir
    @cmd.execute

    bundler_spec.executables.each do |e|
      assert_path_exist prepend_destdir(destdir, File.join(@gemhome, "gems", bundler_spec.full_name, bundler_spec.bindir, e))
    end
  end

  def test_destdir_flag_regenerates_binstubs
    # install to destdir
    destdir = File.join(@tempdir, "foo")
    gem_bin_path = gem_install "destdir-only-gem", install_dir: destdir

    # change binstub manually
    write_file gem_bin_path do |io|
      io.puts "I changed it!"
    end

    @cmd.options[:destdir] = destdir
    @cmd.options[:prefix] = "/"
    @cmd.execute

    assert_match(/\A#!/, File.read(gem_bin_path))
  end

  def test_files_in
    assert_equal %w[rubygems.rb rubygems/requirement.rb rubygems/ssl_certs/rubygems.org/foo.pem],
                 @cmd.files_in("lib").sort
  end

  def test_install_lib
    @cmd.extend FileUtils

    Dir.mktmpdir "lib" do |dir|
      @cmd.install_lib dir

      assert_path_exist File.join(dir, "rubygems.rb")
      assert_path_exist File.join(dir, "rubygems/ssl_certs/rubygems.org/foo.pem")

      assert_path_exist File.join(dir, "bundler.rb")
      assert_path_exist File.join(dir, "bundler/b.rb")

      assert_path_exist File.join(dir, "bundler/templates/.circleci/config.yml")
    end
  end

  def test_install_default_bundler_gem
    @cmd.extend FileUtils

    bin_dir = File.join(@gemhome, "bin")
    @cmd.install_default_bundler_gem bin_dir

    default_spec_path = File.join(Gem.default_specifications_dir, "#{bundler_spec.full_name}.gemspec")
    spec = Gem::Specification.load(default_spec_path)

    spec.executables.each do |e|
      if Gem.win_platform?
        assert_path_exist File.join(bin_dir, "#{e}.bat")
      end

      assert_path_exist File.join bin_dir, e
    end

    # expect to remove other versions of bundler gemspecs on default specification directory.
    assert_path_not_exist previous_bundler_specification_path
    assert_path_exist new_bundler_specification_path

    # expect to not remove bundler-* gemspecs.
    assert_path_exist File.join(Gem.dir, "specifications", "bundler-audit-1.0.0.gemspec")

    # expect to remove normal gem that was same version. because it's promoted default gems.
    assert_path_not_exist File.join(Gem.dir, "specifications", "bundler-#{bundler_version}.gemspec")

    # expect to remove the previous default version
    assert_path_not_exist "#{Gem.dir}/gems/bundler-1.15.4"

    assert_path_exist "#{Gem.dir}/gems/bundler-#{bundler_version}"
    assert_path_exist "#{Gem.dir}/gems/bundler-audit-1.0.0"
  end

  def test_install_default_bundler_gem_with_default_gems_not_installed_at_default_dir
    @cmd.extend FileUtils

    gemhome2 = File.join(@tempdir, "gemhome2")
    Gem.instance_variable_set(:@default_dir, gemhome2)

    FileUtils.mkdir_p gemhome2
    bin_dir = File.join(gemhome2, "bin")

    @cmd.install_default_bundler_gem bin_dir

    # expect to remove other versions of bundler gemspecs on default specification directory.
    assert_path_not_exist previous_bundler_specification_path
    assert_path_exist new_bundler_specification_path
  end

  def test_install_default_bundler_gem_with_force_flag
    @cmd.extend FileUtils

    bin_dir = File.join(@gemhome, "bin")
    bundle_bin = File.join(bin_dir, "bundle")

    write_file bundle_bin do |f|
      f.puts "#!/usr/bin/ruby"
      f.puts ""
      f.puts 'echo "hello"'
    end

    @cmd.options[:force] = true

    @cmd.install_default_bundler_gem bin_dir

    default_spec_path = File.join(Gem.default_specifications_dir, "#{bundler_spec.full_name}.gemspec")
    spec = Gem::Specification.load(default_spec_path)

    spec.executables.each do |e|
      if Gem.win_platform?
        assert_path_exist File.join(bin_dir, "#{e}.bat")
      end

      assert_path_exist File.join bin_dir, e
    end
  end

  def test_install_default_bundler_gem_with_destdir_flag
    @cmd.extend FileUtils

    FileUtils.chmod "-w", @gemhome

    destdir = File.join(@tempdir, "foo")
    bin_dir = File.join(destdir, "bin")

    @cmd.options[:destdir] = destdir

    @cmd.install_default_bundler_gem bin_dir

    # leaves other versions of bundler gemspecs on default specification directory.
    assert_path_exist previous_bundler_specification_path
    assert_path_not_exist new_bundler_specification_path

    # installs the updated bundler gemspec to destdir
    assert_path_not_exist prepend_destdir(destdir, previous_bundler_specification_path)
    assert_path_exist prepend_destdir(destdir, new_bundler_specification_path)

    bundler_spec.executables.each do |e|
      assert_path_exist prepend_destdir(destdir, File.join(@gemhome, "gems", bundler_spec.full_name, bundler_spec.bindir, e))
    end
  ensure
    FileUtils.chmod "+w", @gemhome
  end

  def test_install_default_bundler_gem_with_destdir_and_prefix_flags
    @cmd.extend FileUtils

    destdir = File.join(@tempdir, "foo")
    bin_dir = File.join(destdir, "bin")

    @cmd.options[:destdir] = destdir
    @cmd.options[:prefix] = "/"

    @cmd.install_default_bundler_gem bin_dir

    bundler_spec.executables.each do |e|
      assert_path_exist File.join destdir, "gems", bundler_spec.full_name, bundler_spec.bindir, e
    end
  end

  def test_remove_old_lib_files
    lib                   = RbConfig::CONFIG["sitelibdir"]
    lib_rubygems          = File.join lib, "rubygems"
    lib_bundler           = File.join lib, "bundler"
    lib_rubygems_defaults = File.join lib_rubygems, "defaults"
    lib_bundler_templates = File.join lib_bundler, "templates"

    securerandom_rb = File.join lib, "securerandom.rb"

    engine_defaults_rb = File.join lib_rubygems_defaults, "jruby.rb"
    os_defaults_rb     = File.join lib_rubygems_defaults, "operating_system.rb"

    old_gauntlet_rubygems_rb = File.join lib, "gauntlet_rubygems.rb"

    old_builder_rb     = File.join lib_rubygems, "builder.rb"
    old_format_rb      = File.join lib_rubygems, "format.rb"
    old_bundler_c_rb   = File.join lib_bundler,  "c.rb"
    old_bundler_ci     = File.join lib_bundler_templates, ".lecacy_ci", "config.yml"

    files_that_go   = [old_gauntlet_rubygems_rb, old_builder_rb, old_format_rb, old_bundler_c_rb, old_bundler_ci]
    files_that_stay = [securerandom_rb, engine_defaults_rb, os_defaults_rb]

    create_dummy_files(files_that_go + files_that_stay)

    @cmd.remove_old_lib_files lib

    files_that_go.each {|file| assert_path_not_exist(file) unless file == old_bundler_ci }

    files_that_stay.each {|file| assert_path_exist file }
  end

  def test_remove_old_man_files
    man = File.join RbConfig::CONFIG["mandir"], "man"

    ruby_1             = File.join man, "man1", "ruby.1"
    bundle_b_1         = File.join man, "man1", "bundle-b.1"
    bundle_b_1_ronn    = File.join man, "man1", "bundle-b.1.ronn"
    bundle_b_1_txt     = File.join man, "man1", "bundle-b.1.txt"
    gemfile_5          = File.join man, "man5", "gemfile.5"
    gemfile_5_ronn     = File.join man, "man5", "gemfile.5.ronn"
    gemfile_5_txt      = File.join man, "man5", "gemfile.5.txt"

    files_that_go   = [bundle_b_1, bundle_b_1_txt, bundle_b_1_ronn, gemfile_5, gemfile_5_txt, gemfile_5_ronn]
    files_that_stay = [ruby_1]

    create_dummy_files(files_that_go + files_that_stay)

    @cmd.remove_old_man_files man

    files_that_go.each {|file| assert_path_not_exist file }

    files_that_stay.each {|file| assert_path_exist file }
  end

  def test_show_release_notes
    @default_external = @ui.outs.external_encoding
    @ui.outs.set_encoding Encoding::US_ASCII

    @cmd.options[:previous_version] = Gem::Version.new "2.0.2"

    File.open "CHANGELOG.md", "w" do |io|
      io.puts <<-HISTORY_TXT
# Changelog

## #{Gem::VERSION} / 2013-03-26

### Bug fixes:
  * Fixed release note display for LANG=C when installing rubygems
  * π is tasty

## 2.0.2 / 2013-03-06

### Bug fixes:
  * Other bugs fixed

## 2.0.1 / 2013-03-05

### Bug fixes:
  * Yet more bugs fixed
      HISTORY_TXT
    end

    use_ui @ui do
      @cmd.show_release_notes
    end

    expected = <<-EXPECTED
## #{Gem::VERSION} / 2013-03-26

### Bug fixes:
  * Fixed release note display for LANG=C when installing rubygems
  * π is tasty

    EXPECTED

    output = @ui.output
    output.force_encoding Encoding::UTF_8

    assert_equal expected, output
  ensure
    @ui.outs.set_encoding @default_external if @default_external
  end

  private

  def create_dummy_files(list)
    list.each do |file|
      FileUtils.mkdir_p File.dirname(file)

      File.open file, "w" do |io|
        io.puts "# #{File.basename(file)}"
      end
    end
  end

  def gem_install(name, **options)
    gem = util_spec name do |s|
      s.executables = [name]
      s.files = %W[bin/#{name}]
    end
    write_file File.join @tempdir, "bin", name do |f|
      f.puts "#!/usr/bin/ruby"
    end
    install_gem gem, **options
    File.join options[:install_dir] || @gemhome, "bin", name
  end

  def gem_install_with_plugin(name)
    gem = util_spec name do |s|
      s.files = %W[lib/rubygems_plugin.rb]
    end
    write_file File.join @tempdir, "lib", "rubygems_plugin.rb" do |f|
      f.puts "# do nothing"
    end
    install_gem gem

    File.join Gem.plugindir, "#{name}_plugin.rb"
  end

  def default_gem_bin_path
    File.join RbConfig::CONFIG["bindir"], "gem"
  end

  def default_bundle_bin_path
    File.join RbConfig::CONFIG["bindir"], "bundle"
  end

  def default_bundler_bin_path
    File.join RbConfig::CONFIG["bindir"], "bundler"
  end

  def previous_bundler_specification_path
    File.join(Gem.default_specifications_dir, "bundler-1.15.4.gemspec")
  end

  def new_bundler_specification_path
    File.join(Gem.default_specifications_dir, "bundler-#{bundler_version}.gemspec")
  end

  def bundler_spec
    Gem::Specification.load("bundler/bundler.gemspec")
  end

  def bundler_version
    bundler_spec.version
  end

  def prepend_destdir(destdir, path)
    File.join(destdir, path.gsub(/^[a-zA-Z]:/, ""))
  end
end unless Gem.java_platform?