rubygems-update 3.0.3 → 3.4.7

data/test/rubygems/test_gem_commands_push_command.rb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
-require 'rubygems/test_case'
-require 'rubygems/commands/push_command'
+require_relative "helper"
+require "rubygems/commands/push_command"
 
 class TestGemCommandsPushCommand < Gem::TestCase
-
   def setup
     super
+
+    credential_setup
+
     ENV["RUBYGEMS_HOST"] = nil
     Gem.host = Gem::DEFAULT_HOST
     Gem.configuration.disable_default_gem_server = false
 
-    @gems_dir  = File.join @tempdir, 'gems'
+    @gems_dir  = File.join @tempdir, "gems"
     @cache_dir = File.join @gemhome, "cache"
 
     FileUtils.mkdir @gems_dir
@@ -19,7 +21,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
       "ed244fbf2b1a52e012da8616c512fa47f9aa5250"
 
     @spec, @path = util_gem "freewill", "1.0.0"
-    @host = 'https://rubygems.example'
+    @host = "https://rubygems.example"
     @api_key = Gem.configuration.rubygems_api_key
 
     @fetcher = Gem::FakeFetcher.new
@@ -27,7 +29,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
 
     @cmd = Gem::Commands::PushCommand.new
 
-    class << Gem
+    singleton_gem_class.class_eval do
       alias_method :orig_latest_rubygems_version, :latest_rubygems_version
 
       def latest_rubygems_version
@@ -37,9 +39,11 @@ class TestGemCommandsPushCommand < Gem::TestCase
   end
 
   def teardown
+    credential_teardown
+
     super
 
-    class << Gem
+    singleton_gem_class.class_eval do
       remove_method :latest_rubygems_version
       alias_method :latest_rubygems_version, :orig_latest_rubygems_version
     end
@@ -64,7 +68,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
 
   def test_execute
     @response = "Successfully registered gem: freewill (1.0.0)"
