rails_api_benchmark 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16e76dc43a1a8457ffc51885a838b224bbb2f37d
+  data.tar.gz: 44020a8c4cd7bae78d0c758653d1f45f0244b9ba
+SHA512:
+  metadata.gz: 36f8f6ec137d2227ef6b9b9b7bc7759d0c4068aa7c094fad84c1d5c2226a9f54e4a0ac04b0ba10a4b3ed8f7885cf60f3a1b868070578c64ec99807a7b8e00d65
+  data.tar.gz: 57695424f8624fa90b5117b63e050fdd79c22d38ba2518612423e18a43e73f1eafed84cd5dadc8050975cf018f50320ed698e9a2199d91f75ba4637b77f7b265

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Doc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# RailsApiBenchmark
+
+Work in progress, yet you can use it like this.
+
+## Usage
+
+Run it with rake api:benchmark
+
+## Installation
+
+Install gnuplot (Google)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_api_benchmark'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Provide necessary configuration in initializer, example config (mine):
+
+```ruby
+unless Rails.env.production?
+  RailsApiBenchmark.configure do |config|
+    # Try different configs. You may need to run the
+    # benchmark in a production ready environment to get reliable results
+    config.concurrency = 2
+    config.host = 'localhost:5000' # example.com
+    config.nb_requests = 3000
+    config.results_folder = 'benchmark'
+    config.auth_header = 'Authorization: Token token=benchToken'
+    # Use only if you want to log the responses
+    config.curl_cmd = 'curl -H "%{auth_header}" http://%{host}%{route}'
+    # Use Apache Bench
+    config.bench_cmd = 'ab -n %{nb_requests} -c %{concurrency} -g plot.tsv -e plot.csv -H "%{auth_header}" http://%{host}%{route}'
+    config.server_cmd = 'bundle exec puma'
+    config.env_vars = {
+      'RAILS_MAX_THREADS' => '2',
+      'SECRET_KEY_BASE' => 'bench',
+      'RAILS_ENV' => 'production',
+      'SSL_DISABLE' => 'yup',
+      'PORT' => '5000'
+    }
+    config.regexps = [ # Used to get results from the output of benchmark tools
+      {
+        name: 'Average time per request (ms)',
+        regexp: /Time\s+per\s+request:\s+([0-9.]*).*\(mean\)/
+      }, {
+        name: 'Requests per second (#)',
+        regexp: /Requests\s+per\s+second:\s+([0-9.]*).*\(mean\)/
+      }
+    ]
+    config.routes = [
+      {
+        name: 'candidates_per_25',
+        route: '/candidates',
+        method: :get,
+        title: 'GET /candidates'
+      }
+    ].freeze
+  end
+end
+```
+
+Next, add this to your Rakefile:
+
+```ruby
+require 'rails_api_benchmark/benchmark_tasks'
+```
+
+You can now run `rake api:benchmark` !
+
+## Contributing
+Contributions are welcome
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+### TODO
+* POST requests
+* Create Formatter class to avoid dirty code in Endpoint
+* Create markdown template to embed nicely on github (Mustache)
+* Create generators (for config initializer first)
+* Add simplecov to permit controller coverage for example
+* Generate documentation page(s) (markdown) to list the results

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsApiBenchmark'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+# require 'rake/testtask'
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << 'test'
+#   t.pattern = 'test/**/*_test.rb'
+#   t.verbose = false
+# end
+
+# task default: :test

data/lib/rails_api_benchmark/benchmark_tasks.rb

@@ -0,0 +1,20 @@
+module RailsApiBenchmark
+  class BenchmarkTasks
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      namespace :api do
+        desc 'Runs Rails API benchmark'
+        task benchmark: :environment do # Gosh, that's dirty !
+          puts RailsApiBenchmark.config.all
+          RailsApiBenchmark::Server.run
+          sleep(3) # Leave time to boot
+          RailsApiBenchmark::Core.run
+          RailsApiBenchmark::Subprocess.kill_all
+        end
+      end
+    end
+  end
+end
+
+RailsApiBenchmark::BenchmarkTasks.new.install_tasks

data/lib/rails_api_benchmark/core.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RailsApiBenchmark
+  class Core
+    include Logging
+
+    class << self
+      def run
+        logger.info 'Begin benchmark...'
+        RailsApiBenchmark.config.routes.each do |route|
+          puts route[:name]
+          Endpoint.new(route).benchmark
+          Endpoint.new(route).query
+        end
+        logger.info 'DONE!'
+      end
+    end
+  end
+end

