rubyfarm-bisect 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 561ce8b5d13e224cbf37496b67dab8ef921f0bca276ddd676c50521f89798151
+  data.tar.gz: 7f8c97069d5da97a41c924b340e50a03b7177d6e682388a150614fb9f14e9170
+SHA512:
+  metadata.gz: 930b2fadcb428b5257d9881e62f08a0cc38625323616685d7a4ad4328ed34c56585ec6cea1e6173b32c7f7043602fece9b3ae798586613289c403d5254df49ea
+  data.tar.gz: f57779725fdc87734eb202b8f5687928dcf1713eae38d3c03b3ca7738e182fbd3cbd98c4729f6187a22795e67830812a2e1eed3225ed8e63252b048e5dcf4067

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubyfarm-bisect.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yusuke Endoh
+
+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,130 @@
+# rubyfarm-bisect
+
+This tool allows you to do "git bisect" MRI revisions easily.
+Instead of compiling each revision locally, it uses ["mametter/rubyfarm" repository](https://hub.docker.com/r/mametter/rubyfarm/tags/) in DockerHub, which contains all MRI revisions since r57410 that were successfully built.
+In short, you don't need to worry about "exit 125" (compilation failure).
+
+## How to setup
+
+You need to install rubyfarm-bisect.
+
+```
+$ gem install rubyfarm-biesct
+```
+
+You also need to be able to use "docker" command without "sudo".
+
+```
+$ docker run --rm -t mametter/rubyfarm:r60001 ruby -v
+Unable to find image 'mametter/rubyfarm:r60001' locally
+r60001: Pulling from mametter/rubyfarm
+
+  *snip*
+
+Status: Downloaded newer image for mametter/rubyfarm:r60001
+ruby 2.5.0dev (2017-09-23 trunk 60001) [x86_64-linux]
+```
+
+## How to use
+
+The simplest way:
+
+```
+$ rubyfarm-bisect ruby -e '<your test code>'
+```
+
+which assumes that `<your test code>` runs successfully at r57410, and fails at HEAD.
+
+### `-g`/`-b`: specify a good/bad commit range
+
+You can specify good and bad commits for git bisect:
+
+```
+$ rubyfarm-bisect -g 7c1b30a6 -b HEAD ruby -e '<your test code>'
+```
+
+`-g` is a good commit, and `-b` is a bad commit.
+The arguments must be a SVN revision (e.g., "r60000"), or a commit hash of [git.ruby-lang.org/ruby.git](https://git.ruby-lang.org/ruby.git) (e.g., 7c1b30a6).
+
+### `-u`: specify a git url
+
+This tool clones [the git repository of ruby](https://git.ruby-lang.org/ruby.git) into temporary directory, which takes some minutes.
+To make it fast, you can use your local repository:
+
+```
+$ git clone https://git.ruby-lang.org/ruby /path/to/local/git/repo
+$ rubyfarm-bisect -u /path/to/local/git/repo ruby -e '<your test code>'
+```
+
+### `-t`: use `test.rb`
+
+If you want to pass a test script instead of a command-line argument, use:
+
+```
+$ vim test.rb # create and save your test.rb
+$ rubyfarm-bisect -t
+```
+
+which mounts `test.rb` in the current directory to `/root/test.rb` in the docker container.
+
+### `-m`: specify a path to be mounted to `/root`
+
+If you want to pass not only a test script but also some data files, you can specify a directory to be mounted to `/root`:
+
+```
+$ rubyfarm-bisect -m /path/to/dir ruby /root/test.rb
+```
+
+Your `/path/to/dir` must contains `test.rb`.  Note that the directory is mounted in read-only mode.
+
+## Example
+
+Consider that you encounter a bug of trunk:
+
+```
+$ ruby -rripper -e 'Ripper.slice("foo", "ident")'
+Traceback (most recent call last):
+	8: from -e:1:in `<main>'
+	7: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:156:in `slice'
+	6: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:163:in `token_match'
+	5: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:163:in `new'
+	4: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:181:in `initialize'
+	3: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:202:in `compile'
+	2: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:202:in `scan'
+	1: from /opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:205:in `block in compile'
+/opt/ruby/lib/ruby/2.5.0/ripper/lexer.rb:205:in `concat': can't modify frozen String (RuntimeError)
+
+```
+
+You can find the regression by using rubyfarm-bisect:
+
+```
+$ rubyfarm-bisect ruby -rripper -e 'Ripper.slice("foo", "ident")'
+
+  *snip*
+
+e3300dce829955390b5099c013ab4452a74ffd20 is the first bad commit
+commit e3300dce829955390b5099c013ab4452a74ffd20
+Author: kazu <kazu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
+Date:   Sun Feb 5 07:54:32 2017 +0000
+
+    {ext,test}/ripper: Specify frozen_string_literal: true.
+    
+    git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57538 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
+
+:040000 040000 7092727b90c406b5672852457099250bc0a8f62e 5ad04f3dce97452d18b6c72850ac69f6b34014bc M	ext
+:040000 040000 83300d1a837029ed91f9675b2de984dcce2fe735 e679db1ae68baac0825f0fde89e3dd743781dd26 M	test
+bisect run success
+```
+
+```
+$ rubyfarm-bisect -g r57410 -b r60000 -u /path/to/ruby.git/ ruby -rripper -e 'Ripper.slice("foo", "ident")'
+```
+
+```
+$ cat test.rb
+require "ripper"
+Ripper.slice("foo", "ident")
+
+$ rubyfarm-bisect -t
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/exe/rubyfarm-bisect

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require "tmpdir"
+require "optparse"
+require "open3"
+
+FIRST_COMMIT = "7c1b30a602ab109d8d5388d7dfb3c5b180ba24e1" # r57410
+ORIGINAL_GIT_PATH = "https://git.ruby-lang.org/ruby.git"
+CORE = File.join(__dir__, "rubyfarm-bisect-core")
+
+good_commit = FIRST_COMMIT
+bad_commit = "HEAD"
+git_url = ORIGINAL_GIT_PATH
+mounts = []
+
+opt = OptionParser.new
+opt.on("-u URL", "--git-url URL", "URL of git repository (defalut: #{ ORIGINAL_GIT_PATH })") {|v| git_url = v }
+opt.on("-g COMMIT", "--good-commit COMMIT", "good commit (defalut: 7c1b30a)") {|v| good_commit = v }
+opt.on("-b COMMIT", "--bad-commit COMMIT", "bad commit (defalut: HEAD)") {|v| bad_commit = v }
+opt.on("-m PATH", "--mount-volume PATH", "mount PATH to /root (default: none)") {|v| mounts << v }
+opt.on("-t", "--test-rb", "run test.rb") do
+  mounts = ["test.rb"]
+  ARGV.concat(["ruby", "/root/test.rb"])
+end
+opt.order!(ARGV)
+
+mounts = mounts.flat_map do |path|
+  path = File.expand_path(path)
+  bind = nil
+  if File.directory?(path)
+    bind = "#{ path }:/root"
+  else
+    bind = "#{ path }:/root/#{ File.basename(path) }"
+  end
+  ["-v", bind + ":ro"]
+end
+
+solve_rev = -> commit do
+  case commit
+  when /\A\h+\z/
+    commit
+  when /\Ar(\d+)\z/
+    id = "git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@#$1"
+    commits, = Open3.capture2("git", "log", "--grep", id, "--format=format:%H")
+    commits.lines.last.chomp
+  else
+    raise "unknown revision format: #{ commit }"
+  end
+end
+
+puts "color legend: \e[36mgit clone\e[0m git bisect \e[1m\e[32mrubyfarm-bisect\e[0m \e[34mdocker\e[0m \e[31mtest script\e[0m"
+puts
+Dir.mktmpdir do |dir|
+  Dir.chdir(dir) do
+    print "\e[36m"
+    system("git", "clone", git_url)
+    puts "\e[0m"
+    Dir.chdir("ruby") do
+      system("git", "bisect", "start", solve_rev[bad_commit], solve_rev[good_commit])
+      system("git", "bisect", "run", CORE, *mounts, "--", *ARGV)
+    end
+  end
+end

data/exe/rubyfarm-bisect-core

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require "shellwords"
+
+REPOSITORY = "mametter/rubyfarm"
+
+puts
+rev = "r" + `git show HEAD`[%r(git-svn-id: svn\+ssh://ci.ruby-lang.org/ruby/trunk@(\d+)), 1]
+log = -> msg do
+  puts "\e[1m\e[32mrubyfarm-bisect[#{ rev }]: #{ msg }\e[0m"
+end
+run = -> color, *cmd do
+  log[Shellwords.join(cmd)]
+  print color
+  system(*cmd)
+  print "\e[0m"
+end
+tag = "mametter/rubyfarm:#{ rev }"
+
+run["\e[34m", "docker", "pull", tag]
+
+unless $?.success?
+  log["failed to pull #{ tag }; skip #{ rev }"]
+  exit 125
+end
+
+i = ARGV.index("--")
+opt = ARGV[0, i]
+cmd = ARGV[i + 1 .. -1]
+
+run["\e[31m", "docker", "run", "--rm", "-t", *opt, tag, *cmd]
+
+status = $?.exitstatus
+msg = { 0 => "good", 125 => "skip" }[status] || "bad"
+log["status = #{ status } (#{ rev } is #{ msg })"]
+puts
+exit status

data/rubyfarm-bisect.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |spec|
+  spec.name          = "rubyfarm-bisect"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Yusuke Endoh"]
+  spec.email         = ["mame@ruby-lang.org"]
+
+  spec.summary       = %q{"git bisect" ruby without compilation trouble}
+  spec.description   = %q{rubyfarm-bisect allows you to do "git bisect" MRI revisions without compilation.}
+  spec.homepage      = "https://github.com/mame/rubyfarm-bisect"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rubyfarm-bisect
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yusuke Endoh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: rubyfarm-bisect allows you to do "git bisect" MRI revisions without compilation.
+email:
+- mame@ruby-lang.org
+executables:
+- rubyfarm-bisect
+- rubyfarm-bisect-core
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exe/rubyfarm-bisect
+- exe/rubyfarm-bisect-core
+- rubyfarm-bisect.gemspec
+homepage: https://github.com/mame/rubyfarm-bisect
+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.7.3
+signing_key: 
+specification_version: 4
+summary: '"git bisect" ruby without compilation trouble'
+test_files: []