shipit-engine 0.38.0 → 0.40.0

data/app/models/shipit/hook.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Hook < Record
     class DeliverySigner
@@ -46,7 +47,7 @@ module Shipit
           'Content-Type' => content_type,
           'X-Shipit-Event' => event,
           'X-Shipit-Signature' => signature,
-          'Accept' => '*/*',
+          'Accept' => '*/*'
         }
       end
 
@@ -63,10 +64,10 @@ module Shipit
 
     CONTENT_TYPES = {
       'json' => 'application/json',
-      'form' => 'application/x-www-form-urlencoded',
+      'form' => 'application/x-www-form-urlencoded'
     }.freeze
 
-    EVENTS = %w(
+    EVENTS = %w[
       stack
       review_stack
       task
@@ -78,7 +79,7 @@ module Shipit
       merge_status
       merge
       pull_request
-    ).freeze
+    ].freeze
 
     belongs_to :stack, required: false
     has_many :deliveries
@@ -87,7 +88,7 @@ module Shipit
     validates :content_type, presence: true, inclusion: { in: CONTENT_TYPES.keys }
     validates :events, presence: true, subset: { of: EVENTS }
 
-    serialize :events, Shipit::CSVSerializer
+    serialize :events, coder: Shipit::CSVSerializer
 
     scope :global, -> { where(stack_id: nil) }
     scope :scoped_to, ->(stack) { where(stack_id: stack.id) }
@@ -96,10 +97,11 @@ module Shipit
     class << self
       def emit(event, stack, payload)
         raise "#{event} is not declared in Shipit::Hook::EVENTS" unless EVENTS.include?(event.to_s)
+
         Shipit::EmitEventJob.perform_later(
           event: event.to_s,
           stack_id: stack&.id,
-          payload: coerce_payload(payload),
+          payload: coerce_payload(payload)
         )
         deliver_internal_hooks(event, stack, payload)
       end
@@ -142,7 +144,7 @@ module Shipit
         url: delivery_url,
         content_type: CONTENT_TYPES[content_type],
         payload: serialize_payload(payload),
-        secret: secret,
+        secret:
       )
     end
 

data/app/models/shipit/membership.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Membership < Record
     belongs_to :team, required: true

data/app/models/shipit/merge_request.rb

@@ -1,13 +1,14 @@
 # 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
+    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)
 
@@ -85,14 +86,14 @@ module Shipit
       end
 
       event :retry do
-        transition %i(rejected canceled revalidating) => :pending
+        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|
+      before_transition %i[fetching rejected canceled] => :pending do |pr|
         pr.merge_requested_at = Time.now.utc
       end
 
@@ -100,7 +101,7 @@ module Shipit
         pr.revalidated_at = Time.now.utc
       end
 
-      before_transition %i(pending) => :merged do |pr|
+      before_transition %i[pending] => :merged do |pr|
         Stack.increment_counter(:undeployed_commits_count, pr.stack_id)
       end
     end
@@ -117,6 +118,7 @@ module Shipit
       when %r{\Ahttps://#{Regexp.escape(Shipit.github(organization: org).domain)}/([^/]+)/([^/]+)/pull/(\d+)}
         return unless $1.downcase == stack.repo_owner.downcase
         return unless $2.downcase == stack.repo_name.downcase
+
         $3.to_i
       end
     end
@@ -126,10 +128,10 @@ module Shipit
       merge_request = begin
         create_with(
           merge_requested_at: now,
-          merge_requested_by: user.presence,
+          merge_requested_by: user.presence
         ).find_or_create_by!(
-          stack: stack,
-          number: number,
+          stack:,
+          number:
         )
       rescue ActiveRecord::RecordNotUnique
         retry
@@ -144,6 +146,7 @@ module Shipit
       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
@@ -154,6 +157,7 @@ module Shipit
       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
 
@@ -168,7 +172,7 @@ module Shipit
         merge_message,
         sha: head.sha,
         commit_message: 'Merged by Shipit',
-        merge_method: stack.merge_method,
+        merge_method: stack.merge_method
       )
       begin
         if stack.github_api.pull_requests(stack.github_repo_name, base: branch).empty?
