summaryrefslogtreecommitdiff
path: root/test/rubygems/test_gem_update_suggestion.rb
blob: 520a69ac69015fc774904378e79e6b6463ccbf64 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# 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_eglible_environment(**params)
    self.class.with_eglible_environment(**params) do
      yield
    end
  end

  def self.with_eglible_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
          cmd.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_eglible_for_update
    with_eglible_environment(cmd: @cmd) do
      Time.stub :now, 123456789 do
        assert @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, 123456789

        # test last check is written to config file
        assert File.read(Gem.configuration.state_file_name).match("123456789")
      end
    end
  end

  def test_eglible_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 eglible since new version
    # is not released yet and stored
    with_eglible_environment(cmd: @cmd, rubygems_version: current_version, latest_rubygems_version: latest_version) do
      Time.stub :now, @start_time do
        refute @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, @start_time
      end
    end

    # checking next week, it is not eglible since new version
    # is not released yet and timestamp is stored
    with_eglible_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 @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, @start_time + @week
      end
    end

    # pretend new version is released
    latest_version = Gem::Version.new("1.3.0")

    # checking later same next week, it is not eglible even new version
    # is released and timestamp is not stored
    with_eglible_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 @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, @start_time + @week
      end
    end
  end

  def test_eglible_for_update_is_not_annoying_when_not_upgraded
    with_eglible_environment(cmd: @cmd) do
      # checking for first time, it is eglible and stored
      Time.stub :now, @start_time do
        assert @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, @start_time
      end

      # checking minute later is not eglible and not stored
      Time.stub :now, @start_time + @minute do
        refute @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, @start_time
      end

      # checking week later is eglible again and stored
      Time.stub :now, @start_time + @week do
        assert @cmd.eglible_for_update?
        assert_equal Gem.configuration.last_update_check, @start_time + @week
      end
    end
  end

  def test_eglible_for_update_prevent_config
    with_eglible_environment(cmd: @cmd) do
      begin
        original_config, Gem.configuration[:prevent_update_suggestion] = Gem.configuration[:prevent_update_suggestion], true
        refute @cmd.eglible_for_update?
      ensure
        Gem.configuration[:prevent_update_suggestion] = original_config
      end
    end
  end

  def test_eglible_for_update_prevent_env
    with_eglible_environment(cmd: @cmd) do
      begin
        original_env, ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"], "yes"
        refute @cmd.eglible_for_update?
      ensure
        ENV["RUBYGEMS_PREVENT_UPDATE_SUGGESTION"] = original_env
      end
    end
  end

  def test_eglible_for_update_non_tty
    with_eglible_environment(tty: false, cmd: @cmd) do
      refute @cmd.eglible_for_update?
    end
  end

  def test_eglible_for_update_for_prerelease
    with_eglible_environment(rubygems_version: Gem::Version.new("1.0.0-rc1"), cmd: @cmd) do
      refute @cmd.eglible_for_update?
    end
  end

  def test_eglible_for_update_disabled_update
    with_eglible_environment(cmd: @cmd) do
      begin
        original_disable, Gem.disable_system_update_message = Gem.disable_system_update_message, "disabled"
        refute @cmd.eglible_for_update?
      ensure
        Gem.disable_system_update_message = original_disable
      end
    end
  end

  def test_eglible_for_update_on_ci
    with_eglible_environment(ci: true, cmd: @cmd) do
      refute @cmd.eglible_for_update?
    end
  end

  def test_eglible_for_update_unwrittable_config
    with_eglible_environment(cmd: @cmd) do
      Gem.configuration.stub :state_file_writable?, false do
        refute @cmd.eglible_for_update?
      end
    end
  end

  def test_eglible_for_update_notification_delay
    with_eglible_environment(cmd: @cmd) do
      Gem.configuration.last_update_check = Time.now.to_i
      refute @cmd.eglible_for_update?
    end
  end
end