path: root/test/rubygems/test_gem_commands_signin_command.rb

# frozen_string_literal: true

require_relative "helper"
require "rubygems/commands/signin_command"
require "rubygems/installer"

class TestGemCommandsSigninCommand < Gem::TestCase
  def setup
    super

    credential_setup

    Gem.configuration.rubygems_api_key = nil
    Gem.configuration.api_keys.clear

    @cmd = Gem::Commands::SigninCommand.new
  end

  def teardown
    credential_teardown

    super
  end

  def test_execute_when_not_already_signed_in
    sign_in_ui = util_capture { @cmd.execute }
    assert_match(/Signed in./, sign_in_ui.output)
  end

  def test_execute_when_not_already_signed_in_and_not_preexisting_credentials_folder
    FileUtils.rm Gem.configuration.credentials_path

    sign_in_ui = util_capture { @cmd.execute }
    assert_match(/Signed in./, sign_in_ui.output)
  end

  def test_execute_when_already_signed_in_with_same_host
    host = "http://some-gemcutter-compatible-host.org"

    util_capture(nil, host) { @cmd.execute }
    old_credentials = load_yaml_file Gem.configuration.credentials_path

    util_capture(nil, host) { @cmd.execute }
    new_credentials = load_yaml_file Gem.configuration.credentials_path

    assert_equal old_credentials[host], new_credentials[host]
  end

  def test_execute_when_already_signed_in_with_different_host
    api_key = "a5fdbb6ba150cbb83aad2bb2fede64cf04045xxxx"

    util_capture(nil, nil, api_key) { @cmd.execute }
    host = "http://some-gemcutter-compatible-host.org"

    util_capture(nil, host, api_key) { @cmd.execute }
    credentials = load_yaml_file Gem.configuration.credentials_path

    assert_equal credentials[:rubygems_api_key], api_key

    assert_nil credentials[host]
  end

  def test_execute_with_host_supplied
    host = "http://some-gemcutter-compatible-host.org"

    sign_in_ui = util_capture(nil, host) { @cmd.execute }
    assert_match(/Enter your #{host} credentials./, sign_in_ui.output)
    assert_match(/Signed in./, sign_in_ui.output)

    api_key     = "a5fdbb6ba150cbb83aad2bb2fede64cf040453903"
    credentials = load_yaml_file Gem.configuration.credentials_path
    assert_equal api_key, credentials[host]
  end

  def test_execute_with_host_permanent_redirect
    host = "http://rubygems.example/"
    ENV["RUBYGEMS_HOST"] = host
    path = "/api/v1/api_key"
    redirected_uri = "http://rubygems.example#{path}"
    fetcher = Gem::FakeFetcher.new
    fetcher.data["#{host}#{path}"] = HTTPResponseFactory.create(
      body: "",
      code: "308",
      msg: "Permanent Redirect",
      headers: { "location" => redirected_uri }
    )
    Gem::RemoteFetcher.fetcher = fetcher
    ui = Gem::MockGemUi.new("you@example.com\nsecret\n\n\n")

    assert_raise Gem::MockGemUi::TermError do
      use_ui ui do
        @cmd.execute
      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_execute_with_valid_creds_set_for_default_host
    util_capture { @cmd.execute }

    api_key     = "a5fdbb6ba150cbb83aad2bb2fede64cf040453903"
    credentials = load_yaml_file Gem.configuration.credentials_path

    assert_equal api_key, credentials[:rubygems_api_key]
  end

  def test_execute_with_key_name_default_scope
    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\n\n"
    util_capture(key_name_ui, nil, api_key, fetcher) { @cmd.execute }

    user = ENV["USER"] || ENV["USERNAME"]

    assert_match "API Key name [#{Socket.gethostname}-#{user}", key_name_ui.output
    assert_match "The default access scope is:", key_name_ui.output
    assert_match "index_rubygems: y", key_name_ui.output
    assert_match "Do you want to customise scopes? [yN]", key_name_ui.output
    assert_equal "name=test-key&index_rubygems=true", fetcher.last_request.body

    credentials = load_yaml_file Gem.configuration.credentials_path
    assert_equal api_key, credentials[:rubygems_api_key]
  end

  def test_execute_with_key_name_and_custom_scope
    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\ny\n\n\ny\n\n\n\n\n\n\n"
    util_capture(key_name_ui, nil, api_key, fetcher) { @cmd.execute }

    user = ENV["USER"] || ENV["USERNAME"]

    assert_match "API Key name [#{Socket.gethostname}-#{user}", key_name_ui.output
    assert_match "The default access scope is:", key_name_ui.output
    assert_match "Do you want to customise scopes? [yN]", key_name_ui.output
    assert_match "show_dashboard (exclusive scope, answering yes will not prompt for other scopes) [yN]", key_name_ui.output
    assert_match "index_rubygems [yN]", key_name_ui.output
    assert_match "push_rubygem [yN]", key_name_ui.output
    assert_match "yank_rubygem [yN]", key_name_ui.output
    assert_match "add_owner [yN]", key_name_ui.output
    assert_match "remove_owner [yN]", key_name_ui.output
    assert_match "access_webhooks [yN]", key_name_ui.output
    assert_equal "name=test-key&push_rubygem=true", fetcher.last_request.body

    credentials = load_yaml_file Gem.configuration.credentials_path
    assert_equal api_key, credentials[:rubygems_api_key]
  end

  def test_execute_with_key_name_and_exclusive_scope
    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\ny\ny\n"
    util_capture(key_name_ui, nil, api_key, fetcher) { @cmd.execute }

    user = ENV["USER"] || ENV["USERNAME"]

    assert_match "API Key name [#{Socket.gethostname}-#{user}", key_name_ui.output
    assert_match "The default access scope is:", key_name_ui.output
    assert_match "index_rubygems: y", key_name_ui.output
    assert_match "Do you want to customise scopes? [yN]", key_name_ui.output
    assert_match "show_dashboard (exclusive scope, answering yes will not prompt for other scopes) [yN]", key_name_ui.output
    assert_equal "name=test-key&show_dashboard=true", fetcher.last_request.body

    credentials = load_yaml_file Gem.configuration.credentials_path
    assert_equal api_key, credentials[:rubygems_api_key]
  end

  def test_execute_with_key_name_custom_scope_and_mfa_level_of_ui_only
    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher
    mfa_level = "ui_only"

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\ny\n\n\ny\n\n\n\n\n\n\ny"
    util_capture(key_name_ui, nil, api_key, fetcher, mfa_level) { @cmd.execute }

    user = ENV["USER"] || ENV["USERNAME"]

    assert_match "API Key name [#{Socket.gethostname}-#{user}", key_name_ui.output
    assert_match "The default access scope is:", key_name_ui.output
    assert_match "Do you want to customise scopes? [yN]", key_name_ui.output
    assert_match "show_dashboard (exclusive scope, answering yes will not prompt for other scopes) [yN]", key_name_ui.output
    assert_match "index_rubygems [yN]", key_name_ui.output
    assert_match "push_rubygem [yN]", key_name_ui.output
    assert_match "yank_rubygem [yN]", key_name_ui.output
    assert_match "add_owner [yN]", key_name_ui.output
    assert_match "remove_owner [yN]", key_name_ui.output
    assert_match "access_webhooks [yN]", key_name_ui.output
    assert_match "Would you like to enable MFA for this key? (strongly recommended) [yn]", key_name_ui.output
    assert_equal "name=test-key&push_rubygem=true&mfa=true", fetcher.last_request.body

    credentials = load_yaml_file Gem.configuration.credentials_path
    assert_equal api_key, credentials[:rubygems_api_key]
  end

  def test_execute_with_key_name_custom_scope_and_mfa_level_of_gem_signin
    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher
    mfa_level = "ui_and_gem_signin"

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\ny\n\n\ny\n\n\n\n\n\n\ny"
    util_capture(key_name_ui, nil, api_key, fetcher, mfa_level) { @cmd.execute }

    user = ENV["USER"] || ENV["USERNAME"]

    assert_match "API Key name [#{Socket.gethostname}-#{user}", key_name_ui.output
    assert_match "The default access scope is:", key_name_ui.output
    assert_match "Do you want to customise scopes? [yN]", key_name_ui.output
    assert_match "show_dashboard (exclusive scope, answering yes will not prompt for other scopes) [yN]", key_name_ui.output
    assert_match "index_rubygems [yN]", key_name_ui.output
    assert_match "push_rubygem [yN]", key_name_ui.output
    assert_match "yank_rubygem [yN]", key_name_ui.output
    assert_match "add_owner [yN]", key_name_ui.output
    assert_match "remove_owner [yN]", key_name_ui.output
    assert_match "access_webhooks [yN]", key_name_ui.output
    assert_match "Would you like to enable MFA for this key? (strongly recommended) [yn]", key_name_ui.output
    assert_equal "name=test-key&push_rubygem=true&mfa=true", fetcher.last_request.body

    credentials = load_yaml_file Gem.configuration.credentials_path
    assert_equal api_key, credentials[:rubygems_api_key]
  end

  def test_execute_with_warnings
    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher
    mfa_level = "disabled"
    warning   = "/[WARNING/] For protection of your account and gems"

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\n\ny\n\n\n\n\n\ny"
    util_capture(key_name_ui, nil, api_key, fetcher, mfa_level, warning) { @cmd.execute }

    assert_match warning, key_name_ui.output
  end

  def test_execute_on_gemserver_without_profile_me_endpoint
    host = "http://some-gemcutter-compatible-host.org"

    email     = "you@example.com"
    password  = "secret"
    api_key   = "1234abcd"
    fetcher   = Gem::RemoteFetcher.fetcher

    key_name_ui = Gem::MockGemUi.new "#{email}\n#{password}\ntest-key\ny\n\n\ny\n\n\n\n\n\n\ny"

    # Set the expected response for the Web-API supplied
    ENV["RUBYGEMS_HOST"]       = host
    data_key                   = "#{ENV["RUBYGEMS_HOST"]}/api/v1/api_key"
    fetcher.data[data_key]     = HTTPResponseFactory.create(body: api_key, code: 200, msg: "OK")

    use_ui key_name_ui do
      @cmd.execute
    end

    user = ENV["USER"] || ENV["USERNAME"]

    assert_match "API Key name [#{Socket.gethostname}-#{user}", key_name_ui.output
    assert_match "show_dashboard (exclusive scope, answering yes will not prompt for other scopes) [yN]", key_name_ui.output
    assert_match "index_rubygems [yN]", key_name_ui.output
    assert_match "push_rubygem [yN]", key_name_ui.output
    assert_match "yank_rubygem [yN]", key_name_ui.output
    assert_match "add_owner [yN]", key_name_ui.output
    assert_match "remove_owner [yN]", key_name_ui.output
    assert_match "access_webhooks [yN]", key_name_ui.output
    assert_equal "name=test-key&push_rubygem=true", fetcher.last_request.body
  end

  # Utility method to capture IO/UI within the block passed

  def util_capture(ui_stub = nil, host = nil, api_key = nil, fetcher = Gem::FakeFetcher.new, mfa_level = "disabled", warning = nil)
    api_key        ||= "a5fdbb6ba150cbb83aad2bb2fede64cf040453903"
    response         = HTTPResponseFactory.create(body: api_key, code: 200, msg: "OK")
    profile_response = HTTPResponseFactory.create(body: "mfa: #{mfa_level}\nwarning: #{warning}", code: 200, msg: "OK")
    email            = "you@example.com"
    password         = "secret"

    # Set the expected response for the Web-API supplied
    ENV["RUBYGEMS_HOST"]       = host || Gem::DEFAULT_HOST
    data_key                   = "#{ENV["RUBYGEMS_HOST"]}/api/v1/api_key"
    fetcher.data[data_key]     = response
    profile                    = "#{ENV["RUBYGEMS_HOST"]}/api/v1/profile/me.yaml"
    fetcher.data[profile]      = profile_response
    Gem::RemoteFetcher.fetcher = fetcher

    sign_in_ui = ui_stub || Gem::MockGemUi.new("#{email}\n#{password}\n\n\n")

    use_ui sign_in_ui do
      yield
    end

    sign_in_ui
  end
end