pullermann 1.0.6 → 1.1.0

data/lib/pullermann/pullermann.rb

@@ -7,23 +7,25 @@ class Pullermann
                 :rerun_on_source_change,
                 :rerun_on_target_change,
                 :prepare_block,
-                :test_block,
-                :log_level
+                :exec_block,
+                :logger,
+                :success
 
   # Allow configuration blocks being passed to Pullermann.
+  # See the README.md for examples on how to call this method.
   def self.setup
     yield main_instance
   end
 
-  def test_preparation(&block)
+  def preparation(&block)
     self.prepare_block = block
   end
 
-  def test_execution(&block)
-    self.test_block = block
+  def execution(&block)
+    self.exec_block = block
   end
 
-  # The main Pullermann task. Call this to start testing.
+  # The main Pullermann task. Call this to run your code.
   def self.run
     main_instance.run
   end
@@ -31,24 +33,20 @@ class Pullermann
   def run
     # Populate variables and setup environment.
     configure
+    self.prepare_block.call
     # 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?
+      next unless run_necessary?
       # GitHub always creates a merge commit for its 'Merge Button'.
+      # Pullermann reuses that commit to run the code on it.
       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.
-      @test_success ||= $? == 0
-      # We need to switch back to the original branch in case we need to test
-      # more pull requests.
+      # Run specified code (i.e. tests) for the project.
+      self.exec_block.call
+      # Unless self.success has already been set manually,
+      # the success/failure is determined by the last command's return code.
+      self.success ||= $? == 0
       switch_branch_back
       comment_on_github
     end
@@ -63,8 +61,13 @@ class Pullermann
   end
 
   def configure
-    @log = Logger.new(STDOUT)
-    @log.level = self.log_level || Logger::INFO
+    # Use existing logger or fall back to a new one with standard log level.
+    if self.logger
+      @log = self.logger
+    else
+      @log = Logger.new(STDOUT)
+      @log.level = Logger::INFO
+    end
     # Set default fall back values for options that aren't set.
     self.username ||= git_config['github.login']
     self.password ||= git_config['github.password']
@@ -73,8 +76,8 @@ class Pullermann
     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` }
+    self.prepare_block ||= lambda {}
+    self.exec_block ||= lambda { `rake` }
     @github = connect_to_github
     @github_fail = if self.username == self.username_fail
       @github
@@ -109,11 +112,11 @@ class Pullermann
     pulls
   end
 
-  # Test runs are necessary if:
-  # - the pull request hasn't been tested before.
+  # (Re-)runs are necessary if:
+  # - the pull request hasn't been used for a run 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?
+  def run_necessary?
     pull_request = @github.pull_request @project, @request_id
     @log.info "Checking pull request ##{@request_id}: #{pull_request.title}"
     # Compare current sha ids of target and source branch with those from the last test run.
@@ -134,7 +137,7 @@ class Pullermann
     end
     # If it's not mergeable, we need to delete all comments of former test runs.
     unless pull_request.mergeable
-      @log.info 'Pull request not auto-mergeable. Not running tests.'
+      @log.info 'Pull request not auto-mergeable. Not running.'
       if @comment
         @log.info 'Deleting existing comment.'
         call_github(old_comment_success?).delete_comment(@project, @comment.id)
@@ -145,18 +148,18 @@ class Pullermann
       @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.'
+        @log.info 'Re-running 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.'
+        @log.info 'Re-running due to new commit in target branch.'
         return true
       end
     else
       # If there are no comments yet, it has to be a new request.
-      @log.info 'New pull request detected, test run needed.'
+      @log.info 'New pull request detected, run needed.'
       return true
     end
-    @log.info "Not running tests for request ##{@request_id}."
+    @log.info "Not running for request ##{@request_id}."
     false
   end
 
@@ -179,35 +182,34 @@ class Pullermann
     `git checkout master &> /dev/null`
   end
 
-  # Analyze old comment to see whether it was a successful or a failing one.
   def old_comment_success?
     return unless @comment
-    # Determine boolean value.
+    # Analyze old comment to see whether it was a successful or a failing one.
     @comment.body.include? 'Well done!'
   end
 
-  # Output the result to a comment on the pull request on GitHub.
   def comment_on_github
     # Determine comment message.
-    message = if @test_success
-      @log.info 'Tests are passing.'
-      'Well done! All tests are still passing after merging this pull request.'
+    # TODO: Allow for custom messages.
+    message = if self.success
+      @log.info 'Successful run.'
+      'Well done! Your code is still running successfully after merging this pull request.'
     else
-      @log.info 'Tests are failing.'
-      'Unfortunately your tests are failing after merging this pull request.'
+      @log.info 'Failing run.'
+      'Unfortunately your code is failing after merging this pull request.'
     end
     message += "\n( master sha# #{@target_head_sha} ; pull sha# #{@pull_head_sha} )"
-    if old_comment_success? == @test_success
+    if old_comment_success? == self.success
       # Replace existing @comment's body with the correct connection.
-      @log.info "Updating existing #{notion(@test_success)} comment."
-      call_github(@test_success).update_comment(@project, @comment['id'], message)
+      @log.info "Updating existing #{notion(self.success)} comment."
+      call_github(self.success).update_comment(@project, @comment['id'], message)
     else
-      @log.info "Deleting existing #{notion(!@test_success)} comment."
+      @log.info "Deleting existing #{notion(!self.success)} comment."
       # Delete old @comment with correct connection (if @comment exists).
-      call_github(!@test_success).delete_comment(@project, @comment['id']) if @comment
+      call_github(!self.success).delete_comment(@project, @comment['id']) if @comment
       # Create new comment with correct connection.
-      @log.info "Adding new #{notion(@test_success)} comment."
-      call_github(@test_success).add_comment(@project, @request_id, message)
+      @log.info "Adding new #{notion(self.success)} comment."
+      call_github(self.success).add_comment(@project, @request_id, message)
     end
   end
 
@@ -224,7 +226,6 @@ class Pullermann
   # 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('=')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pullermann
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -45,10 +45,10 @@ dependencies:
     - - ! '>='
       - !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.
+description: Pullermann runs custom code (i.e. your project's test suite) on open
+  pull requests on GitHub. Afterwards it posts the result as a comment to the respective
+  request. This should give you an outlook on the future state of your repository
+  in case you accept the request and merge the code.
 email: bamboo@suse.com
 executables: []
 extensions: []
@@ -82,5 +82,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: An easy way to test pull requests.
+summary: An easy way to loop through open pull requests and run code on the merged
+  branch.
 test_files: []