ruby/test/uri/test_common.rb

# frozen_string_literal: false
require 'test/unit'
require 'envutil'
require 'uri'

class URI::TestCommon < Test::Unit::TestCase
  def setup
  end

  def teardown
  end

  def test_fallback_constants
    orig_verbose = $VERBOSE
    $VERBOSE = nil
    assert URI::ABS_URI
    assert_raise(NameError) { URI::FOO }
  ensure
    $VERBOSE = orig_verbose
  end

  def test_parser_switch
    assert_equal(URI::Parser, URI::RFC3986_Parser)
    refute defined?(URI::REGEXP)
    refute defined?(URI::PATTERN)

    URI.parser = URI::RFC2396_PARSER

    assert_equal(URI::Parser, URI::RFC2396_Parser)
    assert defined?(URI::REGEXP)
    assert defined?(URI::PATTERN)
    assert defined?(URI::PATTERN::ESCAPED)

    URI.parser = URI::RFC3986_PARSER

    assert_equal(URI::Parser, URI::RFC3986_Parser)
    refute defined?(URI::REGEXP)
    refute defined?(URI::PATTERN)
  ensure
    URI.parser = URI::RFC3986_PARSER
  end

  def test_extract
    EnvUtil.suppress_warning do
      assert_equal(['http://example.com'],
                   URI.extract('http://example.com'))
      assert_equal(['http://example.com'],
                   URI.extract('(http://example.com)'))
      assert_equal(['http://example.com/foo)'],
                   URI.extract('(http://example.com/foo)'))
      assert_equal(['http://example.jphttp://example.jp'],
                   URI.extract('http://example.jphttp://example.jp'), "[ruby-list:36086]")
      assert_equal(['http://example.jphttp://example.jp'],
                   URI.extract('http://example.jphttp://example.jp', ['http']), "[ruby-list:36086]")
      assert_equal(['http://', 'mailto:'].sort,
                   URI.extract('ftp:// http:// mailto: https://', ['http', 'mailto']).sort)
      # reported by Doug Kearns <djkea2@mugca.its.monash.edu.au>
      assert_equal(['From:', 'mailto:xxx@xxx.xxx.xxx]'].sort,
                   URI.extract('From: XXX [mailto:xxx@xxx.xxx.xxx]').sort)
    end
  end

  def test_ractor
    return unless defined?(Ractor)
    assert_ractor(<<~RUBY, require: 'uri')
      r = Ractor.new { URI.parse("https://ruby-lang.org/").inspect }
      assert_equal(URI.parse("https://ruby-lang.org/").inspect, r.take)
    RUBY
  end

  DEFAULT_SCHEMES = ["FILE", "FTP", "HTTP", "HTTPS", "LDAP", "LDAPS", "MAILTO", "WS", "WSS"].sort.freeze

  def test_register_scheme
    assert_equal(DEFAULT_SCHEMES, URI.scheme_list.keys.sort)

    foobar = Class.new(URI::Generic)
    URI.register_scheme 'FOOBAR', foobar
    begin
      assert_include(URI.scheme_list.keys, "FOOBAR")
      assert_equal foobar, URI.parse('foobar://localhost').class
    ensure
      URI.const_get(:Schemes).send(:remove_const, :FOOBAR)
    end

    assert_equal(DEFAULT_SCHEMES, URI.scheme_list.keys.sort)
  end

  def test_register_scheme_lowercase
    assert_equal(DEFAULT_SCHEMES, URI.scheme_list.keys.sort)

    foobar = Class.new(URI::Generic)
    URI.register_scheme 'foobarlower', foobar
    begin
      assert_include(URI.scheme_list.keys, "FOOBARLOWER")
      assert_equal foobar, URI.parse('foobarlower://localhost').class
    ensure
      URI.const_get(:Schemes).send(:remove_const, :FOOBARLOWER)
    end

    assert_equal(DEFAULT_SCHEMES, URI.scheme_list.keys.sort)
  end

  def test_register_scheme_with_symbols
    # Valid schemes from https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
    some_uri_class = Class.new(URI::Generic)
    assert_raise(NameError) { URI.register_scheme 'ms-search', some_uri_class }
    assert_raise(NameError) { URI.register_scheme 'microsoft.windows.camera', some_uri_class }
    assert_raise(NameError) { URI.register_scheme 'coaps+ws', some_uri_class }

    ms_search_class = Class.new(URI::Generic)
    URI.register_scheme 'MS_SEARCH', ms_search_class
    begin
      assert_equal URI::Generic, URI.parse('ms-search://localhost').class
    ensure
      URI.const_get(:Schemes).send(:remove_const, :MS_SEARCH)
    end
  end

  def test_regexp
    EnvUtil.suppress_warning do
      assert_instance_of Regexp, URI.regexp
      assert_instance_of Regexp, URI.regexp(['http'])
      assert_equal URI.regexp, URI.regexp
      assert_equal 'http://', 'x http:// x'.slice(URI.regexp)
      assert_equal 'http://', 'x http:// x'.slice(URI.regexp(['http']))
      assert_equal 'http://', 'x http:// x ftp://'.slice(URI.regexp(['http']))
      assert_equal nil, 'http://'.slice(URI.regexp([]))
      assert_equal nil, ''.slice(URI.regexp)
      assert_equal nil, 'xxxx'.slice(URI.regexp)
      assert_equal nil, ':'.slice(URI.regexp)
      assert_equal 'From:', 'From:'.slice(URI.regexp)
    end
  end

  def test_kernel_uri
    expected = URI.parse("http://www.ruby-lang.org/")
    assert_equal(expected, URI("http://www.ruby-lang.org/"))
    assert_equal(expected, Kernel::URI("http://www.ruby-lang.org/"))
    assert_raise(NoMethodError) { Object.new.URI("http://www.ruby-lang.org/") }
  end

  def test_parse_timeout
    pre = ->(n) {
      'https://example.com/dir/' + 'a' * (n * 100) + '/##.jpg'
    }
    assert_linear_performance((1..3).map {|i| 10**i}, rehearsal: 1000, pre: pre) do |uri|
      assert_raise(URI::InvalidURIError) do
        URI.parse(uri)
      end
    end
  end

  def test_encode_www_form_component
    assert_equal("%00+%21%22%23%24%25%26%27%28%29*%2B%2C-.%2F09%3A%3B%3C%3D%3E%3F%40" \
                 "AZ%5B%5C%5D%5E_%60az%7B%7C%7D%7E",
                 URI.encode_www_form_component("\x00 !\"\#$%&'()*+,-./09:;<=>?@AZ[\\]^_`az{|}~"))
    assert_equal("%95A", URI.encode_www_form_component(
                   "\x95\x41".force_encoding(Encoding::Shift_JIS)))
    assert_equal("0B", URI.encode_www_form_component(
                   "\x30\x42".force_encoding(Encoding::UTF_16BE)))
    assert_equal("%1B%24B%24%22%1B%28B", URI.encode_www_form_component(
                   "\e$B$\"\e(B".force_encoding(Encoding::ISO_2022_JP)))

    assert_equal("%E3%81%82", URI.encode_www_form_component(
                   "\u3042", Encoding::ASCII_8BIT))
    assert_equal("%82%A0", URI.encode_www_form_component(
                   "\u3042", Encoding::Windows_31J))
    assert_equal("%E3%81%82", URI.encode_www_form_component(
                   "\u3042", Encoding::UTF_8))

    assert_equal("%82%A0", URI.encode_www_form_component(
                   "\u3042".encode("sjis"), Encoding::ASCII_8BIT))
    assert_equal("%A4%A2", URI.encode_www_form_component(
                   "\u3042".encode("sjis"), Encoding::EUC_JP))
    assert_equal("%E3%81%82", URI.encode_www_form_component(
                   "\u3042".encode("sjis"), Encoding::UTF_8))
    assert_equal("B0", URI.encode_www_form_component(
                   "\u3042".encode("sjis"), Encoding::UTF_16LE))
    assert_equal("%26%23730%3B", URI.encode_www_form_component(
                   "\u02DA", Encoding::WINDOWS_1252))

    # invalid
    assert_equal("%EF%BF%BD%EF%BF%BD", URI.encode_www_form_component(
                   "\xE3\x81\xFF", "utf-8"))
    assert_equal("%E6%9F%8A%EF%BF%BD%EF%BF%BD", URI.encode_www_form_component(
                   "\x95\x41\xff\xff".force_encoding(Encoding::Shift_JIS), "utf-8"))
  end

  def test_decode_www_form_component
    assert_equal("  !\"\#$%&'()*+,-./09:;<=>?@AZ[\\]^_`az{|}~",
                 URI.decode_www_form_component(
                   "%20+%21%22%23%24%25%26%27%28%29*%2B%2C-.%2F09%3A%3B%3C%3D%3E%3F%40" \
                   "AZ%5B%5C%5D%5E_%60az%7B%7C%7D%7E"))
    assert_equal("\xA1\xA2".force_encoding(Encoding::EUC_JP),
                 URI.decode_www_form_component("%A1%A2", "EUC-JP"))
    assert_equal("\xE3\x81\x82\xE3\x81\x82".force_encoding("UTF-8"),
                 URI.decode_www_form_component("\xE3\x81\x82%E3%81%82".force_encoding("UTF-8")))

    assert_raise(ArgumentError){URI.decode_www_form_component("%")}
    assert_raise(ArgumentError){URI.decode_www_form_component("%a")}
    assert_raise(ArgumentError){URI.decode_www_form_component("x%a_")}
    assert_nothing_raised(ArgumentError){URI.decode_www_form_component("x"*(1024*1024))}
  end

  def test_encode_uri_component
    assert_equal("%00%20%21%22%23%24%25%26%27%28%29*%2B%2C-.%2F09%3A%3B%3C%3D%3E%3F%40" \
                 "AZ%5B%5C%5D%5E_%60az%7B%7C%7D%7E",
                 URI.encode_uri_component("\x00 !\"\#$%&'()*+,-./09:;<=>?@AZ[\\]^_`az{|}~"))
    assert_equal("%95A", URI.encode_uri_component(
                   "\x95\x41".force_encoding(Encoding::Shift_JIS)))
    assert_equal("0B", URI.encode_uri_component(
                   "\x30\x42".force_encoding(Encoding::UTF_16BE)))
    assert_equal("%1B%24B%24%22%1B%28B", URI.encode_uri_component(
                   "\e$B$\"\e(B".force_encoding(Encoding::ISO_2022_JP)))

    assert_equal("%E3%81%82", URI.encode_uri_component(
                   "\u3042", Encoding::ASCII_8BIT))
    assert_equal("%82%A0", URI.encode_uri_component(
                   "\u3042", Encoding::Windows_31J))
    assert_equal("%E3%81%82", URI.encode_uri_component(
                   "\u3042", Encoding::UTF_8))

    assert_equal("%82%A0", URI.encode_uri_component(
                   "\u3042".encode("sjis"), Encoding::ASCII_8BIT))
    assert_equal("%A4%A2", URI.encode_uri_component(
                   "\u3042".encode("sjis"), Encoding::EUC_JP))
    assert_equal("%E3%81%82", URI.encode_uri_component(
                   "\u3042".encode("sjis"), Encoding::UTF_8))
    assert_equal("B0", URI.encode_uri_component(
                   "\u3042".encode("sjis"), Encoding::UTF_16LE))
    assert_equal("%26%23730%3B", URI.encode_uri_component(
                   "\u02DA", Encoding::WINDOWS_1252))

    # invalid
    assert_equal("%EF%BF%BD%EF%BF%BD", URI.encode_uri_component(
                   "\xE3\x81\xFF", "utf-8"))
    assert_equal("%E6%9F%8A%EF%BF%BD%EF%BF%BD", URI.encode_uri_component(
                   "\x95\x41\xff\xff".force_encoding(Encoding::Shift_JIS), "utf-8"))
  end

  def test_decode_uri_component
    assert_equal(" +!\"\#$%&'()*+,-./09:;<=>?@AZ[\\]^_`az{|}~",
                 URI.decode_uri_component(
                   "%20+%21%22%23%24%25%26%27%28%29*%2B%2C-.%2F09%3A%3B%3C%3D%3E%3F%40" \
                   "AZ%5B%5C%5D%5E_%60az%7B%7C%7D%7E"))
    assert_equal("\xA1\xA2".force_encoding(Encoding::EUC_JP),
                 URI.decode_uri_component("%A1%A2", "EUC-JP"))
    assert_equal("\xE3\x81\x82\xE3\x81\x82".force_encoding("UTF-8"),
                 URI.decode_uri_component("\xE3\x81\x82%E3%81%82".force_encoding("UTF-8")))

    assert_raise(ArgumentError){URI.decode_uri_component("%")}
    assert_raise(ArgumentError){URI.decode_uri_component("%a")}
    assert_raise(ArgumentError){URI.decode_uri_component("x%a_")}
    assert_nothing_raised(ArgumentError){URI.decode_uri_component("x"*(1024*1024))}
  end

  def test_encode_www_form
    assert_equal("a=1", URI.encode_www_form("a" => "1"))
    assert_equal("a=1", URI.encode_www_form(a: 1))
    assert_equal("a=1", URI.encode_www_form([["a", "1"]]))
    assert_equal("a=1", URI.encode_www_form([[:a, 1]]))
    expected = "a=1&%E3%81%82=%E6%BC%A2"
    assert_equal(expected, URI.encode_www_form("a" => "1", "\u3042" => "\u6F22"))
    assert_equal(expected, URI.encode_www_form(a: 1, :"\u3042" => "\u6F22"))
    assert_equal(expected, URI.encode_www_form([["a", "1"], ["\u3042", "\u6F22"]]))
    assert_equal(expected, URI.encode_www_form([[:a, 1], [:"\u3042", "\u6F22"]]))
    assert_equal("a=1&%82%A0=%8A%BF",
                 URI.encode_www_form({"a" => "1", "\u3042" => "\u6F22"}, "sjis"))

    assert_equal('+a+=+1+', URI.encode_www_form([[' a ', ' 1 ']]))
    assert_equal('text=x%0Ay', URI.encode_www_form([['text', "x\u000Ay"]]))
    assert_equal('constellation=Bo%C3%B6tes', URI.encode_www_form([['constellation', "Bo\u00F6tes"]]))
    assert_equal('name=%00value', URI.encode_www_form([['name', "\u0000value"]]))
    assert_equal('Cipher=c%3D%28m%5Ee%29%25n', URI.encode_www_form([['Cipher', 'c=(m^e)%n']]))
    assert_equal('&', URI.encode_www_form([['', nil], ['', nil]]))
    assert_equal('&=', URI.encode_www_form([['', nil], ['', '']]))
    assert_equal('=&', URI.encode_www_form([['', ''], ['', nil]]))
    assert_equal('=&=', URI.encode_www_form([['', ''], ['', '']]))
    assert_equal('', URI.encode_www_form([['', nil]]))
    assert_equal('', URI.encode_www_form([]))
    assert_equal('=', URI.encode_www_form([['', '']]))
    assert_equal('a%26b=1&c=2%3B3&e=4', URI.encode_www_form([['a&b', '1'], ['c', '2;3'], ['e', '4']]))
    assert_equal('image&title&price', URI.encode_www_form([['image', nil], ['title', nil], ['price', nil]]))

    assert_equal("q=ruby&lang=en", URI.encode_www_form([["q", "ruby"], ["lang", "en"]]))
    assert_equal("q=ruby&lang=en", URI.encode_www_form("q" => "ruby", "lang" => "en"))
    assert_equal("q=ruby&q=perl&lang=en", URI.encode_www_form("q" => ["ruby", "perl"], "lang" => "en"))
    assert_equal("q=ruby&q=perl&lang=en", URI.encode_www_form([["q", "ruby"], ["q", "perl"], ["lang", "en"]]))
  end

  def test_decode_www_form
    assert_equal([%w[a 1], %w[a 2]], URI.decode_www_form("a=1&a=2"))
    assert_equal([%w[a 1;a=2]], URI.decode_www_form("a=1;a=2"))
    assert_equal([%w[a 1], ['', ''], %w[a 2]], URI.decode_www_form("a=1&&a=2"))
    assert_raise(ArgumentError){URI.decode_www_form("\u3042")}
    assert_equal([%w[a 1], ["\u3042", "\u6F22"]],
                 URI.decode_www_form("a=1&%E3%81%82=%E6%BC%A2"))
    assert_equal([%w[a 1], ["\uFFFD%8", "\uFFFD"]],
                 URI.decode_www_form("a=1&%E3%81%8=%E6%BC"))
    assert_equal([%w[?a 1], %w[a 2]], URI.decode_www_form("?a=1&a=2"))
    assert_equal([], URI.decode_www_form(""))
    assert_equal([%w[% 1]], URI.decode_www_form("%=1"))
    assert_equal([%w[a %]], URI.decode_www_form("a=%"))
    assert_equal([%w[a 1], %w[% 2]], URI.decode_www_form("a=1&%=2"))
    assert_equal([%w[a 1], %w[b %]], URI.decode_www_form("a=1&b=%"))
    assert_equal([['a', ''], ['b', '']], URI.decode_www_form("a&b"))
    bug4098 = '[ruby-core:33464]'
    assert_equal([['a', 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'], ['b', '']], URI.decode_www_form("a=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&b"), bug4098)

    assert_raise(ArgumentError){ URI.decode_www_form("a=1&%82%A0=%8A%BF", "x-sjis") }
    assert_equal([["a", "1"], [s("\x82\xA0"), s("\x8a\xBF")]],
                 URI.decode_www_form("a=1&%82%A0=%8A%BF", "sjis"))
    assert_equal([["a", "1"], [s("\x82\xA0"), s("\x8a\xBF")], %w[_charset_ sjis], [s("\x82\xA1"), s("\x8a\xC0")]],
                 URI.decode_www_form("a=1&%82%A0=%8A%BF&_charset_=sjis&%82%A1=%8A%C0", use__charset_: true))
    assert_equal([["", "isindex"], ["a", "1"]],
                 URI.decode_www_form("isindex&a=1", isindex: true))
  end

  private
  def s(str) str.force_encoding(Encoding::Windows_31J); end
end