shipit-engine 0.39.0 → 0.40.0

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

@@ -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

data/app/models/shipit/stack.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'fileutils'
 
 module Shipit
@@ -24,7 +25,7 @@ module Shipit
     end
 
     ENVIRONMENT_MAX_SIZE = 50
-    REQUIRED_HOOKS = %i(push status).freeze
+    REQUIRED_HOOKS = %i[push status].freeze
 
     has_many :commits, dependent: :destroy
     has_many :merge_requests, dependent: :destroy
@@ -32,12 +33,13 @@ module Shipit
     has_many :deploys
     has_many :rollbacks
     has_many :deploys_and_rollbacks,
-      -> { where(type: %w(Shipit::Deploy Shipit::Rollback)) },
-      class_name: 'Task',
-      inverse_of: :stack
+             -> { where(type: %w[Shipit::Deploy Shipit::Rollback]) },
+             class_name: 'Task',
+             inverse_of: :stack
     has_many :github_hooks, dependent: :destroy, class_name: 'Shipit::GithubHook::Repo'
     has_many :hooks, dependent: :destroy
     has_many :api_clients, dependent: :destroy
+    has_one :continuous_delivery_schedule, dependent: :destroy
     belongs_to :lock_author, class_name: :User, optional: true
     belongs_to :repository
     validates_associated :repository
@@ -56,7 +58,7 @@ module Shipit
         'GITHUB_REPO_OWNER' => repository.owner,
         'GITHUB_REPO_NAME' => repository.name,
         'DEPLOY_URL' => deploy_url,
-        'BRANCH' => branch,
+        'BRANCH' => branch
       }
     end
 
@@ -86,17 +88,17 @@ module Shipit
     after_commit :sync_github_if_necessary, on: :update
 
     def sync_github_if_necessary
-      if (archived_since_previously_changed? && archived_since.nil?) || branch_previously_changed?
-        sync_github
-      end
+      return unless (archived_since_previously_changed? && archived_since.nil?) || branch_previously_changed?
+
+      sync_github
     end
 
     validates :repository, uniqueness: {
-      scope: %i(environment), case_sensitive: false,
-      message: 'cannot be used more than once with this environment. Check archived stacks.',
+      scope: %i[environment], case_sensitive: false,
+      message: 'cannot be used more than once with this environment. Check archived stacks.'
     }
-    validates :environment, format: { with: /\A[a-z0-9\-_\:]+\z/ }, length: { maximum: ENVIRONMENT_MAX_SIZE }
-    validates :deploy_url, format: { with: URI.regexp(%w(http https ssh)) }, allow_blank: true
+    validates :environment, format: { with: /\A[a-z0-9\-_:]+\z/ }, length: { maximum: ENVIRONMENT_MAX_SIZE }
+    validates :deploy_url, format: { with: URI::DEFAULT_PARSER.make_regexp(%w[http https ssh]) }, allow_blank: true
     validates :branch, presence: true
 
     validates :lock_reason, length: { maximum: 4096 }
@@ -130,7 +132,7 @@ module Shipit
 
     def trigger_task(definition_id, user, env: nil, force: false)
       definition = find_task_definition(definition_id)
-      env = env&.to_h || {}
+      env = env.to_h
 
       definition.variables_with_defaults.each do |variable|
         env[variable.name] ||= variable.default
@@ -139,12 +141,12 @@ module Shipit
       commit = last_deployed_commit.presence || commits.first
       task = tasks.create(
         user_id: user.id,
-        definition: definition,
+        definition:,
         until_commit_id: commit.id,
         since_commit_id: commit.id,
         env: definition.filter_envs(env),
         allow_concurrency: definition.allow_concurrency? || force,
-        ignored_safeties: force,
+        ignored_safeties: force
       )
       task.enqueue
       task
@@ -154,12 +156,12 @@ module Shipit
       since_commit = last_deployed_commit.presence || commits.first
       deploys.build(
         user_id: user.id,
-        until_commit: until_commit,
-        since_commit: since_commit,
-        env: filter_deploy_envs(env&.to_h || {}),
-        allow_concurrency: allow_concurrency,
+        until_commit:,
+        since_commit:,
+        env: filter_deploy_envs(env.to_h),
+        allow_concurrency:,
         ignored_safeties: force || !until_commit.deployable?,
-        max_retries: retries_on_deploy,
+        max_retries: retries_on_deploy
       )
     end
 
