diff options
Diffstat (limited to 'test/rubygems/test_gem_update_suggestion.rb')
| -rw-r--r-- | test/rubygems/test_gem_update_suggestion.rb | 209 |
1 files changed, 209 insertions, 0 deletions
diff --git a/test/rubygems/test_gem_update_suggestion.rb b/test/rubygems/test_gem_update_suggestion.rb new file mode 100644 index 0000000000..8cb8ee57ff --- /dev/null +++ b/test/rubygems/test_gem_update_suggestion.rb @@ -0,0 +1,209 @@ +# frozen_string_literal: true + +require_relative "helper" +require "rubygems/command" +require "rubygems/update_suggestion" + +class TestUpdateSuggestion < Gem::TestCase + def setup + super + + @cmd = Gem::Command.new "dummy", "dummy" + @cmd.extend Gem::UpdateSuggestion + @start_time = 1_000_000 + @minute = 60 * 60 + @week = 7 * 24 * @minute + end + + def with_eligible_environment(**params) + self.class.with_eligible_environment(**params) do + yield + end + end + + def self.with_eligible_environment( + tty: true, + rubygems_version: Gem::Version.new("1.2.3"), + latest_rubygems_version: Gem::Version.new("2.0.0"), + ci: false, + reset_last_update_check: true, + cmd: + ) + original_config = Gem.configuration[:prevent_update_suggestion] + Gem.configuration[:prevent_update_suggestion] = nil + original_env = ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] + ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = nil + original_disable = Gem.disable_system_update_message + Gem.disable_system_update_message = nil + Gem.configuration.last_update_check = 0 if reset_last_update_check + + Gem.ui.stub :tty?, tty do + Gem.stub :rubygems_version, rubygems_version do + Gem.stub :latest_rubygems_version, latest_rubygems_version do + Gem::CIDetector.stub :ci?, ci do + yield + end + end + end + end + ensure + Gem.configuration[:prevent_update_suggestion] = original_config + ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = original_env + Gem.disable_system_update_message = original_disable + end + + def test_update_suggestion + Gem.stub :rubygems_version, Gem::Version.new("1.2.3") do + Gem.stub :latest_rubygems_version, Gem::Version.new("2.0.0") do + assert_equal @cmd.update_suggestion, <<~SUGGESTION + + A new release of RubyGems is available: 1.2.3 → 2.0.0! + Run `gem update --system 2.0.0` to update your installation. + + SUGGESTION + end + end + end + + def test_eligible_for_update + with_eligible_environment(cmd: @cmd) do + Time.stub :now, 123_456_789 do + assert_predicate @cmd, :eligible_for_update? + assert_equal 123_456_789, Gem.configuration.last_update_check + + # test last check is written to config file + assert_include File.read(Gem.configuration.state_file_name), "123456789" + end + end + end + + def test_eligible_for_update_is_not_annoying_when_new_version_is_released + current_version = Gem::Version.new("1.2.0") + latest_version = current_version + + # checking for first time, it is not eligible since new version + # is not released yet and stored + with_eligible_environment(cmd: @cmd, rubygems_version: current_version, latest_rubygems_version: latest_version) do + Time.stub :now, @start_time do + refute_predicate @cmd, :eligible_for_update? + assert_equal @start_time, Gem.configuration.last_update_check + end + end + + # checking next week, it is not eligible since new version + # is not released yet and timestamp is stored + with_eligible_environment( + cmd: @cmd, + rubygems_version: current_version, + latest_rubygems_version: latest_version, + reset_last_update_check: false + ) do + Time.stub :now, @start_time + @week do + refute_predicate @cmd, :eligible_for_update? + assert_equal @start_time + @week, Gem.configuration.last_update_check + end + end + + # pretend new version is released + latest_version = Gem::Version.new("1.3.0") + + # checking later same next week, it is not eligible even new version + # is released and timestamp is not stored + with_eligible_environment( + cmd: @cmd, + rubygems_version: current_version, + latest_rubygems_version: latest_version, + reset_last_update_check: false + ) do + Time.stub :now, @start_time + @week + @minute do + refute_predicate @cmd, :eligible_for_update? + assert_equal @start_time + @week, Gem.configuration.last_update_check + end + end + end + + def test_eligible_for_update_is_not_annoying_when_not_upgraded + with_eligible_environment(cmd: @cmd) do + # checking for first time, it is eligible and stored + Time.stub :now, @start_time do + assert_predicate @cmd, :eligible_for_update? + assert_equal @start_time, Gem.configuration.last_update_check + end + + # checking minute later is not eligible and not stored + Time.stub :now, @start_time + @minute do + refute_predicate @cmd, :eligible_for_update? + assert_equal @start_time, Gem.configuration.last_update_check + end + + # checking week later is eligible again and stored + Time.stub :now, @start_time + @week do + assert_predicate @cmd, :eligible_for_update? + assert_equal @start_time + @week, Gem.configuration.last_update_check + end + end + end + + def test_eligible_for_update_prevent_config + with_eligible_environment(cmd: @cmd) do + original_config = Gem.configuration[:prevent_update_suggestion] + Gem.configuration[:prevent_update_suggestion] = true + refute_predicate @cmd, :eligible_for_update? + ensure + Gem.configuration[:prevent_update_suggestion] = original_config + end + end + + def test_eligible_for_update_prevent_env + with_eligible_environment(cmd: @cmd) do + original_env = ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] + ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = "yes" + refute_predicate @cmd, :eligible_for_update? + ensure + ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = original_env + end + end + + def test_eligible_for_update_non_tty + with_eligible_environment(tty: false, cmd: @cmd) do + refute_predicate @cmd, :eligible_for_update? + end + end + + def test_eligible_for_update_for_prerelease + with_eligible_environment(rubygems_version: Gem::Version.new("1.0.0-rc1"), cmd: @cmd) do + refute_predicate @cmd, :eligible_for_update? + end + end + + def test_eligible_for_update_disabled_update + with_eligible_environment(cmd: @cmd) do + original_disable = Gem.disable_system_update_message + Gem.disable_system_update_message = "disabled" + refute_predicate @cmd, :eligible_for_update? + ensure + Gem.disable_system_update_message = original_disable + end + end + + def test_eligible_for_update_on_ci + with_eligible_environment(ci: true, cmd: @cmd) do + refute_predicate @cmd, :eligible_for_update? + end + end + + def test_eligible_for_update_unwrittable_config + with_eligible_environment(cmd: @cmd) do + Gem.configuration.stub :state_file_writable?, false do + refute_predicate @cmd, :eligible_for_update? + end + end + end + + def test_eligible_for_update_notification_delay + with_eligible_environment(cmd: @cmd) do + Gem.configuration.last_update_check = Time.now.to_i + refute_predicate @cmd, :eligible_for_update? + end + end +end |