shipit-engine 0.38.0 → 0.40.0

data/app/models/shipit/commit.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Commit < Record
     include DeferredTouch
@@ -21,7 +22,7 @@ module Shipit
     after_create { stack.update_undeployed_commits_count }
 
     after_commit :schedule_refresh_statuses!, :schedule_refresh_check_runs!, :schedule_fetch_stats!,
-      :schedule_continuous_delivery, on: :create
+                 :schedule_continuous_delivery, on: :create
 
     belongs_to :author, class_name: 'User', optional: true, inverse_of: :authored_commits
     belongs_to :committer, class_name: 'User', optional: true, inverse_of: :commits
@@ -54,25 +55,29 @@ module Shipit
     scope :reachable, -> { where(detached: false) }
 
     delegate :broadcast_update, :github_repo_name, :hidden_statuses, :required_statuses, :blocking_statuses,
-      :soft_failing_statuses, to: :stack
+             :soft_failing_statuses, to: :stack
 
     def self.newer_than(commit)
       return all unless commit
+
       where('id > ?', commit.try(:id) || commit)
     end
 
     def self.older_than(commit)
       return all unless commit
+
       where('id < ?', commit.try(:id) || commit)
     end
 
     def self.since(commit)
       return all unless commit
+
       where('id >= ?', commit.try(:id) || commit)
     end
 
     def self.until(commit)
       return all unless commit
+
       where('id <= ?', commit.try(:id) || commit)
     end
 
@@ -85,12 +90,11 @@ module Shipit
     end
 
     def self.by_sha(sha)
-      if sha.to_s.size < 6
-        raise AmbiguousRevision, "Short SHA1 #{sha} is ambiguous (too short)"
-      end
+      raise AmbiguousRevision, "Short SHA1 #{sha} is ambiguous (too short)" if sha.to_s.size < 6
 
       commits = where('sha like ?', "#{sha}%").take(2)
       raise AmbiguousRevision, "Short SHA1 #{sha} is ambiguous (matches multiple commits)" if commits.size > 1
+
       commits.first
     end
 
@@ -107,26 +111,22 @@ module Shipit
       record = new(
         sha: commit.sha,
         message: commit.commit.message,
-        author:  author,
-        committer: committer,
+        author:,
+        committer:,
         committed_at: commit.commit.committer.date,
         authored_at: commit.commit.author.date,
         additions: commit.stats&.additions,
-        deletions: commit.stats&.deletions,
+        deletions: commit.stats&.deletions
       )
 
-      if record.pull_request?
-        record.pull_request_head_sha = commit.parents.last.sha
-      end
+      record.pull_request_head_sha = commit.parents.last.sha if record.pull_request?
 
       record
     end
 
     def message=(message)
       limit = self.class.columns_hash['message'].limit
-      if limit && message && message.bytesize > limit
-        message = message.truncate_bytes(limit)
-      end
+      message = message.truncate_bytes(limit) if limit && message && message.bytesize > limit
       super(message)
     end
 
@@ -168,10 +168,26 @@ module Shipit
       end
     end
 
-    def refresh_check_runs!
+    def paginated_check_runs
       response = stack.handle_github_redirections do
-        stack.github_api.check_runs(github_repo_name, sha)
+        stack.github_api.check_runs(github_repo_name, sha, per_page: 100)
+      end
+
+      return response if stack.github_api.last_response.rels[:next].nil?
+
+      loop do
+        page = stack.handle_github_redirections do
+          stack.github_api.get(stack.github_api.last_response.rels[:next].href)
+        end
+        response.check_runs.concat(page.check_runs)
+        break if stack.github_api.last_response.rels[:next].nil?
       end
+
+      response
+    end
+
+    def refresh_check_runs!
+      response = paginated_check_runs
       response.check_runs.each do |check_run|
         create_or_update_check_run_from_github!(check_run)
       end
@@ -190,11 +206,11 @@ module Shipit
 
       @last_release_status = nil
       release_statuses.create!(
-        stack: stack,
-        user: user,
-        state: state,
-        target_url: target_url,
-        description: description,
+        stack:,
+        user:,
+        state:,
+        target_url:,
+        description:
       )
     end
 
@@ -223,7 +239,7 @@ module Shipit
     end
 
     def children
-      self.class.where(stack_id: stack_id).newer_than(self)
+      self.class.where(stack_id:).newer_than(self)
     end
 
     def detach_children!
@@ -266,6 +282,7 @@ module Shipit
 
     def schedule_continuous_delivery
       return unless deployable? && stack.continuous_deployment? && stack.deployable?
+
       # This buffer is to allow for statuses and checks to be refreshed before evaluating if the commit is deployable
       # - e.g. if the commit was fast-forwarded with already passing CI.
       ContinuousDeliveryJob.set(wait: RECENT_COMMIT_THRESHOLD).perform_later(stack)
@@ -282,7 +299,7 @@ module Shipit
     def fetch_stats!
       update!(
         additions: github_commit.stats&.additions,
-        deletions: github_commit.stats&.deletions,
+        deletions: github_commit.stats&.deletions
       )
     end
 
@@ -300,6 +317,7 @@ module Shipit
 
     def identify_merge_request
       return unless message_parser.pull_request?
+
       if merge_request = stack.merge_requests.find_by(number: message_parser.pull_request_number)
         self.merge_request = merge_request
         self.pull_request_number = merge_request.number
@@ -322,14 +340,14 @@ module Shipit
     def lock(user)
       update!(
         locked: true,
-        lock_author_id: user.id,
+        lock_author_id: user.id
       )
     end
 
     def self.lock_all(user)
       update_all(
         locked: true,
-        lock_author_id: user.id,
+        lock_author_id: user.id
       )
     end
 
@@ -356,19 +374,15 @@ module Shipit
       new_status = status
 
       unless already_deployed
-        payload = { commit: self, stack: stack, status: new_status.state }
-        if previous_status != new_status
-          Hook.emit(:commit_status, stack, payload.merge(commit_status: new_status))
-        end
+        payload = { commit: self, stack:, status: new_status.state }
+        Hook.emit(:commit_status, stack, payload.merge(commit_status: new_status)) if previous_status != new_status
       end
 
       if previous_status.simple_state != new_status.simple_state
         if !already_deployed && (!new_status.pending? || previous_status.unknown?)
           Hook.emit(:deployable_status, stack, payload.merge(deployable_status: new_status))
         end
-        if new_status.pending? || new_status.success?
-          stack.schedule_merges
-        end
+        stack.schedule_merges if new_status.pending? || new_status.success?
       end
       new_status
     end

data/app/models/shipit/commit_checks.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitChecks < EphemeralCommitChecks
     OUTPUT_TTL = 10.minutes.to_i
-    FINAL_STATUSES = %w(failed error success).freeze
+    FINAL_STATUSES = %w[failed error success].freeze
 
     def initialize(commit)
       @commit = commit
@@ -16,12 +17,13 @@ module Shipit
 
     def schedule
       return false if Shipit.redis.get(key('status')).present?
+
       synchronize do
         return false if Shipit.redis.get(key('status')).present?
 
         initialize_redis_state
       end
-      PerformCommitChecksJob.perform_later(commit: commit)
+      PerformCommitChecksJob.perform_later(commit:)
       true
     end
 

data/app/models/shipit/commit_deployment.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitDeployment < Record
     belongs_to :task
@@ -11,8 +12,8 @@ module Shipit
     def create_on_github!
       create_deployment_on_github!
       statuses.order(id: :asc).each(&:create_on_github!)
-    rescue Octokit::NotFound, Octokit::Forbidden => error
-      Rails.logger.warn("Got #{error.class.name} creating deployment or statuses: #{error.message}")
+    rescue Octokit::NotFound, Octokit::Forbidden => e
+      Rails.logger.warn("Got #{e.class.name} creating deployment or statuses: #{e.message}")
       # If no one can create the deployment we can only give up
     end
 
@@ -23,6 +24,7 @@ module Shipit
         create_deployment_on_github(stack.github_api)
       rescue Octokit::ClientError
         raise if Shipit.github(organization: stack.repository.owner).api == stack.github_api
+
         # If the deploy author didn't gave us the permission to create the deployment we falback the the main shipit
         # user.
         #
@@ -55,9 +57,9 @@ module Shipit
           shipit: {
             task_id: task.id,
             from_sha: task.since_commit.sha,
-            to_sha: task.until_commit.sha,
-          },
-        }.to_json,
+            to_sha: task.until_commit.sha
+          }
+        }.to_json
       )
     end
   end

data/app/models/shipit/commit_deployment_status.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitDeploymentStatus < Record
     DESCRIPTION_CHARACTER_LIMIT_ON_GITHUB = 140
