racknga 0.9.2 → 0.9.4

data/test/{test-nginx-log-parser.rb → test-access-log-parser.rb}

@@ -15,34 +15,37 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 require 'stringio'
 
-module NginxAccessLogParserTests
+module AccessLogParserTests
   module Data
     private
-    def time_log_component
-      times = ["03/Aug/2011:16:58:01 +0900", runtime, request_time].compact
-      "[#{times.join(', ')}]"
+    def time_local
+      "03/Aug/2011:16:58:01 +0900"
+    end
+
+    def log_line(content)
+      content
     end
 
     def usual_log_line
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
     end
 
     def usual_log_entry_options
       {
         :remote_address => "127.0.0.1",
-        :remote_user => "-",
+        :remote_user => nil,
         :time_local => Time.local(2011, 8, 3, 16, 58, 1),
         :runtime => runtime,
         :request_time => request_time,
         :request => "GET / HTTP/1.1",
         :status => 200,
         :body_bytes_sent => 613,
-        :http_referer => "-",
+        :http_referer => nil,
         :http_user_agent => "Ruby",
       }
     end
@@ -52,8 +55,8 @@ module NginxAccessLogParserTests
     end
 
     def not_found_log_line
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET /the-truth.html HTTP/1.1\" 404 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET /the-truth.html HTTP/1.1\" 404 613 \"-\" \"Ruby\"")
     end
 
     def not_found_log_entry
@@ -71,8 +74,8 @@ module NginxAccessLogParserTests
     def valid_utf8_log_line
       path = utf8_path
 
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
     end
 
     def valid_utf8_log_entry
@@ -90,8 +93,41 @@ module NginxAccessLogParserTests
     def invalid_utf8_log_line
       path = garbled_path
 
-      "127.0.0.1 - - #{time_log_component}  " +
-        "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\""
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET #{path} HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
+    end
+
+    def ipv6_log_line
+      log_line("::1 - - #{time_log_component}  " +
+               "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
+    end
+
+    def ipv6_log_entry
+      options = {
+        :remote_address => "::1",
+      }
+      create_log_entry(usual_log_entry_options.merge(options))
+    end
+
+    def apache_combined_log_line
+      log_line("127.0.0.1 - - #{time_log_component} " +
+               "\"GET / HTTP/1.1\" 200 613 \"-\" \"Ruby\"")
+    end
+
+    def apache_combined_log_entry
+      usual_log_entry
+    end
+
+    def no_body_bytes_sent_log_line
+      log_line("127.0.0.1 - - #{time_log_component}  " +
+               "\"GET / HTTP/1.1\" 200 - \"-\" \"Ruby\"")
+    end
+
+    def no_body_bytes_sent_log_entry
+      options = {
+        :body_bytes_sent => nil,
+      }
+      create_log_entry(usual_log_entry_options.merge(options))
     end
 
     def bad_log_line
@@ -110,11 +146,11 @@ module NginxAccessLogParserTests
     end
 
     def create_log_parser(file)
-      Racknga::NginxAccessLogParser.new(file)
+      Racknga::AccessLogParser.new(file)
     end
 
     def create_reversed_log_parser(file)
-      Racknga::ReversedNginxAccessLogParser.new(file)
+      Racknga::ReversedAccessLogParser.new(file)
     end
 
     def join_lines(*lines)
@@ -137,18 +173,36 @@ module NginxAccessLogParserTests
   end
 
   module Tests
-    def test_usual_nginx_access_log
+    def test_usual_log
       accesses = parse(join_lines(usual_log_line))
-      access = accesses.first
-      assert_equal(usual_log_entry, access)
+      assert_equal([usual_log_entry],
+                   accesses)
     end
 
-    def test_no_access_log
+    def test_ipv6_log
+      accesses = parse(join_lines(ipv6_log_line))
+      assert_equal([ipv6_log_entry],
+                   accesses)
+    end
+
+    def test_apache_combined_log
+      accesses = parse(join_lines(apache_combined_log_line))
+      assert_equal([apache_combined_log_entry],
+                   accesses)
+    end
+
+    def test_no_body_bytes_sent_log
+      accesses = parse(join_lines(no_body_bytes_sent_log_line))
+      assert_equal([no_body_bytes_sent_log_entry],
+                   accesses)
+    end
+
+    def test_no_log
       accesses = parse(join_lines())
       assert_equal([], accesses)
     end
 
-    def test_multiple_nginx_access_log
+    def test_multiple_logs
       accesses = parse(join_lines(usual_log_line,
                                   usual_log_line,
                                   not_found_log_line))
@@ -158,7 +212,7 @@ module NginxAccessLogParserTests
                    accesses)
     end
 
