git-autobisect 0.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+gemspec
+
+gem 'rake'
+gem 'rspec', '~>2'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    git-autobisect (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git-autobisect!
+  rake
+  rspec (~> 2)

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+task :default do
+  sh "rspec spec/"
+end

data/Readme.md

@@ -0,0 +1,36 @@
+Find the first broken commit without having to learn git bisect.
+
+ - automagically bundles if necessary
+ - stops at first bad commit
+ - starts slow (HEAD~1, HEAD~2, HEAD~3) then goes in steps of 10 (..., HEAD~10, HEAD~20, HEAD~30)
+
+Install
+=======
+
+    gem install git-autobisect
+
+Usage
+=====
+
+    cd your project
+    # run a test that has a non-0 exit status
+    git-autobisect 'rspec spec/models/user_spec.rb'
+    ... grab a coffee ...
+    ---> The first bad commit is a4328fa
+    git show
+
+TODO
+====
+ - go with 1 2 4 8 16 16 16 16 commits back
+ - option for max-step -> if you think the problem is very fresh/very old
+
+Development
+===========
+ - `bundle && bundle exec rake`
+ - Tests run a lot faster without `bundle exec`
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/git-autobisect

@@ -0,0 +1,94 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Find the commit that broke the build
+
+Usage:
+    git-autobisect 'ruby test/foo_test.rb -n "/xxx/"' [options]
+
+Options:
+BANNER
+  opts.on("-h", "--help","Show this.") { puts opts; exit }
+  opts.on("-v", "--version","Show Version"){
+    version = File.read(File.expand_path("../../VERSION", __FILE__))
+    puts "git-autobisect #{version}"; exit
+  }
+end.parse!
+
+command = ARGV.first
+if command.to_s.empty?
+  puts "Usage instructions: git-autobisect --help"
+  exit
+end
+
+def run(cmd)
+  all = ""
+  puts cmd
+  IO.popen(cmd) do |pipe|
+    while str = pipe.gets
+      all << str
+      puts str
+    end
+  end
+  [$?.success?, all]
+end
+
+def run!(command)
+  raise "Command failed #{command}" unless run(command).first
+end
+
+def find_first_good_commit(commits, command)
+  # scan backwards through commits to find a good
+  i = 0
+  stay_slow_until = 3
+
+  loop do
+    # pick next commit (start slow, then get faster)
+    i += 1
+    offset = (i <= stay_slow_until ? i-1 : (i-1)*10)
+    break unless commit = commits[offset]
+
+    # see if it works
+    puts " ---> Now trying #{commit}"
+    run!("git checkout #{commit}")
+    return commit if run(command).first
+  end
+end
+
+command = "(bundle check || bundle) && (#{command})" if File.exist?("Gemfile")
+puts " ---> Initial run:"
+if run(command).first
+  puts " ---> Current commit is not broken"
+  exit 1
+end
+
+puts " ---> Trying to find first good commit:"
+max_commits = 1000
+commits = `git log --pretty=format:'%h' | head -n #{max_commits}`.split("\n")
+unless good = find_first_good_commit(commits[1..-1], command)
+  puts " --> No good commit found"
+  exit 1
+end
+
+# bisect to get exact match
+bad = commits[0]
+run! "git bisect reset"
+run! "git bisect start"
+run! "git checkout #{bad}"
+run! "git bisect bad"
+run! "git checkout #{good}"
+run! "git bisect good"
+success, output = run("git bisect run sh -c '#{command}'")
+if success
+  # git bisect randomly stops at a commit
+  first_bad = output.match(/([\da-f]+) is the first bad commit/)[1]
+  run! "git checkout #{first_bad}"
+  exit 0
+else
+  exit 1
+end
+

data/git-autobisect.gemspec

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+name = "git-autobisect"
+version = File.read(File.expand_path("../VERSION", __FILE__))
+
+Gem::Specification.new name, version do |s|
+  s.summary = "Find the first broken commit without having to learn git bisect"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = "MIT"
+end

data/spec/git-autobisect_spec.rb

@@ -0,0 +1,134 @@
+ROOT = File.expand_path('../../', __FILE__)
+
+describe "git-autobisect" do
+  def run(command, options={})
+    result = `#{command} 2>&1`
+    message = (options[:fail] ? "SUCCESS BUT SHOULD FAIL" : "FAIL")
+    raise "[#{message}] #{result} [#{command}]" if $?.success? == !!options[:fail]
+    result
+  end
+
+  def autobisect(args, options={})
+    run "#{ROOT}/bin/git-autobisect #{args}", options
+  end
+
+  def current_commit
+    run "git log --oneline | head -1"
+  end
+
+  def add_irrelevant_commit(name)
+    run "touch #{name} && git add #{name} && git commit -m 'added #{name}'"
+  end
+
+  def remove_a
+    run "git rm a && git commit -m 'remove a'"
+  end
+
+  before do
+    Dir.chdir ROOT
+  end
+
+  describe "basics" do
+    it "shows its usage without arguments" do
+      autobisect("").should include("Usage")
+    end
+
+    it "shows its usage with -h" do
+      autobisect("-h").should include("Usage")
+    end
+
+    it "shows its usage with --help" do
+      autobisect("--help").should include("Usage")
+    end
+
+    it "shows its version with -v" do
+      autobisect("-v").should =~ /^git-autobisect \d+\.\d+\.\d+$/
+    end
+
+    it "shows its version with --version" do
+      autobisect("-v").should =~ /^git-autobisect \d+\.\d+\.\d+$/
+    end
+  end
+
+  describe "bisecting" do
+    before do
+      run "rm -rf spec/tmp ; mkdir spec/tmp"
+      Dir.chdir "spec/tmp"
+      run "git init && touch a && git add a && git commit -m 'added a'"
+    end
+
+    it "stops when the first commit works" do
+      autobisect("'test 1'", :fail => true).should include("Current commit is not broken")
+    end
+
+    it "stops when no commit works" do
+      autobisect("test", :fail => true).should include("No good commit found")
+    end
+
+    it "finds the first broken commit for 1 commit" do
+      remove_a
+      result = autobisect("'test -e a'")
+      result.should include("bisect run success")
+      result.should =~ /is the first bad commit.*remove a/m
+    end
+
+    it "can run a complex command" do
+      remove_a
+      result = autobisect("'sleep 0.01 && test -e a'")
+      result.should include("bisect run success")
+      result.should =~ /is the first bad commit.*remove a/m
+    end
+
+    it "is fast for a large number of commits" do
+      # build a ton of commits
+      40.times do |i|
+        add_irrelevant_commit("#{i}_good")
+      end
+      run "git rm a && git commit -m 'remove a'"
+      40.times do |i|
+        add_irrelevant_commit("#{i}_bad")
+      end
+
+      # ran successful ?
+      result = autobisect("'echo a >> count && test -e a'")
+      result.should include("bisect run success")
+      result.should =~ /is the first bad commit.*remove a/m
+
+      # ran fast?
+      File.read('count').count('a').should < 20
+    end
+
+    it "stays at the first broken commit" do
+      remove_a
+      autobisect("'test -e a'")
+      current_commit.should include("remove a")
+    end
+
+    context "with multiple good commits after broken commit" do
+      before do
+        add_irrelevant_commit "b"
+        add_irrelevant_commit "c"
+        add_irrelevant_commit "d"
+        add_irrelevant_commit "e" # first good
+        remove_a
+        add_irrelevant_commit "f" # last bad
+        add_irrelevant_commit "g"
+      end
+
+      it "finds the first broken commit for n commits" do
+        result = autobisect("'test -e a'")
+        result.should include("bisect run success")
+        result.should =~ /is the first bad commit.*remove a/m
+        current_commit.should include("remove a")
+      end
+
+      it "does not run test too often" do
+        result = autobisect("'echo a >> count && test -e a'")
+        result.should include("bisect run success")
+        result.should include("added e")
+        result.should_not include("added d")
+        File.read('count').count('a').should == 6
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: git-autobisect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- bin/git-autobisect
+- git-autobisect.gemspec
+- spec/git-autobisect_spec.rb
+homepage: http://github.com/grosser/git-autobisect
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2506649951595822978
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2506649951595822978
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Find the first broken commit without having to learn git bisect
+test_files: []