shipit-engine 0.38.0 → 0.40.0

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!
@@ -95,6 +99,8 @@ module Shipit
       update!(github_user: Shipit.github.api.user(github_id))
     rescue Octokit::NotFound
       identify_renamed_user!
+    rescue Octokit::Forbidden
+      Rails.logger.info("User #{name}, github_id #{github_id} has forbidden access to their GitHub, likely deleted.")
     end
 
     def github_user=(github_user)
@@ -110,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
 
@@ -130,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
@@ -161,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

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

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

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

@@ -13,7 +13,7 @@ module Shipit
           end
 
           def stack
-            @stack ||= scope.find_by(environment: environment)
+            @stack ||= scope.find_by(environment:)
           end
 
           def find_or_create!
@@ -87,9 +87,9 @@ module Shipit
           def stack_attributes
             {
               branch: params.pull_request.head.ref,
-              environment: environment,
+              environment:,
               ignore_ci: false,
-              continuous_deployment: false,
+              continuous_deployment: false
             }
           end
 

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

@@ -65,7 +65,7 @@ module Shipit
           def stack
             @stack ||=
               Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter
-                .new(params, scope: repository.review_stacks)
+              .new(params, scope: repository.review_stacks)
           end
 
           def pull_request

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Webhooks
     module Handlers
@@ -9,7 +10,7 @@ module Shipit
         def process
           stacks
             .not_archived
-            .where(branch: branch)
+            .where(branch:)
             .find_each(&:sync_github)
         end
 

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

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

data/app/models/shipit/webhooks.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Webhooks
     class << self
@@ -13,11 +14,11 @@ module Shipit
             Handlers::PullRequest::AssignedHandler,
             Handlers::PullRequest::LabeledHandler,
             Handlers::PullRequest::UnlabeledHandler,
-            Handlers::PullRequest::LabelCapturingHandler,
+            Handlers::PullRequest::LabelCapturingHandler
           ],
           'status' => [Handlers::StatusHandler],
           'membership' => [Handlers::MembershipHandler],
-          'check_suite' => [Handlers::CheckSuiteHandler],
+          'check_suite' => [Handlers::CheckSuiteHandler]
         }
       end
 

data/app/serializers/concerns/shipit/conditional_attributes.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module ConditionalAttributes
     extend ActiveSupport::Concern

data/app/serializers/shipit/anonymous_user_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class AnonymousUserSerializer < UserSerializer
   end

data/app/serializers/shipit/command_line_user_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommandLineUserSerializer < UserSerializer
   end

data/app/serializers/shipit/commit_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitSerializer < ShortCommitSerializer
     include GithubUrlHelper
@@ -24,7 +25,7 @@ module Shipit
     def pull_request
       {
         number: object.pull_request_number,
-        html_url: github_pull_request_url(object),
+        html_url: github_pull_request_url(object)
       }
     end
 

data/app/serializers/shipit/deploy_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class DeploySerializer < TaskSerializer
     include GithubUrlHelper

data/app/serializers/shipit/hook_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class HookSerializer < ActiveModel::Serializer
     include ConditionalAttributes

data/app/serializers/shipit/merge_request_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class MergeRequestSerializer < ActiveModel::Serializer
     include GithubUrlHelper
@@ -8,7 +9,7 @@ module Shipit
     has_one :head, serializer: ShortCommitSerializer
 
     attributes :id, :number, :title, :github_id, :additions, :deletions, :state, :merge_status, :mergeable,
-      :merge_requested_at, :rejection_reason, :html_url, :branch, :base_ref
+               :merge_requested_at, :rejection_reason, :html_url, :branch, :base_ref
 
     def html_url
       github_pull_request_url(object)

data/app/serializers/shipit/rollback_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class RollbackSerializer < DeploySerializer
     def type

data/app/serializers/shipit/short_commit_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ShortCommitSerializer < ActiveModel::Serializer
     attributes :sha, :message

data/app/serializers/shipit/stack_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class StackSerializer < ActiveModel::Serializer
     include ConditionalAttributes
@@ -6,9 +7,9 @@ module Shipit
     has_one :lock_author
 
     attributes :id, :repo_owner, :repo_name, :environment, :html_url, :url, :tasks_url, :deploy_url,
-      :merge_requests_url, :deploy_spec, :undeployed_commits_count, :is_locked, :lock_reason, :continuous_deployment,
-      :created_at, :updated_at, :locked_since, :last_deployed_at, :branch, :merge_queue_enabled, :is_archived,
-      :archived_since, :ignore_ci
+               :merge_requests_url, :deploy_spec, :undeployed_commits_count, :is_locked, :lock_reason,
+               :continuous_deployment, :created_at, :updated_at, :locked_since, :last_deployed_at, :branch,
+               :merge_queue_enabled, :is_archived, :archived_since, :ignore_ci
 
     def url
       api_stack_url(object)

data/app/serializers/shipit/tail_task_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class TailTaskSerializer < ActiveModel::Serializer
     include ChunksHelper
@@ -8,6 +9,7 @@ module Shipit
 
     def url
       return @url if defined? @url
+
       @url = next_chunks_url(task, last_byte: next_offset)
     end
 
@@ -29,7 +31,7 @@ module Shipit
 
     private
 
-    alias_method :task, :object
+    alias task object
     delegate :stack, to: :object
 
     def next_offset
@@ -42,6 +44,7 @@ module Shipit
 
     def rollback
       return @rollback if defined? @rollback
+
       @rollback = stack.rollbacks.where(parent_id: task.id).last
     end
   end

data/app/serializers/shipit/task_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class TaskSerializer < ActiveModel::Serializer
     include ConditionalAttributes

data/app/serializers/shipit/user_serializer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class UserSerializer < ActiveModel::Serializer
     attributes :id, :name, :email, :login, :avatar_url, :created_at, :updated_at, :github_id, :anonymous

data/app/validators/ascii_only_validator.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 class AsciiOnlyValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    if value && !value.ascii_only?
-      record.errors.add(attribute, :ascii)
-    end
+    return unless value && !value.ascii_only?
+
+    record.errors.add(attribute, :ascii)
   end
 end

data/app/validators/subset_validator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class SubsetValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     superset = options[:of]