shipit-engine 0.28.0 → 0.32.0

data/app/models/shipit/status.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Shipit
-  class Status < ActiveRecord::Base
+  class Status < Record
     include Common
     include DeferredTouch
 
@@ -11,7 +12,7 @@ module Shipit
 
     deferred_touch commit: :updated_at
 
-    validates :state, inclusion: {in: STATES, allow_blank: true}, presence: true
+    validates :state, inclusion: { in: STATES, allow_blank: true }, presence: true
 
     after_create :enable_ci_on_stack
     after_commit :schedule_continuous_delivery, :broadcast_update, on: :create

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

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
 module Shipit
   class Status
     module Common
       def unknown?
-        state == 'unknown'.freeze
+        state == 'unknown'
       end
 
       def pending?
-        state == 'pending'.freeze
+        state == 'pending'
       end
 
       def success?
-        state == 'success'.freeze
+        state == 'success'
       end
 
       def error?
-        state == 'error'.freeze
+        state == 'error'
       end
 
       def failure?
-        state == 'failure'.freeze
+        state == 'failure'
       end
 
       def missing?
@@ -30,7 +31,7 @@ module Shipit
       end
 
       def simple_state
-        state == 'error'.freeze ? 'failure'.freeze : state
+        state == 'error' ? 'failure' : state
       end
 
       def allowed_to_fail?

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class Status
     class Group

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class Status
     class Missing
@@ -15,7 +16,7 @@ module Shipit
       end
 
       def state
-        'pending'.freeze
+        'pending'
       end
 
       def missing?

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class Status
     class Unknown
@@ -21,7 +22,7 @@ module Shipit
       end
 
       def state
-        'unknown'.freeze
+        'unknown'
       end
 
       def missing?

data/app/models/shipit/task.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
 module Shipit
-  class Task < ActiveRecord::Base
+  class Task < Record
     include DeferredTouch
 
     ConcurrentTaskRunning = Class.new(StandardError)
 
-    PRESENCE_CHECK_TIMEOUT = 15
+    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
+    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"
 
     attr_accessor :pid
 
@@ -16,8 +20,10 @@ module Shipit
     belongs_to :user, optional: true
     belongs_to :aborted_by, class_name: 'User', optional: true
     belongs_to :stack, counter_cache: true
-    belongs_to :until_commit, class_name: 'Commit'
-    belongs_to :since_commit, class_name: 'Commit'
+    belongs_to :until_commit, class_name: 'Commit', required: false
+    belongs_to :since_commit, class_name: 'Commit', required: false
+
+    belongs_to :rollback_once_aborted_to, class_name: 'Task', optional: true
 
     deferred_touch stack: :updated_at
 
@@ -29,14 +35,18 @@ module Shipit
     scope :success, -> { where(status: 'success') }
     scope :completed, -> { where(status: COMPLETED_STATUSES) }
     scope :active, -> { where(status: ACTIVE_STATUSES) }
+    scope :not_active, -> { where(status: COMPLETED_STATUSES + UNSUCCESSFUL_STATUSES) }
     scope :exclusive, -> { where(allow_concurrency: false) }
     scope :unsuccessful, -> { where(status: UNSUCCESSFUL_STATUSES) }
+    scope :last_seven_days, -> { where("created_at > ?", 7.days.ago) }
+    scope :previous_seven_days, -> { where(created_at: 14.days.ago..7.days.ago) }
 
     scope :due_for_rollup, -> { completed.where(rolled_up: false).where('created_at <= ?', 1.hour.ago) }
 
     after_save :record_status_change
     after_create :prevent_concurrency, unless: :allow_concurrency?
-    after_commit :emit_hooks
+    after_commit :emit_hooks, on: :create
+    after_commit :emit_hooks_if_status_changed, on: :update
 
     class << self
       def durations
@@ -194,7 +204,15 @@ module Shipit
       if rolled_up?
         output
       else
-        chunks.pluck(:text).join
+        blob = chunks.pluck(:text).join
+
+        if blob.size > OUTPUT_SIZE_LIMIT
+          Rails.logger.warn("Task #{id} output exceeds limit of #{HUMAN_READABLE_OUTPUT_LIMIT}, and will be truncated.")
+          blob = blob.last(OUTPUT_SIZE_LIMIT - OUTPUT_TRUNCATED_MESSAGE.size)
+          blob = OUTPUT_TRUNCATED_MESSAGE + blob
+        end
+
+        blob
       end
     end
 
@@ -276,8 +294,12 @@ module Shipit
       end
     end
 
-    def abort!(rollback_once_aborted: false, aborted_by:)
-      update!(rollback_once_aborted: rollback_once_aborted, aborted_by_id: aborted_by.id)
+    def abort!(rollback_once_aborted: false, rollback_once_aborted_to: nil, aborted_by:)
+      update!(
+        rollback_once_aborted: rollback_once_aborted,
+        rollback_once_aborted_to: rollback_once_aborted_to,
+        aborted_by_id: aborted_by.id
+      )
 
       if alive?
         aborting
@@ -303,9 +325,13 @@ module Shipit
       end
     end
 
-    def emit_hooks
+    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)
     end
 
@@ -327,6 +353,35 @@ module Shipit
       end
     end
 
+    def commit_range?
+      since_commit && until_commit
+    end
+
+    def includes_commit?(commit)
+      return false unless commit_range?
+
+      if since_commit == until_commit
+        commit.id == since_commit.id
+      else
+        commit.id > since_commit.id && commit.id <= until_commit.id
+      end
+    end
+
+    def self.recently_created_at
+      5.minutes.ago
+    end
+
+    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,
+        )
+        .reject(&:alive?)
+    end
+
     private
 
     def prevent_concurrency

