shipit-engine 0.28.1 → 0.33.0

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
@@ -70,6 +92,7 @@ module Shipit
         env: env&.to_h || {},
         allow_concurrency: force,
         ignored_safeties: force,
+        max_retries: stack.retries_on_rollback,
       )
     end
 
@@ -87,8 +110,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 +238,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 +280,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
@@ -85,6 +104,10 @@ module Shipit
       Duration.parse(config('deploy', 'interval') { 0 })
     end
 
+    def provisioning_handler_name
+      config('provision', 'handler_name')
+    end
+
     def deploy_steps
       around_steps('deploy') do
         config('deploy', 'override') { discover_deploy_steps }
@@ -103,6 +126,10 @@ module Shipit
       deploy_variables.map { |v| [v.name, v.default] }.to_h
     end
 
+    def retries_on_deploy
+      config('deploy', 'retries') { nil }
+    end
+
     def rollback_steps
       around_steps('rollback') do
         config('rollback', 'override') { discover_rollback_steps }
@@ -113,6 +140,10 @@ module Shipit
       rollback_steps || cant_detect!(:rollback)
     end
 
+    def retries_on_rollback
+      config('rollback', 'retries') { nil }
+    end
+
     def fetch_deployed_revision_steps
       config('fetch') || discover_fetch_deployed_revision_steps
     end
@@ -160,12 +191,12 @@ module Shipit
       Array.wrap(config('ci', 'blocking'))
     end
 
-    def pull_request_merge_method
+    def merge_request_merge_method
       method = config('merge', 'method')
       method if %w(merge rebase squash).include?(method)
     end
 
-    def pull_request_required_statuses
+    def merge_request_required_statuses
       if config('merge', 'require') || config('merge', 'ignore')
         Array.wrap(config('merge', 'require'))
       else
@@ -173,7 +204,7 @@ module Shipit
       end
     end
 
-    def pull_request_ignored_statuses
+    def merge_request_ignored_statuses
       if config('merge', 'require') || config('merge', 'ignore')
         Array.wrap(config('merge', 'ignore')) + [release_status_context].compact
       else
@@ -181,7 +212,7 @@ module Shipit
       end
     end
 
-    def revalidate_pull_requests_after
+    def revalidate_merge_requests_after
       if timeout = config('merge', 'revalidate_after')
         begin
           Duration.parse(timeout)
@@ -255,11 +286,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
@@ -12,6 +13,7 @@ module Shipit
       def initialize(app_dir, env)
         @app_dir = Pathname(app_dir)
         @env = env
+        super(nil)
       end
 
       def cacheable
@@ -31,10 +33,10 @@ module Shipit
       def cacheable_config
         (config || {}).deep_merge(
           'merge' => {
-            'require' => pull_request_required_statuses,
-            'ignore' => pull_request_ignored_statuses,
-            'revalidate_after' => revalidate_pull_requests_after&.to_i,
-            'method' => pull_request_merge_method,
+            'require' => merge_request_required_statuses,
+            'ignore' => merge_request_ignored_statuses,
+            'revalidate_after' => revalidate_merge_requests_after&.to_i,
+            'method' => merge_request_merge_method,
             'max_divergence' => {
               'commits' => max_divergence_commits&.to_i,
               'age' => max_divergence_age&.to_i,
@@ -61,14 +63,19 @@ module Shipit
             'context' => release_status_context,
             'delay' => release_status_delay,
           },
-          'dependencies' => {'override' => dependencies_steps},
+          'dependencies' => { 'override' => dependencies_steps },
+          'provision' => { 'handler_name' => provisioning_handler_name },
           'deploy' => {
             'override' => deploy_steps,
             'variables' => deploy_variables.map(&:to_h),
             'max_commits' => maximum_commits_per_deploy,
             'interval' => pause_between_deploys,
+            'retries' => retries_on_deploy,
+          },
+          'rollback' => {
+            'override' => rollback_steps,
+            'retries' => retries_on_rollback,
           },
-          'rollback' => {'override' => rollback_steps},
           'fetch' => fetch_deployed_revision_steps,
           'tasks' => cacheable_tasks,
         )
@@ -84,10 +91,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

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

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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 
 module Shipit

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

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 require 'json'
 
 module Shipit
   class DeploySpec
     module NpmDiscovery
       # https://docs.npmjs.com/cli/publish
-      PUBLIC = 'public'.freeze
-      PRIVATE = 'restricted'.freeze
+      PUBLIC = 'public'
+      PRIVATE = 'restricted'
       VALID_ACCESS = [PUBLIC, PRIVATE].freeze
-      NPM_REGISTRY = "https://registry.npmjs.org/".freeze
+      NPM_REGISTRY = "https://registry.npmjs.org/"
 
       def discover_dependencies_steps
         discover_package_json || super
@@ -57,7 +58,7 @@ module Shipit
         # are treated as 'next' npm dist-tags.
         # An 1.0.0-beta.1 would be installable using both:
         # `yarn add package@1.0.0-beta.1` and `yarn add package@next`
-        return 'next' if ['-beta', '-alpha', '-rc', '-next'].any? { |tag| version.include? tag }
+        return 'next' if ['-beta', '-alpha', '-rc', '-next'].any? { |tag| version.include?(tag) }
         'latest'
       end
 

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

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

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

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

data/app/models/shipit/deploy_stats.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Shipit
+  class DeployStats
+    delegate :empty?, to: :@deploys
+
+    def initialize(deploys)
+      @deploys = deploys
+      @durations = @deploys.map { |d| d.duration&.value }.compact
+    end
+
+    def count
+      @deploys.length
+    end
+
+    def average_duration
+      return if empty?
+      @durations.sum / @durations.length.to_f
+    end
+
+    def max_duration
+      @durations.max
+    end
+
+    def min_duration
+      @durations.min
+    end
+
+    def median_duration
+      return if @durations.empty?
+      (sorted_durations[(@durations.length - 1) / 2] + sorted_durations[@durations.length / 2]) / 2.0
+    end
+
+    def success_rate
+      return if empty?
+      (@deploys.count(&:success?) / @deploys.length.to_f) * 100
+    end
+
+    def compare(compare_stats)
+      {
+        count: percent_change(compare_stats.count, count),
+        average_duration: percent_change(compare_stats.average_duration, average_duration),
+        median_duration: percent_change(compare_stats.median_duration, median_duration),
+      }
+    end
+
+    protected
+
+    def sorted_durations
+      @sorted ||= @durations.sort
+    end
+
+    def percent_change(from, to)
+      return if to.nil? || from.nil?
+      return to * 100 if from.zero?
+      ((to - from) / from.to_f) * 100
+    end
+  end
+end