shipit-engine 0.27.1 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495cc8d38c4896d2059a99ef8e30073ffbabf569b1a23a8d71496989b6134a2a
-  data.tar.gz: 2429d8adfffac81cf04174a9ea03d27cc64a535072433eccce9c3550dc2660a6
+  metadata.gz: bdb3736fb9999c0409f7b81081a52467f33a39ee419f2a40e14e6aca73866263
+  data.tar.gz: f58bfcbbc8084bb18cf2234ed0a75658a5c6bc9e2b593bc8a2b90e5f89d030b5
 SHA512:
-  metadata.gz: 8721520921c29b8ba7a5b1af921b1bd2d870a9047916370ce250415f5a39f9298b1f3df414ca2dfe674b1c0bf6e6459b2145a94eef99aac1ebd27aae6af5af28
-  data.tar.gz: fd4320cd7b7ca5b2b4030abb6c045a4106ba6ef2fc785b9caa08e7ccd4482033ad1584ad806638937eb5557628b914dd6acd4452b01cfe6c17f0f091377a6219
+  metadata.gz: 19ffafe44e93c6f02f277c5208160a605286557f5080cf3569355fcfa85b2a8583eace47a89c1ac223490ad157de451f0837343d5b818e891c9794b27ca20554
+  data.tar.gz: 57be6895de1d5757a48b603cfb4796316f477b791feef7cfc876dc57b5226d869e65b2332e920e695e3edbba3bd99b39dc75e0e3ceeab2b6aee851eaeea15c2e

data/README.md

