rubybench_runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca15668599b749d7424f2af741069ee545fe8896858c4c672fcf09c79472ee95
+  data.tar.gz: 71201b051732cc8cf52865e8bc0a86406eb9059e2fbd9cf89678f674d17016a0
+SHA512:
+  metadata.gz: b4f64c8f8020652216c1be336580b4e8d4d7e5e7e605658fd631ee34fdd9338b8fd756b29273307aabb68c77445bb8578ed608289c9c7d062e42c5bcc3d01bfa
+  data.tar.gz: 645cfc04e1f8b679bb799be1cb50a5379b165113c56309517809830928534421a062cbe60834bfe93833b5668ad314a67bc01e94cb982558478cdf979ceb8b39

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+.byebug_history
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at asooomaasoooma90@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubybench_runner.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    rubybench_runner (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    mysql2 (0.5.2)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pg (1.1.4)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  minitest (~> 5.0)
+  mysql2 (= 0.5.2)
+  pg (= 1.1.4)
+  rake (~> 10.0)
+  rubocop (~> 0.70)
+  rubybench_runner!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 OsamaSayegh
+
+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,43 @@
+# RubybenchRunner
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubybench_runner`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubybench_runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubybench_runner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubybench_runner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RubybenchRunner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubybench_runner/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubybench_runner'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rubybench_runner

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$:.unshift File.expand_path('../lib', __dir__)
+
+require 'rubybench_runner'
+
+require 'optparse'
+
+command = ARGV[0]
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<~BANNER
+    Usage: rubybench_runner [command] [args] [options]
+
+    commands:
+      * run <repo_name> <script_url> <local_path> [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)
+
+      * help
+        Show help
+
+    Available options:
+  BANNER
+  opts.on("--db=DB", "Select database to use for the benchmarks. Valud options are: `postgres` and `mysql`") do |v|
+    v = v.strip.downcase
+    pg_options = %w{pg postgres postgresql}
+    mysql_options = %w{mysql mysql2}
+    if pg_options.include?(v)
+      options[:db] = "postgres"
+    elsif mysql_options.include?(v)
+      options[:db] = "mysql2"
+    else
+      puts <<~OUTPUT
+        Invalid --db value \"#{v}\". Valid options are: (case insensitive)
+          #{pg_options.first} (aliases: #{pg_options[1..-1].join(", ")})
+          #{mysql_options.first} (aliases: #{mysql_options[1..-1].join(", ")})
+      OUTPUT
+      exit 1
+    end
+  end
+
+  opts.on("-c", "--repeat-count=COUNT", Integer, "Number of times to run the benchmark (default 2)") do |c|
+    options[:repeat_count] = c
+  end
+
+  opts.on("--skip-dep-check", "Skip dependency checks performed before the benchmarks are run") do
+    options[:skip_dependencies_check] = true
+  end
+
+  opts.on("-r", "--round=ROUND", Integer, "Round results to the nearest value with a precision of N digits (default 2)") do |r|
+    options[:round] = r
+  end
+
+  opts.on("--quiet", "Be quite when the the benchmarks are being run") do
+    options[:quiet] = true
+  end
+
+  opts.on("--verbose", "Show extra informative output while the benchmarks are running") do
+    options[:verbose] = true
+  end
+
+  opts.on("--fresh", "Remove installed gems from previous runs and reinstall them for this run") do
+    options[:fresh_run] = true
+  end
+
+  opts.on("--cleanup", "Remove gems installed during this run after the run is complete") do
+    options[:cleanup] = true
+  end
+
+  opts.on("-wps", "--with-prepared-statements", "Run benchmarks with prepared statements") do
+    options[:wps] = true
+  end
+
+  opts.on("-v", "--version", "Display installed version of RubybenchRunner") do
+    puts RubybenchRunner::VERSION
+    exit 0
+  end
+
+  opts.on("-h", "--help", "Show help") do
+    puts opts
+    exit 0
+  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"
+  puts opts
+else
+  puts "Unknown command #{command}"
+  exit 1
+end
+
+# "https://github.com/ruby-bench/ruby-bench-suite/blob/master/rails/benchmarks/bm_activerecord_destroy.rb"

data/lib/rubybench_runner.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'json'
+require 'yaml'
+require 'fileutils'
+require 'tmpdir'
+require 'ostruct'
+
+require 'rubybench_runner/version'
+require 'rubybench_runner/base_runner'
+require 'rubybench_runner/dependencies_checker'
+require 'rubybench_runner/configurations'
+require 'rubybench_runner/rails_runner'
+
+module RubybenchRunner
+end

data/lib/rubybench_runner/base_runner.rb

@@ -0,0 +1,233 @@
+module RubybenchRunner
+  def self.run(repo, script_url, repo_path, opts = {})
+    if repo == "rails"
+      klass = RubybenchRunner::RailsRunner
+    else
+      raise "Unknown repo #{repo}"
+    end
+    klass.new(script_url, repo_path, opts).run
+  end
+
+  class BaseRunner
+    HELPERS_VERSION_FILE = "helpers_version"
+
+    COPY_FOLDERS = %w{
+      support
+      rails
+    }
+    attr_reader :script_url, :repo_path, :opts
+
+    DEFAULT_OPTS = {
+      repeat_count: 1,
+      quiet: false,
+      fresh_run: false,
+      skip_dependencies_check: false,
+      cleanup: false,
+      wps: false,
+      round: 2
+    }
+
+    def initialize(url, repo_path, opts = {})
+      @script_url = normalize_url(url)
+      @repo_path = repo_path
+      @opts = OpenStruct.new(DEFAULT_OPTS.merge(opts))
+      @results = []
+      @error = nil
+      @output = ""
+    end
+
+    def run
+      create_tmpdir
+      cleanup(before: true)
+      check_dependencies
+      download_script
+      write_gemfile
+      bundle_install
+      setup_db
+      run_benchmarks
+      process_results
+      print_results
+    ensure
+      cleanup(after: true)
+    end
+
+    def dest_dir
+      # directory where all helpers and gems will be installed/copied to
+      @dest_dir ||= File.join(Dir.tmpdir, "rubybench_runner_tmp")
+    end
+
+    def create_tmpdir
+      FileUtils.mkdir_p(dest_dir)
+      copy_helpers(dest_dir)
+    end
+
+    def copy_helpers(dest)
+      gem_helpers_version_path = File.join(__dir__, HELPERS_VERSION_FILE)
+      current_helpers_version_path = File.join(dest, HELPERS_VERSION_FILE)
+      if !File.exists?(current_helpers_version_path) ||
+        File.read(gem_helpers_version_path) != File.read(current_helpers_version_path)
+        FileUtils.cp(gem_helpers_version_path, current_helpers_version_path)
+        COPY_FOLDERS.each do |folder|
+          origin = File.join(__dir__, folder)
+          destination = File.join(dest, folder)
+          FileUtils.cp_r(origin, destination)
+        end
+      end
+    end
+
+    def save_dir
+      raise "Override the `save_dir` method in your subclass #{self.class.name}"
+    end
+
+    def gemfile_content
+      nil
+    end
+
+    def script_path
+      @script_path ||= File.join(save_dir, "benchmarks")
+    end
+
+    def script_full_path
+      @script_full_path ||= File.join(script_path, script_name)
+    end
+
+    def script_name
+      "script.rb"
+    end
+
+    def command
+      if without_bundle?
+        "ruby #{script_name}"
+      else
+        "BUNDLE_GEMFILE=#{gemfile_location} bundle exec ruby #{script_name}"
+      end
+    end
+
+    def benchmark_name
+      raise "Override the `benchmark_name` method in your class"
+    end
+
+    def require_db?
+      false
+    end
+
+    def check_dependencies
+      return if opts.skip_dependencies_check
+      log("Checking dependencies...")
+      RubybenchRunner::DependenciesChecker.check
+    end
+
+    def setup_db
+    end
+
+    def run_benchmarks
+      log("Running benchmarks...")
+      Dir.chdir(script_path) do
+        opts.repeat_count.times do |n|
+          res = `#{command}`
+          @results[n] = res
+          @results[n] = JSON.parse(res)
+        end
+      end
+    rescue => err
+      @error = err
+    end
+
+    def process_results
+      return if @error
+      @results.map! do |res|
+        res.each do |key, val|
+          if Float === val
+            res[key] = val.round(opts.round)
+          end
+        end
+        res
+      end
+
+      @results.sort_by! do |res|
+        res['iterations_per_second']
+      end
+    end
+
+    def print_results
+      if @error
+        @output = <<~OUTPUT
+          An error occurred while running the benchmarks:
+          Error: #{@error.message}
+          Backtrace:
+          #{@error.backtrace.join("\n")}
+          ------
+          Raw results until this error:
+          #{@results}
+        OUTPUT
+      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')
+          res.delete('version')
+          { "run #{ind + 1}" => res }
+        end
+        @output += "\n"
+        @output += @results.to_yaml.sub("---\n", "")
+      end
+      puts @output
+    end
+
+    def bundle_install
+      return if without_bundle?
+
+      log("Installing gems...")
+      comm = "bundle install"
+      comm += " > /dev/null 2>&1" if !opts.verbose
+      Dir.chdir(File.dirname(gemfile_location)) do
+        system(comm)
+      end
+      Dir.chdir(File.join(dest_dir, "support", "setup")) do
+        system(comm)
+      end
+    end
+
+    def download_script
+      log("Downloading script...")
+      content = open(script_url).read
+      File.write(script_full_path, content)
+    end
+
+    def write_gemfile
+      return if without_bundle?
+      File.write(gemfile_location, gemfile_content)
+    end
+
+    private
+
+    def log(msg)
+      return if opts.quiet
+      puts msg
+    end
+
+    def without_bundle?
+      !gemfile_content
+    end
+
+    def gemfile_location
+      File.join(save_dir, "Gemfile")
+    end
+
+    def cleanup(before: false, after: false)
+      FileUtils.rm_f(script_full_path)
+      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
+      end
+    end
+  end
+end