pullermann 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 Dominik Bamberger bamboo@suse.com 
+
+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/lib/pullermann/pullermann.rb

@@ -0,0 +1,203 @@
+class Pullermann
+
+  attr_accessor :username,
+                :password,
+                :username_fail,
+                :password_fail,
+                :rerun_on_source_change,
+                :rerun_on_target_change,
+                :prepare_block,
+                :test_block,
+                :log_level
+
+  # Allow configuration blocks being passed to Pullermann.
+  def self.setup
+    yield main_instance
+  end
+
+  def test_preparation(&block)
+    self.prepare_block = block
+  end
+
+  def test_execution(&block)
+    self.test_block = block
+  end
+
+  # The main Pullermann task. Call this to start testing.
+  def self.run
+    main_instance.run
+  end
+
+  def run
+    # Populate variables and setup environment.
+    configure
+    # Loop through all 'open' pull requests.
+    pull_requests.each do |request|
+      @request_id = request['number']
+      # Jump to next iteration if source and/or target haven't change since last run.
+      next unless test_run_necessary?
+      # GitHub always creates a merge commit for its 'Merge Button'.
+      switch_branch_to_merged_state
+      # Prepare project and CI (e.g. Jenkins) for the test run.
+      self.prepare_block.call
+      # Run specified tests for the project.
+      # NOTE: Either ensure the last call in that block runs your tests
+      # or manually set @result to a boolean inside this block.
+      self.test_block.call
+      # Unless already set, the success/failure is determined by the last
+      # command's return code.
+      @result ||= $? == 0
+      # We need to switch back to the original branch in case we need to test
+      # more pull requests.
+      switch_branch_back
+      comment_on_github
+    end
+  end
+
+
+  private
+
+  # Remember the one instance we setup in our application and want to run.
+  def self.main_instance
+    @main_instance ||= Pullermann.new
+  end
+
+  def configure
+    @log = Logger.new(STDOUT)
+    @log.level = self.log_level || Logger::INFO
+    # Set default fall back values for options that aren't set.
+    self.username ||= git_config['github.login']
+    self.password ||= git_config['github.password']
+    self.username_fail ||= self.username
+    self.password_fail ||= self.password
+    self.rerun_on_source_change = true unless self.rerun_on_source_change == false
+    self.rerun_on_target_change = true unless self.rerun_on_target_change == false
+    # Find environment (tasks, project, ...).
+    @prepare_block ||= lambda {}
+    @test_block ||= lambda { `rake test` }
+    connect_to_github
+  end
+
+  def connect_to_github(user = self.username, pass = self.password)
+    @github = Octokit::Client.new(
+      :login => user,
+      :password => pass
+    )
+    # Check user login to GitHub.
+    @github.login
+    @log.info "Successfully logged into GitHub (API v#{@github.api_version}) with user '#{user}'."
+    # Ensure the user has access to desired project.
+    @project = /:(.*)\.git/.match(git_config['remote.origin.url'])[1]
+    begin
+      @github.repo @project
+      @log.info "Successfully accessed GitHub project '#{@project}'"
+    rescue Octokit::Unauthorized => e
+      @log.error "Unable to access GitHub project with user '#{user}':\n#{e.message}"
+      abort
+    end
+  end
+
+  def pull_requests
+    pulls = @github.pulls @project, 'open'
+    @log.info "Found #{pulls.size > 0 ? pulls.size : 'no'} open pull requests in '#{@project}'."
+    pulls
+  end
+
+  # Test runs are necessary if:
+  # - the pull request hasn't been tested before.
+  # - the pull request has been updated since the last run.
+  # - the target (i.e. master) has been updated since the last run.
+  def test_run_necessary?
+    pull_request = @github.pull_request @project, @request_id
+    @log.info "Checking pull request ##{@request_id}: #{pull_request.title}"
+    # If it's not mergeable, there is no point in going on.
+    unless pull_request.mergeable
+      @log.info 'Pull request not auto-mergeable, skipping... '
+      return false
+    end
+    comments = @github.issue_comments(@project, @request_id)
+    comments = comments.select{ |c| [username, username_fail].include?(c.user.login) }.reverse
+    if comments.empty?
+      # If there are no comments yet, it has to be a new request.
+      @log.info 'New pull request detected, test run needed.'
+      return true
+    else
+      # Compare current sha ids of target and source branch with those from the last test run.
+      @target_head_sha ||= @github.commits(@project).first.sha
+      @pull_head_sha = pull_request.head.sha
+      # Initialize shas to ensure it will live on after the 'each' block.
+      shas = nil
+      comments.each do |comment|
+        shas = /master sha# ([\w]+) ; pull sha# ([\w]+)/.match(comment.body)
+        break if shas && shas[1] && shas[2]
+      end
+      # We finally found the latest comment that includes the necessary information.
+      if shas && shas[1] && shas[2]
+        @log.info "Current target sha: '#{@target_head_sha}', pull sha: '#{@pull_head_sha}'."
+        @log.info "Last test run target sha: '#{shas[1]}', pull sha: '#{shas[2]}'."
+        if self.rerun_on_source_change && (shas[2] != @pull_head_sha)
+          @log.info 'Re-running test due to new commit in pull request.'
+          return true
+        elsif self.rerun_on_target_change && (shas[1] != @target_head_sha)
+          @log.info 'Re-running test due to new commit in target branch.'
+          return true
+        end
+      else
+        @log.info 'New pull request detected, test run needed.'
+        return true
+      end
+    end
+    @log.info "Not running tests for request ##{@request_id}."
+    false
+  end
+
+  def switch_branch_to_merged_state
+    # Fetch the merge-commit for the pull request.
+    # NOTE: This commit is automatically created by 'GitHub Merge Button'.
+    # FIXME: Use cheetah to pipe to @log.debug instead of that /dev/null hack.
+    `git fetch origin refs/pull/#{@request_id}/merge: &> /dev/null`
+    `git checkout FETCH_HEAD &> /dev/null`
+    unless $? == 0
+      @log.error 'Unable to switch to merge branch.'
+      abort
+    end
+
+  end
+
+  def switch_branch_back
+    # FIXME: Use cheetah to pipe to @log.debug instead of that /dev/null hack.
+    @log.info 'Switching back to original branch.'
+    # FIXME: For branches other than master, remember the original branch.
+    `git co master &> /dev/null`
+  end
+
+  # Output the result to a comment on the pull request on GitHub.
+  def comment_on_github
+    sha_string = "\n( master sha# #{@target_head_sha} ; pull sha# #{@pull_head_sha} )"
+    if @result
+      message = 'Well done! All tests are still passing after merging this pull request. '
+    else
+      unless self.username == self.username_fail
+        # Re-connect with username_fail and password_fail.
+        connect_to_github(self.username, self.password)
+      end
+      message = 'Unfortunately your tests are failing after merging this pull request. '
+    end
+    @github.add_comment(@project, @request_id, message + sha_string)
+  end
+
+  # Collect git config information in a Hash for easy access.
+  # Checks '~/.gitconfig' for credentials.
+  def git_config
+    unless @git_config
+      # Read @git_config from local git config.
+      @git_config = {}
+      `git config --list`.split("\n").each do |line|
+        key, value = line.split('=')
+        @git_config[key] = value
+      end
+    end
+    @git_config
+  end
+
+end

data/lib/pullermann/railtie.rb

@@ -0,0 +1,8 @@
+require 'pullermann'
+require 'rails'
+
+class Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/pullermann.rake'
+  end
+end

data/lib/pullermann.rb

@@ -0,0 +1,4 @@
+require 'octokit'
+require 'logger'
+require 'pullermann/railtie' if defined?(Rails)
+require 'pullermann/pullermann'

data/lib/tasks/pullermann.rake

@@ -0,0 +1,4 @@
+desc 'Test open pull requests'
+task :pullermann => :environment do
+  Pullermann.run
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: pullermann
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Dominik Bamberger
+- Thomas Schmidt
+- Jordi Massaguer Pla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pullermann runs your project's test suite on open pull requests on GitHub.
+  Afterwards it posts the result as a comment to the respective request. That way
+  you know whether your tests are still going to pass if you accept the request and
+  merge the code.
+email: bamboo@suse.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/pullermann.rb
+- lib/tasks/pullermann.rake
+- lib/pullermann/pullermann.rb
+- lib/pullermann/railtie.rb
+homepage: http://github.com/b4mboo/pullermann
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An easy way to test pull requests.
+test_files: []