shipit-engine 0.39.0 → 0.40.0

data/app/models/shipit/status.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 module Shipit
   class Status < Record
     include Common
     include DeferredTouch
 
-    STATES = %w(pending success failure error).freeze
-    enum state: STATES.zip(STATES).to_h
+    STATES = %w[pending success failure error].freeze
+    enum :state, STATES.zip(STATES).to_h
 
     belongs_to :stack, required: true
     belongs_to :commit, required: true
@@ -22,12 +23,12 @@ module Shipit
     class << self
       def replicate_from_github!(stack_id, github_status)
         find_or_create_by!(
-          stack_id: stack_id,
+          stack_id:,
           state: github_status.state,
           description: github_status.description,
           target_url: github_status.target_url,
           context: github_status.context,
-          created_at: github_status.created_at,
+          created_at: github_status.created_at
         )
       end
     end

data/app/models/shipit/task.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class Task < Record
     include DeferredTouch
@@ -10,12 +11,12 @@ module Shipit
     end
 
     PRESENCE_CHECK_TIMEOUT = 30
-    ACTIVE_STATUSES = %w(pending running aborting).freeze
-    COMPLETED_STATUSES = %w(success flapping faulty validating).freeze
-    UNSUCCESSFUL_STATUSES = %w(error failed aborted flapping timedout faulty).freeze
+    ACTIVE_STATUSES = %w[pending running aborting].freeze
+    COMPLETED_STATUSES = %w[success flapping faulty validating].freeze
+    UNSUCCESSFUL_STATUSES = %w[error failed aborted flapping timedout faulty].freeze
     OUTPUT_SIZE_LIMIT = 16.megabytes # A MySQL mediumblob
     HUMAN_READABLE_OUTPUT_LIMIT = ActionController::Base.helpers.number_to_human_size(OUTPUT_SIZE_LIMIT)
-    OUTPUT_TRUNCATED_MESSAGE = "Output exceeded the limit of #{HUMAN_READABLE_OUTPUT_LIMIT} and was truncated\n"
+    OUTPUT_TRUNCATED_MESSAGE = "Output exceeded the limit of #{HUMAN_READABLE_OUTPUT_LIMIT} and was truncated\n".freeze
 
     attr_accessor :pid
 
@@ -35,6 +36,7 @@ module Shipit
       class << self
         def dump(hash)
           raise TypeError, "Task#env should be a Hash[String => String]" unless hash.is_a?(Hash)
+
           hash = hash.to_h.stringify_keys
           hash.transform_values! do |value|
             case value
@@ -49,7 +51,7 @@ module Shipit
         end
 
         def load(hash)
-          hash&.to_h || {} # cast back to a real hash
+          hash.to_h # cast back to a real hash
         end
 
         def new
@@ -104,11 +106,11 @@ module Shipit
         task.ended_at ||= Time.now.utc
       end
 
-      after_transition any => %i(success failed error timedout) do |task|
+      after_transition any => %i[success failed error timedout] do |task|
         task.async_refresh_deployed_revision
       end
 
-      after_transition any => %i(aborted success failed error timedout) do |task|
+      after_transition any => %i[aborted success failed error timedout] do |task|
         task.schedule_rollup_chunks
       end
 
@@ -120,7 +122,7 @@ module Shipit
         task.async_update_estimated_deploy_duration
       end
 
-      after_transition any => %i(failed error timedout) do |task|
+      after_transition any => %i[failed error timedout] do |task|
         task.retry_if_necessary
       end
 
@@ -129,19 +131,19 @@ module Shipit
       end
 
       event :failure do
-        transition %i(running flapping) => :failed
+        transition %i[running flapping] => :failed
       end
 
       event :complete do
-        transition %i(running flapping validating faulty) => :success
+        transition %i[running flapping validating faulty] => :success
       end
 
       event :enter_validation do
-        transition %i(running flapping) => :validating
+        transition %i[running flapping] => :validating
       end
 
       event :mark_faulty do
-        transition %i(validating success) => :faulty
+        transition %i[validating success] => :faulty
       end
 
       event :error do
@@ -153,7 +155,7 @@ module Shipit
       end
 
       event :aborting do
