rails_api_benchmark 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc553c272bb5f42a3b765748336af37be9503e74
-  data.tar.gz: 6cff65ef9d213d09b809fdc7d3b237a53707e824
+  metadata.gz: 11d43775977eaa602c80e9a4fe751dae26a0ba14
+  data.tar.gz: d134a38f1b2daaac6c8b2014cc2f50b81c93edab
 SHA512:
-  metadata.gz: 144655c6afb4d8711864152918a5f78e6bbbdc0f2a5d56e61cd59fa62e205eb36c8b8453794a024903d0baf0df9a06acda0a5cd5fb05ffdae260951eec6f7f20
-  data.tar.gz: faeda2140659f2f4d7a509c447ddde94813b770013b997963f1d91ef0651cfb90043f42fd301bc5c30d0960c3888450cb666e3c2cd5d260e8c48b7b2e46ee290
+  metadata.gz: 742f151da69b6eee0a0c93357dbccb4af28b03e770c2645685ca10852e15a635fc096f1e1f7b0b605e25382c54806d553c9bf954ed1d87e9964a4840b4bb59b3
+  data.tar.gz: 5b4dd39b9977699cbb638f912debf6f89281e7c26a8275f83eb9c29f28bc69e3401820942912b2934a6c1a6a8fe7b13ee3db87068503922ce907f991b344b95c

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 Doc
+Copyright 2017 Terry Raimondo
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -27,7 +27,8 @@ Example output:
   "bench_cmd": "ab -n %{nb_requests} -c %{concurrency} -g plot.tsv -H \"%{auth_header}\" http://%{host}%{route}",
   "server_cmd": "bundle exec puma",
   "env_vars": {
-    "RAILS_MAX_THREADS": "2"
+    "RAILS_MAX_THREADS": "2",
+    "RAILS_ENV": "production"
   },
   "regexps": [
     {

data/lib/rails_api_benchmark/core.rb

@@ -10,31 +10,37 @@ module RailsApiBenchmark
 
     def initialize
       @config = RailsApiBenchmark.config
+      @resultset = ResultSet.new
+      init_files
+      write_index
     end
 
     def run
-      init_files
       @config.routes.each do |route|
         e = Endpoint.new(route)
         res = e.run_benchmark
-        write_results(e, res)
+        @resultset.add(e, res)
       end
-      create_index
+      @resultset.compute_relative_speed
+      write_results
     end
 
-    def write_results(endpoint, results)
-      Renderer.new(endpoint, results).process
+    private
+
+    def write_results
+      Views::SummaryMarkdown.new(@resultset).write if @config.summary
+
+      @resultset.each_result do |endpoint, results|
+        Renderer.new(endpoint, results).process
+      end
     end
 
     def init_files
       FileUtils.mkdir_p(@config.results_folder)
     end
 
-    def create_index
-      view = Views::IndexMarkdown.new(@config.routes)
-      File.open(File.join(@config.results_folder, view.file_name), 'w') do |file|
-        file << view.render
-      end
+    def write_index
+      Views::IndexMarkdown.new.write
     end
   end
 end

data/lib/rails_api_benchmark/logging.rb

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

data/lib/rails_api_benchmark/result_set.rb

@@ -0,0 +1,48 @@
+module RailsApiBenchmark
+  class ResultSet
+    attr_reader :results
+
+    def initialize
+      @results = []
+    end
+
+    def add(endpoint, results)
+      @results << { endpoint: endpoint, results: results }
+    end
+
+    def averages
+      rps = @results.map { |v| v[:results][:req_per_sec] }.compact
+      rt = @results.map { |v| v[:results][:response_time] }.compact
+
+      avg_rps = rps.inject(0) { |sum, v| sum + v.to_i } / rps.count
+      avg_rt = rt.inject(0) { |sum, v| sum + v.to_i } / rt.count
+
+      { req_per_sec: avg_rps, response_time: avg_rt }
+    end
+
+    # Returns only the results with the relative speed
+    def compute_relative_speed
+      @results = @results.map do |r|
+        avgs = averages
+        res = r[:results]
+
+        avg_rt = avgs[:response_time]
+        avg_rps = avgs[:req_per_sec]
+
+        f_rt = ((res[:response_time].to_f - avg_rt) / avg_rt * 100).round(1)
+        f_rps = ((res[:req_per_sec].to_f - avg_rps) / avg_rps * 100).round(1)
+        r.merge(factors: { response_time: f_rt, req_per_sec: f_rps })
+      end
+    end
+
+    # Use it like this:
+    # resultset.each_result do |endpoint, results|
+    #   ...
+    # end
+    def each_result
+      @results.each do |r|
+        yield r[:endpoint], r[:results]
+      end
+    end
+  end
+end

data/lib/rails_api_benchmark/templates/index_markdown.erb

@@ -0,0 +1,23 @@
+# Benchmark
+
+**Configuration:**
+- Concurrency: <%= @config.concurrency %>
+- Request nb: <%= @config.nb_requests %>
+- Host: <%= @config.host %>
+
+## Endpoints tested (<%= @nb_routes -%>)
+
+[See results summary](summary.md)
+
+<% @routes.each do |r| -%>
+### <%= r[:title] %>
+* Name: <%= r[:name] %>
+
+* Route: <%= r[:route] %>
+
+<% if r[:description] %>
+* Description: <%= r[:description] %>
+<% end %>
+
+[See results](<%= r[:name] -%>/results.md)
+<% end %>

data/lib/rails_api_benchmark/templates/results_markdown.erb

@@ -0,0 +1,15 @@
+# <%= @target.title %>
+
+### Results
+
+Requests per second: <%= @results[:req_per_sec] %> #
+
+Average response time: <%= @results[:response_time] %> ms
+
+### Graph
+![<%= @target.title %>](../<%= @target.name %>_plot.jpg?raw=true "<%= @target.title %>")
+
+### Response
+```json
+<%= @results[:response] %>
+```

data/lib/rails_api_benchmark/templates/summary_markdown.erb

@@ -0,0 +1,19 @@
+# Summary:
+
+* Average response time: **<%= @avg[:response_time] -%> ms**
+* Average requests per sec: **<%= @avg[:req_per_sec] -%> #**
+
+|Route|Response time factor|Request per second factor|
+|---|---|---|
+<% @results.sort_by { |v| -v[:factors][:response_time] }.each do |r| -%>
+<%
+  rps = r[:factors][:req_per_sec]
+  rt = r[:factors][:response_time]
+ -%>
+ <%# I don't care about magic string values, it's templating %>
+  <%=
+    "|#{r[:endpoint].title}" \
+    "|#{rt.abs} % #{rt < 0 ? 'faster than average' : 'slower than average'}" \
+    "|#{rps.abs} % #{rps >= 0 ? 'more than average' : 'less than average'}|\n"
+   -%>
+<% end %>

data/lib/rails_api_benchmark/version.rb

@@ -1,3 +1,3 @@
 module RailsApiBenchmark
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

data/lib/rails_api_benchmark/views/index_markdown.rb

@@ -5,11 +5,10 @@ module RailsApiBenchmark
     class IndexMarkdown < View
       attr_reader :routes, :nb_routes, :config
 
-      def initialize(routes)
+      def initialize
         super
         @file_name = 'README'
-        @config = RailsApiBenchmark.config.all
-        @routes = routes
+        @routes = @config.routes
         @nb_routes = routes.count
       end
 

data/lib/rails_api_benchmark/views/summary_markdown.rb

@@ -0,0 +1,21 @@
+require 'mustache'
+
+module RailsApiBenchmark
+  module Views
+    class SummaryMarkdown < View
+      attr_reader :results, :avg
+
+      def initialize(resultset)
+        super
+        @file_name = 'summary'
+        @results = resultset.results
+        @avg = resultset.averages
+      end
+
+      # Maybe put this in a superclass like MarkdownView to DRY
+      def extension
+        'md'
+      end
+    end
+  end
+end

data/lib/rails_api_benchmark/views/view.rb

@@ -1,22 +1,36 @@
-require 'mustache'
+require 'erubis'
 
 module RailsApiBenchmark
   module Views
-    class View < Mustache
+    class View
       def initialize(*_args)
+        @config = RailsApiBenchmark.config
         @template_path = File.expand_path('../../templates', __FILE__)
       end
 
+      # Override this method in your view
       def file_name
         "#{@file_name}.#{extension}"
       end
 
+      # Override this method in your view
+      def folder
+        nil
+      end
+
       def file_path
         [folder, file_name].compact.join('/')
       end
 
-      def folder
-        nil
+      def write
+        File.open(File.join(@config.results_folder, file_path), 'w') do |file|
+          file << render
+        end
+      end
+
+      def render
+        template = File.read(File.join(@template_path, "#{template_name}.erb"))
+        Erubis::Eruby.new(template).result(binding)
       end
 
       private
@@ -34,4 +48,5 @@ module RailsApiBenchmark
 end
 
 require_relative 'results_markdown'
+require_relative 'summary_markdown'
 require_relative 'index_markdown'

data/lib/rails_api_benchmark.rb

@@ -3,6 +3,7 @@ require 'rails_api_benchmark/server'
 require 'rails_api_benchmark/core'
 require 'rails_api_benchmark/renderer'
 require 'rails_api_benchmark/graph'
+require 'rails_api_benchmark/result_set'
 require 'rails_api_benchmark/subprocess'
 require 'rails_api_benchmark/endpoint'
 require 'rails_api_benchmark/views/view' # Requires all the views
@@ -11,7 +12,7 @@ module RailsApiBenchmark
   class Configuration
     attr_accessor :concurrency, :nb_requests, :auth_header,
                   :server_cmd, :bench_cmd, :curl_cmd, :results_folder,
-                  :regexps, :env_vars, :routes, :host
+                  :regexps, :env_vars, :routes, :host, :summary
 
     # Default values, INSANE. Must be refactored
     # Maybe create a yaml or json file to import for default values
@@ -23,6 +24,7 @@ module RailsApiBenchmark
                   ' -H "%{auth_header}" http://%{host}%{route}'
       self.curl_cmd = 'curl -H "%{auth_header}" http://%{host}%{route}'
       self.results_folder = 'benchmark'
+      self.summary = true
       self.regexps = [
         {
           key: :response_time,
@@ -35,10 +37,11 @@ module RailsApiBenchmark
         }
       ]
       self.env_vars = {
-        'RAILS_MAX_THREADS' => 2,
-        'SSL_DISABLE' => true,
-        'SECRET_KEY_BASE' => '123',
-        'PORT' => 5000
+        'RAILS_MAX_THREADS' => '2',
+        'RAILS_ENV' => 'production',
+        'SSL_DISABLE' => 'true',
+        'SECRET_KEY_BASE' => 'a1b2c3',
+        'PORT' => '5000'
       }
       self.routes = []
       self.host = 'localhost:5000'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_benchmark
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Terry Raimondo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,25 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.1.2
 - !ruby/object:Gem::Dependency
-  name: mustache
+  name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.99.4
+        version: '0'
   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
+        version: '0'
 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:
@@ -65,14 +59,16 @@ files:
 - lib/rails_api_benchmark/graph.rb
 - lib/rails_api_benchmark/logging.rb
 - lib/rails_api_benchmark/renderer.rb
-- lib/rails_api_benchmark/results_markdown.rb
+- lib/rails_api_benchmark/result_set.rb
 - lib/rails_api_benchmark/server.rb
 - lib/rails_api_benchmark/subprocess.rb
-- lib/rails_api_benchmark/templates/index_markdown.mustache
-- lib/rails_api_benchmark/templates/results_markdown.mustache
+- lib/rails_api_benchmark/templates/index_markdown.erb
+- lib/rails_api_benchmark/templates/results_markdown.erb
+- lib/rails_api_benchmark/templates/summary_markdown.erb
 - lib/rails_api_benchmark/version.rb
 - lib/rails_api_benchmark/views/index_markdown.rb
 - lib/rails_api_benchmark/views/results_markdown.rb
+- lib/rails_api_benchmark/views/summary_markdown.rb
 - lib/rails_api_benchmark/views/view.rb
 homepage: https://github.com/terry90/rails_api_benchmark
 licenses:

data/lib/rails_api_benchmark/results_markdown.rb

@@ -1,29 +0,0 @@
-require 'mustache'
-
-module RailsApiBenchmark
-  module Views
-    class ResultsMarkdown < View
-      attr_reader :title, :req_per_sec, :response_time
-
-      def initialize(target, results)
-        super
-        @title = target.title
-        @req_per_sec = results[:req_per_sec] || 'Unknown'
-        @response_time = results[:response_time] || 'Unknown'
-      end
-
-      # Maybe put this in a superclass like MarkdownView to DRY
-      def extension
-        'md'
-      end
-
-      def file_name
-        'results'
-      end
-
-      def folder
-        @target.name
-      end
-    end
-  end
-end

data/lib/rails_api_benchmark/templates/index_markdown.mustache

@@ -1,26 +0,0 @@
-# Benchmark results:
-
-{{#config}}
-**Configuration:**
-- Concurrency: {{concurrency}}
-- Request nb: {{nb_requests}}
-- Host: {{host}}
-{{/config}}
-
-## Endpoints tested ({{nb_routes}})
-
-{{#routes}}
-{{#.}}
-### {{title}}
-* Name: {{name}}
-
-* Route: {{route}}
-
-{{#description}}
-* Description: {{description}}
-{{/description}}
-
-[See results]({{name}}/results.md)
-
-{{/.}}
-{{/routes}}

data/lib/rails_api_benchmark/templates/results_markdown.mustache

@@ -1,21 +0,0 @@
-# {{title}}
-
-### Results
-
-{{#results}}
-Requests per second: {{req_per_sec}} #
-
-Average response time: {{response_time}} ms
-{{/results}}
-
-{{#target}}
-### Graph
-![{{title}}](../{{name}}_plot.jpg?raw=true "{{title}}")
-{{/target}}
-
-### Response
-{{#results}}
-```json
-{{{response}}}
-```
-{{/results}}