@@ -11,10 +12,12 @@ module Shipit
 
     def create_on_github!
       return if github_id?
+
       response = begin
         create_status_on_github(stack.github_api)
       rescue Octokit::ClientError
         raise if Shipit.github(organization: stack.repository.owner).api == stack.github_api
+
         # If the deploy author didn't gave us the permission to create the deployment we falback the the main shipit
         # user.
         #
@@ -30,7 +33,7 @@ module Shipit
         "deployment_description.#{task_type}.#{status}",
         sha: task.until_commit.short_sha,
         author: task.author.login,
-        stack: stack.to_param,
+        stack: stack.to_param
       )
     end
 
@@ -48,10 +51,9 @@ module Shipit
       client.create_deployment_status(
         commit_deployment.api_url,
         status,
-        accept: 'application/vnd.github.flash-preview+json',
         target_url: url_helpers.stack_deploy_url(stack, task),
         description: description.truncate(DESCRIPTION_CHARACTER_LIMIT_ON_GITHUB),
-        environment_url: stack.deploy_url,
+        environment_url: stack.deploy_url
       )
     end
 

data/app/models/shipit/commit_message.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitMessage
     GITHUB_MERGE_COMMIT_PATTERN = /\AMerge pull request #(?<pr_id>\d+) from \S+\n\n(?<pr_title>.*)/
@@ -27,6 +28,7 @@ module Shipit
 
     def parsed
       return @parsed if defined?(@parsed)
+
       @parsed = to_s.match(GITHUB_MERGE_COMMIT_PATTERN)
     end
   end

data/app/models/shipit/continuous_delivery_schedule.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Shipit
+  class ContinuousDeliverySchedule < Record
+    belongs_to(:stack)
+
+    DAYS = %w[sunday monday tuesday wednesday thursday friday saturday].freeze
+
+    validates(
+      *DAYS.map { |day| "#{day}_enabled" },
+      inclusion: [true, false]
+    )
+
+    validates(
+      *DAYS.product([:start, :end]).map { |parts| parts.join("_") },
+      presence: true
+    )
+
+    validate(:validate_time_windows)
+
+    DeploymentWindow = Struct.new(:starts_at, :ends_at, :enabled) do
+      alias_method :enabled?, :enabled
+    end
+
+    def can_deploy?(now = Time.current)
+      # Make sure time is in the default time zone so weekdays match what is
+      # stored in the database.
+      now = now.in_time_zone(Time.zone)
+
+      deployment_window = get_deployment_window(now.to_date)
+
+      deployment_window.enabled? &&
+        now >= deployment_window.starts_at &&
+        now <= deployment_window.ends_at
+    end
+
+    def get_deployment_window(date)
+      wday_name = DAYS.fetch(date.wday)
+
+      enabled = read_attribute("#{wday_name}_enabled")
+
+      starts_at, ends_at = [:start, :end].map do |bound|
+        raw_time = read_attribute("#{wday_name}_#{bound}")
+
+        # `ActiveRecord::Type::Time` attributes are stored as timestamps
+        # normalized to 2000-01-01 so they can't be used for comparisons without
+        # having their dates adjusted.
+        # https://github.com/rails/rails/blob/ec667e5f114df58087493096253541f1034815af/activemodel/lib/active_model/type/time.rb#L23
+        Time.zone.local(
+          date.year,
+          date.month,
+          date.day,
+          raw_time.hour,
+          raw_time.min
+        )
+      end
+
+      DeploymentWindow.new(
+        starts_at,
+        # Includes the full minute in the configured range. This is required so
+        # that a window configured to end at 17:59 actually ends at 17:59:59
+        # instead of 17:59:00.
+        ends_at.at_end_of_minute,
+        enabled
+      )
+    end
+
+    private
+
+    # Make sure every `*_end` attribute comes after its matching `*_start`
+    # attribute
+    def validate_time_windows
+      DAYS.each do |day|
+        day_start, day_end = [:start, :end].map { |bound| read_attribute("#{day}_#{bound}") }
+
+        next unless day_start && day_end
+
+        next if day_start <= day_end
+
+        errors.add("#{day}_end", :must_be_after_start, start: day_start.strftime("%I:%M %p"))
+      end
+    end
+  end
+end

data/app/models/shipit/delivery.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 module Shipit
   class Delivery < Record
-    STATUSES = %w(pending scheduled sent).freeze
-    enum status: STATUSES.zip(STATUSES).to_h
+    STATUSES = %w[pending scheduled sent].freeze
+    enum :status, STATUSES.zip(STATUSES).to_h
 
     belongs_to :hook
 
     validates :url, presence: true, url: { no_local: true, allow_blank: true }
     validates :content_type, presence: true
 
-    serialize :response_headers, SafeJSON
+    serialize :response_headers, coder: SafeJSON
 
     after_commit :purge_old_deliveries, on: :create
 
@@ -47,7 +48,7 @@ module Shipit
         'Content-Type' => content_type,
         'X-Shipit-Event' => event,
         'X-Shipit-Delivery' => id.to_s,
-        'Accept' => '*/*',
+        'Accept' => '*/*'
       }
     end
   end

data/app/models/shipit/deploy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'fileutils'
 
 module Shipit
@@ -26,7 +27,7 @@ module Shipit
         'success' => 'success',
         'faulty' => 'error',
         'error' => 'error',
-        'aborted' => 'error',
+        'aborted' => 'error'
       }.freeze
 
       def append_status(task_status)
@@ -37,7 +38,7 @@ module Shipit
               "Creating #{github_status} deploy status for deployment #{deployment.id}. "\
               "Commit: #{deployment.sha}, Github id: #{deployment.github_id}, "\
               "Repo: #{deployment.stack.repo_name}, Environment: #{deployment.stack.environment}, "\
-              "API Url: #{deployment.api_url}.",
+              "API Url: #{deployment.api_url}."
             )
             deployment.statuses.create!(status: github_status)
           end
@@ -47,7 +48,7 @@ module Shipit
               "No GitHub status for task status #{task_status}. "\
               "Commit: #{deployment.sha}, Github id: #{deployment.github_id}, "\
               "Repo: #{deployment.stack.repo_name}, Environment: #{deployment.stack.environment}, "\
-              "API Url: #{deployment.api_url}.",
+              "API Url: #{deployment.api_url}."
             )
           end
         end
@@ -64,70 +65,75 @@ module Shipit
 
     def self.newer_than(deploy)
       return all unless deploy
+
       where('id > ?', deploy.try(:id) || deploy)
     end
 
     def self.older_than(deploy)
       return all unless deploy
+
       where('id < ?', deploy.try(:id) || deploy)
     end
 
     def self.since(deploy)
       return all unless deploy
+
       where('id >= ?', deploy.try(:id) || deploy)
     end
 
     def self.until(deploy)
       return all unless deploy
+
       where('id <= ?', deploy.try(:id) || deploy)
     end
 
     def build_rollback(user = nil, env: nil, force: false)
       Rollback.new(
         user_id: user&.id,
-        stack_id: stack_id,
+        stack_id:,
         parent_id: id,
         since_commit: stack.last_deployed_commit,
-        until_commit: until_commit,
-        env: env&.to_h || {},
+        until_commit:,
+        env: env.to_h,
         allow_concurrency: force,
         ignored_safeties: force,
-        max_retries: stack.retries_on_rollback,
+        max_retries: stack.retries_on_rollback
       )
     end
 
     # Rolls the stack back to this deploy
     def trigger_rollback(user = AnonymousUser.new, env: nil, force: false, lock: true)
-      rollback = build_rollback(user, env: env, force: force)
+      rollback = build_rollback(user, env:, force:)
       rollback.save!
       rollback.enqueue
 
       if lock
         lock_reason = "A rollback for #{rollback.since_commit.sha} has been triggered. " \
           "Please make sure the reason for the rollback has been addressed before deploying again."
-        stack.update!(lock_reason: lock_reason, lock_author_id: user.id)
+        stack.update!(lock_reason:, lock_author_id: user.id)
       end
 
       rollback
     end
 
     # Rolls the stack back to the most recent **previous** successful deploy
-    def trigger_revert(force: false, rollback_to: nil)
+    def trigger_revert(force: false, rollback_to: nil, env: nil)
       previous_successful_commit = rollback_to&.until_commit || commit_to_rollback_to
 
       rollback = Rollback.create!(
-        user_id: user_id,
-        stack_id: stack_id,
+        user_id:,
+        stack_id:,
         parent_id: id,
         since_commit: until_commit,
         until_commit: previous_successful_commit,
-        allow_concurrency: force,
+        env: env || self.env,
+        allow_concurrency: force
       )
 
       rollback.enqueue
       lock_reason = "A rollback for #{until_commit.sha} has been triggered. " \
         "Please make sure the reason for the rollback has been addressed before deploying again."