-        transition all - %i(aborted) => :aborting
+        transition all - %i[aborted] => :aborting
       end
 
       event :aborted do
@@ -161,7 +163,7 @@ module Shipit
       end
 
       event :flap do
-        transition %i(failed error timedout success) => :flapping
+        transition %i[failed error timedout success] => :flapping
       end
 
       state :pending
@@ -206,7 +208,7 @@ module Shipit
     end
 
     delegate :acquire_git_cache_lock, :async_refresh_deployed_revision, :async_update_estimated_deploy_duration,
-      to: :stack
+             to: :stack
 
     delegate :checklist, to: :definition
 
@@ -219,16 +221,18 @@ module Shipit
     end
 
     def spec
-      @spec ||= DeploySpec::FileSystem.new(working_directory, stack.environment)
+      @spec ||= DeploySpec::FileSystem.new(working_directory, stack)
     end
 
     def enqueue
       raise "only persisted jobs can be enqueued" unless persisted?
+
       PerformTaskJob.perform_later(self)
     end
 
     def run_now!
       raise "only persisted jobs can be run" unless persisted?
+
       PerformTaskJob.perform_now(self)
     end
 
@@ -350,10 +354,10 @@ module Shipit
       end
     end
 
-    def abort!(rollback_once_aborted: false, rollback_once_aborted_to: nil, aborted_by:)
+    def abort!(aborted_by:, rollback_once_aborted: false, rollback_once_aborted_to: nil)
       update!(
-        rollback_once_aborted: rollback_once_aborted,
-        rollback_once_aborted_to: rollback_once_aborted_to,
+        rollback_once_aborted:,
+        rollback_once_aborted_to:,
         aborted_by_id: aborted_by.id
       )
 
@@ -383,12 +387,13 @@ module Shipit
 
     def emit_hooks_if_status_changed
       return unless @status_changed
+
       @status_changed = nil
       emit_hooks
     end
 
     def emit_hooks
-      Hook.emit(hook_event, stack, hook_event => self, status: status, stack: stack)
+      Hook.emit(hook_event, stack, hook_event => self, status:, stack:)
     end
 
     def hook_event
@@ -427,13 +432,13 @@ module Shipit
       5.minutes.ago
     end
 
-    ZOMBIE_STATES = %w(running aborting).freeze
+    ZOMBIE_STATES = %w[running aborting].freeze
     private_constant :ZOMBIE_STATES
     def self.zombies
       where(status: ZOMBIE_STATES)
         .where(
           "created_at <= :recently",
-          recently: recently_created_at,
+          recently: recently_created_at
         )
         .reject(&:alive?)
     end
@@ -441,13 +446,13 @@ module Shipit
     def retry_if_necessary
       return unless retries_configured? && !stack.reload.locked?
 
-      if retry_attempt < max_retries
-        retry_task = duplicate_task
-        retry_task.retry_attempt = duplicate_task.retry_attempt + 1
-        retry_task.save!
+      return unless retry_attempt < max_retries
 
-        retry_task.enqueue
-      end
+      retry_task = duplicate_task
+      retry_task.retry_attempt = duplicate_task.retry_attempt + 1
+      retry_task.save!
+
+      retry_task.enqueue
     end
 
     def retries_configured?

data/app/models/shipit/task_definition.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class TaskDefinition
     NotFound = Class.new(StandardError)
@@ -6,18 +7,20 @@ module Shipit
     class << self
       def load(payload)
         return if payload.blank?
+
         json = JSON.parse(payload)
         new(json.delete('id'), json)
       end
 
       def dump(definition)
         return if definition.blank?
+
         JSON.dump(definition.as_json)
       end
     end
 
     attr_reader :id, :action, :description, :steps, :checklist, :variables
-    alias_method :to_param, :id
+    alias to_param id
 
     def initialize(id, config)
       @id = id
@@ -46,14 +49,14 @@ module Shipit
 
     def as_json
       {
-        id: id,
-        action: action,
+        id:,
+        action:,
         title: @title,
-        description: description,
-        steps: steps,
+        description:,
+        steps:,
         variables: variables.map(&:to_h),
-        checklist: checklist,
-        allow_concurrency: allow_concurrency?,
+        checklist:,
+        allow_concurrency: allow_concurrency?
       }
     end
 

data/app/models/shipit/task_execution_strategy/default.rb

@@ -21,16 +21,16 @@ module Shipit
         perform_task
         @task.write("\nCompleted successfully\n")
         @task.report_complete!
-      rescue Command::TimedOut => error
-        @task.write("\n#{error.message}\n")
-        @task.report_timeout!(error)
-      rescue Command::Error => error
-        @task.write("\n#{error.message}\n")
-        @task.report_failure!(error)
-      rescue StandardError => error
-        @task.report_error!(error)
-      rescue Exception => error
-        @task.report_error!(error)
+      rescue Command::TimedOut => e
+        @task.write("\n#{e.message}\n")
+        @task.report_timeout!(e)
+      rescue Command::Error => e
+        @task.write("\n#{e.message}\n")
+        @task.report_failure!(e)
+      rescue StandardError => e
+        @task.report_error!(e)
+      rescue Exception => e
+        @task.report_error!(e)
         raise
       end
 
@@ -42,8 +42,8 @@ module Shipit
         else
           @task.write("Can't abort, no recorded pid, WTF?\n")
         end
-      rescue SystemCallError => error
-        @task.write("kill: (#{pid}) - #{error.message}\n")
+      rescue SystemCallError => e
+        @task.write("kill: (#{pid}) - #{e.message}\n")
       end
 
       def check_for_abort
@@ -94,7 +94,7 @@ module Shipit
           @task.write(line)
         end
         finished_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        @task.write("pid: #{command.pid} finished in: #{finished_at - started_at} seconds\n")
+        @task.write("pid: #{command.pid} finished in: #{(finished_at - started_at).round(3)} seconds\n")
         command.success?
       end
 

data/app/models/shipit/team.rb

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
+
 module Shipit
   class Team < Record
-    REQUIRED_HOOKS = %i(membership).freeze
+    REQUIRED_HOOKS = %i[membership].freeze
 
     has_many :memberships
     has_many :members, class_name: :User, through: :memberships, source: :user
 
     has_many :github_hooks,
-      -> { where(event: REQUIRED_HOOKS) },
-      foreign_key: :organization,
-      primary_key: :organization,
-      class_name: 'GithubHook::Organization',
-      inverse_of: false
+             -> { where(event: REQUIRED_HOOKS) },
+             foreign_key: :organization,
+             primary_key: :organization,
+             class_name: 'GithubHook::Organization',
+             inverse_of: false
 
     class << self
       def find_or_create_by_handle(handle)
         organization, slug = handle.split('/').map(&:downcase)
-        find_by(organization: organization, slug: slug) || fetch_and_create_from_github(organization, slug)
+        find_by(organization:, slug:) || fetch_and_create_from_github(organization, slug)
       end
 
       def fetch_and_create_from_github(organization, slug)
-        if github_team = find_team_on_github(organization, slug)
-          create!(github_team: github_team, organization: organization)
-        end
+        return unless github_team = find_team_on_github(organization, slug)
+
+        create!(github_team:, organization:)
       end
 
       def find_team_on_github(organization, slug)
-        gh_api = Shipit.github(organization: organization).api
+        gh_api = Shipit.github(organization:).api
         teams = Shipit::OctokitIterator.new(github_api: gh_api) { gh_api.org_teams(organization, per_page: 100) }
         teams.find { |t| t.slug == slug }
       rescue Octokit::NotFound
@@ -42,7 +43,7 @@ module Shipit
     end
 
     def refresh_members!
-      github_api = Shipit.github(organization: organization).api
+      github_api = Shipit.github(organization:).api
       github_members = Shipit::OctokitIterator.new(github_api.get(api_url).rels[:members])
       members = github_members.map { |u| User.find_or_create_from_github(u) }
       self.members = members

data/app/models/shipit/undeployed_commit.rb

@@ -1,4 +1,10 @@
 # frozen_string_literal: true
+
+# rubocop:disable Lint/MissingCopEnableDirective, Style/OptionalBooleanParameter
+# Disabling for now because we need to support the `bypass_safeties` parameter
+# in the `deploy_state` and `redeploy_state` methods. We can revisit this later.
+
+require 'delegate'
 module Shipit
   class UndeployedCommit < DelegateClass(Commit)
     attr_reader :index
@@ -26,9 +32,7 @@ module Shipit
 
     def redeploy_state(bypass_safeties = false)
       state = 'allowed'
-      unless bypass_safeties
-        state = 'deploying' if stack.active_task?
-      end
+      state = 'deploying' if !bypass_safeties && stack.active_task?
       state
     end
 
@@ -50,6 +54,7 @@ module Shipit
 
     def blocked?
       return @blocked if defined?(@blocked)
+
       @blocked = super
     end
   end

data/app/models/shipit/unlimited_api_client.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 module Shipit
   class UnlimitedApiClient
     def stack_id?
       false
     end
 
-    def check_permissions!(*)
-    end
+    def check_permissions!(*); end
   end
 end

data/app/models/shipit/user.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Shipit
   class User < Record
     DEFAULT_AVATAR = URI.parse('https://avatars.githubusercontent.com/u/583231?')
 
-    self.ignored_columns = %w(encrypted_github_access_token_iv)
+    self.ignored_columns = %w[encrypted_github_access_token_iv]
 
     has_many :memberships
     has_many :teams, through: :memberships
@@ -19,7 +20,7 @@ module Shipit
     after_find :discard_outdated_credentials!
 
     def self.find_or_create_by_login!(login)
-      find_or_create_by!(login: login) do |user|
+      find_or_create_by!(login:) do |user|
         # Users are global, any app can be used
         # This will not work for users that only exist in an Enterprise install
         user.github_user = Shipit.github.api.user(login)
@@ -31,7 +32,7 @@ module Shipit
     end
 
     def self.find_or_create_author_from_github_commit(github_commit)
