drnbench 1.0.0

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# News
+
+## 1.0.0: 2014-01-29
+
+The first release!!!

data/drnbench.gemspec

@@ -0,0 +1,59 @@
+# -*- mode: ruby; coding: utf-8 -*-
+#
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+require "drnbench/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "drnbench"
+  spec.version = Drnbench::VERSION
+  spec.homepage = "https://github.com/groonga/grntest"
+  spec.authors = ["YUKI Hiroshi", "Kouhei Sutou"]
+  spec.email = ["yuki@clear-code.com", "kou@clear-code.com"]
+  readme = File.read("README.md")
+  readme.force_encoding("UTF-8") if readme.respond_to?(:force_encoding)
+  entries = readme.split(/^\#\#\s(.*)$/)
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "GPLv3 or later"
+  spec.files = [
+    "README.md",
+    "Rakefile",
+    "Gemfile",
+    "#{spec.name}.gemspec",
+    "LICENSE.txt",
+  ]
+  spec.files += Dir.glob("doc/text/**/*")
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.test_files += Dir.glob("test/**/*")
+  Dir.chdir("bin") do
+    spec.executables = Dir.glob("*")
+  end
+
+  spec.add_runtime_dependency("json")
+  spec.add_runtime_dependency("droonga-client")
+  spec.add_runtime_dependency("drntest")
+
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("packnga")
+  spec.add_development_dependency("kramdown")
+end

data/lib/drnbench.rb

@@ -0,0 +1,22 @@
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "drnbench/version"
+require "drnbench/request-response/configuration"
+require "drnbench/request-response/runner"
+require "drnbench/request-response/gradual-runner"
+require "drnbench/publish-subscribe/configuration"
+require "drnbench/publish-subscribe/runner"
+require "drnbench/publish-subscribe/gradual-runner"

data/lib/drnbench/client/http-droonga.rb

@@ -0,0 +1,37 @@
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Drnbench
+  class HttpDroongaClient < HttpClient
+    DEFAULT_PATH_BASE = "/droonga"
+    DEFAULT_COMMAND   = "search"
+    DEFAULT_METHOD    = "POST"
+
+    def initialize(params, config)
+      super
+      @command = params["command"] || DEFAULT_COMMAND
+    end
+
+    private
+    def fixup_request(request)
+      request = {
+        "body" => request,
+      }
+      request["path"]   ||= "#{DEFAULT_PATH_BASE}/#{@command}"
+      request["method"] ||= DEFAULT_METHOD
+      super(request)
+    end
+  end
+end

data/lib/drnbench/client/http.rb

@@ -0,0 +1,68 @@
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "thread"
+require "droonga/client"
+require "json"
+
+module Drnbench
+  class HttpClient
+    attr_reader :requests, :results, :wait
+
+    def initialize(params, config)
+      @requests = params[:requests]
+      @result   = params[:result]
+      @config   = config
+    end
+
+    def run
+      @thread = Thread.new do
+        loop do
+          request = @requests.pop
+          request = fixup_request(request)
+
+          client = Droonga::Client.new(:protocol => :http,
+                                       :host => request["host"],
+                                       :port => request["port"])
+          request["headers"] ||= {}
+          request["headers"]["user-agent"] = "Ruby/#{RUBY_VERSION} Droonga::Benchmark::Runner::HttpClient"
+          start_time = Time.now
+          response = client.request(request)
+          @result << {
+            :request => request,
+            :status => response.code,
+            :elapsed_time => Time.now - start_time,
+          }
+          sleep @config.wait
+        end
+      end
+      self
+    end
+
+    def stop
+      @thread.exit
+    end
+
+    private
+    def fixup_request(request)
+      request["host"] ||= @config.default_host
+      request["port"] ||= @config.default_port
+      request["path"] ||= @config.default_path
+      request["method"] ||= @config.default_method
+      request["method"] = request["method"].upcase
+      request
+    end
+  end
+end

data/lib/drnbench/publish-subscribe/configuration.rb

@@ -0,0 +1,76 @@
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "drnbench/server/configuration"
+
+module Drnbench
+  module PublishSubscribe
+    class Configuration
+      attr_accessor :start_n_subscribers, :n_publishings, :n_steps, :timeout
+      attr_accessor :subscribe_request_file, :feed_file, :engine, :protocol_adapter
+      attr_accessor :report_progressively, :output_path
+
+      def initialize
+        @start_n_subscribers  = 1000
+        @n_publishings        = 1000
+        @n_steps              = 10
+        @timeout              = 10
+
+        @report_progressively = true
+        @output_path          = "/tmp/drnbench-pubsub-result.csv"
+
+        @engine           = Server::EngineConfiguration.new
+        @protocol_adapter = Server::ProtocolAdapterConfiguration.new
+        @protocol_adapter.engine = @engine
+      end
+
+      def validate
+        if @subscribe_request_file.nil?
+          raise ArgumentError.new("You must specify a JSON file for a message pattern to subscribe.")
+        end
+        if @feed_file.nil?
+          raise ArgumentError.new("You must specify a JSON file for a message pattern to feed.")
+        end
+      end
+
+      def subscribe_request
+        @subscribe_request ||= prepare_subscribe_request
+      end
+
+      def new_subscribe_request
+        Marshal.load(Marshal.dump(subscribe_request))
+      end
+
+      def feed
+        @feed ||= prepare_feed
+      end
+
+      def new_feed
+        Marshal.load(Marshal.dump(feed))
+      end
+
+      private
+      def prepare_subscribe_request
+        subscribe_request_file = Pathname(@subscribe_request_file).expand_path(Dir.pwd)
+        JSON.parse(subscribe_request_file.read)
+      end
+
+      def prepare_feed
+        feed_file = Pathname(@feed_file).expand_path(Dir.pwd)
+        JSON.parse(feed_file.read)
+      end
+    end
+  end
+end

data/lib/drnbench/publish-subscribe/gradual-runner.rb

@@ -0,0 +1,66 @@
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "benchmark"
+require "csv"
+
+module Drnbench
+  module PublishSubscribe
+    class GradualRunner
+      attr_reader :total_results
+
+      def initialize(config)
+        @config = config
+        @runner = Runner.new(@config)
+      end
+
+      def run
+        results = []
+        @runner.setup
+        begin
+          @config.n_steps.times do
+            run_once(results)
+          end
+        ensure
+          @runner.teardown
+        end
+        @total_results = [
+          ["case", "qps"],
+        ]
+        @total_results += results
+      end
+
+      private
+      def run_once(results)
+        @runner.increase_subscribers
+        label = "#{@runner.n_subscribers} subscribers"
+        GC.disable
+        result = Benchmark.bm do |benchmark|
+          benchmark.report(label) do
+            @runner.run
+          end
+        end
+        GC.enable
+        GC.start
+        result = result.join("").strip.gsub(/[()]/, "").split(/\s+/)
+        qps = @config.n_publishings.to_f / result.last.to_f
+        if @config.report_progressively
+          puts "   (#{qps} queries per second)"
+        end
+        results << [label, qps]
+      end
+    end
+  end
+end

data/lib/drnbench/publish-subscribe/runner.rb

@@ -0,0 +1,136 @@
+# Copyright (C) 2013-2014  Droonga Project
+#
+# 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
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "pathname"
+require "droonga/client"
+require "drnbench/server/engine"
+require "drnbench/server/protocol-adapter"
+
+module Drnbench
+  module PublishSubscribe
+    class Runner
+      def initialize(config)
+        @config = config
+        @published_messages = Queue.new
+      end
+
+      def n_subscribers
+        @subscribers.size
+      end
+
+      def setup
+        setup_server
+        setup_subscribers
+      end
+
+      def teardown
+        teardown_subscribers
+        teardown_server
+      end
+
+      def run
+        publishing_times = @config.n_publishings
+        n_will_be_published_messages = @subscribers.size * publishing_times
+
+        do_feed(publishing_times)
+        receive_messages(n_will_be_published_messages)
+      end
+
+      def increase_subscribers
+        if @subscribers.empty?
+          new_n_subscribers = @config.start_n_subscribers
+        else
+          new_n_subscribers = @subscribers.size
+        end
+        add_subscribers(new_n_subscribers)
+        ensure_subscribers_ready
+      end
+
+      private
+      def setup_server
+        @engine = Engine.new(@config.engine)
+        @engine.start
+
+        @protocol_adapter = ProtocolAdapter.new(@config.protocol_adapter)
+        @protocol_adapter.start
+      end
+
+      def teardown_server
+        @protocol_adapter.stop
+        @engine.stop
+      end
+
+      def setup_subscribers
+        @subscribers = []
+      end
+
+      def teardown_subscribers
+        @subscribers.each do |subscriber|
+          subscriber.close
+        end
+      end
+
+      def add_subscribers(n_subscribers)
+        n_subscribers.times do
+          message = @config.new_subscribe_request
+          client = Droonga::Client.new(:protocol => :http,
+                                       :host => @config.protocol_adapter.host,
+                                       :port => @config.protocol_adapter.port)
+          client.subscribe(message) do |published_message|
+            @published_messages.push(published_message)
+          end
+          @subscribers << client
+        end
+      end
+
+      def ensure_subscribers_ready
+        sleep(1)
+        2.times do
+          do_feed(1)
+          n_subscribers.times do
+            @published_messages.pop
+            break if @published_messages.empty?
+          end
+        end
+        @published_messages.clear
+      end
+
+      def do_feed(count)
+        Droonga::Client.open(:tag => @config.engine.tag,
+                             :host => @config.engine.host,
+                             :port => @config.engine.port) do |feeder|
+          count.times do
+            do_one_feed(feeder)
+          end
+        end
+      end
+
+      def do_one_feed(feeder)
+        message = @config.new_feed
+        feeder.send(message)
+      end
+
+      def receive_messages(count)
+        n_published_messages = 0
+        count.times do
+          # we should implement "timeout" for too slow cases
+          @published_messages.pop
+          n_published_messages += 1
+        end
+        n_published_messages
+      end
+    end
+  end
+end