@@ -35,6 +35,11 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 * [Configuring providers](#configuring-providers)
 * [Free samples](/examples/shipit.yml)
 
+**IV. CONTRIBUTING**
+
+* [Instructions](#contributing-instructions)
+* [Local development](#contributing-local-dev)
+
 * * *
 
 <h2 id="installation-and-setup">I. INSTALLATION & SETUP</h2>
@@ -112,7 +117,7 @@ The settings in the `shipit.yml` file relate to the different things you can do
 * [CI](#ci) (`ci.require`, `ci.hide`, `ci.allow_failures`)
 * [Merge Queue](#merge-queue) (`merge.revalidate_after`, `merge.require`, `merge.ignore`, `merge.max_divergence`)
 * [Custom Tasks](#custom-tasks) (`tasks`)
-* [Custom links](#custom-links) (`links`) 
+* [Custom links](#custom-links) (`links`)
 * [Review Process](#review-process) (`review.checklist`, `review.monitoring`, `review.checks`)
 
 All the settings in `shipit.yml` are optional. Most applications can be deployed from Shipit without any configuration.
@@ -628,3 +633,27 @@ For Kubernetes, you have to provision Shipit environment with the following tool
 
 * `kubectl`
 * `kubernetes-deploy` [gem](https://github.com/Shopify/kubernetes-deploy)
+
+<h2 id="contributing">IV. CONTRIBUTING</h2>
+
+<h3 id="contributing-instructions">Instructions</h3>
+
+1. Fork it ( https://github.com/shopify/shipit-engine/fork )
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create a new Pull Request
+
+<h3 id="contributing-local-dev">Local development</h3>
+
+This repository has a [test/dummy](/test/dummy) app in it which can be used for local development without having to setup a new rails application.
+
+Run `./bin/bootstrap` in order to bootstrap the dummy application. The bootstrap script is going to:
+
+- Copy `config/secrets.development.example.yml` to `config/secrets.development.yml`;
+- Make sure all dependencies are installed;
+- Create and seed database (recreate database if already available);
+
+Run `./test/dummy/bin/rails server` to run the rails dummy application.
+
+Set the environment variable `SHIPIT_DISABLE_AUTH=1` in order to disable authentication.

data/app/assets/stylesheets/_pages/_commits.scss

@@ -77,6 +77,8 @@
     margin-bottom: 1rem;
     order: -1;
   }
+
+  @include truncate;
 }
 
 .commit-title {

data/app/assets/stylesheets/_pages/_deploy.scss

@@ -144,6 +144,12 @@
     font-size: .875rem;
     padding: .25em .45em;
   }
+
+  .short-sha-no-bg {
+    font-family: Menlo, monospace;
+    border-radius: 4px;
+    font-size: .875rem;
+  }
 }
 
 .search-bar {

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

@@ -0,0 +1,22 @@
+module Shipit
+  module Api
+    class ReleaseStatusesController < BaseController
+      require_permission :deploy, :stack
+
+      params do
+        requires :status, String
+        validates :status, inclusion: {in: %w(success failure)}
+      end
+      def create
+        deploy = stack.deploys_and_rollbacks.find(params[:deploy_id])
+        case params[:status]
+        when 'success'
+          deploy.report_healthy!(user: current_user)
+        when 'failure'
+          deploy.report_faulty!(user: current_user)
+        end
+        render_resource deploy, status: :created
+      end
+    end
+  end
+end

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

@@ -2,7 +2,7 @@ module Shipit
   module Api
     class StacksController < BaseController
       require_permission :read, :stack, only: %i(index show)
-      require_permission :write, :stack, only: %i(create)
+      require_permission :write, :stack, only: %i(create destroy)
 
       def index
         render_resources stacks
@@ -25,6 +25,11 @@ module Shipit
         render_resource stack
       end
 
+      def destroy
+        stack.schedule_for_destroy!
+        head :accepted
+      end
+
       private
 
       def stack

data/app/controllers/shipit/commits_controller.rb

@@ -1,7 +1,14 @@
 module Shipit
   class CommitsController < ShipitController
     def update
-      commit.update(params.require(:commit).permit(:locked))
+      if update_params[:locked].present?
+        if Shipit::CastValue.to_boolean(update_params[:locked])
+          commit.lock(current_user)
+        else
+          commit.unlock
+        end
+      end
+
       head :ok
     end
 
@@ -14,5 +21,9 @@ module Shipit
     def stack
       @stack ||= Stack.from_param!(params[:stack_id])
     end
+
+    def update_params
+      @update_params ||= params.require(:commit).permit(:locked)
+    end
   end
 end

data/app/controllers/shipit/deploys_controller.rb

@@ -5,6 +5,7 @@ module Shipit
     before_action :load_stack
     before_action :load_deploy, only: %i(show rollback revert)
     before_action :load_until_commit, only: :create
+    helper_method :short_commit_sha
 
     def new
       @commit = @stack.commits.by_sha!(params[:sha])
@@ -40,6 +41,12 @@ module Shipit
       redirect_to rollback_stack_deploy_path(@stack, previous_deploy)
     end
 
+    def short_commit_sha(task)
+      if previous_successful_deploy_commit(task)
+        @short_commit_sha ||= @previous_successful_deploy_commit&.short_sha
+      end
+    end
+
     private
 
     def load_deploy
@@ -57,5 +64,9 @@ module Shipit
     def deploy_params
       @deploy_params ||= params.require(:deploy).permit(:until_commit_id, env: @stack.deploy_variables.map(&:name))
     end
+
+    def previous_successful_deploy_commit(task)
+      @previous_successful_deploy_commit ||= task.commit_to_rollback_to
+    end
   end
 end

data/app/controllers/shipit/stacks_controller.rb

@@ -17,7 +17,28 @@ module Shipit
       return if flash.empty? && !stale?(last_modified: @stack.updated_at)
 
       @tasks = @stack.tasks.order(id: :desc).preload(:since_commit, :until_commit, :user).limit(10)
-      @commits = @stack.undeployed_commits { |scope| scope.preload(:author, :statuses, :check_runs) }
+
+      commits = @stack.undeployed_commits do |scope|
+        scope.preload(:author, :statuses, :check_runs, :lock_author)
+      end
+
+      next_expected_commit_to_deploy = @stack.next_expected_commit_to_deploy(commits: commits)
+
+      @active_commits = []
+      @undeployed_commits = []
+
+      commits.each do |commit|
+        (commit.active? ? @active_commits : @undeployed_commits) << commit
+      end
+
+      @active_commits = map_to_undeployed_commit(
+        @active_commits,
+        next_expected_commit_to_deploy: next_expected_commit_to_deploy,
+      )
+      @undeployed_commits = map_to_undeployed_commit(
+        @undeployed_commits,
+        next_expected_commit_to_deploy: next_expected_commit_to_deploy,
+      )
     end
 
     def lookup
@@ -73,6 +94,13 @@ module Shipit
 
     private
 
+    def map_to_undeployed_commit(commits, next_expected_commit_to_deploy:)
+      commits.map.with_index do |c, i|
+        index = commits.size - i - 1
+        UndeployedCommit.new(c, index: index, next_expected_commit_to_deploy: next_expected_commit_to_deploy)
+      end
+    end
+
     def load_stack
       @stack = Stack.from_param!(params[:id])
     end

data/app/controllers/shipit/tasks_controller.rb

@@ -2,7 +2,7 @@ module Shipit
   class TasksController < ShipitController
     include Pagination
 
-    before_action :stack
+    before_action :stack, except: [:lookup]
 
     self.default_page_size = 20
 
@@ -50,8 +50,20 @@ module Shipit
       render json: TailTaskSerializer.new(task, context: params)
     end
 
+    def lookup
+      @task = Task.find(params[:id])
+
+      redirect_to url_for_task
+    end
+
     private
 
+    def url_for_task
+      base_task = @task.is_a?(Deploy) ? @task.becomes(Deploy) : @task
+
+      url_for([base_task.stack, base_task])
+    end
+
     def task
       @task ||= stack.tasks.find(params[:id])
     end

data/app/helpers/shipit/merge_status_helper.rb

@@ -1,7 +1,7 @@
 module Shipit
   module MergeStatusHelper
-    def too_many_commits?(commits)
-      commits > 4
+    def display_commit_count_warning?(commits)
+      commits > 4 && @stack.merge_queue_enabled?
     end
   end
 end

data/app/helpers/shipit/stacks_helper.rb

@@ -1,9 +1,7 @@
 module Shipit
   module StacksHelper
-    COMMIT_TITLE_LENGTH = 79
-
     def redeploy_button(deployed_commit)
-      commit = UndeployedCommit.new(deployed_commit, 0)
+      commit = UndeployedCommit.new(deployed_commit, index: 0)
       url = new_stack_deploy_path(commit.stack, sha: commit.sha)
       classes = %W(btn btn--primary deploy-action #{commit.state})
 
@@ -46,7 +44,7 @@ module Shipit
     end
 
     def render_commit_message(pull_request_or_commit)
-      message = pull_request_or_commit.title.to_s.truncate(COMMIT_TITLE_LENGTH)
+      message = pull_request_or_commit.title.to_s
       content_tag(:span, emojify(message), class: 'event-message')
     end
 
@@ -80,5 +78,13 @@ module Shipit
     def render_raw_commit_id_link(commit)
       link_to(commit.short_sha, github_commit_url(commit), target: '_blank', class: 'number')
     end
+
+    def unlock_commit_tooltip(commit)
+      if commit.lock_author.present?
+        t('commit.unlock_with_author', author: commit.lock_author.name)
+      else
+        t('commit.unlock')
+      end
+    end
   end
 end

data/app/jobs/shipit/perform_task_job.rb

@@ -18,6 +18,7 @@ module Shipit
       @task.run!
       checkout_repository
       perform_task
+      @task.write("\nCompleted successfully\n")
       @task.report_complete!
     rescue Command::TimedOut => error
       @task.write("\n#{error.message}\n")

data/app/jobs/shipit/update_github_last_deployed_ref_job.rb

@@ -0,0 +1,41 @@
+module Shipit
+  class UpdateGithubLastDeployedRefJob < BackgroundJob
+    queue_as :default
+
+    DEPLOY_PREFIX = 'shipit-deploy'.freeze
+
+    def perform(stack)
+      stack_sha = stack.last_successful_deploy_commit&.sha
+      return unless stack_sha
+
+      environment = stack.environment
+      stack_ref = create_full_ref(environment)
+      client = Shipit.github.api
+
+      full_repo_name = stack.github_repo_name
+
+      update_or_create_ref(client: client, repo_name: full_repo_name, ref: stack_ref, new_sha: stack_sha)
+    end
+
+    private
+
+    def create_full_ref(stack_environment)
+      [DEPLOY_PREFIX, stack_environment].join("/")
+    end
+
+    def create_ref(client:, repo_name:, ref:, sha:)
+      client.create_ref(repo_name, ref, sha)
+    end
+
+    def update_or_create_ref(client:, repo_name:, ref:, new_sha:)
+      client.update_ref(repo_name, ref, new_sha)
+    rescue Octokit::UnprocessableEntity => e
+      error_msg = e.message
+      if error_msg.include? "Reference does not exist"
+        create_ref(client: client, repo_name: repo_name, ref: ref, sha: new_sha)
+      else
+        raise
+      end
+    end
+  end
+end

data/app/models/shipit/command_line_user.rb

@@ -0,0 +1,58 @@
+module Shipit
+  class CommandLineUser
+    def present?
+      false
+    end
+
+    def email
+      'command_line@example.com'
+    end
+
+    def login
+      'command_line'
+    end
+
+    def name
+      'CommandLine'
+    end
+
+    def avatar_url
+      'https://github.com/images/error/octocat_happy.gif'
+    end
+
+    def id
+    end
+
+    def github_id
+    end
+
+    def logged_in?
+      false
+    end
+
+    def authorized?
+      Shipit.authentication_disabled?
+    end
+
+    def stacks_contributed_to
+      []
+    end
+
+    def avatar_uri
+      User::DEFAULT_AVATAR.dup
+    end
+
+    def created_at
+      Time.at(0).utc
+    end
+    alias_method :updated_at, :created_at
+
+    def read_attribute_for_serialization(attr)
+      public_send(attr)
+    end
+
+    def github_api
+      Shipit.github.api
+    end
+  end
+end

data/app/models/shipit/commit.rb

@@ -7,7 +7,7 @@ module Shipit
     belongs_to :stack
     has_many :deploys
     has_many :statuses, -> { order(created_at: :desc) }, dependent: :destroy, inverse_of: :commit
-    has_many :check_runs, dependent: :destroy
+    has_many :check_runs, -> { order(created_at: :desc) }, dependent: :destroy, inverse_of: :commit
     has_many :commit_deployments, dependent: :destroy
     has_many :release_statuses, dependent: :destroy
     belongs_to :pull_request, inverse_of: :merge_commit, optional: true
@@ -23,6 +23,7 @@ module Shipit
 
     belongs_to :author, class_name: 'User', inverse_of: :authored_commits
     belongs_to :committer, class_name: 'User', inverse_of: :commits
+    belongs_to :lock_author, class_name: :User, optional: true, inverse_of: false
 
     def author
       super || AnonymousUser.new
@@ -32,6 +33,10 @@ module Shipit
       super || AnonymousUser.new
     end
 
+    def lock_author
+      super || AnonymousUser.new
+    end
+
     scope :reachable, -> { where(detached: false) }
 
     delegate :broadcast_update, :github_repo_name, :hidden_statuses, :required_statuses, :blocking_statuses,
@@ -47,6 +52,11 @@ module Shipit
       where('id < ?', commit.try(:id) || commit)
     end
 
+    def self.since(commit)
+      return all unless commit
+      where('id >= ?', commit.try(:id) || commit)
+    end
+
     def self.until(commit)
       return all unless commit
       where('id <= ?', commit.try(:id) || commit)
@@ -164,6 +174,18 @@ module Shipit
 
     delegate :pending?, :success?, :error?, :failure?, :blocking?, :state, to: :status
 
+    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
+    end
+
     def deployable?
       !locked? && (stack.ignore_ci? || (success? && !blocked?))
     end
@@ -198,7 +220,7 @@ module Shipit
     end
 
     def message_header
-      message.lines.first.strip
+      message.lines.first.to_s.strip
     end
 
     # TODO: remove in a few versions when it is assumed the commits table was backfilled
@@ -271,6 +293,24 @@ module Shipit
       end
     end
 
+    def lock(user)
+      update!(
+        locked: true,
+        lock_author_id: user.id,
+      )
+    end
+
+    def self.lock_all(user)
+      update_all(
+        locked: true,
+        lock_author_id: user.id,
+      )
+    end
+
+    def unlock
+      update!(locked: false, lock_author: nil)
+    end
+
     private
 
     def message_parser