prophet 1.6.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d406c9bd4203b9aa5c02875eafd8295d102746d3
-  data.tar.gz: 24e1380804b9b326c782ce7b170c95a3b9886d43
+SHA256:
+  metadata.gz: 63a3b73db0063a2926440a4e1f19a0ae76d62be4a5ae20e7a88fb677229000b5
+  data.tar.gz: 7fff7b419b81c22b5f612a3523a04a73b71c53f935d1bdd7f0aca05ec4470ee5
 SHA512:
-  metadata.gz: 5b801cca85b70e5d1509f3fa20fae331ce6e91dda9ccf35f89bb97c162f82455e56304c771edbd10ff40e9e987475495c4ec8dffc22766f4018f75e05779eff2
-  data.tar.gz: 57e9e478771fe063f828d236705bf143d943986d28cc5228725da32f6c92408a48bc54bfb2de143fbe6101271c4fabb757626d250c2db3abb89be2245dc0b6ec
+  metadata.gz: 12ce2eda7bcb9e7e401b32c0f28375a7e873188d41b83dc1a6ec892dc7f4f14f64daeb79f6e3509f918f086852368e0fb2ba0b8bc7310f00d7ec4e00621409e5
+  data.tar.gz: 0bd79da7a4d39026bc89e3cdb31a8efcc7109cf1c98948f57e915349fa4689a162c9ac6814b54156c480aabd7561bb9e4fe22d4580eadc195b912ac642d85840

data/lib/prophet/prophet.rb

@@ -1,9 +1,12 @@
+require 'English'
+require 'open3'
+
 class Prophet
 
-  attr_accessor :username,
-                :password,
+  attr_accessor :username_pass,
+                :access_token_pass,
                 :username_fail,
-                :password_fail,
+                :access_token_fail,
                 :rerun_on_source_change,
                 :rerun_on_target_change,
                 :prepare_block,
@@ -15,7 +18,10 @@ class Prophet
                 :status_success,
                 :comment_failure,
                 :comment_success,
-                :reuse_comments
+                :disable_comments,
+                :reuse_comments,
+                :status_context,
+                :status_target_url
 
   # Allow configuration blocks being passed to Prophet.
   # See the README.md for examples on how to call this method.
@@ -42,7 +48,7 @@ class Prophet
     begin
       self.prepare_block.call
     rescue Exception => e
-      @log.error "Preparation block raised an exception: #{e}"
+      logger.error "Preparation block raised an exception: #{e}"
     end
     # Loop through all 'open' pull requests.
     selected_requests = pull_requests.select do |request|
@@ -53,30 +59,38 @@ class Prophet
       remove_comment unless self.reuse_comments
       true
     end
+
     # Run code on all selected requests.
     selected_requests.each do |request|
       @request = request
-      @log.info "Running for request ##{@request.id}."
+      logger.info "Running for request ##{@request.id}."
       # GitHub always creates a merge commit for its 'Merge Button'.
       # Prophet reuses that commit to run the code on it.
-      switch_branch_to_merged_state
-      # Run specified code (i.e. tests) for the project.
-      begin
-        self.exec_block.call
-        # Unless self.success has already been set (to true/false) manually,
-        # the success/failure is determined by the last command's return code.
-        self.success = ($? && $?.exitstatus == 0) if self.success.nil?
-      rescue Exception => e
-        @log.error "Execution block raised an exception: #{e}"
-        self.success = false
+      if switch_branch_to_merged_state
+        # Run specified code (i.e. tests) for the project.
+        begin
+          self.exec_block.call
+          # Unless self.success has already been set (to true/false) manually,
+          # the success/failure is determined by the last command's return code.
+          self.success = ($CHILD_STATUS && $CHILD_STATUS.exitstatus == 0) if self.success.nil?
+        rescue Exception => e
+          logger.error "Execution block raised an exception: #{e}"
+          self.success = false
+        end
+        switch_branch_back
+        comment_on_github
+        set_status_on_github
       end
-      switch_branch_back
-      comment_on_github
-      set_status_on_github
       self.success = nil
     end
   end
 
+  def logger
+    @logger ||= Logger.new(STDOUT).tap do |log|
+      log.level = Logger::INFO
+    end
+  end
+
 
   private
 
@@ -86,67 +100,57 @@ class Prophet
   end
 
   def configure
-    # 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
+    self.username_fail ||= self.username_pass
+    self.access_token_fail ||= self.access_token_pass
+
     # 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 if self.rerun_on_source_change.nil?
     self.rerun_on_target_change = true if self.rerun_on_target_change.nil?
     self.reuse_comments = false if self.reuse_comments.nil?
+    self.disable_comments = false if self.disable_comments.nil?
     # Allow for custom messages.
     self.status_pending ||= 'Prophet is still running.'
     self.status_failure ||= 'Prophet reports failure.'
     self.status_success ||= 'Prophet reports success.'
     self.comment_failure ||= 'Prophet reports failure.'
     self.comment_success ||= 'Prophet reports success.'
+    self.status_context ||= 'prophet/default'
     # Find environment (tasks, project, ...).
     self.prepare_block ||= lambda {}
     self.exec_block ||= lambda { `rake` }
-    @github = connect_to_github
-    @github_fail = if self.username == self.username_fail
-      @github
-    else
-      connect_to_github self.username_fail, self.password_fail
-    end
+    @github = connect_to_github(access_token: access_token_pass)
+    @github_fail = connect_to_github(access_token: access_token_fail)
   end
 
-  def connect_to_github(user = self.username, pass = self.password)
-    github = Octokit::Client.new(
-      :login => user,
-      :password => pass
-    )
+  def connect_to_github(access_token:)
+    github = Octokit::Client.new(access_token: access_token)
+
     # Check user login to GitHub.
     github.login
-    @log.info "Successfully logged into GitHub (API v#{github.api_version}) with user '#{user}'."
+    logger.info "Successfully logged into GitHub with user '#{github.user.login}'."
+
     # Ensure the user has access to desired project.
-    # NOTE: Both variants should work:
+    # NOTE: All three variants should work:
     # 'ssh://git@github.com:user/project.git'
     # 'git@github.com:user/project.git'
-    @project ||= /com:(.*)\.git/.match(git_config['remote.origin.url'])[1]
+    # 'https://github.com/user/project.git'
+    @project ||= /github\.com[\/:](.*)\.git$/.match(git_config['remote.origin.url'])[1]
     begin
       github.repo @project
-      @log.info "Successfully accessed GitHub project '#{@project}'"
+      logger.info "Successfully accessed GitHub project '#{@project}'"
       github
     rescue Octokit::Unauthorized => e
-      @log.error "Unable to access GitHub project with user '#{user}':\n#{e.message}"
+      logger.error "Unable to access GitHub project with user '#{github.user}':\n#{e.message}"
       abort
     end
   end
 
   def pull_requests
-    request_list = @github.pulls @project, 'open'
+    request_list = @github.pulls @project, state: 'open'
     requests = request_list.collect do |request|
       PullRequest.new(@github.pull_request @project, request.number)
     end
-    @log.info "Found #{requests.size > 0 ? requests.size : 'no'} open pull requests in '#{@project}'."
+    logger.info "Found #{requests.size > 0 ? requests.size : 'no'} open pull requests in '#{@project}'."
     requests
   end
 
@@ -154,73 +158,91 @@ class Prophet
   # - 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.
+  # - the pull request does not originate from a fork (to avoid malicious code execution on CI machines)
   def run_necessary?
-    @log.info "Checking pull request ##{@request.id}: #{@request.content.title}"
-    # Compare current sha ids of target and source branch with those from the last test run.
-    @request.target_head_sha = @github.commits(@project).first.sha
-    comments = @github.issue_comments(@project, @request.id)
-    comments = comments.select { |c| [username, username_fail].include?(c.user.login) }.reverse
-    # Initialize shas to ensure it will live on after the 'each' block.
-    shas = nil
-    @request.comment = nil
-    comments.each do |comment|
-      shas = /Merged ([\w]+) into ([\w]+)/.match(comment.body)
-      if shas && shas[1] && shas[2]
-        # Remember comment to be able to update or delete it later.
-        @request.comment = comment
-        break
+    logger.info "Checking pull request ##{@request.id}: #{@request.content.title}"
+
+    unless @request.from_fork || @request.wip
+      # Compare current sha ids of target and source branch with those from the last test run.
+      @request.target_head_sha = @github.commits(@project).first.sha
+      comments = @github.issue_comments(@project, @request.id)
+      comments = comments.select { |c| [username_pass, username_fail].include?(c.user.login) }.reverse
+      comments.each do |comment|
+        @request.comment = comment if /Merged ([\w]+) into ([\w]+)/.match(comment.body)
       end
-    end
-    # If it's not mergeable, we need to delete all comments of former test runs.
-    unless @request.content.mergeable
-      # Sometimes GitHub doesn't have a proper boolean value stored.
-      if @request.content.mergeable.nil? && switch_branch_to_merged_state(false)
-        # Pull request is mergeable after all.
-        switch_branch_back
+
+      statuses = @github.status(@project, @request.head_sha).statuses.select { |s| s.context == self.status_context }
+      # Only run if it's mergeable.
+      if @request.content.mergeable
+        if statuses.empty?
+          # If there is no status yet, it has to be a new request.
+          logger.info 'New pull request detected, run needed.'
+          return true
+        elsif !self.disable_comments && !@request.comment
+          logger.info 'Rerun forced.'
+          return true
+        end
       else
-        @log.info 'Pull request not auto-mergeable. Not running.'
-        if @request.comment
-          @log.info 'Deleting existing comment.'
-          call_github(old_comment_success?).delete_comment(@project, @request.comment.id)
+        # Sometimes GitHub doesn't have a proper boolean value stored.
+        if @request.content.mergeable.nil? && switch_branch_to_merged_state
+          # Pull request is mergeable after all.
+          switch_branch_back
+        else
+          logger.info 'Pull request not auto-mergeable. Not running.'
+          if @request.comment
+            logger.info 'Deleting existing comment.'
+            call_github(old_comment_success?).delete_comment(@project, @request.comment.id)
+          end
+          create_status(:error, "Pull request not auto-mergeable. Not running.") if statuses.first && statuses.first.state != 'error'
+          return false
         end
-        return false
       end
-    end
-    if @request.comment
-      @log.info "Current target sha: '#{@request.target_head_sha}', pull sha: '#{@request.head_sha}'."
-      @log.info "Last test run target sha: '#{shas[2]}', pull sha: '#{shas[1]}'."
-      if self.rerun_on_source_change && (shas[1] != @request.head_sha)
-        @log.info 'Re-running due to new commit in pull request.'
-        return true
-      elsif self.rerun_on_target_change && (shas[2] != @request.target_head_sha)
-        @log.info 'Re-running due to new commit in target branch.'
+
+      # Initialize shas to ensure it will live on after the 'each' block.
+      shas = nil
+      statuses.each do |status|
+        shas = /Merged ([\w]+) into ([\w]+)/.match(status.description)
+        break if shas && shas[1] && shas[2]
+      end
+
+      if shas
+        logger.info "Current target sha: '#{@request.target_head_sha}', pull sha: '#{@request.head_sha}'."
+        logger.info "Last test run target sha: '#{shas[2]}', pull sha: '#{shas[1]}'."
+        if self.rerun_on_source_change && (shas[1] != @request.head_sha)
+          logger.info 'Re-running due to new commit in pull request.'
+          return true
+        elsif self.rerun_on_target_change && (shas[2] != @request.target_head_sha)
+          logger.info 'Re-running due to new commit in target branch.'
+           return true
+        end
+      else
+        # If there are no SHAs yet, it has to be a new request.
+        logger.info 'New pull request detected, run needed.'
         return true
       end
-    else
-      # If there are no comments yet, it has to be a new request.
-      @log.info 'New pull request detected, run needed.'
-      return true
     end
-    @log.info "Not running for request ##{@request.id}."
+
+    logger.info "Pull request comes from a fork." if @request.from_fork
+    logger.info "Not running for request ##{@request.id}."
     false
   end
 
-  def switch_branch_to_merged_state(hard = true)
+  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.
+    # FIXME: Use cheetah to pipe to logger.debug instead of that /dev/null hack.
     `git fetch origin refs/pull/#{@request.id}/merge: &> /dev/null`
-    `git checkout FETCH_HEAD &> /dev/null`
-    unless ($? && $?.exitstatus == 0)
-      @log.error 'Unable to switch to merge branch.'
-      hard ? abort : false
+    _output, status = Open3.capture2 'git checkout FETCH_HEAD &> /dev/null'
+    if status != 0
+      logger.error 'Unable to switch to merge branch.'
+      return false
     end
     true
   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: Use cheetah to pipe to logger.debug instead of that /dev/null hack.
+    logger.info 'Switching back to original branch.'
     # FIXME: For branches other than master, remember the original branch.
     `git checkout master &> /dev/null`
     # Clean up potential remains and run garbage collector.
@@ -242,33 +264,60 @@ class Prophet
   end
 
   def comment_on_github
+    return if self.disable_comments
+
     # Determine comment message.
     message = if self.success
-      @log.info 'Successful run.'
-      self.comment_success + "\n( Success: "
+      logger.info 'Successful run.'
+      self.comment_success
     else
-      @log.info 'Failing run.'
-      self.comment_failure + "\n( Failure: "
+      logger.info 'Failing run.'
+      self.comment_failure
     end
-    message += "Merged #{@request.head_sha} into #{@request.target_head_sha} )"
+    message += status_string
     if self.reuse_comments && old_comment_success? == self.success
       # Replace existing comment's body with the correct connection.
-      @log.info "Updating existing #{notion(self.success)} comment."
+      logger.info "Updating existing #{notion(self.success)} comment."
       call_github(self.success).update_comment(@project, @request.comment.id, message)
     else
       if @request.comment
-        @log.info "Deleting existing #{notion(!self.success)} comment."
+        logger.info "Deleting existing #{notion(!self.success)} comment."
         # Delete old comment with correct connection (if @request.comment exists).
         call_github(!self.success).delete_comment(@project, @request.comment.id)
       end
       # Create new comment with correct connection.
-      @log.info "Adding new #{notion(self.success)} comment."
+      logger.info "Adding new #{notion(self.success)} comment."
       call_github(self.success).add_comment(@project, @request.id, message)
     end
   end
 
+  def status_string
+    case self.success
+      when true
+        " (Merged #{@request.head_sha} into #{@request.target_head_sha})"
+      when false
+        " (Merged #{@request.head_sha} into #{@request.target_head_sha})"
+      else
+        ""
+    end
+  end
+
+  def create_status(state, description)
+    logger.info "Setting status '#{state}': '#{description}'"
+    @github.create_status(
+      @project,
+      @request.head_sha,
+      state,
+      {
+        "description" => description,
+        "context" => status_context,
+        "target_url" => self.status_target_url
+      }
+    )
+  end
+
   def set_status_on_github
-    @log.info 'Updating status on GitHub.'
+    logger.info 'Updating status on GitHub.'
     case self.success
     when true
       state_symbol = :success
@@ -280,12 +329,7 @@ class Prophet
       state_symbol = :pending
       state_message = self.status_pending
     end
-    @github.post(
-      "repos/#{@project}/statuses/#{@request.head_sha}", {
-        :state => state_symbol,
-        :description => state_message
-      }
-    )
+    create_status(state_symbol, state_message + status_string)
   end
 
   def notion(success)

data/lib/prophet/pull_request.rb

@@ -4,12 +4,16 @@ class PullRequest
                 :content,
                 :comment,
                 :head_sha,
-                :target_head_sha
+                :target_head_sha,
+                :from_fork,
+                :wip
 
   def initialize(content)
     @content = content
     @id = content.number
     @head_sha = content.head.sha
+    @from_fork = content.head.repo.fork
+    @wip = content.labels.map(&:name).map(&:downcase).include? 'wip'
   end
 
 end

data/lib/prophet/railtie.rb

@@ -3,6 +3,6 @@ require 'rails'
 
 class Railtie < Rails::Railtie
   rake_tasks do
-    load 'tasks/prophet.rake.rake'
+    load 'tasks/prophet.rake'
   end
 end

metadata

@@ -1,59 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: prophet
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Dominik Bamberger
 - Thomas Schmidt
 - Jordi Massaguer Pla
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: '4.0'
 description: Prophet 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
@@ -73,26 +73,24 @@ homepage: http://github.com/b4mboo/prophet
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+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.2.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: An easy way to loop through open pull requests and run code onthe merged
   branch.
 test_files: []
-has_rdoc: