shipit-engine 0.38.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f671228679f81a64a70284699951ea5cc8fce83e82a56263cf6a4f52055f5976
-  data.tar.gz: 0d795762874714a9d592edb0dd3fd1b599f1819edc06d1085252a9e26ef0073b
+  metadata.gz: 6b42049322671e225e86884f3990cf0233fcd0b4ac7eaec63643a3c57dbe8f9b
+  data.tar.gz: 132aee7cfff7bc2801a0a28224be08e625880bfc59fcc98a6adabd1459a2b812
 SHA512:
-  metadata.gz: 6c55d8a3f3ab16affd874abd8c15e51c19a29e81ddb3131a4695d9ca2ba409e312e40892ddbd66ec6bca32ce403254f02de632dbab06a97306c6a0da5e684c2e
-  data.tar.gz: fd7b4ad69bd0b03a486a38a4ce2dcf0802581aee836e44f1390f362aeace5b1fbb30f24bd3a5579da89e0bfca8f588ed16d121e9be7a4afd7f7f1efda208a97f
+  metadata.gz: 2d75e469feb17bab9a1792cefd41da3ae8daf38d1b32ef0c1ab39df1bfd931b033f27d83cadefb92e77ff3063f2b8ebdcea4844ef64b88d61a9a87d1183eca19
+  data.tar.gz: 667e3e0cbaac19bc64c11defa7e502d504aea73c09010e81bf1368a52d5794fc8953e29b34d7cb65865f5229d3c3ab38bbe2bc62db822bdb59fb119d59b728c9

data/README.md

@@ -25,8 +25,8 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 **II. USING SHIPIT**
 
 * [Adding stacks](#adding-stacks)
-* [Working on stacks](#working-on-stacks),
-* [Configuring stacks](#configuring-stacks).
+* [Working on stacks](#working-on-stacks)
+* [Configuring stacks](#configuring-stacks)
 
 **III. REFERENCE**
 
@@ -123,6 +123,7 @@ The settings in the `shipit.yml` file relate to the different things you can do
 * [Custom Tasks](#custom-tasks) (`tasks`)
 * [Custom links](#custom-links) (`links`)
 * [Review Process](#review-process) (`review.checklist`, `review.monitoring`, `review.checks`)
+* [Inherit From](#inherit-from)(`inherit_from`)
 
 All the settings in `shipit.yml` are optional. Most applications can be deployed from Shipit without any configuration.
 
@@ -130,6 +131,8 @@ Also, if your repository is deployed different ways depending on the environment
 
 For example for a stack like: `my-org/my-repo/staging`, `shipit.staging.yml` will have priority over `shipit.yml`.
 
+In order to reduce duplication across different environment specific files, you can specify an `inherit_from` key in your relevant `shipit.yml` file. This key expects a string of the file name to inherit from. If this key is specified, a deep-merge will be performed on the file therein, overwriting any duplicated values from the parent. See [Inherit From](#inherit-from)(`inherit_From`) for example.
+
 Lastly, if you override the `app_name` configuration in your Shipit deployment, `yourapp.yml` and `yourapp.staging.yml` will work.
 
 * * *
@@ -357,6 +360,11 @@ For example:
 fetch:
   curl --silent https://app.example.com/services/ping/version
 ```
+
+**Note:** Currently, deployments in emergency mode are configured to occur concurrently via [the `build_deploy` method](https://github.com/Shopify/shipit-engine/blob/main/app/models/shipit/stack.rb),
+whose `allow_concurrency` keyword argument defaults to `force`, where `force` is true when emergency mode is enabled. 
+If you'd like to separate these two from one another, override this method as desired in your service.
+
 <h3 id="kubernetes">Kubernetes</h3>
 
 **<code>kubernetes</code>** allows to specify a Kubernetes namespace and context to deploy to.
@@ -608,9 +616,45 @@ review:
     - bundle exec rake db:migrate:status
 ```
 
+<h3 id="inherit-from">Inherit From</h3>
+
+If the `inherit_from` key is specified, a deep-merge will be performed on the file therein, overwriting any duplicated values from the parent. Keys may be chained across files. Example:
+
+``` yaml
+# shipit.production.yml
+inherit_from: shipit.staging.yml
+
+machine:
+  environment:
+    PUBLIC: true
+```
+
+``` yaml
+# shipit.staging.yml
+inherit_from: shipit.yml
+
+deploy:
+  override:
+    - ./some_deployment_process.sh ${PUBLIC}
+```
+
+``` yaml
+# shipit.yml
+
+machine:
+  environment:
+    TEST: true
+    PUBLIC: false
+```
+
+Loading 'shipit.production.yml' would result in:
+```rb
+{"machine"=>{"environment"=>{"TEST"=>true, "PUBLIC"=>true}}, "deploy"=>{"override"=>["./some_deployment_process.sh ${PUBLIC}"]}}
+```
+
 <h3 id="shell-commands-timeout">Shell commands timeout</h3>
 
-All the shell commands can take an optional `timeout` parameter to limit their duration:
+All the shell commands can take an optional `timeout` parameter. This is the value in seconds that a command can be inactive before Shipit will terminate the task.
 
 ```yml
 deploy:
@@ -641,7 +685,7 @@ Your deploy scripts have access to the following environment variables:
 * `GITHUB_REPO_OWNER`: The GitHub username of the repository owner for the current deploy/task.
 * `EMAIL`: Email of the user that triggered the deploy/task (if available)
 * `ENVIRONMENT`: The stack environment (e.g `production` / `staging`)
-* `BRANCH`: The stack branch (e.g `master`)
+* `BRANCH`: The stack branch (e.g `main`)
 * `LAST_DEPLOYED_SHA`: The git SHA of the last deployed commit
 * `DIFF_LINK`: URL to the diff on GitHub.
 * `TASK_ID`: ID of the task that is running

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
@@ -8,7 +9,7 @@ begin
 rescue LoadError
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 load('rails/tasks/engine.rake')
 
 Bundler::GemHelper.install_tasks

data/app/assets/javascripts/shipit/continuous_delivery_schedule.js.coffee

@@ -0,0 +1,15 @@
+$(document)
+    .on "click", ".continuous-delivery-schedule [data-action='copy-to-all']", (event) -> 
+        form = event.target.closest("form");
+
+        mondayStart = form.elements.namedItem("continuous_delivery_schedule[monday_start]").value
+        mondayEnd = form.elements.namedItem("continuous_delivery_schedule[monday_end]").value
+
+        Array.from(form.elements).forEach (formElement) ->
+            return unless formElement.type == "time"
+
+            if formElement.name.endsWith("_start]")
+                formElement.value = mondayStart
+
+            if formElement.name.endsWith("_end]")
+                formElement.value = mondayEnd

data/app/controllers/concerns/shipit/active_model_serializers_patch.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module ActiveModelSerializersPatch
     private

data/app/controllers/concerns/shipit/api/cacheable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     module Cacheable

data/app/controllers/concerns/shipit/api/paginable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     module Paginable
@@ -23,8 +24,8 @@ module Shipit
           resource,
           self,
           order: default_order,
-          max_page_size: max_page_size,
-          default_page_size: default_page_size,
+          max_page_size:,
+          default_page_size:
         )
         headers[LINK] = render_links(paginator.links)
         super(paginator.to_a)

data/app/controllers/concerns/shipit/api/rendering.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     module Rendering

data/app/controllers/concerns/shipit/authentication.rb

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

data/app/controllers/concerns/shipit/pagination.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Pagination
     extend ActiveSupport::Concern
@@ -20,8 +21,8 @@ module Shipit
         relation,
         self,
         order: default_order,
-        max_page_size: max_page_size,
-        default_page_size: default_page_size,
+        max_page_size:,
+        default_page_size:
       )
     end
   end

data/app/controllers/shipit/api/base_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class BaseController < ActionController::Base
@@ -35,7 +36,7 @@ module Shipit
 
         private
 
-        def has_basic_credentials?(request)
+        def basic_credentials?(request)
           request.authorization.present? && (auth_scheme(request).downcase == "basic")
         end
       end
@@ -46,14 +47,15 @@ module Shipit
 
       def authenticate_api_client
         @current_api_client = if Shipit.disable_api_authentication
-          UnlimitedApiClient.new
-        else
-          BasicAuth.authenticate(request) do |*parts|
-            token = parts.select(&:present?).join('--')
-            ApiClient.authenticate(token)
-          end
-        end
+                                UnlimitedApiClient.new
+                              else
+                                BasicAuth.authenticate(request) do |*parts|
+                                  token = parts.select(&:present?).join('--')
+                                  ApiClient.authenticate(token)
+                                end
+                              end
         return if @current_api_client
+
         headers['WWW-Authenticate'] = 'Basic realm="Authentication token"'
         render(status: :unauthorized, json: { message: 'Bad credentials' })
       end
@@ -93,8 +95,8 @@ module Shipit
         render(status: :not_found, json: { status: '404', error: 'Not Found' })
       end
 
-      def conflict(_error)
-        render(status: :conflict, json: { status: '409', error: 'Conflict' })
+      def conflict(error)
+        render(status: :conflict, json: { status: '409', error: error.message })
       end
     end
   end

data/app/controllers/shipit/api/ccmenu_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class CCMenuController < BaseController
@@ -20,7 +21,7 @@ module Shipit
 
       def show
         latest_deploy = stack.deploys_and_rollbacks.last || NoDeploy.new
-        render('shipit/ccmenu/project', formats: [:xml], locals: { stack: stack, deploy: latest_deploy })
+        render('shipit/ccmenu/project', formats: [:xml], locals: { stack:, deploy: latest_deploy })
       end
 
       private

data/app/controllers/shipit/api/commits_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class CommitsController < BaseController
@@ -6,9 +7,7 @@ module Shipit
 
       def index
         commits = stack.commits.reachable.includes(:statuses)
-        if params[:undeployed]
-          commits = commits.newer_than(stack.last_deployed_commit)
-        end
+        commits = commits.newer_than(stack.last_deployed_commit) if params[:undeployed]
 
         render_resources(commits)
       end

data/app/controllers/shipit/api/deploys_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class DeploysController < BaseController
@@ -11,6 +12,7 @@ module Shipit
       params do
         requires :sha, String, length: { in: 6..40 }
         accepts :force, Boolean, default: false
+        accepts :allow_concurrency, Boolean
         accepts :require_ci, Boolean, default: false
         accepts :env, Hash, default: {}
       end
@@ -18,7 +20,10 @@ module Shipit
         commit = stack.commits.by_sha(params.sha) || param_error!(:sha, 'Unknown revision')
         param_error!(:force, "Can't deploy a locked stack") if !params.force && stack.locked?
         param_error!(:require_ci, "Commit is not deployable") if params.require_ci && !commit.deployable?
-        deploy = stack.trigger_deploy(commit, current_user, env: params.env, force: params.force)
+
+        allow_concurrency = params.allow_concurrency.nil? ? params.force : params.allow_concurrency
+        deploy = stack.trigger_deploy(commit, current_user, env: params.env, force: params.force,
+                                                            allow_concurrency:)
         render_resource(deploy, status: :accepted)
       end
     end

data/app/controllers/shipit/api/hooks_controller.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class HooksController < BaseController
-      require_permission :read, :hook, only: %i(index show)
-      require_permission :write, :hook, only: %i(create update destroy)
+      require_permission :read, :hook, only: %i[index show]
+      require_permission :write, :hook, only: %i[create update destroy]
 
       def index
         render_resources(hooks)
@@ -43,7 +44,7 @@ module Shipit
       end
 
       def hooks
-        Hook.where(stack_id: stack_id)
+        Hook.where(stack_id:)
       end
 
       def stack_id

data/app/controllers/shipit/api/locks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class LocksController < BaseController

data/app/controllers/shipit/api/merge_requests_controller.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class MergeRequestsController < BaseController
       require_permission :read, :stack
-      require_permission :deploy, :stack, only: %i(update destroy)
+      require_permission :deploy, :stack, only: %i[update destroy]
 
       def index
         render_resources(stack.merge_requests.includes(:head).order(id: :desc))
@@ -19,16 +20,16 @@ module Shipit
           head(:accepted)
         elsif merge_request.merged?
           render(status: :method_not_allowed, json: {
-            message: "This pull request was already merged.",
-          })
+                   message: "This pull request was already merged."
+                 })
         else
           raise "Pull Request is neither waiting nor merged, this should be impossible"
         end
       end
 
       def destroy
-        if merge_request = stack.merge_requests.where(number: params[:id]).first
-          merge_request.cancel! if merge_request.waiting?
+        if (merge_request = stack.merge_requests.where(number: params[:id]).first) && merge_request.waiting?
+          merge_request.cancel!
         end
         head(:no_content)
       end

data/app/controllers/shipit/api/outputs_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class OutputsController < BaseController

data/app/controllers/shipit/api/release_statuses_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class ReleaseStatusesController < BaseController
@@ -6,7 +7,7 @@ module Shipit
 
       params do
         requires :status, String
-        validates :status, inclusion: { in: %w(success failure) }
+        validates :status, inclusion: { in: %w[success failure] }
       end
       def create
         deploy = stack.deploys_and_rollbacks.find(params[:deploy_id])

data/app/controllers/shipit/api/rollbacks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class RollbacksController < BaseController

data/app/controllers/shipit/api/stacks_controller.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class StacksController < BaseController
-      require_permission :read, :stack, only: %i(index show)
-      require_permission :write, :stack, only: %i(create update destroy)
+      require_permission :read, :stack, only: %i[index show]
+      require_permission :write, :stack, only: %i[create update destroy]
 
       params do
         accepts :repo_owner, String
@@ -14,10 +15,10 @@ module Shipit
         if params[:repo_owner] && params[:repo_name]
           full_repo_name = [repo_owner, repo_name].join('/')
           @stacks = if (repository = Repository.from_github_repo_name(full_repo_name))
-            stacks.where(repository: repository)
-          else
-            Stack.none
-          end
+                      stacks.where(repository:)
+                    else
+                      Stack.none
+                    end
         end
         render_resources(@stacks)
       end
@@ -75,7 +76,7 @@ module Shipit
       private
 
       def create_params
-        params.reject { |key, _| %i(repo_owner repo_name).include?(key) }
+        params.reject { |key, _| %i[repo_owner repo_name].include?(key) }
       end
 
       def stack
@@ -83,12 +84,12 @@ module Shipit
       end
 
       def update_archived
-        if key?(:archived)
-          if params[:archived]
-            stack.archive!(nil)
-          elsif stack.archived?
-            stack.unarchive!
-          end
+        return unless key?(:archived)
+
+        if params[:archived]
+          stack.archive!(nil)
+        elsif stack.archived?
+          stack.unarchive!
         end
       end
 
@@ -98,7 +99,7 @@ module Shipit
 
       def update_params
         params.select do |key, _|
-          %i(environment branch deploy_url ignore_ci merge_queue_enabled continuous_deployment).include?(key)
+          %i[environment branch deploy_url ignore_ci merge_queue_enabled continuous_deployment].include?(key)
         end
       end
 

data/app/controllers/shipit/api/tasks_controller.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
+
 module Shipit
   module Api
     class TasksController < BaseController
       require_permission :read, :stack
-      require_permission :deploy, :stack, only: %i(trigger abort)
+      require_permission :deploy, :stack, only: %i[trigger abort]
 
       def index
         render_resources(stack.tasks)
@@ -20,8 +21,8 @@ module Shipit
         render_resource(stack.trigger_task(params[:task_name], current_user, env: params.env), status: :accepted)
       rescue Shipit::Task::ConcurrentTaskRunning
         render(status: :conflict, json: {
-          message: 'A task is already running.',
-        })
+                 message: 'A task is already running.'
+               })
       end
 
       def abort
@@ -30,8 +31,8 @@ module Shipit
           head(:accepted)
         else
           render(status: :method_not_allowed, json: {
-            message: "This task is not currently running.",
-          })
+                   message: "This task is not currently running."
+                 })
         end
       end
 

data/app/controllers/shipit/api_clients_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class ApiClientsController < ShipitController
     include Pagination
@@ -15,9 +16,7 @@ module Shipit
 
     def create
       @api_client = ApiClient.new(create_params.merge(creator_id: current_user.id))
-      unless @api_client.save
-        flash[:warning] = @api_client.errors.full_messages.to_sentence
-      end
+      flash[:warning] = @api_client.errors.full_messages.to_sentence unless @api_client.save
 
       respond_with(@api_client)
     end
@@ -29,10 +28,10 @@ module Shipit
     def update
       @api_client = ApiClient.find(params[:id])
       options = if @api_client.update(update_params)
-        { flash: { success: 'Successfully updated' } }
-      else
-        { flash: { warning: @stack.errors.full_messages.to_sentence } }
-      end
+                  { flash: { success: 'Successfully updated' } }
+                else
+                  { flash: { warning: @stack.errors.full_messages.to_sentence } }
+                end
 
       redirect_to(params[:return_to].presence || api_client_path(@api_client), options)
     end

data/app/controllers/shipit/ccmenu_url_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'uri'
 
 module Shipit
@@ -12,8 +13,8 @@ module Shipit
     private
 
     def client
-      @client ||= ApiClient.create_with(permissions: %w(read:stack))
-        .find_or_create_by!(creator: current_user, name: 'CCMenu Client')
+      @client ||= ApiClient.create_with(permissions: %w[read:stack])
+                           .find_or_create_by!(creator: current_user, name: 'CCMenu Client')
     end
 
     def stack

data/app/controllers/shipit/commit_checks_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitChecksController < ShipitController
     def show
@@ -16,7 +17,7 @@ module Shipit
         url = stack_tail_commit_checks_path(stack, sha: commit.sha, since: next_offset)
       end
 
-      render(json: { url: url, output: output, status: checks.status })
+      render(json: { url:, output:, status: checks.status })
     end
 
     private

data/app/controllers/shipit/commits_controller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Shipit
   class CommitsController < ShipitController
     def update

data/app/controllers/shipit/continuous_delivery_schedules_controller.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Shipit
+  class ContinuousDeliverySchedulesController < ShipitController
+    before_action :load_stack
+
+    def show
+      @continuous_delivery_schedule = @stack.continuous_delivery_schedule || @stack.build_continuous_delivery_schedule
+    end
+
+    def update
+      @continuous_delivery_schedule = @stack.continuous_delivery_schedule || @stack.build_continuous_delivery_schedule
+      @continuous_delivery_schedule.assign_attributes(continuous_delivery_schedule_params)
+
+      if @continuous_delivery_schedule.save
+        flash[:success] = "Successfully updated"
+        redirect_to(stack_continuous_delivery_schedule_path)
+      else
+        flash.now[:warning] = "Check form for errors"
+        render(:show, status: :unprocessable_entity)
+      end
+    end
+
+    private
+
+    def load_stack
+      @stack = Stack.from_param!(params[:id])
+    end
+
+    def continuous_delivery_schedule_params
+      params.require(:continuous_delivery_schedule).permit(
+        *Shipit::ContinuousDeliverySchedule::DAYS.flat_map do |day|
+          [
+            "#{day}_start",
+            "#{day}_end",
+            "#{day}_enabled"
+          ]
+        end
+      )
+    end
+  end
+end

data/app/controllers/shipit/deploys_controller.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 module Shipit
   class DeploysController < ShipitController
     include ChunksHelper
 
     before_action :load_stack
-    before_action :load_deploy, only: %i(show rollback revert)
+    before_action :load_deploy, only: %i[show rollback revert]
     before_action :load_until_commit, only: :create
     helper_method :short_commit_sha
 
@@ -26,7 +27,7 @@ module Shipit
         @until_commit,
         current_user,
         env: deploy_params[:env],
-        force: params[:force].present?,
+        force: params[:force].present?
       )
       respond_with(@deploy.stack, @deploy)
     rescue Task::ConcurrentTaskRunning
@@ -43,9 +44,9 @@ module Shipit
     end
 
     def short_commit_sha(task)
-      if previous_successful_deploy_commit(task)
-        @short_commit_sha ||= @previous_successful_deploy_commit&.short_sha
-      end
+      return unless previous_successful_deploy_commit(task)
+
+      @short_commit_sha ||= @previous_successful_deploy_commit&.short_sha
     end
 
     private