shipit-engine 0.28.0 → 0.32.0

data/app/models/shipit/check_run.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 module Shipit
   class CheckRun < ApplicationRecord
-    CONCLUSIONS = %w(success failure neutral cancelled timed_out action_required).freeze
+    CONCLUSIONS = %w(success failure neutral cancelled timed_out action_required stale).freeze
     include DeferredTouch
     include Status::Common
 
@@ -9,7 +10,7 @@ module Shipit
 
     deferred_touch commit: :updated_at
 
-    validates :conclusion, inclusion: {in: CONCLUSIONS, allow_nil: true}
+    validates :conclusion, inclusion: { in: CONCLUSIONS, allow_nil: true }
 
     after_create :enable_ci_on_stack
 
@@ -45,7 +46,7 @@ module Shipit
         'pending'
       when 'success', 'neutral'
         'success'
-      when 'failure', 'cancelled'
+      when 'failure', 'cancelled', 'stale'
         'failure'
       when 'timed_out'
         'error'

data/app/models/shipit/command_line_user.rb

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

data/app/models/shipit/commit.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
 module Shipit
-  class Commit < ActiveRecord::Base
+  class Commit < Record
     include DeferredTouch
 
+    RECENT_COMMIT_THRESHOLD = 10.seconds
+
     AmbiguousRevision = Class.new(StandardError)
 
     belongs_to :stack
@@ -90,7 +93,7 @@ module Shipit
       committer = User.find_or_create_committer_from_github_commit(commit)
       committer ||= Anonymous.new
 
-      new(
+      record = new(
         sha: commit.sha,
         message: commit.commit.message,
         author:  author,
@@ -100,6 +103,20 @@ module Shipit
         additions: commit.stats&.additions,
         deletions: commit.stats&.deletions,
       )
+
+      if record.pull_request?
+        record.pull_request_head_sha = commit.parents.last.sha
+      end
+
+      record
+    end
+
+    def message=(message)
+      limit = self.class.columns_hash['message'].limit
+      if limit && message && message.size > limit
+        message = message.truncate_bytes(limit)
+      end
+      super(message)
     end
 
     def reload(*)
@@ -126,7 +143,9 @@ module Shipit
     end
 
     def refresh_statuses!
-      github_statuses = stack.handle_github_redirections { Shipit.github.api.statuses(github_repo_name, sha) }
+      github_statuses = stack.handle_github_redirections do
+        Shipit.github.api.statuses(github_repo_name, sha, per_page: 100)
+      end
       github_statuses.each do |status|
         create_status_from_github!(status)
       end
@@ -177,13 +196,7 @@ module Shipit
     def active?
       return false unless stack.active_task?
 
-      active_task = stack.active_task
-
-      if active_task.since_commit == active_task.until_commit
-        id == active_task.since_commit.id
-      else
-        id > active_task.since_commit.id && id <= active_task.until_commit.id
-      end
+      stack.active_task.includes_commit?(self)
     end
 
     def deployable?
@@ -242,7 +255,9 @@ module Shipit
 
     def schedule_continuous_delivery
       return unless deployable? && stack.continuous_deployment? && stack.deployable?
-      ContinuousDeliveryJob.perform_later(stack)
+      # 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)
     end
 
     def github_commit
@@ -311,6 +326,10 @@ module Shipit
       update!(locked: false, lock_author: nil)
     end
 
+    def recently_pushed?
+      created_at > RECENT_COMMIT_THRESHOLD.ago
+    end
+
     private
 
     def message_parser
@@ -326,7 +345,7 @@ module Shipit
       new_status = status
 
       unless already_deployed
-        payload = {commit: self, stack: stack, status: new_status.state}
+        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

data/app/models/shipit/commit_checks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class CommitChecks < EphemeralCommitChecks
     OUTPUT_TTL = 10.minutes.to_i

data/app/models/shipit/commit_deployment.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module Shipit
-  class CommitDeployment < ActiveRecord::Base
-    belongs_to :commit
+  class CommitDeployment < Record
     belongs_to :task
     has_many :statuses, dependent: :destroy, class_name: 'CommitDeploymentStatus'
 
@@ -9,11 +9,10 @@ module Shipit
     delegate :stack, :author, to: :task
 
     def create_on_github!
-      return unless commit.pull_request?
-
       create_deployment_on_github!
       statuses.order(id: :asc).each(&:create_on_github!)
-    rescue Octokit::NotFound, Octokit::Forbidden
+    rescue Octokit::NotFound, Octokit::Forbidden => error
+      Rails.logger.warn("Got #{error.class.name} creating deployment or statuses: #{error.message}")
       # If no one can create the deployment we can only give up
     end
 
@@ -34,25 +33,31 @@ module Shipit
       update!(github_id: response.id, api_url: response.url)
     end
 
-    def pull_request_head
-      pull_request = Shipit.github.api.pull_request(stack.github_repo_name, commit.pull_request_number)
-      pull_request.head.sha
-    end
-
     def schedule_create_on_github
       CreateOnGithubJob.perform_later(self)
     end
 
+    def short_sha
+      sha[0..9]
+    end
+
     private
 
     def create_deployment_on_github(client)
       client.create_deployment(
         stack.github_repo_name,
-        pull_request_head,
+        sha,
         auto_merge: false,
         required_contexts: [],
-        description: "Via Shipit",
+        description: "Via #{Shipit.app_name}",
         environment: stack.environment,
+        payload: {
+          shipit: {
+            task_id: task.id,
+            from_sha: task.since_commit.sha,
+            to_sha: task.until_commit.sha,
+          },
+        }.to_json,
       )
     end
   end

data/app/models/shipit/commit_deployment_status.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 module Shipit
-  class CommitDeploymentStatus < ActiveRecord::Base
+  class CommitDeploymentStatus < Record
+    DESCRIPTION_CHARACTER_LIMIT_ON_GITHUB = 140
+
     belongs_to :commit_deployment
 
     after_commit :schedule_create_on_github, on: :create
@@ -25,7 +28,7 @@ module Shipit
     def description
       I18n.t(
         "deployment_description.#{task_type}.#{status}",
-        sha: task.until_commit.sha,
+        sha: task.until_commit.short_sha,
         author: task.author.login,
         stack: stack.to_param,
       )
@@ -45,8 +48,10 @@ 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,
+        description: description.truncate(DESCRIPTION_CHARACTER_LIMIT_ON_GITHUB),
+        environment_url: stack.deploy_url,
       )
     end
 