-    def test_reversed_nginx_access_log
+    def test_reversed_parse
       accesses = reversed_parse(join_lines(usual_log_line,
                                            usual_log_line,
                                            not_found_log_line))
@@ -168,8 +222,8 @@ module NginxAccessLogParserTests
                    accesses)
     end
 
-    def test_bad_nginx_access_log
-      assert_raise(Racknga::NginxAccessLogParser::FormatError) do
+    def test_bad_log
+      assert_raise(Racknga::AccessLogParser::FormatError) do
         parse(join_lines(bad_log_line))
       end
     end
@@ -189,6 +243,12 @@ module NginxAccessLogParserTests
     include Data
     include Tests
 
+    private
+    def time_log_component
+      times = [time_local, runtime, request_time].compact
+      "[#{times.join(', ')}]"
+    end
+
     def runtime
       nil
     end
@@ -198,11 +258,40 @@ module NginxAccessLogParserTests
     end
   end
 
-  class CombinedWithTimeLogTest < Test::Unit::TestCase
+  class CombinedWithTimeNginxLogTest < Test::Unit::TestCase
+    include Environment
+    include Data
+    include Tests
+
+    private
+    def time_log_component
+      times = [time_local, runtime, request_time].compact
+      "[#{times.join(', ')}]"
+    end
+
+    def runtime
+      0.000573
+    end
+
+    def request_time
+      0.001
+    end
+  end
+
+  class CombinedWithTimeApacheLogTest < Test::Unit::TestCase
     include Environment
     include Data
     include Tests
 
+    private
+    def time_log_component
+      "[#{time_local}]"
+    end
+
+    def log_line(content)
+      "#{content} #{runtime} #{(request_time * 1_000_000).to_i}"
+    end
+
     def runtime
       0.000573
     end

data/test/test-api-keys.rb

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2012  Haruka Yoshihara <yoshihara@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class APIKeysTest < Test::Unit::TestCase
+  include RackngaTestUtils
+
+  def setup
+    @api_keys = Racknga::APIKeys.new(query_parameter, api_keys)
+  end
+
+  def test_matched_key
+    assert_matched(query_parameter, api_key)
+  end
+
+  def test_not_matched_key
+    assert_not_matched(query_parameter, "notapikey")
+  end
+
+  def test_empty_key
+    assert_not_matched(query_parameter, "")
+  end
+
+  def test_empty_query_parameter
+    assert_not_matched("", api_key)
+  end
+
+  def test_mismatched_query_parameter
+    assert_not_matched("not-api-key", api_key)
+  end
+
+  private
+  def assert_matched(parameter, key)
+    environment = generate_environment(parameter, key)
+    assert_true(@api_keys.include?(environment))
+  end
+
+  def assert_not_matched(parameter, key)
+    environment = generate_environment(parameter, key)
+    assert_false(@api_keys.include?(environment))
+  end
+
+  def generate_environment(parameter, key)
+    url = "http://example.org"
+
+    unless parameter.empty?
+      api_url = "#{url}?#{parameter}=#{key}"
+    else
+      api_url = url
+    end
+
+    Rack::MockRequest.env_for(api_url)
+  end
+
+  def query_parameter
+    "api-key"
+  end
+
+  def api_keys
+    ["key", "key2"]
+  end
+
+  def api_key
+    api_keys.first
+  end
+end

data/test/test-middleware-auth-api-key.rb

