racknga 0.9.3 → 0.9.5

data/munin/plugins/passenger_application_

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -23,16 +23,11 @@ require 'rubygems'
 
 mode = ARGV[0]
 
-def passenger_status_path(gem_path)
-  File.join(gem_path, "bin", "passenger-status")
-end
-
 @label = ENV["label"]
 @pid_file = ENV["pid_file"]
 @ruby = ENV["ruby"] || Gem.ruby
-@gem_path = ((ENV["GEM_HOME"] || '').split(/:/) + Gem.path).find do |path|
-  File.exist?(passenger_status_path(path))
-end
+passenger_spec = Gem::Specification.find_by_name("passenger")
+@passenger_status = passenger_spec.bin_file("passenger-status")
 
 if @label
   parameter_prefix = /\Apassenger_(?:#{@label}_)?application_/
@@ -40,7 +35,7 @@ else
   parameter_prefix = /\Apassenger_application_/
 end
 parameter = File.basename($0).gsub(parameter_prefix, '')
-if /_(sessions|processed|uptime)\z/ =~ parameter
+if /_(\S+)\z/ =~ parameter
   @application = $PREMATCH
   @type = $1
   @application = nil if @application and @application.empty?
@@ -57,28 +52,25 @@ def passenger_status
   else
     pid = nil
   end
-  result = `#{@ruby} #{passenger_status_path(@gem_path)} #{pid}`
+  result = `#{@ruby} #{@passenger_status} #{pid}`
   [$?.success?, result]
 end
 
-def parse_uptime(uptime)
-  uptime_in_minutes = 0
-  if /\A(?:(?:(\d+)h\s+)?(\d+)m\s+)?(\d+)s\z/ =~ uptime
+def parse_time(time)
+  time_in_minutes = 0
+  if /\A(?:(?:(\d+)h\s+)?(\d+)m\s+)?(\d+)s\z/ =~ time
     hours = $1.to_i
     minutes = $2.to_i
     seconds = $3.to_i
-    uptime_in_minutes = minutes + hours * 60
+    time_in_minutes = minutes + hours * 60
   end
-  uptime_in_minutes
+  time_in_minutes
 end
 
 def extract_application_name(path)
   components = path.split(/\//)
-  ignore_components = ["current"]
-  while ignore_components.include?(components.last)
-    components.pop
-  end
-  components.pop
+  application_name, tag = components.last.split(/#/)
+  application_name
 end
 
 def parse_result(result)
@@ -86,34 +78,47 @@ def parse_result(result)
   section = nil
   application_name = nil
   result.each_line do |line|
-    case section
-    when "Application groups"
-      case line.chomp
-      when /\A(.+):\s*\z/
-        path = $1
-        application_name = extract_application_name(path)
-        sections[section] << [application_name, []]
-      when /\A\s+\*\s+
-              PID:\s+(\d+)\s+
-              Sessions:\s+(\d+)\s+
-              Processed:\s+(\d+)\s+
-              Uptime:\s+(.+)\z/x
-        pid = $1.to_i
-        sessions = $2.to_i
-        processed = $3.to_i
-        uptime = parse_uptime($4)
-        _application_name, processes = sections[section].last
-        processes << {
-          :pid => pid,
-          :sessions => sessions,
-          :processed => processed,
-          :uptime => uptime
-        }
-      end
+    case line
+    when /-+\s+(.+)\s+-+/
+      section = $1
+      sections[section] = []
     else
-      if /-+\s+(.+)\s+-+/ =~ line
-        section = $1
-        sections[section] = []
+      case section
+      when "Application groups"
+        case line.chomp
+        when /\A(\/.+):\s*\z/
+          path = $1
+          application_name = extract_application_name(path)
+          sections[section] << [application_name, []]
+        when /\A\s+\*\s+
+                PID:\s+(\d+)\s+
+                Sessions:\s+(\d+)\s+
+                Processed:\s+(\d+)\s+
+                Uptime:\s+(.+)\z/x
+          pid = $1.to_i
+          sessions = $2.to_i
+          processed = $3.to_i
+          uptime = parse_time($4)
+          _application_name, processes = sections[section].last
+          processes << {
+            :pid => pid,
+            :sessions => sessions,
+            :processed => processed,
+            :uptime => uptime
+          }
+        when /\A\s+
+                CPU:\s+(\d+)%\s+
+                Memory\s*:\s+(\d+)M\s+
+                Last\sused:\s+(.+)(?:\s+ago)\z/x
+          cpu = $1.to_i
+          memory = $2.to_i * 1024 * 1024
+          last_used = parse_time($3)
+          _application_name, processes = sections[section].last
+          process = processes.last
+          process[:cpu] = cpu
+          process[:memory] = memory
+          process[:last_used] = last_used
+        end
       end
     end
   end
@@ -138,6 +143,12 @@ def vlabel
     "number of processed sessions"
   when "uptime"
     "uptime by minutes"
+  when "cpu"
+    "CPU usage in percent"
+  when "memory"
+    "memory usage"
+  when "last_used"
+    "last used by minutes"
   else
     "unknown"
   end
@@ -219,6 +230,9 @@ when "suggest"
         puts "#{application}_sessions"
         puts "#{application}_processed"
         puts "#{application}_uptime"
+        puts "#{application}_cpu"
+        puts "#{application}_memory"
+        puts "#{application}_last_used"
       end
       exit(true)
     end

data/munin/plugins/passenger_status

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (C) 2010  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2013  Kouhei Sutou <kou@clear-code.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -22,16 +22,11 @@ require 'rubygems'
 
 mode = ARGV[0]
 
-def passenger_status_path(gem_path)
-  File.join(gem_path, "bin", "passenger-status")
-end
-
 @label = ENV["label"]
 @pid_file = ENV["pid_file"]
 @ruby = ENV["ruby"] || Gem.ruby
-@gem_path = ((ENV["GEM_HOME"] || '').split(/:/) + Gem.path).find do |path|
-  File.exist?(passenger_status_path(path))
-end
+passenger_spec = Gem::Specification.find_by_name("passenger")
+@passenger_status = passenger_spec.bin_file("passenger-status")
 
 def passenger_status
   if @pid_file
@@ -42,32 +37,60 @@ def passenger_status
   else
     pid = nil
   end
-  result = `#{@ruby} #{passenger_status_path(@gem_path)} #{pid}`
+  result = `#{@ruby} #{@passenger_status} #{pid}`
   [$?.success?, result]
 end
 
+def label_to_key(label)
+  label.downcase.gsub(/[ -]+/, "_")
+end
+
+def extract_application_name(path)
+  components = path.split(/\//)
+  application_name, tag = components.last.split(/#/)
+  application_name
+end
+
 def parse_result(result)
   sections = {}
   section = nil
   result.each_line do |line|
-    case section
-    when "General information"
-      case line.chomp
-      when /\A(\S+)\s*=\s*(\d+)\z/
-        key = $1
-        value = $2.to_i
-        sections[section] << {:key => key, :label => key, :value => value}
-      when /\A(Waiting on global queue):\s*(\d+)\z/
-        label = $1
-        value = $2.to_i
-        sections[section] << {:key => "global_queue",
-                              :label => label,
-                              :value => value}
-      end
+    case line
+    when /-+\s+(.+)\s+-+/
+      section = $1
+      sections[section] = []
     else
-      if /-+\s+(.+)\s+-+/ =~ line
-        section = $1
-        sections[section] = []
+      case section
+      when "General information"
+        case line.chomp
+        when /\A(.+):\s*(\d+)\z/
+          label = $1.strip
+          value = $2.to_i
+          key = label_to_key(label)
+          sections[section] << {
+            :key => key,
+            :label => label,
+            :value => value,
+          }
+        end
+      when "Application groups"
+        case line.chomp
+        when /\A(\/.+):\s*\z/
+          path = $1
+          application_name = extract_application_name(path)
+          sections[section] << [application_name, []]
+        when /\A\s+(.+):\s*(\d+)\z/
+          label = $1.strip
+          value = $2.to_i
+          _application_name, attributes = sections[section].last
+          key = "#{_application_name}_#{label_to_key(label)}"
+          label = "#{label}: #{_application_name}"
+          attributes << {
+            :key => key,
+            :label => label,
+            :value => value,
+          }
+        end
       end
     end
   end
@@ -95,12 +118,16 @@ graph_vlabel number of processes
 
 EOC
   have_stack_base = false
-  sections["General information"].each do |attributes|
-    key = attributes[:key]
+  attributes = sections["General information"]
+  sections["Application groups"].each do |_, application_attributes|
+    attributes += application_attributes
+  end
+  attributes.each do |attribute|
+    key = attribute[:key]
     next if key == "count"
-    puts("#{key}.label #{attributes[:label]}")
+    puts("#{key}.label #{attribute[:label]}")
     case key
-    when "max", "global_queue"
+    when /max/, /queue/
       draw = "LINE2"
     else
       if have_stack_base
@@ -110,7 +137,7 @@ EOC
         have_stack_base = true
       end
     end
-    puts("#{attributes[:key]}.draw #{draw}")
+    puts("#{attribute[:key]}.draw #{draw}")
   end
 end
 
@@ -119,8 +146,12 @@ def report
   exit(false) unless success
 
   sections = parse_result(result)
-  sections["General information"].each do |attributes|
-    puts("#{attributes[:key]}.value #{attributes[:value]}")
+  attributes = sections["General information"]
+  sections["Application groups"].each do |_, application_attributes|
+    attributes += application_attributes
+  end
+  attributes.each do |attribute|
+    puts("#{attribute[:key]}.value #{attribute[:value]}")
   end
 end
 

data/test/racknga-test-utils.rb

@@ -12,20 +12,16 @@
 #
 # 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 "test/unit/capybara"
 require 'json'
 
 require 'racknga'
+require 'racknga/middleware/auth/api-key'
 require 'racknga/middleware/cache'
 require 'racknga/middleware/instance_name'
 
-Capybara.configure do |config|
-  config.default_driver = nil
-  config.current_driver = nil
-end
-
 module RackngaTestUtils
   include Capybara::DSL
 

data/test/run-test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 #
-# Copyright (C) 2010-2011  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2010-2024  Sutou Kouhei <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
@@ -14,12 +14,10 @@
 #
 # 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
 
 $VERBOSE = true
 
-$KCODE = "u" if RUBY_VERSION < "1.9"
-
 require 'pathname'
 
 base_dir = Pathname(__FILE__).dirname.parent.expand_path
@@ -33,7 +31,6 @@ require "rubygems"
 require "bundler/setup"
 
 require 'test/unit'
-require 'test/unit/notify'
 
 Test::Unit::Priority.enable
 

data/test/test-access-log-parser.rb

@@ -15,7 +15,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
 
 require 'stringio'
 

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