-      if (match_info = github_commit.commit.message.match(/^#{MergeRequest::MERGE_REQUEST_FIELD}: ([\w\-\.]+)$/))
+      if (match_info = github_commit.commit.message.match(/^#{MergeRequest::MERGE_REQUEST_FIELD}: ([\w\-.]+)$/))
         begin
           return find_or_create_by_login!(match_info[1])
         rescue Octokit::NotFound
@@ -48,11 +49,12 @@ module Shipit
 
     def self.find_from_github(github_user)
       return unless github_user.id
+
       find_by(github_id: github_user.id)
     end
 
     def self.create_from_github(github_user)
-      create(github_user: github_user)
+      create(github_user:)
     end
 
     def self.refresh_shard(shard_index, shards_count)
@@ -68,7 +70,7 @@ module Shipit
     end
 
     def identifiers_for_ping
-      { github_id: github_id, name: name, email: email, github_login: login }
+      { github_id:, name:, email:, github_login: login }
     end
 
     def logged_in?
@@ -81,12 +83,14 @@ module Shipit
 
     def repositories_contributed_to
       return [] unless id
+
       Stack.where(id: stacks_contributed_to).distinct.pluck(:repository_id)
     end
 
     def stacks_contributed_to
       return [] unless id
-      Commit.where('author_id = :id or committer_id = :id', id: id).distinct.pluck(:stack_id)
+
+      Commit.where('author_id = :id or committer_id = :id', id:).distinct.pluck(:stack_id)
     end
 
     def refresh_from_github!
@@ -112,7 +116,7 @@ module Shipit
         email: appropriate_email_for(github_user),
         login: github_user.login,
         avatar_url: github_user.avatar_url,
-        api_url: github_user.url,
+        api_url: github_user.url
       )
     end
 
@@ -132,18 +136,19 @@ module Shipit
     private
 
     def discard_outdated_credentials!
-      if encrypted_github_access_token_before_type_cast.present?
-        begin
-          encrypted_github_access_token
-        rescue ActiveRecord::Encryption::Errors::Decryption
-          update_column(:encrypted_github_access_token, nil)
-        end
+      return unless encrypted_github_access_token_before_type_cast.present?
+
+      begin
+        encrypted_github_access_token
+      rescue ActiveRecord::Encryption::Errors::Decryption
+        update_column(:encrypted_github_access_token, nil)
       end
     end
 
     def identify_renamed_user!
       last_commit = commits.last
       return unless last_commit
+
       github_author = last_commit.github_commit.author
       update!(github_user: github_author)
     rescue Octokit::NotFound
@@ -163,9 +168,9 @@ module Shipit
 
       begin
         github_api.emails
-          .sort_by { |e| e.primary ? 0 : 1 }
-          .map(&:email)
-          .find { |e| email_valid_and_preferred?(e) }
+                  .sort_by { |e| e.primary ? 0 : 1 }
+                  .map(&:email)
+                  .find { |e| email_valid_and_preferred?(e) }
       rescue Octokit::NotFound, Octokit::Forbidden, Octokit::Unauthorized
         # If the user hasn't agreed to the necessary permission, we can't access their private emails.
         Rails.logger.warn("Failed to retrieve emails for user '#{github_user.name || github_user.login}'")

data/app/models/shipit/variable_definition.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class VariableDefinition
     attr_reader :name, :title, :default, :select
@@ -20,7 +21,7 @@ module Shipit
         'name' => @name,
         'title' => @title,
         'default' => @default,
-        'select' => @select,
+        'select' => @select
       }
     end
   end

data/app/models/shipit/webhooks/handlers/check_suite_handler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Webhooks
     module Handlers

data/app/models/shipit/webhooks/handlers/handler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Webhooks
     module Handlers

data/app/models/shipit/webhooks/handlers/membership_handler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Webhooks
     module Handlers

data/app/models/shipit/webhooks/handlers/pull_request/assigned_handler.rb

@@ -52,16 +52,16 @@ module Shipit
 
           def pull_request
             @pull_request ||= Shipit::PullRequest
-              .joins(:stack, stack: :repository)
-              .find_by(
-                number: params.number,
-                stacks: {
-                  repositories:
-                    {
-                      id: repository.id,
-                    },
-                }
-              )
+                              .joins(:stack, stack: :repository)
+                              .find_by(
+                                number: params.number,
+                                stacks: {
+                                  repositories:
+                                    {
+                                      id: repository.id
+                                    }
+                                }
+                              )
           end
 
           def repository

data/app/models/shipit/webhooks/handlers/pull_request/closed_handler.rb

@@ -55,7 +55,7 @@ module Shipit
           def review_stack
             @review_stack ||=
               Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter
-                .new(params, scope: repository.review_stacks)
+              .new(params, scope: repository.review_stacks)
           end
 
           def respond_to_pull_request_closed?

data/app/models/shipit/webhooks/handlers/pull_request/edited_handler.rb

@@ -48,16 +48,16 @@ module Shipit
 
           def pull_request
             @pull_request ||= Shipit::PullRequest
-              .joins(:stack, stack: :repository)
-              .find_by(
-                number: params.number,
-                stacks: {
-                  repositories:
-                    {
-                      id: repository.id,
-                    },
-                }
-              )
+                              .joins(:stack, stack: :repository)
+                              .find_by(
+                                number: params.number,
+                                stacks: {
+                                  repositories:
+                                    {
+                                      id: repository.id
+                                    }
+                                }
+                              )
           end
 
           def repository

data/app/models/shipit/webhooks/handlers/pull_request/label_capturing_handler.rb

@@ -104,13 +104,13 @@ module Shipit
           def review_stack
             @review_stack ||=
               Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter
-                .new(params, scope: repository.review_stacks)
+              .new(params, scope: repository.review_stacks)
           end
 
           def repository
             @repository ||=
               Shipit::Repository
-                .from_github_repo_name(params.repository.full_name) || NullRepository.new
+              .from_github_repo_name(params.repository.full_name) || NullRepository.new
           end
 
           def stack

data/app/models/shipit/webhooks/handlers/pull_request/labeled_handler.rb

@@ -59,12 +59,12 @@ module Shipit
           def stack
             @stack ||=
               Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter
-                .new(params, scope: repository.review_stacks)
+              .new(params, scope: repository.review_stacks)
           end
 
           def repository
             @repository ||= Shipit::Repository.from_github_repo_name(params.repository.full_name) ||
-              Shipit::NullRepository.new
+                            Shipit::NullRepository.new
           end
 
           def pull_request