groonga-query-log 1.0.0

data/test/fixtures/reporter/json.expected

@@ -0,0 +1,4 @@
+[
+{"start_time":START_TIME,"last_time":LAST_TIME,"elapsed":0.003128856,"return_code":0,"command":{"raw":"load --table Video","name":"load","parameters":[{"key":"table","value":"Video"}]},"operations":[]},
+{"start_time":START_TIME,"last_time":LAST_TIME,"elapsed":0.00121714,"return_code":0,"command":{"raw":"select --table Users --query follower:@groonga --output_columns _key,name","name":"select","parameters":[{"key":"table","value":"Users"},{"key":"query","value":"follower:@groonga"},{"key":"output_columns","value":"_key,name"}]},"operations":[{"name":"filter","relative_elapsed":0.0008429529999999999,"context":"query: follower:@groonga"},{"name":"select","relative_elapsed":2.7947e-05,"context":null},{"name":"output","relative_elapsed":0.000195852,"context":"_key,name"}]}
+]

data/test/groonga-query-log-test-utils.rb

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011-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
+# 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
+
+require "cgi"
+require "stringio"
+
+require "groonga/command"
+
+require "groonga/query-log"
+
+module GroongaQueryLogTestUtils
+  module CommandParser
+    private
+    def command(name, parameters)
+      command_class = Groonga::Command.find(name)
+      command = command_class.new(name, parameters)
+      command.original_format = :command
+      command
+    end
+
+    def parse_http_path(command, parameters)
+      path = "/d/#{command}.json"
+      unless parameters.empty?
+        uri_parameters = parameters.collect do |key, value|
+          [CGI.escape(key.to_s), CGI.escape(value.to_s)].join("=")
+        end
+        path << "?"
+        path << uri_parameters.join("&")
+      end
+      Groonga::Command::Parser.parse(path)
+    end
+
+    def parse_command_line(command, parameters)
+      command_line = "#{command} --output_type json"
+      parameters.each do |key, value|
+        if /"| / =~ value
+          escaped_value = '"' + value.gsub(/"/, '\"') + '"'
+        else
+          escaped_value = value
+        end
+        command_line << " --#{key} #{escaped_value}"
+      end
+      Groonga::Command::Parser.parse(command_line)
+    end
+  end
+
+  module HTTPCommandParser
+    include CommandParser
+
+    private
+    def parse(command, parameters={})
+      parse_http_path(command, parameters)
+    end
+  end
+
+  module CommandLineCommandParser
+    include CommandParser
+
+    private
+    def parse(command, parameters={})
+      parse_command_line(command, parameters)
+    end
+  end
+end

data/test/run-test.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 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
+# 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
+
+$VERBOSE = true
+
+$KCODE = "u" if RUBY_VERSION < "1.9"
+
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+lib_dir = File.join(base_dir, "lib")
+test_dir = File.join(base_dir, "test")
+
+require "test-unit"
+require "test/unit/notify"
+
+Test::Unit::Priority.enable
+
+$LOAD_PATH.unshift(lib_dir)
+
+$LOAD_PATH.unshift(test_dir)
+require "groonga-query-log-test-utils"
+
+Dir.glob("#{base_dir}/test/**/test{_,-}*.rb") do |file|
+  require file.sub(/\.rb\z/, '')
+end
+
+ENV["TEST_UNIT_MAX_DIFF_TARGET_STRING_SIZE"] ||= "5000"
+
+exit Test::Unit::AutoRunner.run

data/test/test-analyzer.rb

@@ -0,0 +1,82 @@
+# -*- 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
+
+require "tempfile"
+require "pathname"
+require "groonga/query-log/analyzer"
+
+class AnalyzerTest < Test::Unit::TestCase
+  setup
+  def setup_fixtures
+    @fixtures_path = File.join(File.dirname(__FILE__), "fixtures")
+    @query_log_path = File.join(@fixtures_path, "query.log")
+  end
+
+  def setup
+    @analyzer = Groonga::QueryLog::Analyzer.new
+  end
+
+  data(:console => "console", :html => "html", :json => "json")
+  def test_reporter(reporter)
+    actual_result = run_analyzer("--reporter", reporter, @query_log_path)
+    actual_result = normalize_json(actual_result) if reporter == "json"
+
+    expected_result = expected_analyzed_query("reporter/#{reporter}.expected")
+    assert_equal(expected_result, actual_result)
+  end
+
+  def test_n_entries
+    actual_result = run_analyzer("--n-entries=1", @query_log_path)
+    expected_result = expected_analyzed_query("n_entries.expected")
+    assert_equal(expected_result, actual_result)
+  end
+
+  data(:asc_elapsed => "elapsed", :asc_start_time => "start-time",
+         :desc_elapsed => "-elapsed", :desc_start_time => "-start-time")
+  def test_order(order)
+    actual_result = run_analyzer("--order=#{order}", @query_log_path)
+
+    expected_result = expected_analyzed_query("order/#{order}.expected")
+    assert_equal(expected_result, actual_result)
+  end
+
+  def test_no_report_summary
+    actual_result = run_analyzer("--no-report-summary", @query_log_path)
+    expected_result = expected_analyzed_query("no-report-summary.expected")
+    assert_equal(expected_result, actual_result)
+  end
+
+  private
+  def run_analyzer(*arguments)
+    Tempfile.open("output.actual") do |output|
+      arguments << "--output" << output.path
+      @analyzer.run(*arguments)
+      File.read(output.path)
+    end
+  end
+
+  def normalize_json(json_string)
+    json_string = json_string.gsub(/(\"start_time\"):\d+/,
+                                   "\\1:START_TIME")
+    json_string.gsub(/(\"last_time\"):\d+/, "\\1:LAST_TIME")
+  end
+
+  def expected_analyzed_query(file_name)
+    File.read(File.join(@fixtures_path, file_name))
+  end
+end

data/test/test-parser.rb

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2011-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
+# 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 ParserTest < Test::Unit::TestCase
+  def test_load
+    @log = <<-EOL
+2012-12-13 11:15:21.628105|0x7fff148c8a50|>load --table Video
+2012-12-13 11:15:21.645119|0x7fff148c8a50|<000000017041150 rc=0
+EOL
+    parsed_command = statistics.first.command
+    assert_instance_of(Groonga::Command::Load, parsed_command)
+  end
+
+  private
+  def statistics
+    statistics = []
+    parser = Groonga::QueryLog::Parser.new
+    parser.parse(StringIO.new(log)) do |statistic|
+      statistics << statistic
+    end
+    statistics
+  end
+
+  def log
+    @log
+  end
+
+  class StatisticOperationTest < self
+    def setup
+      @log = <<-EOL
+2011-06-02 16:27:04.731685|5091e5c0|>/d/select.join?table=Entries&filter=local_name+%40+%22gsub%22+%26%26+description+%40+%22string%22&sortby=_score&output_columns=_key&drilldown=name,class
+2011-06-02 16:27:04.733539|5091e5c0|:000000001849451 filter(15)
+2011-06-02 16:27:04.734978|5091e5c0|:000000003293459 filter(13)
+2011-06-02 16:27:04.735012|5091e5c0|:000000003327415 select(13)
+2011-06-02 16:27:04.735096|5091e5c0|:000000003411824 sort(10)
+2011-06-02 16:27:04.735232|5091e5c0|:000000003547265 output(10)
+2011-06-02 16:27:04.735606|5091e5c0|:000000003921419 drilldown(3)
+2011-06-02 16:27:04.735762|5091e5c0|:000000004077552 drilldown(2)
+2011-06-02 16:27:04.735808|5091e5c0|<000000004123726 rc=0
+EOL
+    end
+
+    def test_context
+      operations = statistics.first.operations.collect do |operation|
+        [operation[:name], operation[:context]]
+      end
+      expected = [
+        ["filter", "local_name @ \"gsub\""],
+        ["filter", "description @ \"string\""],
+        ["select", nil],
+        ["sort", "_score"],
+        ["output", "_key"],
+        ["drilldown", "name"],
+        ["drilldown", "class"],
+      ]
+      assert_equal(expected, operations)
+    end
+
+    def test_n_records
+      operations = statistics.first.operations.collect do |operation|
+        [operation[:name], operation[:n_records]]
+      end
+      expected = [
+        ["filter", 15],
+        ["filter", 13],
+        ["select", 13],
+        ["sort", 10],
+        ["output", 10],
+        ["drilldown", 3],
+        ["drilldown", 2],
+      ]
+      assert_equal(expected, operations)
+    end
+  end
+end

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: groonga-query-log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kouhei Sutou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: groonga-command
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-notify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: packnga
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- kou@clear-code.com
+executables:
+- groonga-query-log-analyzer
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- Gemfile
+- groonga-query-log.gemspec
+- lib/groonga/query-log.rb
+- lib/groonga/query-log/parser.rb
+- lib/groonga/query-log/analyzer.rb
+- lib/groonga/query-log/analyzer/streamer.rb
+- lib/groonga/query-log/analyzer/statistic.rb
+- lib/groonga/query-log/analyzer/reporter.rb
+- lib/groonga/query-log/analyzer/sized-grouped-operations.rb
+- lib/groonga/query-log/analyzer/sized-statistics.rb
+- lib/groonga/query-log/analyzer/reporter/console.rb
+- lib/groonga/query-log/analyzer/reporter/json.rb
+- lib/groonga/query-log/analyzer/reporter/html.rb
+- lib/groonga/query-log/version.rb
+- doc/text/news.md
+- doc/text/lgpl-2.1.txt
+- .yardopts
+- test/run-test.rb
+- test/command/test-select.rb
+- test/fixtures/no-report-summary.expected
+- test/fixtures/query.log
+- test/fixtures/order/start-time.expected
+- test/fixtures/order/-elapsed.expected
+- test/fixtures/order/-start-time.expected
+- test/fixtures/order/elapsed.expected
+- test/fixtures/n_entries.expected
+- test/fixtures/reporter/html.expected
+- test/fixtures/reporter/json.expected
+- test/fixtures/reporter/console.expected
+- test/groonga-query-log-test-utils.rb
+- test/test-parser.rb
+- test/test-analyzer.rb
+- bin/groonga-query-log-analyzer
+homepage: https://github.com/groonga/groonga-query-log
+licenses:
+- LGPLv2.1+
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 332673278574272449
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 332673278574272449
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Groonga-query-log is a collection of libarary and tools to process [groonga](http://groonga.org/)'s
+  query log. You can write a program to process query log by using groonga-query-log
+  as a library. You can analyze your groonga's queries and test with your groonga's
+  query log by using groonga-query-log as a tool.
+test_files:
+- test/run-test.rb
+- test/command/test-select.rb
+- test/fixtures/no-report-summary.expected
+- test/fixtures/query.log
+- test/fixtures/order/start-time.expected
+- test/fixtures/order/-elapsed.expected
+- test/fixtures/order/-start-time.expected
+- test/fixtures/order/elapsed.expected
+- test/fixtures/n_entries.expected
+- test/fixtures/reporter/html.expected
+- test/fixtures/reporter/json.expected
+- test/fixtures/reporter/console.expected
+- test/groonga-query-log-test-utils.rb
+- test/test-parser.rb
+- test/test-analyzer.rb
+has_rdoc: