rails_api_benchmark 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16e76dc43a1a8457ffc51885a838b224bbb2f37d
-  data.tar.gz: 44020a8c4cd7bae78d0c758653d1f45f0244b9ba
+  metadata.gz: a90d0eb56db8b3b59f332bddfc6922a04d665bf0
+  data.tar.gz: 5da05eee4add84cc3ad4de8121cdbfaf912a1a14
 SHA512:
-  metadata.gz: 36f8f6ec137d2227ef6b9b9b7bc7759d0c4068aa7c094fad84c1d5c2226a9f54e4a0ac04b0ba10a4b3ed8f7885cf60f3a1b868070578c64ec99807a7b8e00d65
-  data.tar.gz: 57695424f8624fa90b5117b63e050fdd79c22d38ba2518612423e18a43e73f1eafed84cd5dadc8050975cf018f50320ed698e9a2199d91f75ba4637b77f7b265
+  metadata.gz: 02d6a923a95a529fcc83552f5e40b6988cb2b22449ee964af315bd867e69c45521e43d146a3251f54d4d623fdf84d6670272956ec2d83d8c346ea1ffd8b9de9d
+  data.tar.gz: 0fda977c19ab3012a0b2ba4a47c1a3d3f5a96e72770a5e17a1c2e567b345416da3b30d5dbb05dfc05a238499bb5fb2b3232e21c9e46dd265616ba3f6e2f3e7fe

data/README.md

@@ -6,6 +6,12 @@ Work in progress, yet you can use it like this.
 
 Run it with rake api:benchmark
 
+## Important
+
+* Only JSON responses are supported yet
+* Only GET requests are supported yet
+* Configuration is not validated
+
 ## Installation
 
 Install gnuplot (Google)
@@ -47,9 +53,11 @@ unless Rails.env.production?
     }
     config.regexps = [ # Used to get results from the output of benchmark tools
       {
+        key: :response_time,
         name: 'Average time per request (ms)',
         regexp: /Time\s+per\s+request:\s+([0-9.]*).*\(mean\)/
       }, {
+        key: :req_per_sec,
         name: 'Requests per second (#)',
         regexp: /Requests\s+per\s+second:\s+([0-9.]*).*\(mean\)/
       }
@@ -82,8 +90,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ### 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/lib/rails_api_benchmark/benchmark_tasks.rb

@@ -10,7 +10,8 @@ module RailsApiBenchmark
           RailsApiBenchmark::Server.run
           sleep(3) # Leave time to boot
           RailsApiBenchmark::Core.run
-          RailsApiBenchmark::Subprocess.kill_all
+
+          at_exit { RailsApiBenchmark::Subprocess.kill_all }
         end
       end
     end

data/lib/rails_api_benchmark/core.rb

@@ -4,15 +4,36 @@ 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!'
+    def self.run
+      new.run
+    end
+
+    def initialize
+      @config = RailsApiBenchmark.config
+    end
+
+    def run
+      init_files
+      @config.routes.each do |route|
+        e = Endpoint.new(route)
+        res = e.run_benchmark
+        write_results(e, res)
+      end
+      create_index
+    end
+
+    def write_results(endpoint, results)
+      Renderer.new(endpoint, results).process
+    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
     end
   end

data/lib/rails_api_benchmark/endpoint.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module RailsApiBenchmark
   class Endpoint
     include Logging
@@ -11,11 +13,16 @@ module RailsApiBenchmark
       @route = opts[:route]
       @method = opts[:method]
       @title = opts[:title]
-      @response = nil
-      @results = []
+      @results = {}
       @results_folder = "#{RailsApiBenchmark.config.results_folder}/#{@name}"
     end
 
+    def run_benchmark
+      query
+      benchmark
+      @results
+    end
+
     def benchmark
       benchmark_cmd = RailsApiBenchmark.config.bench_cmd
       opts = RailsApiBenchmark.config.all.merge(route: @route)
@@ -23,14 +30,14 @@ module RailsApiBenchmark
       output = `#{benchmark_cmd % opts}`
 
       regexps = RailsApiBenchmark.config.regexps
-      regexps.each { |r| @results << output.scan(r[:regexp]) }
+      regexps.each { |r| @results[r[:key]] = output.scan(r[:regexp]).flatten.first }
     end
 
     def query
       curl_cmd = RailsApiBenchmark.config.curl_cmd
       opts = RailsApiBenchmark.config.all.merge(route: @route)
 
-      @response = `#{curl_cmd % opts}`
+      @results[:response] = JSON.pretty_generate(JSON.parse(`#{curl_cmd % opts}`))
     end
 
     private

data/lib/rails_api_benchmark/graph.rb

@@ -0,0 +1,23 @@
+module RailsApiBenchmark
+  class Graph
+    def initialize(target, output_dir)
+      @output_dir = output_dir
+      @target = target
+    end
+
+    def generate
+      run
+      copy_file
+    end
+
+    def run
+      gnuplotscript = File.expand_path('../../../gnuplotscript', __FILE__)
+      `gnuplot -e "plot_title='Benchmark #{@target.title}'; plot_file='#{@target.name}_plot.jpg'" #{gnuplotscript}`
+    end
+
+    def copy_file
+      dest = File.join(@output_dir)
+      FileUtils.mv("#{@target.name}_plot.jpg", dest)
+    end
+  end
+end

data/lib/rails_api_benchmark/logging.rb

@@ -1,15 +1,3 @@
-# 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
@@ -20,7 +8,6 @@ module RailsApiBenchmark
       attr_writer :logger
     end
 
-    # Addition
     def self.included(base)
       class << base
         def logger

data/lib/rails_api_benchmark/renderer.rb

@@ -0,0 +1,27 @@
+module RailsApiBenchmark
+  class Renderer
+    attr_reader :output_dir, :target, :results
+
+    def initialize(target, results)
+      @output_dir = RailsApiBenchmark.config.results_folder
+      @target = target
+      @results = results
+    end
+
+    def process
+      Graph.new(@target, @output_dir).generate
+      generate_view
+    end
+
+    private
+
+    def generate_view
+      view = Views::ResultsMarkdown.new(target, results)
+      dest = File.join(@output_dir, view.file_path)
+      FileUtils.mkdir_p(File.dirname(dest))
+      File.open(File.join(@output_dir, view.file_path), 'w') do |file|
+        file << view.render
+      end
+    end
+  end
+end

data/lib/rails_api_benchmark/results_markdown.rb

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,21 @@
+# {{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}}

data/lib/rails_api_benchmark/version.rb

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

data/lib/rails_api_benchmark/views/index_markdown.rb

@@ -0,0 +1,22 @@
+require 'mustache'
+
+module RailsApiBenchmark
+  module Views
+    class IndexMarkdown < View
+      attr_reader :routes, :nb_routes, :config
+
+      def initialize(routes)
+        super
+        @file_name = 'README'
+        @config = RailsApiBenchmark.config.all
+        @routes = routes
+        @nb_routes = routes.count
+      end
+
+      # Maybe put this in a superclass like MarkdownView to DRY
+      def extension
+        'md'
+      end
+    end
+  end
+end

data/lib/rails_api_benchmark/views/results_markdown.rb

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

data/lib/rails_api_benchmark/views/view.rb

@@ -0,0 +1,37 @@
+require 'mustache'
+
+module RailsApiBenchmark
+  module Views
+    class View < Mustache
+      def initialize(*_args)
+        @template_path = File.expand_path('../../templates', __FILE__)
+      end
+
+      def file_name
+        "#{@file_name}.#{extension}"
+      end
+
+      def file_path
+        [folder, file_name].compact.join('/')
+      end
+
+      def folder
+        nil
+      end
+
+      private
+
+      def template_name # Avoid module
+        self.class.name
+            .split('::').last
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+      end
+    end
+  end
+end
+
+require_relative 'results_markdown'
+require_relative 'index_markdown'

data/lib/rails_api_benchmark.rb

@@ -1,8 +1,11 @@
 require 'rails_api_benchmark/logging'
 require 'rails_api_benchmark/server'
 require 'rails_api_benchmark/core'
+require 'rails_api_benchmark/renderer'
+require 'rails_api_benchmark/graph'
 require 'rails_api_benchmark/subprocess'
 require 'rails_api_benchmark/endpoint'
+require 'rails_api_benchmark/views/view' # Requires all the views
 
 module RailsApiBenchmark
   class Config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_benchmark
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Terry Raimondo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,10 +59,18 @@ files:
 - lib/rails_api_benchmark/benchmark_tasks.rb
 - lib/rails_api_benchmark/core.rb
 - lib/rails_api_benchmark/endpoint.rb
+- 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/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/version.rb
+- lib/rails_api_benchmark/views/index_markdown.rb
+- lib/rails_api_benchmark/views/results_markdown.rb
+- lib/rails_api_benchmark/views/view.rb
 homepage: https://github.com/terry90/rails_api_benchmark
 licenses:
 - MIT