data/app/models/shipit/task_definition.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class TaskDefinition
     NotFound = Class.new(StandardError)

data/app/models/shipit/team.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Shipit
-  class Team < ActiveRecord::Base
+  class Team < Record
     REQUIRED_HOOKS = %i(membership).freeze
 
     has_many :memberships

data/app/models/shipit/undeployed_commit.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class UndeployedCommit < DelegateClass(Commit)
     attr_reader :index

data/app/models/shipit/unlimited_api_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class UnlimitedApiClient
     def stack_id?

data/app/models/shipit/user.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Shipit
-  class User < ActiveRecord::Base
+  class User < Record
     DEFAULT_AVATAR = URI.parse('https://avatars.githubusercontent.com/u/583231?')
 
     has_many :memberships
@@ -23,9 +24,9 @@ module Shipit
     end
 
     def self.find_or_create_author_from_github_commit(github_commit)
-      if github_commit.commit.message =~ /^#{PullRequest::MERGE_REQUEST_FIELD}: ([\w\-\.]+)$/
+      if (match_info = github_commit.commit.message.match(/^#{PullRequest::MERGE_REQUEST_FIELD}: ([\w\-\.]+)$/))
         begin
-          return find_or_create_by_login!($1)
+          return find_or_create_by_login!(match_info[1])
         rescue Octokit::NotFound
           # Corner case where the merge-requested-by user cannot be found (renamed/deleted).
           # In this case we carry on and search for the commit author
@@ -68,7 +69,7 @@ module Shipit
     end
 
     def identifiers_for_ping
-      {github_id: github_id, name: name, email: email, github_login: login}
+      { github_id: github_id, name: name, email: email, github_login: login }
     end
 
     def logged_in?
@@ -100,7 +101,7 @@ module Shipit
       assign_attributes(
         github_id: github_user.id,
         name: github_user.name || github_user.login, # Name is not mandatory on GitHub
-        email: github_user.email,
+        email: appropriate_email_for(github_user),
         login: github_user.login,
         avatar_url: github_user.avatar_url,
         api_url: github_user.url,
@@ -123,5 +124,28 @@ module Shipit
     rescue Octokit::NotFound
       false
     end
+
+    def email_valid_and_preferred?(email_address)
+      org_domains = Shipit.preferred_org_emails
+      return true if org_domains.blank?
+      return false if email_address.blank?
+
+      org_domains.any? { |domain| email_address.end_with?("@#{domain}") }
+    end
+
+    def appropriate_email_for(github_user)
+      return github_user.email if email_valid_and_preferred?(github_user.email)
+
+      begin
+        github_api.emails
+          .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}'")
+        nil
+      end
+    end
   end
 end

data/app/models/shipit/variable_definition.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class VariableDefinition
     attr_reader :name, :title, :default, :select

data/app/models/shipit/webhooks.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Shipit
+  module Webhooks
+    class << self
+      def default_handlers
+        {
+          'push' => [Handlers::PushHandler],
+          'status' => [Handlers::StatusHandler],
+          'membership' => [Handlers::MembershipHandler],
+          'check_suite' => [Handlers::CheckSuiteHandler],
+        }
+      end
+
+      def handlers
+        @handlers ||= reset_handlers!
+      end
+
+      def reset_handlers!
+        @handlers = default_handlers
+      end
+
+      def register_handler(event, callable = nil, &block)
+        handlers[event] ||= []
+        handlers[event] << callable if callable
+        handlers[event] << block if block_given?
+      end
+
+      def for_event(event)
+        handlers.fetch(event) { [] }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Shipit
+  module Webhooks
+    module Handlers
+      class CheckSuiteHandler < Handler
+        params do
+          requires :check_suite do
+            requires :head_sha, String
+            requires :head_branch, String
+          end
+        end
+        def process
+          stacks.where(branch: params.check_suite.head_branch).each do |stack|
+            stack.commits.where(sha: params.check_suite.head_sha).each(&:schedule_refresh_check_runs!)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module Shipit
+  module Webhooks
+    module Handlers
+      class Handler
+        class << self
+          attr_reader :param_parser
+
+          def params(&block)
+            @param_parser = ExplicitParameters::Parameters.define(&block)
+          end
+        end
+
+        def self.call(params)
+          new(params).process
+        end
+
+        attr_reader :params, :payload
+
+        def initialize(payload)
+          @payload = payload
+          @params = self.class.param_parser.parse!(payload)
+        end
+
+        def process
+          raise NotImplementedError
+        end
+
+        private
+
+        def stacks
+          @stacks ||= Repository.from_github_repo_name(repository_name)&.stacks || Stack.none
+        end
+
+        def repository_name
+          payload.dig('repository', 'full_name')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Shipit
+  module Webhooks
+    module Handlers
+      class MembershipHandler < Handler
+        params do
+          requires :action, String
+          requires :team do
+            requires :id, Integer
+            requires :name, String
+            requires :slug, String
+            requires :url, String
+          end
+          requires :organization do
+            requires :login, String
+          end
+          requires :member do
+            requires :login, String
+          end
+        end
+        def process
+          team = find_or_create_team!
+          member = User.find_or_create_by_login!(params.member.login)
+
+          case params.action
+          when 'added'
+            team.add_member(member)
+          when 'removed'
+            team.members.delete(member)
+          else
+            raise ArgumentError, "Don't know how to perform action: `#{action.inspect}`"
+          end
+        end
+
+        private
+
+        def find_or_create_team!
+          Team.find_or_create_by!(github_id: params.team.id) do |team|
+            team.github_team = params.team
+            team.organization = params.organization.login
+          end
+        end
+      end
+    end
+  end
+end