data/app/models/shipit/commit_message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class CommitMessage
     GITHUB_MERGE_COMMIT_PATTERN = /\AMerge pull request #(?<pr_id>\d+) from \S+\n\n(?<pr_title>.*)/

data/app/models/shipit/delivery.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 module Shipit
-  class Delivery < ActiveRecord::Base
+  class Delivery < Record
     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 :url, presence: true, url: { no_local: true, allow_blank: true }
     validates :content_type, presence: true
 
     serialize :response_headers, JSON
@@ -36,7 +37,7 @@ module Shipit
     def http
       Faraday::Connection.new do |connection|
         connection.headers = headers
-        connection.adapter Faraday.default_adapter
+        connection.adapter(Faraday.default_adapter)
       end
     end
 

data/app/models/shipit/deploy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 
 module Shipit
@@ -14,20 +15,41 @@ module Shipit
       after_transition any => any, do: :update_last_deploy_time
     end
 
+    belongs_to :until_commit, class_name: 'Commit', required: true, inverse_of: :deploys
+    belongs_to :since_commit, class_name: 'Commit', required: true, inverse_of: :deploys
     has_many :commit_deployments, dependent: :destroy, inverse_of: :task, foreign_key: :task_id do
       GITHUB_STATUSES = {
         'pending' => 'pending',
+        'running' => 'in_progress',
         'failed' => 'failure',
+        'timedout' => 'failure',
         'success' => 'success',
+        'faulty' => 'error',
         'error' => 'error',
         'aborted' => 'error',
       }.freeze
 
       def append_status(task_status)
         if github_status = GITHUB_STATUSES[task_status]
-          each do |deployment|
+          # Deployments and statuses are created async, we reload the association to ensure we update all instances
+          reload.each do |deployment|
+            Rails.logger.info(
+              "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}.",
+            )
             deployment.statuses.create!(status: github_status)
           end
+        else
+          each do |deployment|
+            Rails.logger.warn(
+              "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}.",
+            )
+          end
         end
       end
     end
@@ -87,8 +109,8 @@ module Shipit
     end
 
     # Rolls the stack back to the most recent **previous** successful deploy