@@ -235,17 +237,16 @@ module Shipit
     end
 
     def deployed_too_recently?
-      if task = last_active_task
-        return true if task.validating?
+      return unless task = last_active_task
+      return true if task.validating?
 
-        task.ended_at? && (task.ended_at + pause_between_deploys).future?
-      end
+      task.ended_at? && (task.ended_at + pause_between_deploys).future?
     end
 
     def async_refresh_deployed_revision
       async_refresh_deployed_revision!
-    rescue => error
-      logger.warn("Failed to dispatch FetchDeployedRevisionJob: [#{error.class.name}] #{error.message}")
+    rescue StandardError => e
+      logger.warn("Failed to dispatch FetchDeployedRevisionJob: [#{e.class.name}] #{e.message}")
     end
 
     def async_refresh_deployed_revision!
@@ -267,7 +268,7 @@ module Shipit
         deploys.create!(
           until_commit: actual_deployed_commit,
           since_commit: last_deployed_commit.presence || commits.first,
-          status: 'success',
+          status: 'success'
         )
       end
     end
@@ -278,8 +279,9 @@ module Shipit
 
     def merge_status(backlog_leniency_factor: 2.0)
       return 'locked' if locked?
-      return 'failure' if %w(failure error).freeze.include?(branch_status)
-      return 'backlogged' if backlogged?(backlog_leniency_factor: backlog_leniency_factor)
+      return 'failure' if %w[failure error].freeze.include?(branch_status)
+      return 'backlogged' if backlogged?(backlog_leniency_factor:)
+
       'success'
     end
 
@@ -290,13 +292,14 @@ module Shipit
     def branch_status
       undeployed_commits.each do |commit|
         state = commit.status.simple_state
-        return state unless %w(pending unknown missing).freeze.include?(state)
+        return state unless %w[pending unknown missing].freeze.include?(state)
       end
       'pending'
     end
 
     def status
       return :deploying if active_task?
+
       :default
     end
 
@@ -313,8 +316,8 @@ module Shipit
         next if commits_to_lock.empty?
 
         affected_rows += commits
-          .where(id: commits_to_lock.map(&:id).uniq)
-          .lock_all(revert.author)
+                         .where(id: commits_to_lock.map(&:id).uniq)
+                         .lock_all(revert.author)
       end
 
       touch if affected_rows > 1
@@ -396,13 +399,14 @@ module Shipit
     end
 
     def acquire_git_cache_lock(timeout: 15, &block)
-      @git_cache_lock ||= Flock.new(git_path.to_s + '.lock')
-      @git_cache_lock.lock(timeout: timeout, &block)
+      @git_cache_lock ||= Flock.new("#{git_path}.lock")
+      @git_cache_lock.lock(timeout:, &block)
     end
 
     def clear_git_cache!
       tmp_path = "#{git_path}-#{SecureRandom.hex}"
       return unless git_path.exist?
+
       acquire_git_cache_lock do
         git_path.rename(tmp_path)
       end
@@ -442,9 +446,7 @@ module Shipit
 
     def refresh_repository!
       resource = github_api.repo(github_repo_name)
-      if resource.try(:message) == 'Moved Permanently'
-        resource = github_api.get(resource.url)
-      end
+      resource = github_api.get(resource.url) if resource.try(:message) == 'Moved Permanently'
       repository.update!(owner: resource.owner.login, name: resource.name)
     end
 
@@ -454,6 +456,7 @@ module Shipit
 
     def active_task
       return @active_task if defined?(@active_task)
+
       @active_task ||= tasks.current
     end
 
@@ -500,7 +503,7 @@ module Shipit
       env = stack.cached_deploy_spec.default_deploy_env
       current_user = Shipit::CommandLineUser.new
 
-      stack.trigger_deploy(until_commit, current_user, env: env, force: true, run_now: true)
+      stack.trigger_deploy(until_commit, current_user, env:, force: true, run_now: true)
     end
 
     def self.from_param!(param)
