shipit-engine 0.31.0 → 0.35.0

data/app/models/shipit/output_chunk.rb

@@ -1,11 +1,16 @@
+# frozen_string_literal: true
 module Shipit
-  class OutputChunk < ActiveRecord::Base
+  class OutputChunk < Record
     belongs_to :task
 
     scope :tail, ->(start) { order(id: :asc).where('id > ?', start || 0) }
 
     def text=(string)
-      super(string.force_encoding(Encoding::UTF_8).scrub)
+      if string.frozen?
+        super(string)
+      else
+        super(string.force_encoding(Encoding::UTF_8).scrub)
+      end
     end
   end
 end

data/app/models/shipit/provisioning_handler/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Shipit
+  module ProvisioningHandler
+    class Base
+      def initialize(stack)
+        @stack = stack
+      end
+
+      def up
+        # Intentionally a noop
+      end
+
+      def down
+        # Intentionally a noop
+      end
+
+      # An (optional) guard to prevent provisioning. Intended to be
+      # use to set logic to determine if enough actual resources exist
+      # to complete the provisioning request.
+      def provision?
+        true
+      end
+
+      private
+
+      attr_accessor :stack
+    end
+  end
+end

data/app/models/shipit/provisioning_handler/unregistered_provisioning_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Shipit
+  module ProvisioningHandler
+    class UnregisteredProvisioningHandler < Shipit::ProvisioningHandler::Base
+      def up
+        lock_and_prevent_transition
+      end
+
+      def down
+        lock_and_prevent_transition
+      end
+
+      private
+
+      def lock_and_prevent_transition
+        stack.lock(
+          "Failed to find a provisioning handler named '#{stack.provisioning_handler_name}' in the " \
+          "ProvisioningHandler registry. Have you registered it via Provisioning::Handler.register?",
+          Shipit::AnonymousUser.new
+        )
+
+        # Prevent transition of the ReviewStack 'provision_status'
+        # state machine. This signals to the state_machines gem that
+        # the transition should be canceled.
+        #
+        # References:
+        #
+        #  - https://github.com/state-machines/state_machines/blob/309668998449ca6c348de809f34660d822bc626e/lib/state_machines/callback.rb#L81-L89
+        #  - https://github.com/state-machines/state_machines/blob/309668998449ca6c348de809f34660d822bc626e/lib/state_machines/transition_collection.rb#L63
+        throw(:halt)
+      end
+    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

data/app/models/shipit/pull_request.rb

@@ -1,298 +1,60 @@
+# frozen_string_literal: true
+
 module Shipit
-  class PullRequest < ApplicationRecord
+  class PullRequest < Record
     include DeferredTouch
 
-    MERGE_REQUEST_FIELD = 'Merge-Requested-By'.freeze
-
-    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&.pull_request_ignored_statuses || []
-      end
-
-      def required_statuses
-        deploy_spec&.pull_request_required_statuses || []
-      end
-    end
-
     belongs_to :stack
+    belongs_to :user
     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
+    has_many :pull_request_assignments
+    has_many :assignees, class_name: :User, through: :pull_request_assignments, source: :user
 
-      event :revalidate do
-        transition pending: :revalidating
-      end
-
-      event :cancel do
-        transition any => :canceled
-      end
+    serialize :labels, Array
 
-      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
+    after_create_commit :emit_create_hooks
+    after_update_commit :emit_update_hooks
+    after_destroy_commit :emit_destroy_hooks
 
-      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
+    def emit_destroy_hooks
+      emit_hooks(:destroyed)
     end
 
-    def self.schedule_merges
-      Shipit::Stack.where(merge_queue_enabled: true).find_each(&:schedule_merges)
+    def emit_create_hooks
+      emit_hooks(:created)
     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
+    def emit_update_hooks
+      emit_hooks(:updated)
     end
 
-    def self.request_merge!(stack, number, user)
-      now = Time.now.utc
-      pull_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
-      pull_request.update!(merge_requested_by: user.presence)
-      pull_request.retry! if pull_request.rejected? || pull_request.canceled? || pull_request.revalidating?
-      pull_request.schedule_refresh!
-      pull_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!
-      return true
-    rescue Octokit::MethodNotAllowed # merge conflict
-      reject!('merge_conflict')
-      return 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_pull_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!
-      RefreshPullRequestJob.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
+    def emit_hooks(reason)
+      Hook.emit('pull_request', stack, action: reason, pull_request: self, stack: stack)
     end
 
     def github_pull_request=(github_pull_request)
       self.github_id = github_pull_request.id
+      self.number = github_pull_request.number
       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
+      self.user = User.find_or_create_by_login!(github_pull_request.user.login)
+      self.assignees = github_pull_request.assignees.map do |github_user|
+        User.find_or_create_by_login!(github_user.login)
       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, pull_request: self, status: merge_status, stack: stack)
+      self.labels = github_pull_request.labels.map(&:name)
+      self.head = find_or_create_commit_from_github_by_sha!(github_pull_request.head.sha)
     end
 
-    def find_or_create_commit_from_github_by_sha!(sha, attributes)
+    def find_or_create_commit_from_github_by_sha!(sha)
       if commit = stack.commits.by_sha(sha)
-        return commit
+        commit
       else
-        github_commit = Shipit.github.api.commit(stack.github_repo_name, sha)
-        stack.commits.create_from_github!(github_commit, attributes)
+        github_commit = stack.github_api.commit(stack.github_repo_name, sha)
+        stack.commits.create_from_github!(github_commit)
       end
     rescue ActiveRecord::RecordNotUnique
       retry

data/app/models/shipit/pull_request_assignment.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Shipit
+  class PullRequestAssignment < Record
+    belongs_to :pull_request, required: true
+    belongs_to :user, required: true
+
+    validates :user_id, uniqueness: { scope: :pull_request_id }
+  end
+end