groonga-query-log 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 445e8c02baa8178322d2b5149f9f57026d483803
-  data.tar.gz: a94bf3aa467173b32823c496217e6aa97ad44a4b
+  metadata.gz: 0419d5711633814c977ad580360a83a79452e0d6
+  data.tar.gz: eebf8ea3c3c40a6282c97a373cdc9f57069ad3f0
 SHA512:
-  metadata.gz: 45c1b525c23c3efecc23fd3ed0f0ac003009c67d0e98af01799d68d7e984e51debc3fcd8484753f0e35a4853eff69f9470a2c90217ead4c20807544074ef5ce7
-  data.tar.gz: 9f4d57caaa380448aefd533753d9aac19f49f83eb57ce7934ef7343ae1c0450e7b7fcdcbfded01c221fb56d39dcc0869668b5a8afe63eb88e8147ae65b6a15d4
+  metadata.gz: 50d316f1fc627b6fd6e7f0bd86e78800b591a9e36a7753a4b2fdd75a1e24f3ffd571b0110cface8befb1b584900241918f37915c99d51b2454d2da6b61a22338
+  data.tar.gz: 4a5a0545f91800ad90a3d82916c9eb18904105911352c8ea15ae52ddeda1272160543cf17c707b6c20a11a3c28eab68ce0122c708cb84077512eea607401b41c

data/bin/groonga-query-log-check-command-version-compatibility

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2013-2014  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 "groonga/query-log/command/check-command-version-compatibility"
+
+command = Groonga::QueryLog::Command::CheckCommandVersionCompatibility.new
+exit(command.run(ARGV))

data/doc/text/news.md

@@ -1,5 +1,13 @@
 # News
 
+## 1.0.9: 2014-09-09
+
+### Improvements
+
+  * groonga-query-log-check-command-version-incompatibility: Added.
+    It parses commands in passed query logs and reports incompatible
+    items in target command version.
+
 ## 1.0.8: 2014-07-23
 
 ### Improvements

data/lib/groonga/query-log.rb

@@ -22,3 +22,4 @@ require "groonga/query-log/extractor"
 require "groonga/query-log/parser"
 require "groonga/query-log/replayer"
 require "groonga/query-log/server-verifier"
+require "groonga/query-log/command-version-compatibility-checker"

data/lib/groonga/query-log/command-version-compatibility-checker.rb

@@ -0,0 +1,100 @@
+# Copyright (C) 2014  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 "groonga/query-log/incompatibility-detector"
+
+module Groonga
+  module QueryLog
+    class CommandVersionCompatibilityChecker
+      def initialize(options)
+        @options = options
+        @incompatibility_detector = @options.create_incompatibility_detector
+        @output = $stdout
+        @nth_item = 1
+      end
+
+      def start
+        original_output = @output
+        result = nil
+        @options.create_output do |output|
+          @output = output
+          result = yield
+        end
+        result
+      ensure
+        @output = original_output
+      end
+
+      def check(input)
+        compatible = true
+        parser = Parser.new
+        parser.parse(input) do |statistic|
+          incompatibles = @incompatibility_detector.detect(statistic)
+          next if incompatibles.empty?
+          compatible = false
+          incompatibles.each do |incompatible|
+            report_incompatible(statistic, incompatible)
+          end
+        end
+        compatible
+      end
+
+      private
+      def report_incompatible(statistic, incompatible)
+        nth_item = @nth_item
+        @nth_item += 1
+        version = @incompatibility_detector.version
+        start_time = statistic.start_time.strftime("%Y-%m-%d %H:%M:%S.%6N")
+        @output.puts("#{nth_item}: version#{version}: #{incompatible}")
+        @output.puts("  %s" % start_time)
+        @output.puts("  #{statistic.raw_command}")
+        @output.puts("  Parameters:")
+        statistic.command.arguments.each do |key, value|
+          @output.puts("    <#{key}>: <#{value}>")
+        end
+      end
+
+      class Options
+        attr_accessor :target_version
+        attr_accessor :output_path
+        def initialize
+          @target_version = 2
+          @output_path = nil
+        end
+
+        def create_incompatibility_detector
+          case @target_version
+          when 1
+            IncompatibilityDetector::Version1.new
+          when 2
+            IncompatibilityDetector::Version2.new
+          else
+            raise ArgumentError, "Unsupported version: #{@target_version}"
+          end
+        end
+
+        def create_output(&block)
+          if @output_path
+            FileUtils.mkdir_p(File.dirname(@output_path))
+            File.open(@output_path, "w", &block)
+          else
+            yield($stdout)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/query-log/command/check-command-version-compatibility.rb