@@ -509,16 +512,16 @@ module Shipit
         .where(
           repositories: {
             owner: repo_owner.downcase,
-            name: repo_name.downcase,
+            name: repo_name.downcase
           },
-          environment: environment,
+          environment:
         ).first!
     end
 
     delegate :plugins, :task_definitions, :hidden_statuses, :required_statuses, :soft_failing_statuses,
-      :blocking_statuses, :deploy_variables, :filter_task_envs, :filter_deploy_envs,
-      :maximum_commits_per_deploy, :pause_between_deploys, :retries_on_deploy, :retries_on_rollback,
-      to: :cached_deploy_spec
+             :blocking_statuses, :deploy_variables, :filter_task_envs, :filter_deploy_envs,
+             :maximum_commits_per_deploy, :pause_between_deploys, :retries_on_deploy, :retries_on_rollback,
+             to: :cached_deploy_spec
 
     def monitoring?
       monitoring.present?
@@ -543,16 +546,16 @@ module Shipit
     end
 
     def update_latest_deployed_ref
-      if Shipit.update_latest_deployed_ref
-        UpdateGithubLastDeployedRefJob.perform_later(self)
-      end
+      return unless Shipit.update_latest_deployed_ref
+
+      UpdateGithubLastDeployedRefJob.perform_later(self)
     end
 
     def broadcast_update
       Pubsubstub.publish(
         "stack.#{id}",
-        { id: id, updated_at: updated_at }.to_json,
-        name: 'update',
+        { id:, updated_at: }.to_json,
+        name: 'update'
       )
     end
 
@@ -624,10 +627,10 @@ module Shipit
       return unless previous_changes.include?('lock_reason')
 
       lock_details = if previous_changes['lock_reason'].last.blank?
-        { from: previous_changes['locked_since'].first, until: Time.zone.now }
-      end
+                       { from: previous_changes['locked_since'].first, until: Time.zone.now }
+                     end
 
-      Hook.emit(:lock, self, locked: locked?, lock_details: lock_details, stack: self)
+      Hook.emit(:lock, self, locked: locked?, lock_details:, stack: self)
     end
 
     private
@@ -662,9 +665,9 @@ module Shipit
     end
 
     def schedule_merges_if_necessary
-      if lock_reason_previously_changed? && lock_reason.blank?
-        schedule_merges
-      end
+      return unless lock_reason_previously_changed? && lock_reason.blank?
+
+      schedule_merges
     end
 
     def emit_added_hooks
@@ -672,7 +675,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(:stack, self, action: :updated, stack: self) if changed
     end
 
@@ -681,7 +684,7 @@ module Shipit
     end
 
     def emit_merge_status_hooks
-      Hook.emit(:merge_status, self, merge_status: merge_status, stack: self)
+      Hook.emit(:merge_status, self, merge_status:, stack: self)
     end
 
     def ci_enabled_cache_key

data/app/models/shipit/status/common.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Status
     module Common

data/app/models/shipit/status/group.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Status
     class Group
@@ -31,7 +32,7 @@ module Shipit
       end
 
       delegate :pending?, :success?, :error?, :failure?, :unknown?, :missing?, :state, :simple_state,
-        to: :significant_status
+               to: :significant_status
       delegate :each, :size, :map, to: :statuses
       delegate :required_statuses, to: :commit
 
@@ -43,8 +44,7 @@ module Shipit
         "#{success_count} / #{statuses.count} checks OK"
       end
 
-      def target_url
-      end
+      def target_url; end
 
       def to_partial_path
         'statuses/group'
@@ -75,8 +75,10 @@ module Shipit
       def select_significant_status(statuses)
         statuses = reject_allowed_to_fail(statuses)
         return Status::Unknown.new(commit) if statuses.empty?
+
         non_success_statuses = statuses.reject(&:success?)
         return statuses.first if non_success_statuses.empty?
+
         non_success_statuses.reject(&:pending?).first || non_success_statuses.first || Status::Unknown.new(commit)
       end
 

data/app/models/shipit/status/missing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Status
     class Missing
@@ -24,7 +25,7 @@ module Shipit
       end
 
       def description
-        I18n.t('missing_status.description', context: context)
+        I18n.t('missing_status.description', context:)
       end
 
       def to_partial_path

data/app/models/shipit/status/unknown.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Status
     class Unknown