@@ -0,0 +1,144 @@
+# Copyright (C) 2012  Haruka Yoshihara <kou@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class MiddlewareAuthAPIKeyTest < Test::Unit::TestCase
+  include RackngaTestUtils
+
+  def app
+    application = Proc.new do |environment|
+      @environment = environment
+      [
+        200,
+        {"Content-Type" => "application/json"},
+        [@body]
+      ]
+    end
+    authorized_api_keys =
+      Racknga::APIKeys.new(@api_query_parameter, @api_keys)
+    api_key_options = {
+      :api_url_prefixes => [@api_url_prefix],
+      :authorized_api_keys => authorized_api_keys,
+      :error_response => @error_response,
+      :disable_authorization => disable_authorization?
+    }
+    api_key = api_key_authorizer(application, api_key_options)
+    Proc.new do |environment|
+      api_key.call(environment)
+    end
+  end
+
+  def setup
+    @api_query_parameter = "api-key"
+    @api_url_prefix = "/api"
+    @api_keys = ["key1", "key2"]
+    @body = "{}"
+    @error_response = {"error" => "this api key is not authorized"}
+    Capybara.app = app
+  end
+
+  def test_authorized_key
+    url = generate_url(url_prefix, query_parameter, valid_key)
+    visit(url)
+    assert_success_response
+  end
+
+  def test_unauthorized_key
+    url = generate_url(url_prefix, query_parameter, "invalidkey")
+    visit(url)
+    assert_failure_response
+  end
+
+  def test_unmatched_query_parameter
+    url = generate_url(url_prefix, "not-api-key", valid_key)
+    visit(url)
+    assert_failure_response
+  end
+
+  def test_unauthorized_key_and_unmatched_query_parameter
+    url = generate_url(url_prefix, "not-api-key", "invalidkey")
+    visit(url)
+    assert_failure_response
+  end
+
+  def test_not_api_url
+    visit("/not/api/url")
+    assert_success_response
+  end
+
+  private
+  def disable_authorization?
+    false
+  end
+
+  def api_key_authorizer(application, api_key_options)
+    Racknga::Middleware::Auth::APIKey.new(application, api_key_options)
+  end
+
+  def generate_url(path, query_parameter, api_key)
+    url = path
+    if query_parameter
+      url << "?#{query_parameter}=#{api_key}"
+    end
+    url
+  end
+
+  def url_prefix
+    @api_url_prefix
+  end
+
+  def query_parameter
+    @api_query_parameter
+  end
+
+  def valid_key
+    @api_keys.first
+  end
+
+  def assert_success_response
+    assert_equal(200, page.status_code)
+    assert_equal(@body, page.source)
+  end
+
+  def assert_failure_response
+    assert_equal(401, page.status_code)
+    assert_equal(@error_response.to_json, page.source)
+  end
+
+  class DisableAuthorizationTest < self
+    def test_unauthorized_key
+      url = generate_url(url_prefix, query_parameter, "invalidkey")
+      visit(url)
+      assert_success_response
+    end
+
+    def test_unmatched_query_parameter
+      url = generate_url(url_prefix, "not-api-key", valid_key)
+      visit(url)
+      assert_success_response
+    end
+
+    def test_unauthorized_key_and_unmatched_query_parameter
+      url = generate_url(url_prefix, "not-api-key", "invalidkey")
+      visit(url)
+      assert_success_response
+    end
+
+    private
+    def disable_authorization?
+      true
+    end
+  end
+end

data/test/test-middleware-cache.rb

@@ -12,7 +12,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 class MiddlewareCacheTest < Test::Unit::TestCase
   include RackngaTestUtils

data/test/test-middleware-instance-name.rb

@@ -12,45 +12,57 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 class InstanceNameTest < Test::Unit::TestCase
   include RackngaTestUtils
 
+  DEFAULT_HEADER_NAME = "X-Responsed-By"
+
   def test_no_option
-    server = default_instance_name.server
-    user = default_instance_name.user
-    revision = default_instance_name.revision
+    footer_variables = extract_from_default_instance_name
 
     instance_name_options({}) do
       request
-      assert_header("Proc (at #{revision}) on #{server} by #{user}")
+      assert_equal("Proc #{default_footer(*footer_variables)}",
+                   response_header(DEFAULT_HEADER_NAME))
+    end
+  end
+
+  def test_header_name
+    header_name = "X-header-name"
+    footer_variables = extract_from_default_instance_name
+
+    instance_name_options(:header_name => header_name) do
+      request
+      assert_equal("Proc #{default_footer(*footer_variables)}",
+                   response_header(header_name))
     end
   end
 
   def test_application_name
     application_name = "HelloWorld"
-    server = default_instance_name.server
-    user = default_instance_name.user
-    revision = default_instance_name.revision
+    footer_variables = extract_from_default_instance_name
 
     instance_name_options(:application_name => application_name) do
       request
-      assert_header("#{application_name} (at #{revision}) on #{server} by #{user}")
+      assert_equal("#{application_name} " +
+                   "#{default_footer(*footer_variables)}",
+                   response_header(DEFAULT_HEADER_NAME))
     end
   end
 
   def test_both_application_name_and_version
     application_name = "HelloWorld"
     version = 1