data/lib/rails_api_benchmark/endpoint.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RailsApiBenchmark
+  class Endpoint
+    include Logging
+
+    attr_reader :name, :route, :method, :title
+
+    def initialize(opts)
+      @name = opts[:name]
+      @route = opts[:route]
+      @method = opts[:method]
+      @title = opts[:title]
+      @response = nil
+      @results = []
+      @results_folder = "#{RailsApiBenchmark.config.results_folder}/#{@name}"
+    end
+
+    def benchmark
+      benchmark_cmd = RailsApiBenchmark.config.bench_cmd
+      opts = RailsApiBenchmark.config.all.merge(route: @route)
+
+      output = `#{benchmark_cmd % opts}`
+
+      regexps = RailsApiBenchmark.config.regexps
+      regexps.each { |r| @results << output.scan(r[:regexp]) }
+    end
+
+    def query
+      curl_cmd = RailsApiBenchmark.config.curl_cmd
+      opts = RailsApiBenchmark.config.all.merge(route: @route)
+
+      @response = `#{curl_cmd % opts}`
+    end
+
+    private
+
+    def write_results
+      FileUtils.mkdir_p(@results_folder)
+      if @response
+        File.open(File.join(@results_folder, 'response.json'), 'w+') do |f|
+          f.write(@response)
+        end
+      end
+      unless @results.empty?
+        File.open(File.join(@results_folder, 'response.json'), 'w+') do |f|
+          f.write(@response)
+        end
+      end
+    end
+  end
+end

data/lib/rails_api_benchmark/logging.rb

@@ -0,0 +1,36 @@
+# module RailsApiBenchmark
+#   module Logging
+#     def logger
+#       Logging.logger
+#     end
+#
+#     def self.logger
+#       @logger ||= Logger.new(STDOUT)
+#     end
+#   end
+# end
+
+module RailsApiBenchmark
+  module Logging
+    class << self
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      attr_writer :logger
+    end
+
+    # Addition
+    def self.included(base)
+      class << base
+        def logger
+          Logging.logger
+        end
+      end
+    end
+
+    def logger
+      Logging.logger
+    end
+  end
+end

data/lib/rails_api_benchmark/server.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsApiBenchmark
+  class Server
+    def initialize
+      @cmd = RailsApiBenchmark.config.server_cmd
+      @env = RailsApiBenchmark.config.env_vars
+    end
+
+    def run
+      Subprocess.new(@cmd, @env)
+    end
+
+    def self.run
+      new.run
+    end
+  end
+end

data/lib/rails_api_benchmark/subprocess.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module RailsApiBenchmark
+  class Subprocess
+    def self.kill_all
+      # Tried things, didn't work. This kills evrything
+      Process.kill('INT', -Process.getpgrp)
+    end
+
+    def initialize(cmd, env)
+      Process.spawn(env, cmd)
+    end
+  end
+end

data/lib/rails_api_benchmark/version.rb

@@ -0,0 +1,3 @@
+module RailsApiBenchmark
+  VERSION = '0.1.1'.freeze
+end

data/lib/rails_api_benchmark.rb

@@ -0,0 +1,31 @@
+require 'rails_api_benchmark/logging'
+require 'rails_api_benchmark/server'
+require 'rails_api_benchmark/core'
+require 'rails_api_benchmark/subprocess'
+require 'rails_api_benchmark/endpoint'
+
+module RailsApiBenchmark
+  class Config
+    attr_accessor :concurrency, :nb_requests, :auth_header,
+                  :server_cmd, :bench_cmd, :curl_cmd, :results_folder,
+                  :regexps, :env_vars, :routes, :host
+    def all
+      instance_variables.inject({}) do |h, v|
+        var = v.to_s.sub('@', '')
+        h.merge(var.to_sym => send(var))
+      end
+    end
+  end
+
+  class << self
+    attr_writer :config
+
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_benchmark
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Terry Raimondo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.99.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.99.4
+description: Benchmark your API endpoints and get the results fast ! This gem leverages
+  the power of ApacheBench, but can be configured with another benchmark tool
+email:
+- terry.raimondo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails_api_benchmark.rb
+- lib/rails_api_benchmark/benchmark_tasks.rb
+- lib/rails_api_benchmark/core.rb
+- lib/rails_api_benchmark/endpoint.rb
+- lib/rails_api_benchmark/logging.rb
+- lib/rails_api_benchmark/server.rb
+- lib/rails_api_benchmark/subprocess.rb
+- lib/rails_api_benchmark/version.rb
+homepage: https://github.com/terry90/rails_api_benchmark
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: RailsApiBenchmark is a benchmark tool for your Rails API
+test_files: []