@@ -188,6 +192,7 @@ module Shipit
 
     def all_status_checks_passed?
       return false unless head
+
       StatusChecker.new(head, head.statuses_and_check_runs, stack.cached_deploy_spec).success?
     end
 
@@ -207,6 +212,7 @@ module Shipit
     def need_revalidation?
       timeout = stack.cached_deploy_spec&.revalidate_merge_requests_after
       return false unless timeout
+
       (revalidated_at + timeout).past?
     end
 
@@ -255,18 +261,21 @@ module Shipit
 
     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
+      if (max_branch_age = spec.max_divergence_age) && (Time.now.utc - head.committed_at > max_branch_age)
+        return true
       end
-      if commit_count_limit = spec.max_divergence_commits
-        return true if comparison.behind_by > commit_count_limit
+      if (commit_count_limit = spec.max_divergence_commits) && (comparison.behind_by > commit_count_limit)
+        return true
       end
+
       false
     end
 
@@ -274,7 +283,7 @@ module Shipit
       @comparison ||= stack.github_api.compare(
         stack.github_repo_name,
         base_ref,
-        head.sha,
+        head.sha
       )
     end
 
@@ -286,8 +295,9 @@ module Shipit
 
     def emit_hooks
       return unless @merge_status_changed
+
       @merge_status_changed = nil
-      Hook.emit('merge', stack, merge_request: self, status: merge_status, stack: stack)
+      Hook.emit('merge', stack, merge_request: self, status: merge_status, stack:)
     end
 
     def find_or_create_commit_from_github_by_sha!(sha, attributes)

data/app/models/shipit/output_chunk.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class OutputChunk < Record
     belongs_to :task

data/app/models/shipit/provisioning_handler.rb

@@ -17,6 +17,7 @@ module Shipit
 
       def fetch(name)
         return default if name.blank?
+
         registry.fetch(name) { ProvisioningHandler::UnregisteredProvisioningHandler }
       end
 

data/app/models/shipit/pull_request.rb

@@ -11,7 +11,7 @@ module Shipit
     has_many :pull_request_assignments
     has_many :assignees, class_name: :User, through: :pull_request_assignments, source: :user
 
-    serialize :labels, Shipit.serialized_column(:labels, type: Array)
+    serialize :labels, coder: Shipit.serialized_column(:labels, type: Array)
 
     after_create_commit :emit_create_hooks
     after_update_commit :emit_update_hooks
@@ -30,7 +30,7 @@ module Shipit
     end
 
     def emit_hooks(reason)
-      Hook.emit('pull_request', stack, action: reason, pull_request: self, stack: stack)
+      Hook.emit('pull_request', stack, action: reason, pull_request: self, stack:)
     end
 
     def github_pull_request=(github_pull_request)

data/app/models/shipit/record.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Record < ActiveRecord::Base
     self.abstract_class = true

data/app/models/shipit/release_status.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ReleaseStatus < Record
     MAX_DESCRIPTION_LENGTH = 140
@@ -13,7 +14,7 @@ module Shipit
 
     scope :to_be_created, -> { where(github_id: nil).order(id: :asc) }
 
-    STATES = %w(pending success failure error).freeze
+    STATES = %w[pending success failure error].freeze
     validates :state, presence: true, inclusion: { in: STATES }
 
     def create_status_on_github!
@@ -30,8 +31,8 @@ module Shipit
         commit.sha,
         state,
         context: stack.release_status_context,
-        target_url: target_url,
-        description: description&.truncate(MAX_DESCRIPTION_LENGTH),
+        target_url:,
+        description: description&.truncate(MAX_DESCRIPTION_LENGTH)
       )
     end
 

data/app/models/shipit/repository.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class NullRepository
     def id
@@ -37,29 +38,29 @@ module Shipit
     NAME_MAX_SIZE = 100
     private_constant :NAME_MAX_SIZE
 