@@ -0,0 +1,71 @@
+# Copyright (C) 2014  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 "optparse"
+
+require "groonga/query-log"
+
+module Groonga
+  module QueryLog
+    module Command
+      class CheckCommandVersionCompatibility
+        def initialize
+          @options = CommandVersionCompatibilityChecker::Options.new
+        end
+
+        def run(command_line)
+          input_paths = create_parser.parse(command_line)
+          checker = CommandVersionCompatibilityChecker.new(@options)
+          checker.start do
+            compatible = true
+            if input_paths.empty?
+              compatible = false unless checker.check($stdin)
+            else
+              input_paths.each do |input_path|
+                File.open(input_path) do |input|
+                  compatible = false unless checker.check(input)
+                end
+              end
+            end
+            compatible
+          end
+        end
+
+        private
+        def create_parser
+          parser = OptionParser.new
+          parser.version = VERSION
+          parser.banner += " QUERY_LOG1 QUERY_LOG2 ..."
+
+          parser.separator("")
+          parser.separator("Options:")
+
+          parser.on("--target-version=VERSION", Integer,
+                    "Check incompatibility against command version VERSION",
+                    "[#{@options.target_version}]") do |version|
+            @options.target_version = version
+          end
+
+          parser.on("--output=PATH",
+                    "Output results to PATH",
+                    "[stdout]") do |path|
+            @options.output_path = path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/groonga/query-log/incompatibility-detector.rb

@@ -0,0 +1,98 @@
+# Copyright (C) 2014  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 "fileutils"
+
+require "groonga/query-log/parser"
+
+module Groonga
+  module QueryLog
+    class IncompatibilityDetector
+      attr_reader :version
+      def initialize(version)
+        @version = version
+      end
+
+      private
+      def build_message(command, parameter, description, value)
+        components = [
+          command,
+          parameter,
+          description,
+          "<#{value}>",
+        ]
+        components.join(": ")
+      end
+
+      class Version1 < self
+        def initialize
+          super(1)
+        end
+
+        def detect(statistic)
+          []
+        end
+      end
+
+      class Version2 < self
+        def initialize
+          super(2)
+        end
+
+        def detect(statistic)
+          case statistic.command.name
+          when "select"
+            detect_select(statistic)
+          else
+            []
+          end
+        end
+
+        private
+        def detect_select(statistic)
+          command = statistic.command
+          incompatibles = []
+          space_delimiter_unacceptable_parameters = ["output_columns"]
+          space_delimiter_unacceptable_parameters.each do |parameter|
+            value = command[parameter]
+            if space_delimiter?(value)
+              description = "space is used as delimiter"
+              message = build_message("select", parameter, description, value)
+              incompatibles << message
+            end
+          end
+          incompatibles
+        end
+
+        def space_delimiter?(string)
+          return false if string.nil?
+          return false if have_function_call?(string)
+          return false if have_comma?(string)
+
+          string.strip.split(/\s+/).size > 1
+        end
+
+        def have_function_call?(string)
+          string.include?("(")
+        end
+
+        def have_comma?(string)
+          string.include?(",")
+        end
+      end
+    end
+  end
+end

data/lib/groonga/query-log/version.rb

@@ -18,6 +18,6 @@
 
 module Groonga
   module QueryLog