-    server = default_instance_name.server
-    user = default_instance_name.user
-    revision = default_instance_name.revision
+    footer_variables = extract_from_default_instance_name
 
     instance_name_options(:application_name => application_name,
                           :version => version) do
       request
-      assert_header("#{application_name} v#{version} (at #{revision}) on #{server} by #{user}")
+      assert_equal("#{application_name} v#{version} " +
+                   "#{default_footer(*footer_variables)}",
+                   response_header(DEFAULT_HEADER_NAME))
     end
   end
 
@@ -72,7 +84,25 @@ class InstanceNameTest < Test::Unit::TestCase
   end
 
   def default_instance_name
-    @default_instance_name ||= create_instance_name(create_minimal_application).freeze
+    @default_instance_name ||=
+      create_instance_name(create_minimal_application).freeze
+  end
+
+  def extract_from_default_instance_name
+    server = default_instance_name.server
+    user = default_instance_name.user
+    revision = default_instance_name.revision
+    branch = default_instance_name.branch
+    ruby = default_instance_name.ruby
+
+    [server, user, revision, branch, ruby]
+  end
+
+  def default_footer(server, user, revision, branch, ruby)
+    footer = ""
+    footer << "(at #{revision} (#{branch})) " if format_is_possible?(revision)
+    footer << "on #{server} by #{user} with #{ruby}"
+    footer
   end
 
   def create_minimal_application
@@ -92,7 +122,11 @@ class InstanceNameTest < Test::Unit::TestCase
     yield
   end
 
-  def assert_header(expected_header)
-    assert_equal(expected_header, page.response_headers["X-Responsed-By"])
+  def response_header(name)
+    page.response_headers[name]
+  end
+
+  def format_is_possible?(data)
+    data and (data.respond_to?(:to_s) and not data.to_s.empty?)
   end
 end

data/test/test-middleware-jsonp.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2012  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -12,7 +12,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 class MiddlewareJSONPTest < Test::Unit::TestCase
   include RackngaTestUtils
@@ -76,6 +76,18 @@ class MiddlewareJSONPTest < Test::Unit::TestCase
                  @environment[@cache_key_key])
   end
 
+  def test_jsonp_content_length
+    @update_environment = Proc.new do |environment|
+      environment["Content-Length"] = @body.bytesize
+      environment
+    end
+    visit("/?callback=jsonp_callback")
+    expected_response = "jsonp_callback(#{@body});"
+    assert_jsonp_response(expected_response)
+    assert_equal(expected_response.bytesize.to_s,
+                 page.response_headers["Content-Length"])
+  end
+
   private
   def assert_jsonp_response(body)
     assert_equal({

data/test/test-middleware-nginx-raw-uri.rb

@@ -0,0 +1,70 @@
+# Copyright (C) 2011  Ryo Onodera <onodera@clear-code.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+class NginxRawURITest < Test::Unit::TestCase
+  include RackngaTestUtils
+
+  class PseudoNginx
+    def initialize(application)
+      @application = application
+    end
+
+    def call(environment)
+      mimic_nginx_behavior(environment)
+
+      @application.call(environment)
+    end
+
+    private
+    def mimic_nginx_behavior(environment)
+      environment["HTTP_X_RAW_REQUEST_URI"] = environment["PATH_INFO"]
+      environment["PATH_INFO"] = Rack::Utils.unescape(environment["PATH_INFO"])
+    end
+  end
+
+  def app
+    application = Proc.new do |environment|
+      @environment = environment
+
+      response
+    end
+
+    raw_uri = Racknga::Middleware::NginxRawURI.new(application)
+    pseudo_nginx = PseudoNginx.new(raw_uri)
+
+    pseudo_nginx
+  end
+
+  def setup
+    Capybara.app = app
+  end
+
+  def test_slash
+    path_info_with_slash = "/keywords/GNU%2fLinux"
+
+    visit(path_info_with_slash)
+    assert_equal(path_info_with_slash, path_info)
+  end
+
+  private
+  def response
+    [200, {"Content-Type" => "plain/text"}, ["this is a response."]]
+  end
+
+  def path_info
+    @environment["PATH_INFO"]
+  end
+end

data/test/test-middleware-range.rb

@@ -12,7 +12,7 @@
 #
 # You should have received a copy of the GNU Lesser General Public
 # License along with this library; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 module MiddlewareRangeTests
   include RackngaTestUtils