-    def trigger_revert(force: false)
-      previous_successful_commit = commit_to_rollback_to
+    def trigger_revert(force: false, rollback_to: nil)
+      previous_successful_commit = rollback_to&.until_commit || commit_to_rollback_to
 
       rollback = Rollback.create!(
         user_id: user_id,
@@ -215,12 +237,24 @@ module Shipit
       end
     end
 
+    def update_commit_deployments
+      commit_deployments.append_status(status)
+    end
+
     private
 
     def create_commit_deployments
-      commits.each do |commit|
-        commit_deployments.create!(commit: commit)
+      # Create one deployment for the head of the batch
+      commit_deployments.create!(sha: until_commit.sha)
+
+      # 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
+
+      # Immediately update to publish the status to the commit deployments
+      update_commit_deployments
     end
 
     def update_release_status
@@ -245,14 +279,10 @@ module Shipit
       end
     end
 
-    def update_commit_deployments
-      commit_deployments.append_status(status)
-    end
-
     def trigger_revert_if_required
       return unless rollback_once_aborted?
       return unless supports_rollback?
-      trigger_revert
+      trigger_revert(rollback_to: rollback_once_aborted_to)
     end
 
     def default_since_commit_id

data/app/models/shipit/deploy_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'pathname'
 
 module Shipit
@@ -5,20 +6,34 @@ module Shipit
     Error = Class.new(StandardError)
 
     class << self
+      attr_accessor :pretty_generate
+
       def load(json)
         config = json.blank? ? {} : JSON.parse(json)
         new(config)
       end
 
       def dump(spec)
-        JSON.dump(spec.cacheable.config) if spec
+        return unless spec
+
+        if pretty_generate?
+          JSON.pretty_generate(spec.cacheable.config)
+        else
+          JSON.dump(spec.cacheable.config)
+        end
       end
 
       def bundle_path
         Rails.root.join('data', 'bundler')
       end
+
+      def pretty_generate?
+        @pretty_generate
+      end
     end
 
+    self.pretty_generate = false
+
     def initialize(config)
       @config = config
     end
@@ -40,6 +55,10 @@ module Shipit
       end
     end
 
+    def blank?
+      config.empty?
+    end
+
     def supports_fetch_deployed_revision?
       fetch_deployed_revision_steps.present?
     end
@@ -255,11 +274,11 @@ module Shipit
     end
 
     def task_not_found!(id)
-      raise TaskDefinition::NotFound.new("No definition for task #{id.inspect}")
+      raise TaskDefinition::NotFound, "No definition for task #{id.inspect}"
     end
 
     def cant_detect!(type)
-      raise DeploySpec::Error.new(I18n.t("deploy_spec.hint.#{type}"))
+      raise DeploySpec::Error, I18n.t("deploy_spec.hint.#{type}")
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DeploySpec
     module BundlerDiscovery
@@ -31,7 +32,7 @@ module Shipit
 
       def remove_ruby_version_from_gemfile
         # Heroku apps often specify a ruby version.
-        if /darwin/ =~ RUBY_PLATFORM
+        if /darwin/i.match?(RUBY_PLATFORM)
           # OSX is nitpicky about the -i.
           %q(/usr/bin/sed -i '' '/^ruby\s/d' Gemfile)
         else

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DeploySpec
     module CapistranoDiscovery

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Shipit
   class DeploySpec
     class FileSystem < DeploySpec
@@ -61,14 +62,14 @@ module Shipit
             'context' => release_status_context,
             'delay' => release_status_delay,
           },
-          'dependencies' => {'override' => dependencies_steps},
+          'dependencies' => { 'override' => dependencies_steps },
           'deploy' => {
             'override' => deploy_steps,
             'variables' => deploy_variables.map(&:to_h),
             'max_commits' => maximum_commits_per_deploy,
             'interval' => pause_between_deploys,
           },
-          'rollback' => {'override' => rollback_steps},
+          'rollback' => { 'override' => rollback_steps },
           'fetch' => fetch_deployed_revision_steps,
           'tasks' => cacheable_tasks,
         )
@@ -84,10 +85,16 @@ module Shipit
       end
 
       def load_config
-        read_config(file("shipit.#{@env}.yml", root: true)) ||
+        read_config(file("#{app_name}.#{@env}.yml", root: true)) ||
+          read_config(file("#{app_name}.yml", root: true)) ||
+          read_config(file("shipit.#{@env}.yml", root: true)) ||
           read_config(file('shipit.yml', root: true))
       end
 
+      def app_name
+        @app_name ||= Shipit.app_name.downcase
+      end
+
       def read_config(path)
         SafeYAML.load(path.read) if path.exist?
       end