-      stack.update!(lock_reason: lock_reason, lock_author_id: user_id)
+      stack.update!(lock_reason:, lock_author_id: user_id)
       stack.emit_lock_hooks
       rollback
     end
@@ -176,6 +182,7 @@ module Shipit
 
     def reject!
       return if failed? || aborted?
+
       transaction do
         flap! unless flapping?
         update!(confirmations: [confirmations - 1, -1].min)
@@ -185,6 +192,7 @@ module Shipit
 
     def accept!
       return if success?
+
       transaction do
         flap! unless flapping?
         update!(confirmations: [confirmations + 1, 1].max)
@@ -198,13 +206,12 @@ module Shipit
 
     delegate :last_release_status, to: :until_commit
     def append_release_status(state, description, user: self.user)
-      status = until_commit.create_release_status!(
+      until_commit.create_release_status!(
         state,
         user: user.presence,
         target_url: permalink,
-        description: description,
+        description:
       )
-      status
     end
 
     def permalink
@@ -225,7 +232,7 @@ module Shipit
         append_release_status(
           'success',
           description,
-          user: user,
+          user:
         )
       end
     end
@@ -236,7 +243,7 @@ module Shipit
         append_release_status(
           'failure',
           description,
-          user: user,
+          user:
         )
       end
     end
@@ -254,6 +261,7 @@ module Shipit
       # Create one for each pull request in the batch, to give feedback on the PR timeline
       commits.select(&:pull_request?).each do |commit|
         next if commit.pull_request_head_sha.blank? # This attribute was not always populated
+
         commit_deployments.create!(sha: commit.pull_request_head_sha)
       end
 
@@ -272,13 +280,17 @@ module Shipit
       when 'aborted', 'aborting'
         append_release_status('failure', "The deploy on #{stack.environment} was canceled")
       when 'validating'
-        append_release_status(
-          'pending',
-          "The deploy on #{stack.environment} succeeded"
-        ) unless stack.release_status_delay.zero?
+        unless stack.release_status_delay.zero?
+          append_release_status(
+            'pending',
+            "The deploy on #{stack.environment} succeeded"
+          )
+        end
 
-        MarkDeployHealthyJob.set(wait: stack.release_status_delay)
-          .perform_later(self) if stack.release_status_delay.positive?
+        if stack.release_status_delay.positive?
+          MarkDeployHealthyJob.set(wait: stack.release_status_delay)
+                              .perform_later(self)
+        end
       when 'success'
         if stack.release_status_delay.zero?
           append_release_status('success', "The deploy on #{stack.environment} succeeded")
@@ -289,11 +301,17 @@ module Shipit
     def trigger_revert_if_required
       return unless rollback_once_aborted?
       return unless supports_rollback?
-      trigger_revert(rollback_to: rollback_once_aborted_to)
+
+      if rollback_once_aborted_to
+        rollback_once_aborted_to.trigger_rollback(aborted_by, env:, force: true)
+      else
+        trigger_revert(force: true, env:)
+      end
     end
 
     def default_since_commit_id
       return unless stack
+
       @default_since_commit_id ||= stack.last_completed_deploy&.until_commit_id
     end
 
@@ -308,6 +326,7 @@ module Shipit
 
     def schedule_continuous_delivery
       return unless stack.continuous_deployment?
+
       ContinuousDeliveryJob.perform_later(stack)
     end
 
@@ -321,6 +340,7 @@ module Shipit
 
     def update_latest_deployed_ref
       return unless previous_changes.include?(:status)
+
       stack.update_latest_deployed_ref if previous_changes[:status].last == 'success'
     end
   end

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

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 module Shipit
   class DeploySpec
     module BundlerDiscovery
-      DEFAULT_BUNDLER_WITHOUT = %w(default production development test staging benchmark debug).freeze
+      DEFAULT_BUNDLER_WITHOUT = %w[default production development test staging benchmark debug].freeze
 
       def discover_dependencies_steps
         discover_bundler || super
@@ -43,6 +44,7 @@ module Shipit
       def frozen_flag
         return unless gemfile_lock_exists?
         return if config('dependencies', 'bundler', 'frozen') == false
+
         '--frozen'
       end