-    @fetcher.data["#{Gem.host}/api/v1/gems"] = [@response, 200, 'OK']
+    @fetcher.data["#{Gem.host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
 
     @cmd.options[:args] = [@path]
 
@@ -77,12 +81,12 @@ class TestGemCommandsPushCommand < Gem::TestCase
   end
 
   def test_execute_host
-    host = 'https://other.example'
+    host = "https://other.example"
 
     @response = "Successfully registered gem: freewill (1.0.0)"
-    @fetcher.data["#{host}/api/v1/gems"] = [@response, 200, 'OK']
+    @fetcher.data["#{host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
     @fetcher.data["#{Gem.host}/api/v1/gems"] =
-      ['fail', 500, 'Internal Server Error']
+      ["fail", 500, "Internal Server Error"]
 
     @cmd.options[:host] = host
     @cmd.options[:args] = [@path]
@@ -97,13 +101,13 @@ class TestGemCommandsPushCommand < Gem::TestCase
 
   def test_execute_allowed_push_host
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata['allowed_push_host'] = "https://privategemserver.example"
+      spec.metadata["allowed_push_host"] = "https://privategemserver.example"
     end
 
     @response = "Successfully registered gem: freewill (1.0.0)"
-    @fetcher.data["#{@spec.metadata['allowed_push_host']}/api/v1/gems"] = [@response, 200, 'OK']
+    @fetcher.data["#{@spec.metadata['allowed_push_host']}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
     @fetcher.data["#{Gem.host}/api/v1/gems"] =
-      ['fail', 500, 'Internal Server Error']
+      ["fail", 500, "Internal Server Error"]
 
     @cmd.options[:args] = [@path]
 
@@ -119,7 +123,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
     Gem.configuration.disable_default_gem_server = true
     response = "You must specify a gem server"
 
-    assert_raises Gem::MockGemUi::TermError do
+    assert_raise Gem::MockGemUi::TermError do
       use_ui @ui do
         @cmd.send_gem(@path)
       end
@@ -132,7 +136,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
     ENV["RUBYGEMS_HOST"] = @host
     Gem.configuration.disable_default_gem_server = true
     @response = "Successfully registered gem: freewill (1.0.0)"
-    @fetcher.data["#{@host}/api/v1/gems"]  = [@response, 200, 'OK']
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
 
     send_battery
   end
@@ -141,18 +145,17 @@ class TestGemCommandsPushCommand < Gem::TestCase
     @host = "http://privategemserver.example"
 
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata['default_gem_server'] = @host
+      spec.metadata["default_gem_server"] = @host
     end
 
     @api_key = "EYKEY"
 
     keys = {
-      :rubygems_api_key => 'KEY',
-      @host => @api_key
+      :rubygems_api_key => "KEY",
+      @host => @api_key,
     }
 
-    FileUtils.mkdir_p File.dirname Gem.configuration.credentials_path
-    File.open Gem.configuration.credentials_path, 'w' do |f|
+    File.open Gem.configuration.credentials_path, "w" do |f|
       f.write keys.to_yaml
     end
     Gem.configuration.load_api_keys
@@ -160,14 +163,14 @@ class TestGemCommandsPushCommand < Gem::TestCase
     FileUtils.rm Gem.configuration.credentials_path
 
     @response = "Successfully registered gem: freebird (1.0.1)"
-    @fetcher.data["#{@host}/api/v1/gems"]  = [@response, 200, 'OK']
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
 
     send_battery
   end
 
   def test_sending_gem
     @response = "Successfully registered gem: freewill (1.0.0)"
-    @fetcher.data["#{@host}/api/v1/gems"]  = [@response, 200, 'OK']
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
 
     send_battery
   end
@@ -176,18 +179,17 @@ class TestGemCommandsPushCommand < Gem::TestCase
     @host = "http://privategemserver.example"
 
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata['allowed_push_host'] = @host
+      spec.metadata["allowed_push_host"] = @host
     end
 
     @api_key = "PRIVKEY"
 
     keys = {
-      :rubygems_api_key => 'KEY',
-      @host => @api_key
+      :rubygems_api_key => "KEY",
+      @host => @api_key,
     }
 
-    FileUtils.mkdir_p File.dirname Gem.configuration.credentials_path
-    File.open Gem.configuration.credentials_path, 'w' do |f|
+    File.open Gem.configuration.credentials_path, "w" do |f|
       f.write keys.to_yaml
     end
     Gem.configuration.load_api_keys
@@ -195,7 +197,22 @@ class TestGemCommandsPushCommand < Gem::TestCase
     FileUtils.rm Gem.configuration.credentials_path
 
     @response = "Successfully registered gem: freebird (1.0.1)"
-    @fetcher.data["#{@host}/api/v1/gems"]  = [@response, 200, 'OK']
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
+    send_battery
+  end
+
+  def test_sending_gem_with_env_var_api_key
+    @host = "http://privategemserver.example"
+
+    @spec, @path = util_gem "freebird", "1.0.1" do |spec|
+      spec.metadata["allowed_push_host"] = @host
+    end
+
+    @api_key = "PRIVKEY"
+    ENV["GEM_HOST_API_KEY"] = "PRIVKEY"
+
+    @response = "Successfully registered gem: freebird (1.0.1)"
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
     send_battery
   end
 
@@ -204,7 +221,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
     @host           = "http://user:password@privategemserver.example"
 
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata['allowed_push_host'] = @sanitized_host
+      spec.metadata["allowed_push_host"] = @sanitized_host
     end
 
     @api_key = "DOESNTMATTER"
@@ -213,8 +230,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
       :rubygems_api_key => @api_key,
     }
 
-    FileUtils.mkdir_p File.dirname Gem.configuration.credentials_path
-    File.open Gem.configuration.credentials_path, 'w' do |f|
+    File.open Gem.configuration.credentials_path, "w" do |f|
       f.write keys.to_yaml
     end
     Gem.configuration.load_api_keys
@@ -222,19 +238,18 @@ class TestGemCommandsPushCommand < Gem::TestCase
     FileUtils.rm Gem.configuration.credentials_path
 
     @response = "Successfully registered gem: freebird (1.0.1)"
-    @fetcher.data["#{@host}/api/v1/gems"]  = [@response, 200, 'OK']
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
     send_battery
   end
 
   def test_sending_gem_to_disallowed_default_host
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata['allowed_push_host'] = "https://privategemserver.example"
+      spec.metadata["allowed_push_host"] = "https://privategemserver.example"
     end
 
+    response = %(ERROR:  "#{@host}" is not allowed by the gemspec, which only allows "https://privategemserver.example")
 
-    response = %{ERROR:  "#{@host}" is not allowed by the gemspec, which only allows "https://privategemserver.example"}
-
-    assert_raises Gem::MockGemUi::TermError do
+    assert_raise Gem::MockGemUi::TermError do
       send_battery
     end
 
@@ -246,18 +261,17 @@ class TestGemCommandsPushCommand < Gem::TestCase
     push_host = "https://privategemserver.example"
 
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata['allowed_push_host'] = push_host
+      spec.metadata["allowed_push_host"] = push_host
     end
 
     @api_key = "PRIVKEY"
 
     keys = {
-      :rubygems_api_key => 'KEY',
-      @host => @api_key
+      :rubygems_api_key => "KEY",
+      @host => @api_key,
     }
 
-    FileUtils.mkdir_p File.dirname Gem.configuration.credentials_path
-    File.open Gem.configuration.credentials_path, 'w' do |f|
+    File.open Gem.configuration.credentials_path, "w" do |f|
       f.write keys.to_yaml
     end
     Gem.configuration.load_api_keys
@@ -266,7 +280,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
 
     response = "ERROR:  \"#{@host}\" is not allowed by the gemspec, which only allows \"#{push_host}\""
 
-    assert_raises Gem::MockGemUi::TermError do
+    assert_raise Gem::MockGemUi::TermError do
       send_battery
     end
 
@@ -277,18 +291,17 @@ class TestGemCommandsPushCommand < Gem::TestCase
     host = "http://privategemserver.example"
 
     @spec, @path = util_gem "freebird", "1.0.1" do |spec|
-      spec.metadata.delete('default_gem_server')
-      spec.metadata['allowed_push_host'] = host
+      spec.metadata.delete("default_gem_server")
+      spec.metadata["allowed_push_host"] = host
     end
 
     api_key = "PRIVKEY"
 
     keys = {
-      host => api_key
+      host => api_key,
     }
 
-    FileUtils.mkdir_p File.dirname Gem.configuration.credentials_path
-    File.open Gem.configuration.credentials_path, 'w' do |f|
+    File.open Gem.configuration.credentials_path, "w" do |f|
       f.write keys.to_yaml
     end
     Gem.configuration.load_api_keys
@@ -296,7 +309,7 @@ class TestGemCommandsPushCommand < Gem::TestCase
     FileUtils.rm Gem.configuration.credentials_path
 
     @response = "Successfully registered gem: freebird (1.0.1)"
-    @fetcher.data["#{host}/api/v1/gems"]  = [@response, 200, 'OK']
+    @fetcher.data["#{host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
 
     # do not set @host
     use_ui(@ui) { @cmd.send_gem(@path) }
@@ -312,19 +325,40 @@ class TestGemCommandsPushCommand < Gem::TestCase
     assert_match @response, @ui.output
   end
 
+  def test_sending_gem_to_host_permanent_redirect
+    @host = "http://rubygems.example"
+    redirected_uri = "https://rubygems.example/api/v1/gems"
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(
+      body: "",
+      code: 308,
+      msg: "Permanent Redirect",
+      headers: { "Location" => redirected_uri }
+    )
+
+    assert_raise Gem::MockGemUi::TermError do
+      use_ui @ui do
+        @cmd.instance_variable_set :@host, @host
+        @cmd.send_gem(@path)
+      end
+    end
+
+    response = "The request has redirected permanently to #{redirected_uri}. Please check your defined push host URL."
+    assert_match response, @ui.output
+  end
+
   def test_raises_error_with_no_arguments
     def @cmd.sign_in(*); end
-    assert_raises Gem::CommandLineError do
+    assert_raise Gem::CommandLineError do
       @cmd.execute
     end
   end
 
   def test_sending_gem_denied
     response = "You don't have permission to push to this gem"
-    @fetcher.data["#{@host}/api/v1/gems"] = [response, 403, 'Forbidden']
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: response, code: 403, msg: "Forbidden")
     @cmd.instance_variable_set :@host, @host
 
-    assert_raises Gem::MockGemUi::TermError do
+    assert_raise Gem::MockGemUi::TermError do
       use_ui @ui do
         @cmd.send_gem(@path)
       end
@@ -335,13 +369,13 @@ class TestGemCommandsPushCommand < Gem::TestCase
 
   def test_sending_gem_key
     @response = "Successfully registered gem: freewill (1.0.0)"
-    @fetcher.data["#{@host}/api/v1/gems"] = [@response, 200, "OK"]
-    File.open Gem.configuration.credentials_path, 'a' do |f|
-      f.write ':other: 701229f217cdf23b1344c7b4b54ca97'
+    @fetcher.data["#{@host}/api/v1/gems"] = HTTPResponseFactory.create(body: @response, code: 200, msg: "OK")
+    File.open Gem.configuration.credentials_path, "a" do |f|
+      f.write ":other: 701229f217cdf23b1344c7b4b54ca97"
     end
     Gem.configuration.load_api_keys
 
-    @cmd.handle_options %w(-k other)
+    @cmd.handle_options %w[-k other]
     @cmd.instance_variable_set :@host, @host
     @cmd.send_gem(@path)
 
@@ -351,39 +385,114 @@ class TestGemCommandsPushCommand < Gem::TestCase
 
   def test_otp_verified_success
     response_fail = "You have enabled multifactor authentication but your request doesn't have the correct OTP code. Please check it and retry."
-    response_success = 'Successfully registered gem: freewill (1.0.0)'
+    response_success = "Successfully registered gem: freewill (1.0.0)"
 
-    @fetcher.data["#{Gem.host}/api/v1/gems"] = proc do
-      @call_count ||= 0
-      (@call_count += 1).odd? ? [response_fail, 401, 'Unauthorized'] : [response_success, 200, 'OK']
-    end
+    @fetcher.data["#{Gem.host}/api/v1/gems"] = [
+      HTTPResponseFactory.create(body: response_fail, code: 401, msg: "Unauthorized"),
+      HTTPResponseFactory.create(body: response_success, code: 200, msg: "OK"),
+    ]
 
     @otp_ui = Gem::MockGemUi.new "111111\n"
     use_ui @otp_ui do
       @cmd.send_gem(@path)
     end
 
-    assert_match 'You have enabled multi-factor authentication. Please enter OTP code.', @otp_ui.output
-    assert_match 'Code: ', @otp_ui.output
+    assert_match "You have enabled multi-factor authentication. Please enter OTP code.", @otp_ui.output
+    assert_match "Code: ", @otp_ui.output
     assert_match response_success, @otp_ui.output
-    assert_equal '111111', @fetcher.last_request['OTP']
+    assert_equal "111111", @fetcher.last_request["OTP"]
   end
 
   def test_otp_verified_failure
     response = "You have enabled multifactor authentication but your request doesn't have the correct OTP code. Please check it and retry."
-    @fetcher.data["#{Gem.host}/api/v1/gems"] = [response, 401, 'Unauthorized']
+    @fetcher.data["#{Gem.host}/api/v1/gems"] = HTTPResponseFactory.create(body: response, code: 401, msg: "Unauthorized")
 
     @otp_ui = Gem::MockGemUi.new "111111\n"
-    assert_raises Gem::MockGemUi::TermError do
+    assert_raise Gem::MockGemUi::TermError do
       use_ui @otp_ui do
         @cmd.send_gem(@path)
       end
     end
 
     assert_match response, @otp_ui.output
-    assert_match 'You have enabled multi-factor authentication. Please enter OTP code.', @otp_ui.output
-    assert_match 'Code: ', @otp_ui.output
-    assert_equal '111111', @fetcher.last_request['OTP']
+    assert_match "You have enabled multi-factor authentication. Please enter OTP code.", @otp_ui.output
+    assert_match "Code: ", @otp_ui.output
+    assert_equal "111111", @fetcher.last_request["OTP"]
   end
 
+  def test_sending_gem_unathorized_api_key_with_mfa_enabled
+    response_mfa_enabled = "You have enabled multifactor authentication but your request doesn't have the correct OTP code. Please check it and retry."
+    response_forbidden = "The API key doesn't have access"
+    response_success   = "Successfully registered gem: freewill (1.0.0)"
+
+    @fetcher.data["#{@host}/api/v1/gems"] = [
+      HTTPResponseFactory.create(body: response_mfa_enabled, code: 401, msg: "Unauthorized"),
+      HTTPResponseFactory.create(body: response_forbidden, code: 403, msg: "Forbidden"),
+      HTTPResponseFactory.create(body: response_success, code: 200, msg: "OK"),
+    ]
+
+    @fetcher.data["#{@host}/api/v1/api_key"] = HTTPResponseFactory.create(body: "", code: 200, msg: "OK")
+    @cmd.instance_variable_set :@host, @host
+    @cmd.instance_variable_set :@scope, :push_rubygem
+
+    @ui = Gem::MockGemUi.new "11111\nsome@mail.com\npass\n"
+    use_ui @ui do
+      @cmd.send_gem(@path)
+    end
+
+    mfa_notice = "You have enabled multi-factor authentication. Please enter OTP code."
+    access_notice = "The existing key doesn't have access of push_rubygem on https://rubygems.example. Please sign in to update access."
+    assert_match mfa_notice, @ui.output
+    assert_match access_notice, @ui.output
+    assert_match "Email:", @ui.output
+    assert_match "Password:", @ui.output
+    assert_match "Added push_rubygem scope to the existing API key", @ui.output
+    assert_match response_success, @ui.output
+    assert_equal "11111", @fetcher.last_request["OTP"]
+  end
+
+  def test_sending_gem_with_no_local_creds
+    Gem.configuration.rubygems_api_key = nil
+
+    response_mfa_enabled = "You have enabled multifactor authentication but your request doesn't have the correct OTP code. Please check it and retry."
+    response_success     = "Successfully registered gem: freewill (1.0.0)"
+    response_profile     = "mfa: disabled\n"
+
+    @fetcher.data["#{@host}/api/v1/gems"] = [
+      HTTPResponseFactory.create(body: response_success, code: 200, msg: "OK"),
+    ]
+
+    @fetcher.data["#{@host}/api/v1/api_key"] = [
+      HTTPResponseFactory.create(body: response_mfa_enabled, code: 401, msg: "Unauthorized"),
+      HTTPResponseFactory.create(body: "", code: 200, msg: "OK"),
+    ]
+
+    @fetcher.data["#{@host}/api/v1/profile/me.yaml"] = [
+      HTTPResponseFactory.create(body: response_profile, code: 200, msg: "OK"),
+    ]
+
+    @cmd.instance_variable_set :@scope, :push_rubygem
+    @cmd.options[:args] = [@path]
+    @cmd.options[:host] = @host
+
+    @ui = Gem::MockGemUi.new "some@mail.com\npass\n11111\n"
+    use_ui @ui do
+      @cmd.execute
+    end
+
+    mfa_notice = "You have enabled multi-factor authentication. Please enter OTP code."
+    assert_match mfa_notice, @ui.output
+    assert_match "Enter your https://rubygems.example credentials.", @ui.output
+    assert_match "Email:", @ui.output
+    assert_match "Password:", @ui.output
+    assert_match "Signed in with API key:", @ui.output
+    assert_match response_success, @ui.output
+    assert_equal "11111", @fetcher.last_request["OTP"]
+  end
+
+  private
+
+  def singleton_gem_class
+    class << Gem; self; end
+  end
 end