-    validates :name, uniqueness: { scope: %i(owner), case_sensitive: false,
-                                   message: 'cannot be used more than once', }
+    validates :name, uniqueness: { scope: %i[owner], case_sensitive: false,
+                                   message: 'cannot be used more than once' }
     validates :owner, :name, presence: true, ascii_only: true
-    validates :owner, format: { with: /\A[a-z0-9_\-\.]+\z/ }, length: { maximum: OWNER_MAX_SIZE }
-    validates :name, format: { with: /\A[a-z0-9_\-\.]+\z/ }, length: { maximum: NAME_MAX_SIZE }
+    validates :owner, format: { with: /\A[a-z0-9_\-.]+\z/ }, length: { maximum: OWNER_MAX_SIZE }
+    validates :name, format: { with: /\A[a-z0-9_\-.]+\z/ }, length: { maximum: NAME_MAX_SIZE }
 
     has_many :stacks, dependent: :destroy
     has_many :review_stacks, dependent: :destroy
 
-    PROVISIONING_BEHAVIORS = %w(allow_all allow_with_label prevent_with_label).freeze
-    enum provisioning_behavior: PROVISIONING_BEHAVIORS.zip(PROVISIONING_BEHAVIORS).to_h, _prefix: :provisioning_behavior
+    PROVISIONING_BEHAVIORS = %w[allow_all allow_with_label prevent_with_label].freeze
+    enum :provisioning_behavior, PROVISIONING_BEHAVIORS.zip(PROVISIONING_BEHAVIORS).to_h, prefix: :provisioning_behavior
 
     def self.from_github_repo_name(github_repo_name)
       repo_owner, repo_name = github_repo_name.downcase.split('/')
       find_by(owner: repo_owner, name: repo_name)
     end
 
-    def name=(n)
-      super(n&.downcase)
+    def name=(name_value)
+      super(name_value&.downcase)
     end
 
-    def owner=(o)
-      super(o&.downcase)
+    def owner=(owner_value)
+      super(owner_value&.downcase)
     end
 
     def github_repo_name
@@ -90,7 +91,7 @@ module Shipit
       repo_owner, repo_name = param.split('/')
       where(
         owner: repo_owner.downcase,
-        name: repo_name.downcase,
+        name: repo_name.downcase
       ).first!
     end
 

data/app/models/shipit/review_stack.rb

@@ -102,11 +102,13 @@ module Shipit
 
     def enqueue_for_provisioning
       return if awaiting_provision
+
       update!(awaiting_provision: true)
     end
 
     def remove_from_provisioning_queue
       return unless awaiting_provision
+
       update!(awaiting_provision: false)
     end
 
@@ -119,7 +121,7 @@ module Shipit
     end
 
     def emit_updated_hooks
-      changed = !(previous_changes.keys - %w(updated_at)).empty?
+      changed = !(previous_changes.keys - %w[updated_at]).empty?
       Hook.emit(:review_stack, self, action: :updated, review_stack: self) if changed
     end
 

data/app/models/shipit/review_stack_provisioning_queue.rb

@@ -20,8 +20,8 @@ module Shipit
 
     def queued_stacks
       @queued_stacks ||= Shipit::ReviewStack
-        .with_provision_status(:deprovisioned)
-        .where(awaiting_provision: true)
+                         .with_provision_status(:deprovisioned)
+                         .where(awaiting_provision: true)
     end
 
     private

data/app/models/shipit/rollback.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Rollback < Deploy
     belongs_to :deploy, foreign_key: :parent_id, inverse_of: false
@@ -45,6 +46,7 @@ module Shipit
       # When we rollback to a certain revision, assume that all later deploys were faulty
       stack.deploys.newer_than(deploy.id).until(stack.last_completed_deploy.id).to_a.each do |deploy|
         next if deploy.id == id
+
         deploy.report_faulty!(description: "A rollback of #{stack.to_param} was triggered")
       end
     end