-    VERSION = "1.0.8"
+    VERSION = "1.0.9"
   end
 end

data/test/test-incompatibility-detector.rb

@@ -0,0 +1,63 @@
+# Copyright (C) 2014  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 IncompatibilityDetectorTest < Test::Unit::TestCase
+  def detect(command)
+    query_log = <<-LOG
+2012-12-12 17:39:17.628846|0x7fff786aa2b0|>#{command}
+2012-12-12 17:39:17.630052|0x7fff786aa2b0|<000000001217140 rc=0
+    LOG
+    statistic = parse_query_log(query_log)
+    @detector.detect(statistic)
+  end
+
+  def parse_query_log(query_log)
+    parser = Groonga::QueryLog::Parser.new
+    parser.parse(query_log) do |statistic|
+      return statistic
+    end
+  end
+
+  sub_test_case("version1") do
+    def setup
+      @detector = Groonga::QueryLog::IncompatibilityDetector::Version1.new
+    end
+  end
+
+  sub_test_case("version2") do
+    def setup
+      @detector = Groonga::QueryLog::IncompatibilityDetector::Version2.new
+    end
+
+    sub_test_case("select") do
+      sub_test_case("output_columns") do
+        def test_space_delimiter
+          message =
+            "select: output_columns: space is used as delimiter: <_id _key>"
+          assert_equal([message], detect("select --output_columns '_id _key'"))
+        end
+
+        def test_comma_delimiter
+          assert_equal([], detect("select --output_columns '_id, _key'"))
+        end
+
+        def test_one_element
+          assert_equal([], detect("select --output_columns '_id'"))
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: groonga-query-log
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: groonga-command-parser
@@ -158,6 +158,7 @@ executables:
 - groonga-query-log-verify-server
 - groonga-query-log-extract
 - groonga-query-log-run-regression-test
+- groonga-query-log-check-command-version-compatibility
 - groonga-query-log-replay
 - groonga-query-log-show-running-queries
 - groonga-query-log-detect-memory-leak
@@ -170,6 +171,7 @@ files:
 - README.md
 - Rakefile
 - bin/groonga-query-log-analyze
+- bin/groonga-query-log-check-command-version-compatibility
 - bin/groonga-query-log-detect-memory-leak
 - bin/groonga-query-log-extract
 - bin/groonga-query-log-format-regression-test-logs
@@ -193,6 +195,8 @@ files:
 - lib/groonga/query-log/analyzer/statistic.rb
 - lib/groonga/query-log/analyzer/streamer.rb
 - lib/groonga/query-log/command-line-utils.rb
+- lib/groonga/query-log/command-version-compatibility-checker.rb
+- lib/groonga/query-log/command/check-command-version-compatibility.rb
 - lib/groonga/query-log/command/detect-memory-leak.rb
 - lib/groonga/query-log/command/format-regression-test-logs.rb
 - lib/groonga/query-log/command/replay.rb
@@ -200,6 +204,7 @@ files:
 - lib/groonga/query-log/command/show-running-queries.rb
 - lib/groonga/query-log/command/verify-server.rb
 - lib/groonga/query-log/extractor.rb
+- lib/groonga/query-log/incompatibility-detector.rb
 - lib/groonga/query-log/memory-leak-detector.rb
 - lib/groonga/query-log/parser.rb
 - lib/groonga/query-log/replayer.rb
@@ -224,6 +229,7 @@ files:
 - test/run-test.rb
 - test/test-analyzer.rb
 - test/test-extractor.rb
+- test/test-incompatibility-detector.rb
 - test/test-parser.rb
 - test/test-replayer.rb
 - test/test-response-comparer.rb
@@ -274,6 +280,7 @@ test_files:
 - test/fixtures/order/start-time.expected
 - test/fixtures/order/-elapsed.expected
 - test/run-test.rb
+- test/test-incompatibility-detector.rb
 - test/test-extractor.rb
 - test/test-replayer.rb
 has_rdoc: