shipit-engine 0.32.0 → 0.33.0

data/app/models/shipit/commit_checks.rb

@@ -6,6 +6,7 @@ module Shipit
 
     def initialize(commit)
       @commit = commit
+      super(commit)
     end
 
     def synchronize(&block)

data/app/models/shipit/deploy.rb

@@ -92,6 +92,7 @@ module Shipit
         env: env&.to_h || {},
         allow_concurrency: force,
         ignored_safeties: force,
+        max_retries: stack.retries_on_rollback,
       )
     end
 

data/app/models/shipit/deploy_spec.rb

@@ -104,6 +104,10 @@ module Shipit
       Duration.parse(config('deploy', 'interval') { 0 })
     end
 
+    def provisioning_handler_name
+      config('provision', 'handler_name')
+    end
+
     def deploy_steps
       around_steps('deploy') do
         config('deploy', 'override') { discover_deploy_steps }
@@ -122,6 +126,10 @@ module Shipit
       deploy_variables.map { |v| [v.name, v.default] }.to_h
     end
 
+    def retries_on_deploy
+      config('deploy', 'retries') { nil }
+    end
+
     def rollback_steps
       around_steps('rollback') do
         config('rollback', 'override') { discover_rollback_steps }
@@ -132,6 +140,10 @@ module Shipit
       rollback_steps || cant_detect!(:rollback)
     end
 
+    def retries_on_rollback
+      config('rollback', 'retries') { nil }
+    end
+
     def fetch_deployed_revision_steps
       config('fetch') || discover_fetch_deployed_revision_steps
     end
@@ -179,12 +191,12 @@ module Shipit
       Array.wrap(config('ci', 'blocking'))
     end
 
-    def pull_request_merge_method
+    def merge_request_merge_method
       method = config('merge', 'method')
       method if %w(merge rebase squash).include?(method)
     end
 
-    def pull_request_required_statuses
+    def merge_request_required_statuses
       if config('merge', 'require') || config('merge', 'ignore')
         Array.wrap(config('merge', 'require'))
       else
@@ -192,7 +204,7 @@ module Shipit
       end
     end
 
-    def pull_request_ignored_statuses
+    def merge_request_ignored_statuses
       if config('merge', 'require') || config('merge', 'ignore')
         Array.wrap(config('merge', 'ignore')) + [release_status_context].compact
       else
@@ -200,7 +212,7 @@ module Shipit
       end
     end
 
-    def revalidate_pull_requests_after
+    def revalidate_merge_requests_after
       if timeout = config('merge', 'revalidate_after')
         begin
           Duration.parse(timeout)

data/app/models/shipit/deploy_spec/file_system.rb

@@ -13,6 +13,7 @@ module Shipit
       def initialize(app_dir, env)
         @app_dir = Pathname(app_dir)
         @env = env
+        super(nil)
       end
 
       def cacheable
@@ -32,10 +33,10 @@ module Shipit
       def cacheable_config
         (config || {}).deep_merge(
           'merge' => {
-            'require' => pull_request_required_statuses,
-            'ignore' => pull_request_ignored_statuses,
-            'revalidate_after' => revalidate_pull_requests_after&.to_i,
-            'method' => pull_request_merge_method,
+            'require' => merge_request_required_statuses,
+            'ignore' => merge_request_ignored_statuses,
+            'revalidate_after' => revalidate_merge_requests_after&.to_i,
+            'method' => merge_request_merge_method,
             'max_divergence' => {
               'commits' => max_divergence_commits&.to_i,
               'age' => max_divergence_age&.to_i,
@@ -63,13 +64,18 @@ module Shipit
             'delay' => release_status_delay,
           },
           'dependencies' => { 'override' => dependencies_steps },
+          'provision' => { 'handler_name' => provisioning_handler_name },
           'deploy' => {
             'override' => deploy_steps,
             'variables' => deploy_variables.map(&:to_h),
             'max_commits' => maximum_commits_per_deploy,
             'interval' => pause_between_deploys,
+            'retries' => retries_on_deploy,
+          },
+          'rollback' => {
+            'override' => rollback_steps,
+            'retries' => retries_on_rollback,
           },
-          'rollback' => { 'override' => rollback_steps },
           'fetch' => fetch_deployed_revision_steps,
           'tasks' => cacheable_tasks,
         )

data/app/models/shipit/hook.rb

@@ -45,6 +45,7 @@ module Shipit
 
     EVENTS = %w(
       stack
+      review_stack
       task
       deploy
       rollback
@@ -53,6 +54,7 @@ module Shipit
       deployable_status
       merge_status
       merge
+      pull_request
     ).freeze
 
     belongs_to :stack, required: false

data/app/models/shipit/merge_request.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+module Shipit
+  class MergeRequest < ApplicationRecord
+    include DeferredTouch
+
+    MERGE_REQUEST_FIELD = 'Merge-Requested-By'
+
+    WAITING_STATUSES = %w(fetching pending).freeze
+    QUEUED_STATUSES = %w(pending revalidating).freeze
+    REJECTION_REASONS = %w(ci_missing ci_failing merge_conflict requires_rebase).freeze
+    InvalidTransition = Class.new(StandardError)
+    NotReady = Class.new(StandardError)
+
+    class StatusChecker < Status::Group
+      def initialize(commit, statuses, deploy_spec)
+        @deploy_spec = deploy_spec
+        super(commit, statuses)
+      end
+
+      private
+
+      attr_reader :deploy_spec
+
+      def reject_hidden(statuses)
+        statuses.reject { |s| ignored_statuses.include?(s.context) }
+      end
+
+      def reject_allowed_to_fail(statuses)
+        statuses.reject { |s| ignored_statuses.include?(s.context) }
+      end
+
+      def ignored_statuses
+        deploy_spec&.merge_request_ignored_statuses || []
+      end
+
+      def required_statuses
+        deploy_spec&.merge_request_required_statuses || []
+      end
+    end
+
+    belongs_to :stack
+    belongs_to :head, class_name: 'Shipit::Commit', optional: true
+    belongs_to :base_commit, class_name: 'Shipit::Commit', optional: true
+    belongs_to :merge_requested_by, class_name: 'Shipit::User', optional: true
+    has_one :merge_commit, class_name: 'Shipit::Commit'
+
+    deferred_touch stack: :updated_at
+
+    validates :number, presence: true, uniqueness: { scope: :stack_id }
+
+    scope :waiting, -> { where(merge_status: WAITING_STATUSES) }
+    scope :pending, -> { where(merge_status: 'pending') }
+    scope :to_be_merged, -> { pending.order(merge_requested_at: :asc) }
+    scope :queued, -> { where(merge_status: QUEUED_STATUSES).order(merge_requested_at: :asc) }
+
+    after_save :record_merge_status_change
+    after_commit :emit_hooks
+
+    state_machine :merge_status, initial: :fetching do
+      state :fetching
+      state :pending
+      state :rejected
+      state :canceled
+      state :merged
+      state :revalidating
+
+      event :fetched do
+        transition fetching: :pending
+      end
+
+      event :reject do
+        transition pending: :rejected
+      end
+
+      event :revalidate do
+        transition pending: :revalidating
+      end
+
+      event :cancel do
+        transition any => :canceled
+      end
+
+      event :complete do
+        transition pending: :merged
+      end
+
+      event :retry do
+        transition %i(rejected canceled revalidating) => :pending
+      end
+
+      before_transition rejected: any do |pr|
+        pr.rejection_reason = nil
+      end
+
+      before_transition %i(fetching rejected canceled) => :pending do |pr|
+        pr.merge_requested_at = Time.now.utc
+      end
+
+      before_transition any => :pending do |pr|
+        pr.revalidated_at = Time.now.utc
+      end
+
+      before_transition %i(pending) => :merged do |pr|
+        Stack.increment_counter(:undeployed_commits_count, pr.stack_id)
+      end
+    end
+
+    def self.schedule_merges
+      Shipit::Stack.where(merge_queue_enabled: true).find_each(&:schedule_merges)
+    end
+
+    def self.extract_number(stack, number_or_url)
+      case number_or_url
+      when /\A#?(\d+)\z/
+        $1.to_i
+      when %r{\Ahttps://#{Regexp.escape(Shipit.github.domain)}/([^/]+)/([^/]+)/pull/(\d+)}
+        return unless $1.downcase == stack.repo_owner.downcase
+        return unless $2.downcase == stack.repo_name.downcase
+        $3.to_i
+      end
+    end
+
+    def self.request_merge!(stack, number, user)
+      now = Time.now.utc
+      merge_request = begin
+        create_with(
+          merge_requested_at: now,
+          merge_requested_by: user.presence,
+        ).find_or_create_by!(
+          stack: stack,
+          number: number,
+        )
+      rescue ActiveRecord::RecordNotUnique
+        retry
+      end
+      merge_request.update!(merge_requested_by: user.presence)
+      merge_request.retry! if merge_request.rejected? || merge_request.canceled? || merge_request.revalidating?
+      merge_request.schedule_refresh!
+      merge_request
+    end
+
+    def reject!(reason)
+      unless REJECTION_REASONS.include?(reason)
+        raise ArgumentError, "invalid reason: #{reason.inspect}, must be one of: #{REJECTION_REASONS.inspect}"
+      end
+      self.rejection_reason = reason.presence
+      super()
+      true
+    end
+
+    def reject_unless_mergeable!
+      return reject!('merge_conflict') if merge_conflict?
+      return reject!('ci_missing') if any_status_checks_missing?
+      return reject!('ci_failing') if any_status_checks_failed?
+      return reject!('requires_rebase') if stale?
+      false
+    end
+
+    def merge!
+      raise InvalidTransition unless pending?
+
+      raise NotReady if not_mergeable_yet?
+
+      Shipit.github.api.merge_pull_request(
+        stack.github_repo_name,
+        number,
+        merge_message,
+        sha: head.sha,
+        commit_message: 'Merged by Shipit',
+        merge_method: stack.merge_method,
+      )
+      begin
+        if Shipit.github.api.pull_requests(stack.github_repo_name, base: branch).empty?
+          Shipit.github.api.delete_branch(stack.github_repo_name, branch)
+        end
+      rescue Octokit::UnprocessableEntity
+        # branch was already deleted somehow
+      end
+      complete!
+      true
+    rescue Octokit::MethodNotAllowed # merge conflict
+      reject!('merge_conflict')
+      false
+    rescue Octokit::Conflict # shas didn't match, PR was updated.
+      raise NotReady
+    end
+
+    def all_status_checks_passed?
+      return false unless head
+      StatusChecker.new(head, head.statuses_and_check_runs, stack.cached_deploy_spec).success?
+    end
+
+    def any_status_checks_failed?
+      status = StatusChecker.new(head, head.statuses_and_check_runs, stack.cached_deploy_spec)
+      status.failure? || status.error?
+    end
+
+    def any_status_checks_missing?
+      StatusChecker.new(head, head.statuses_and_check_runs, stack.cached_deploy_spec).missing?
+    end
+
+    def waiting?
+      WAITING_STATUSES.include?(merge_status)
+    end
+
+    def need_revalidation?
+      timeout = stack.cached_deploy_spec&.revalidate_merge_requests_after
+      return false unless timeout
+      (revalidated_at + timeout).past?
+    end
+
+    def merge_conflict?
+      mergeable == false
+    end
+
+    def not_mergeable_yet?
+      mergeable.nil?
+    end
+
+    def schedule_refresh!
+      RefreshMergeRequestJob.perform_later(self)
+    end
+
+    def closed?
+      state == "closed"
+    end
+
+    def merged_upstream?
+      closed? && merged_at
+    end
+
+    def refresh!
+      update!(github_pull_request: Shipit.github.api.pull_request(stack.github_repo_name, number))
+      head.refresh_statuses!
+      fetched! if fetching?
+      @comparison = nil
+    end
+
+    def github_pull_request=(github_pull_request)
+      self.github_id = github_pull_request.id
+      self.api_url = github_pull_request.url
+      self.title = github_pull_request.title
+      self.state = github_pull_request.state
+      self.mergeable = github_pull_request.mergeable
+      self.additions = github_pull_request.additions
+      self.deletions = github_pull_request.deletions
+      self.branch = github_pull_request.head.ref
+      self.head = find_or_create_commit_from_github_by_sha!(github_pull_request.head.sha, detached: true)
+      self.merged_at = github_pull_request.merged_at
+      self.base_ref = github_pull_request.base.ref
+      self.base_commit = find_or_create_commit_from_github_by_sha!(github_pull_request.base.sha, detached: true)
+    end
+
+    def merge_message
+      return title unless merge_requested_by
+      "#{title}\n\n#{MERGE_REQUEST_FIELD}: #{merge_requested_by.login}\n"
+    end
+
+    def stale?
+      return false unless base_commit
+      spec = stack.cached_deploy_spec
+      if max_branch_age = spec.max_divergence_age
+        return true if Time.now.utc - head.committed_at > max_branch_age
+      end
+      if commit_count_limit = spec.max_divergence_commits
+        return true if comparison.behind_by > commit_count_limit
+      end
+      false
+    end
+
+    def comparison
+      @comparison ||= Shipit.github.api.compare(
+        stack.github_repo_name,
+        base_ref,
+        head.sha,
+      )
+    end
+
+    private
+
+    def record_merge_status_change
+      @merge_status_changed ||= saved_change_to_attribute?(:merge_status)
+    end
+
+    def emit_hooks
+      return unless @merge_status_changed
+      @merge_status_changed = nil
+      Hook.emit('merge', stack, merge_request: self, status: merge_status, stack: stack)
+    end
+
+    def find_or_create_commit_from_github_by_sha!(sha, attributes)
+      if commit = stack.commits.by_sha(sha)
+        commit
+      else
+        github_commit = Shipit.github.api.commit(stack.github_repo_name, sha)
+        stack.commits.create_from_github!(github_commit, attributes)
+      end
+    rescue ActiveRecord::RecordNotUnique
+      retry
+    end
+  end
+end

data/app/models/shipit/provisioning_handler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Shipit
+  module ProvisioningHandler
+    class << self
+      def registry
+        @registry ||= reset_registry!
+      end
+
+      def reset_registry!
+        @registry = {}
+      end
+
+      def register(handler_class)
+        registry[handler_class.to_s] = handler_class
+      end
+
+      def fetch(name)
+        return default if name.blank?
+        registry.fetch(name) { ProvisioningHandler::UnregisteredProvisioningHandler }
+      end
+
+      def default=(handler_class)
+        registry[:default] = handler_class
+      end
+
+      def default
+        registry.fetch(:default) { ProvisioningHandler::Base }
+      end
+    end
+  end
+end