rubybench_runner 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a40314304c75a5bdd11df55abb49b8df15acb8d18b56ff648bc4b605283e578
-  data.tar.gz: 668309018a75e3c6aae9c8e2dc6b4cff38ea0803a2596b2d310819660fe9db43
+  metadata.gz: 4883f9435daeba8053226ff6256bd319f3af8f2200f3bfba7c96cb230fdd7e9b
+  data.tar.gz: 204755d83b2a496893bce8cb22c7288abeccd4ec44943d44c4703e90f57be32e
 SHA512:
-  metadata.gz: 01ac42da2673c614f869789cc5da2ef64fbcded01ddac548eb6ff2d6494edc18b6c912b31d1687aa4379007e470aaac9dfa5a324070e7f50c1946152ddb90f69
-  data.tar.gz: 4fa380cad1ac800a25174e6e8bce37683e273e8753816005c882fdc23b6cc8683f7ea87214f5337413340b0bee06c6a7468344f82c8ee30854fe5809237c5e71
+  metadata.gz: 75f582c907dc3c795312be9fcd7f49adffd0d0f342d56fda1b06f88501aed0db1e32a8c530fa35b9d6e6737729dedce341874a43eba0ed788ba36e8300642fc6
+  data.tar.gz: ee1e4932c05689b15fadadaee4e20ed232b4e897051e354e81544992221af7d79a123eb75d6808048241bf75df10e975c35ecfda69f0ee5d02f50416602aaa3f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+- 2019-06-18: 0.1.4
+
+  - Various enhancements and refactoring (# e07199a)
+
 - 2019-06-16: 0.1.3
 
   - FIX: Do not install gems needed for dp setup unless the benchmark need them (# efad3ce)

data/exe/rubybench_runner

@@ -4,10 +4,18 @@
 $:.unshift File.expand_path('../lib', __dir__)
 
 require 'rubybench_runner'
-
 require 'optparse'
 
+RUN = "run"
+HELP = "help"
+
 command = ARGV[0]
+repo = ""
+script = ""
+
+if command == RUN
+  repo, script = ARGV[1].split("/", 2)
+end
 
 options = {}
 OptionParser.new do |opts|
@@ -15,12 +23,11 @@ OptionParser.new do |opts|
     Usage: rubybench_runner [command] [args] [options]
 
     commands:
-      * run <repo_name> <script_url> <local_path> [options]
+      * #{RUN} <repo_name>/<script_name> [options]
         <repo_name> is one the repos that are benchmarked on rubybench.org. Valid options are: `rails`
-        <script_url> is a direct link to the benchmark you want to run.
-        <local_path> is a path to your local clone of repo_name (e.g. ~/rails)
+        <script_name> is the name of the benchmark from rubybench.org e.g. bm_activerecord_finders_find_by_attributes.rb.
 
-      * help
+      * #{HELP}
         Show help
 
     Available options:
@@ -43,7 +50,7 @@ OptionParser.new do |opts|
     end
   end
 
-  opts.on("-c", "--repeat-count=COUNT", Integer, "Number of times to run the benchmark (default 2)") do |c|
+  opts.on("-c", "--repeat-count=COUNT", Integer, "Number of times to run the benchmark (default 1)") do |c|
     options[:repeat_count] = c
   end
 
@@ -71,7 +78,7 @@ OptionParser.new do |opts|
     options[:cleanup] = true
   end
 
-  opts.on("-wps", "--with-prepared-statements", "Run benchmarks with prepared statements") do
+  opts.on("--wps", "--with-prepared-statements", "Run benchmarks with prepared statements") do
     options[:wps] = true
   end
 
@@ -84,14 +91,23 @@ OptionParser.new do |opts|
     puts opts
     exit 0
   end
+
+  opts.on("--url=URL", "Direct link to a benchmark script") do |url|
+    options[:url] = url
+  end
+
+  RubybenchRunner::SUPPORTED_REPOS.each do |name, _|
+    if repo == name.to_s
+      opts.on("--#{name}=PATH", "Provide local path to #{name}") do |path|
+        options[name] = File.expand_path(path)
+      end
+    end
+  end
 end.parse!
 
-if command == "run"
-  repo_name = ARGV[1]
-  script_url = ARGV[2]
-  repo_path = File.expand_path(ARGV[3])
-  RubybenchRunner.run(repo_name, script_url, repo_path, options)
-elsif command == "help"
+if command == RUN
+  RubybenchRunner.run(repo, script, options)
+elsif command == HELP
   puts opts
 else
   puts "Unknown command #{command}"

data/lib/rubybench_runner.rb

@@ -6,12 +6,16 @@ require 'yaml'
 require 'fileutils'
 require 'tmpdir'
 require 'ostruct'
+require 'open3'
 
 require 'rubybench_runner/version'
-require 'rubybench_runner/base_runner'
 require 'rubybench_runner/dependencies_checker'
 require 'rubybench_runner/configurations'
+require 'rubybench_runner/base_runner'
 require 'rubybench_runner/rails_runner'
 
 module RubybenchRunner
+  SUPPORTED_REPOS = {
+    rails: RailsRunner
+  }
 end

data/lib/rubybench_runner/base_runner.rb

@@ -1,11 +1,14 @@
 module RubybenchRunner
-  def self.run(repo, script_url, repo_path, opts = {})
-    if repo == "rails"
-      klass = RubybenchRunner::RailsRunner
-    else
-      raise "Unknown repo #{repo}"
+  class ShellError < StandardError; end
+
+  def self.run(repo, script, opts = {})
+    SUPPORTED_REPOS.each do |name, klass|
+      if repo == name.to_s
+        klass.new(script, opts).run
+        return
+      end
     end
-    klass.new(script_url, repo_path, opts).run
+    raise "Unknown repo #{repo}"
   end
 
   class BaseRunner
@@ -27,18 +30,19 @@ module RubybenchRunner
       round: 2
     }
 
-    def initialize(url, repo_path, opts = {})
-      @script_url = normalize_url(url)
-      @repo_path = repo_path
+    def initialize(script, opts = {})
+      @script_name = script
       @opts = OpenStruct.new(DEFAULT_OPTS.merge(opts))
+      @script_url = @opts.url || script_full_url(script)
       @results = []
       @error = nil
       @output = ""
     end
 
     def run
-      create_tmpdir
+      set_repo_path
       cleanup(before: true)
+      create_tmpdir
       check_dependencies
       write_gemfile
       bundle_install
@@ -51,6 +55,33 @@ module RubybenchRunner
       cleanup(after: true)
     end
 
+    def possible_repo_path
+      File.join(Dir.home, benchmark_name.downcase)
+    end
+
+    def is_repo_path_valid?
+      true
+    end
+
+    def set_repo_path
+      name = benchmark_name.downcase
+      from_opts = false
+      if path = opts.send(name)
+        from_opts = true
+        @repo_path = path
+      else
+        @repo_path = possible_repo_path
+        log("Running #{name} benchmark #{@script_name}: #{name} path is #{possible_repo_path}\n")
+      end
+
+      unless is_repo_path_valid?
+        output = "Cannot find #{name} at #{@repo_path}."
+        output += "Perhaps try:\n\nrubybench_runner run #{name}/#{@script_name} --#{name}=/path/to/#{name}" unless from_opts
+        log(output, f: true)
+        exit 1
+      end
+    end
+
     def dest_dir
       # directory where all helpers and gems will be installed/copied to
       @dest_dir ||= File.join(Dir.tmpdir, "rubybench_runner_tmp")
@@ -161,12 +192,17 @@ module RubybenchRunner
     end
 
     def run_benchmarks
+      return if @error
       log("Running benchmarks...")
       Dir.chdir(script_path) do
         opts.repeat_count.times do |n|
-          res = `#{command}`
-          @results[n] = res
-          @results[n] = JSON.parse(res)
+          res, err = Open3.capture3(command)
+          if err.size == 0
+            @results[n] = res
+            @results[n] = JSON.parse(res)
+          else
+            raise ShellError.new(err)
+          end
         end
       end
     rescue => err
@@ -193,18 +229,21 @@ module RubybenchRunner
       if @error
         @output = <<~OUTPUT
           An error occurred while running the benchmarks:
-          Error: #{@error.message}
+          Error #{@error.class}: #{@error.message}
           Backtrace:
           #{@error.backtrace.join("\n")}
-          ------
-          Raw results until this error:
-          #{@results}
         OUTPUT
+        if @results.size > 0
+          @output += <<~OUTPUT
+            ------
+            Raw results until this error:
+            #{@results}
+          OUTPUT
+        end
       else
         label = @results.first['label']
         version = @results.first['version']
         @output = "#{benchmark_name} version #{version}\n"
-        @output += "Benchmark name: #{label}\n"
         @output += "Results (#{@results.size} runs):\n"
         @results.map!.with_index do |res, ind|
           res.delete('label')
@@ -245,6 +284,9 @@ module RubybenchRunner
       log("Downloading script...")
       content = open(script_url).read
       File.write(script_full_path, content)
+    rescue OpenURI::HTTPError => e
+      log("Script download failed #{script_url}", f: true)
+      @error = e
     end
 
     def write_gemfile
@@ -254,8 +296,8 @@ module RubybenchRunner
 
     private
 
-    def log(msg)
-      return if opts.quiet
+    def log(msg, f: false)
+      return if opts.quiet && !f
       puts msg
     end
 
@@ -272,12 +314,11 @@ module RubybenchRunner
       FileUtils.rm_rf(dest_dir) if (opts.fresh_run && before) || (opts.cleanup && after)
     end
 
-    def normalize_url(url)
-      if url =~ /^(https?:\/\/github.com)/
-        url.sub($1, "https://raw.githubusercontent.com").sub("/blob/", "/")
-      else
-        url
+    def script_full_url(script)
+      if script !~ /\.rb$/
+        script += ".rb"
       end
+      "https://raw.githubusercontent.com/ruby-bench/ruby-bench-suite/master/#{benchmark_name.downcase}/benchmarks/#{script}"
     end
 
     # small hack for dynamically installing/requiring gems.

data/lib/rubybench_runner/rails_runner.rb

@@ -8,6 +8,10 @@ module RubybenchRunner
       command
     end
 
+    def is_repo_path_valid?
+      File.exists?(File.join(repo_path, "rails.gemspec"))
+    end
+
     def database_url
       return @db_url if @db_url
       raw_config = RubybenchRunner::Configurations.new

data/lib/rubybench_runner/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubybenchRunner
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubybench_runner
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Osama Sayegh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-16 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug