shipit-engine 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09b8ffb2b4130e05d8da6bfbdc22080becca47dd92ee5a06b4113d3729578226'
-  data.tar.gz: 2223bee54a1d2a084823763876a049668829af0725779b413f0ed6d665ed45d6
+  metadata.gz: fc62ac846a6e7816e9de50d219459166c6941f0b230174309ad76bd695ab338e
+  data.tar.gz: 9879387bc8a1a0a89e334bea062ae56bfd060881da2f4e2779bbfddcae3b1f0d
 SHA512:
-  metadata.gz: 2a2bef860f0dc71622f450e4c52949680c7edca82c48462a48db34beb034b4b022e020228d160f5b86b7792d5938e0fdc09e6fb08e018c8a8e7f147bf22b60e7
-  data.tar.gz: 7cf318e67131f2a0a4bfbd316a8b732a5c8cd57fa49428d1f38a25e978a2e1535d0c5c8ca5e67bb83b4ad3c8f7dd07390e43832ef06ba697a9a2c5671e2df2d6
+  metadata.gz: ee9308a0a602a3aed84a3d7e8a2b9d0d0acf9a8eabebc57a245139c78a0404782bd58f6bbd3bd16661fdef199861833d74ae841cbdb3a439f6567351b7f80ed7
+  data.tar.gz: 4ecf8b958d7080b98babff0249bd8db5cdabcfe7c5b920c822a6db52148db5c953e3f7260ec60bf1eeba604d8403f4f8260806a15a3698eb29bf315ca0b84717

data/README.md

@@ -31,7 +31,6 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 **III. REFERENCE**
 
 * [Format and content of shipit.yml](#configuring-shipit)
-* [Format and content of secrets.yml](#configuring-secrets)
 * [Script parameters](#script-parameters)
 * [Configuring providers](#configuring-providers)
 * [Free samples](/examples/shipit.yml)
@@ -406,7 +405,7 @@ ci:
 
 <h3 id="merge-queue">Merge Queue</h3>
 
-The merge queue allow to register pull requests for them to be merged by Shipit once the stack is clear (no lock, no failing CI, no backlog). It can be enabled on a per stack basis via the settings page.
+The merge queue allows developers to register pull requests which will be merged by Shipit once the stack is clear (no lock, no failing CI, no backlog). It can be enabled on a per stack basis via the settings page.
 
 It can be customized via several `shipit.yml` properties:
 
@@ -436,6 +435,14 @@ merge:
     - codeclimate
 ```
 
+**<code>merge.method</code>** the [merge method](https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button) to use for this stack. If it's not set the default merge method will be used. Can be either `merge`, `squash` or `rebase`.
+
+For example:
+```yml
+merge:
+  method: squash
+```
+
 **<code>merge.max_divergence.commits</code>** the maximum number of commits a pull request can be behind its merge base, after which pull requests are rejected from the merge queue.
 
 For example:
@@ -496,6 +503,19 @@ tasks:
         default: 0
 ```
 
+You can also make these variables appear in the task title:
+
+```yml
+tasks:
+  failover:
+    action: "Failover a pod"
+    title: "Failover Pod %{POD_ID}"
+    steps:
+      - script/failover $POD_ID
+    variables:
+      - name: POD_ID
+```
+
 <h3 id="review-process">Review process</h3>
 
 You can display review elements, such as monitoring data or a pre-deployment checklist, on the deployment page in Shipit:

data/app/assets/javascripts/merge_status.coffee

@@ -0,0 +1,83 @@
+class MergeStatusPoller
+  POLL_INTERVAL = 3000
+
+  constructor: ->
+    @request = {abort: ->}
+    @previousLastModified = null
+    @timeoutId = null
+
+  start: ->
+    @timeoutId = setTimeout(@refreshPage, POLL_INTERVAL)
+    @
+
+  stop: ->
+    @request.abort()
+    clearTimeout(@timeoutId)
+    @
+
+  onPageChange: =>
+    window.parent.postMessage({event: 'hctw:height:change', height: document.body.clientHeight, service: 'shipit'}, '*')
+    window.parent.postMessage({event: 'hctw:stack:info', queue_enabled: @isMergeQueueEnabled(), status: @mergeStatus(), service: 'shipit'}, '*')
+
+  fetchPage: (url, callback) ->
+    request = @request = new XMLHttpRequest()
+    request.onreadystatechange = ->
+      if request.readyState == XMLHttpRequest.DONE
+        callback(request.status == 200 && request.responseText, request)
+    request.open('GET', url, true)
+    request.setRequestHeader('X-Requested-With', 'XMLHttpRequest')
+    request.send()
+
+  previousLastModified = null
+  refreshPage: =>
+    @fetchPage window.location.toString(), (html, response) =>
+      @updateDocument(html, response)
+      setTimeout(@refreshPage, POLL_INTERVAL)
+
+  updateDocument: (html, response) =>
+    lastModified = response.getResponseHeader('last-modified')
+    if !lastModified || lastModified != @previousLastModified
+      @previousLastModified = lastModified
+      if html && container = document.querySelector('[data-layout-content]')
+        container.innerHTML = html
+        @onPageChange()
+
+  isMergeQueueEnabled: =>
+    document.querySelector('.merge-status-container .js-details-container').hasAttribute('data-queue-enabled')
+
+  mergeStatus: =>
+    document.querySelector('.merge-status-container .js-details-container').getAttribute('data-merge-status') || 'unknown'
+
+class AjaxAction
+  constructor: (@poller) ->
+    document.addEventListener('submit', @submit, false)
+
+  submit: (event) =>
+    return unless event.target.getAttribute('data-remote') == 'true'
+
+    event.preventDefault()
+
+    @poller.stop()
+    @disableButtons(event.target)
+    @submitFormAsynchronously event.target, (html, request) =>
+      @poller.updateDocument(html, request)
+      @poller.start()
+
+  submitFormAsynchronously: (form, callback) ->
+    request = new XMLHttpRequest()
+    request.onreadystatechange = ->
+      if request.readyState == XMLHttpRequest.DONE
+        callback(request.status == 200 && request.responseText, request)
+    request.open(form.method.toLocaleUpperCase(), form.action, true)
+    request.setRequestHeader('X-Requested-With', 'XMLHttpRequest')
+    request.send(new FormData(form))
+
+  disableButtons: (form) ->
+    for button in form.querySelectorAll('[data-disable-with]')
+      button.disabled = true
+      button.textContent = button.getAttribute('data-disable-with')
+
+poller = new MergeStatusPoller
+poller.onPageChange()
+poller.start()
+new AjaxAction(poller)

data/app/assets/stylesheets/merge_status.scss

@@ -0,0 +1,3 @@
+.merge-status-container {
+  max-width: 700px;
+}

data/app/controllers/shipit/merge_status_controller.rb

@@ -0,0 +1,131 @@
+module Shipit
+  class MergeStatusController < ShipitController
+    skip_authentication only: %i(check show)
+
+    etag { cache_seed }
+    layout 'merge_status'
+
+    def show
+      response.headers['X-Frame-Options'] = 'ALLOWALL'
+      response.headers['Vary'] = 'X-Requested-With'
+
+      if stack
+        return render('logged_out') unless current_user.logged_in?
+        if stale?(last_modified: [stack.updated_at, pull_request.updated_at].max, template: false)
+          render stack_status, layout: !request.xhr?
+        end
+      else
+        render html: ''
+      end
+    end
+
+    def enqueue
+      PullRequest.request_merge!(stack, params[:number], current_user)
+      render stack_status, layout: !request.xhr?
+    end
+
+    def dequeue
+      if pull_request = stack.pull_requests.find_by_number(params[:number])
+        pull_request.cancel! if pull_request.waiting?
+      end
+      render stack_status, layout: !request.xhr?
+    end
+
+    def check
+      respond_to do |format|
+        format.html do
+          if stack_status == 'success'
+            render plain: 'ok'
+          else
+            render plain: stack_status, status: 503
+          end
+        end
+        format.json { render json: {stack_status: stack_status} }
+      end
+    end
+
+    private
+
+    def cache_seed
+      "#{request.xhr? ? 'partial' : 'full'}-#{Shipit.revision}"
+    end
+
+    def stack_status
+      @stack_status ||= stack.merge_status(backlog_leniency_factor: 1.0)
+    end
+
+    def stack
+      @stack ||= if params[:stack_id]
+        Stack.from_param!(params[:stack_id])
+      else
+        scope = Stack.order(id: :asc).where(
+          repo_owner: referrer_parser.repo_owner,
+          repo_name: referrer_parser.repo_name,
+        )
+        scope = if params[:branch]
+          scope.where(branch: params[:branch])
+        else
+          scope.where(environment: 'production')
+        end
+        scope.first
+      end
+    end
+
+    def referrer_parser
+      @referrer_parser ||= ReferrerParser.new(params[:referrer])
+    end
+
+    def pull_request
+      return @pull_request if defined?(@pull_request)
+      @pull_request = pull_request_number && stack.pull_requests.find_by_number(pull_request_number)
+      @pull_request ||= UnknownPullRequest.new
+    end
+
+    def pull_request_number
+      return @pull_request_number if defined?(@pull_request_number)
+      @pull_request_number = referrer_parser.pull_request_number
+    end
+
+    def queue_enabled?
+      stack.merge_queue_enabled? && pull_request_number
+    end
+
+    helper_method :pull_request_number
+    helper_method :pull_request
+    helper_method :queue_enabled?
+    helper_method :stack
+    helper_method :stack_status
+
+    # FIXME: for some reason if invoked in the view, those path helpers will link to /events?...
+    helper_method :enqueue_pull_request_path
+    helper_method :dequeue_pull_request_path
+
+    class ReferrerParser
+      URL_PATTERN = %r{\Ahttps://github\.com/([^/]+)/([^/]+)/pull/(\d+)}
+
+      attr_reader :repo_owner, :repo_name, :pull_request_number
+
+      def initialize(referrer)
+        if URL_PATTERN =~ referrer.to_s
+          @repo_owner = $1.downcase
+          @repo_name = $2.downcase
+          @pull_request_number = $3.to_i
+        else
+          raise ArgumentError, "Invalid referrer: #{referrer.inspect}"
+        end
+      end
+    end
+
+    class UnknownPullRequest
+      attr_reader :updated_at
+
+      def initialize
+        @updated_at = Time.at(0).utc
+      end
+
+      def waiting?
+        false
+      end
+    end
+  end
+end

data/app/helpers/shipit/merge_status_helper.rb

@@ -0,0 +1,7 @@
+module Shipit
+  module MergeStatusHelper
+    def too_many_commits?(commits)
+      commits > 4
+    end
+  end
+end

data/app/jobs/shipit/perform_task_job.rb

@@ -63,9 +63,7 @@ module Shipit
 
     def checkout_repository
       @task.acquire_git_cache_lock do
-        unless capture @commands.fetched?(@task.until_commit)
-          capture! @commands.fetch
-        end
+        capture! @commands.fetch
       end
       capture! @commands.clone
       capture! @commands.checkout(@task.until_commit)

data/app/models/shipit/deploy.rb

@@ -79,6 +79,10 @@ module Shipit
       rollback
     end
 
+    def title
+      I18n.t("#{self.class.name.demodulize.underscore.pluralize}.description", sha: until_commit.short_sha)
+    end
+
     def rollback?
       false
     end

data/app/models/shipit/deploy_spec.rb

@@ -146,6 +146,11 @@ module Shipit
       Array.wrap(config('ci', 'blocking'))
     end
 
+    def pull_request_merge_method
+      method = config('merge', 'method')
+      method if %w(merge rebase squash).include?(method)
+    end
+
     def pull_request_required_statuses
       if config('merge', 'require') || config('merge', 'ignore')
         Array.wrap(config('merge', 'require'))

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

@@ -34,6 +34,7 @@ module Shipit
             'require' => pull_request_required_statuses,
             'ignore' => pull_request_ignored_statuses,
             'revalidate_after' => revalidate_pull_requests_after&.to_i,
+            'method' => pull_request_merge_method,
             'max_divergence' => {
               'commits' => max_divergence_commits&.to_i,
               'age' => max_divergence_age&.to_i,

data/app/models/shipit/hook.rb

@@ -80,7 +80,7 @@ module Shipit
     end
 
     def purge_old_deliveries!(keep: DELIVERIES_LOG_SIZE)
-      delivery_ids = deliveries.sent.order(id: :desc).offset(keep).pluck(:id)
+      delivery_ids = deliveries.sent.order(id: :desc).offset(keep).limit(50).pluck(:id)
       deliveries.where(id: delivery_ids).delete_all
     end
 

data/app/models/shipit/pull_request.rb

@@ -163,7 +163,7 @@ module Shipit
         merge_message,
         sha: head.sha,
         commit_message: 'Merged by Shipit',
-        merge_method: 'merge',
+        merge_method: stack.merge_method,
       )
       begin
         if Shipit.github.api.pull_requests(stack.github_repo_name, base: branch).empty?

data/app/models/shipit/stack.rb

@@ -275,6 +275,10 @@ module Shipit
       merge_queue_enabled? && !locked? && merge_status == 'success'
     end
 
+    def merge_method
+      cached_deploy_spec&.pull_request_merge_method || Shipit.default_merge_method
+    end
+
     def repo_name=(name)
       super(name&.downcase)
     end

data/app/models/shipit/task.rb

@@ -212,6 +212,10 @@ module Shipit
       false
     end
 
+    def title
+      definition.render_title(env)
+    end
+
     def author
       user || AnonymousUser.new
     end

data/app/models/shipit/task_definition.rb

@@ -26,6 +26,15 @@ module Shipit
       @variables = task_variables(config['variables'] || [])
       @checklist = config['checklist'] || []
       @allow_concurrency = config['allow_concurrency'] || false
+      @title = config['title']
+    end
+
+    def render_title(env)
+      if @title
+        @title % env.symbolize_keys
+      else
+        action
+      end
     end
 
     def allow_concurrency?
@@ -36,6 +45,7 @@ module Shipit
       {
         id: id,
         action: action,
+        title: @title,
         description: description,
         steps: steps,
         variables: variables.map(&:to_h),

data/app/models/shipit/user.rb

@@ -46,11 +46,7 @@ module Shipit
     def github_api
       return Shipit.github.api unless github_access_token
 
-      @github_api ||= begin
-        client = Octokit::Client.new(access_token: github_access_token)
-        client.middleware = Shipit.new_faraday_stack
-        client
-      end
+      @github_api ||= Shipit.github.new_client(access_token: github_access_token)
     end
 
     def identifiers_for_ping

data/app/serializers/shipit/task_serializer.rb

@@ -13,6 +13,7 @@ module Shipit
       type
       status
       action
+      title
       description
       started_at
       ended_at

data/app/views/layouts/merge_status.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= stylesheet_link_tag *(params[:stylesheets] || []).select { |url| url.start_with?('https://assets-cdn.github.com/') } %>
+    <%= stylesheet_link_tag 'merge_status' %>
+  </head>
+  <body>
+    <div class="merge-status-container" data-layout-content><%= yield %></div>
+    <%= javascript_include_tag 'merge_status' %>
+  </body>
+</html>

data/app/views/shipit/merge_status/_anchor.html.erb

@@ -0,0 +1,6 @@
+<svg style="fill: <%= color %>; stroke: <%= color %>;" viewBox="-584 580 33 40" enable-background="new -583 582.2 31.3 36.8">
+<path d="M-553.7,605.9l-5.4-1.2l-0.9,3.8l3.2,0.7c-2.2,3.7-6.2,6-10.6,5.9l3.5-19.2c3.5-0.4,6.2-3.3,6.2-6.9
+  c0-3.8-3.1-6.9-6.9-6.9c-3.8,0-6.9,3.1-6.9,6.9c0,2.7,1.6,5,3.8,6.2l-3.5,19.2c-4.3-1.5-7.3-5.4-7.8-9.8l3.8,0.8l0.8-3.8l-5.1-1
+  l-3.1-0.6c-1.8,8.6,3.7,17,12.3,18.7c1.1,0.2,2.2,0.3,3.3,0.3c3.1,0,6-0.9,8.7-2.6c3.5-2.3,6-5.9,6.8-10L-553.7,605.9z M-564.6,586
+  c1.7,0,3,1.4,3,3c0,1.7-1.4,3-3,3c-1.7,0-3-1.4-3-3C-567.7,587.4-566.3,586-564.6,586z"/>
+</svg>

data/app/views/shipit/merge_status/_commit_count_warning.html.erb

@@ -0,0 +1,8 @@
+<p class="status-heading text-red">
+  <%= render 'warning_icon' %>
+  Consider rebasing into a smaller number of commits containing atomic changes. Find out
+  <%= link_to 'why', 'https://docs.google.com/document/d/1lZlNo7ekugQDxug6Nc6pdY87VNobl3g2IQjY7R0YIIc',
+    target: '_blank',
+    rel: 'noopener'
+  %>.
+</p>

data/app/views/shipit/merge_status/_merge_queue_button.html.erb

@@ -0,0 +1,16 @@
+<% classes = 'branch-action-btn float-right js-immediate-updates js-handle-pull-merging-errors' %>
+<% if pull_request.try!(&:waiting?) %>
+  <%= form_tag dequeue_pull_request_path(stack, pull_request_number), method: 'delete', class: classes, data: {remote: true} do %>
+    <%= hidden_field_tag 'referrer', params[:referrer] %>
+    <button type="submit" data-disable-with="Removing from merge queue…" class="btn">
+      Remove from merge queue
+    </button>
+  <% end %>
+<% else %>
+  <%= form_tag enqueue_pull_request_path(stack, pull_request_number), method: 'put', class: classes, data: {remote: true} do %>
+    <%= hidden_field_tag 'referrer', params[:referrer] %>
+    <button type="submit" data-disable-with="Adding to merge queue…" class="btn btn-primary">
+      Add to merge queue
+    </button>
+  <% end %>
+<% end %>

data/app/views/shipit/merge_status/_warning_icon.html.erb

@@ -0,0 +1,4 @@
+<svg aria-hidden="true" class="octicon octicon-issue-opened" height="16" version="1.1" viewBox="0 0 14 16" width="14">
+  <path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7
+    5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z" />
+</svg>

data/app/views/shipit/merge_status/backlogged.html.erb

@@ -0,0 +1,21 @@
+<div class="branch-action-item js-details-container" <% if queue_enabled? %>data-queue-enabled<% end %> data-merge-status="<%= stack_status %>">
+  <%= render 'merge_queue_button' if queue_enabled? %>
+  <div class="branch-action-item-icon completeness-indicator">
+    <%= render 'anchor', color: '#cea61b' %>
+  </div>
+  <h4 class="status-heading text-pending">
+    <% if pull_request.waiting? %>
+      Will be merged shortly after the backlog is shipped!
+    <% else %>
+      Please hold off merging!
+      <% if queue_enabled? %>
+        Add it to the merge queue instead.
+      <% end %>
+    <% end %>
+  </h4>
+  <span class="status-meta">
+    <%= link_to @stack.to_param, stack_url(@stack), target: '_blank', rel: 'noopener' %>
+    is <strong>backlogged</strong>
+  </span>
+  <%= render 'commit_count_warning' if too_many_commits?(params[:commits].to_i) %>
+</div>

data/app/views/shipit/merge_status/failure.html.erb

@@ -0,0 +1,21 @@
+<div class="branch-action-item js-details-container" <% if queue_enabled? %>data-queue-enabled<% end %> data-merge-status="<%= stack_status %>">
+  <%= render 'merge_queue_button' if queue_enabled? %>
+  <div class="branch-action-item-icon completeness-indicator">
+    <%= render 'anchor', color: '#d73a49' %>
+  </div>
+  <h4 class="status-heading text-red">
+    <% if pull_request.waiting? %>
+      Will be merged shortly after the CI is fixed!
+    <% else %>
+      Please hold off merging!
+      <% if queue_enabled? %>
+        Add it to the merge queue instead.
+      <% end %>
+    <% end %>
+  </h4>
+  <span class="status-meta">
+    <%= link_to @stack.to_param, stack_url(@stack), target: '_blank', rel: 'noopener' %>
+    <strong>master branch is failing!</strong>
+  </span>
+  <%= render 'commit_count_warning' if too_many_commits?(params[:commits].to_i) %>
+</div>

data/app/views/shipit/merge_status/locked.html.erb

@@ -0,0 +1,21 @@
+<div class="branch-action-item js-details-container" <% if queue_enabled? %>data-queue-enabled<% end %> data-merge-status="<%= stack_status %>">
+  <%= render 'merge_queue_button' if queue_enabled? %>
+  <div class="branch-action-item-icon completeness-indicator">
+    <%= render 'anchor', color: '#bd2c00' %>
+  </div>
+  <h4 class="status-heading text-red">
+    <% if pull_request.waiting? %>
+      Will be merged shortly after the lock is removed!
+    <% else %>
+      Please hold off merging!
+      <% if queue_enabled? %>
+        Add it to the merge queue instead.
+      <% end %>
+    <% end %>
+  </h4>
+  <span class="status-meta">
+    <%= link_to @stack.to_param, stack_url(@stack), target: '_blank', rel: 'noopener' %>
+    is <strong>locked</strong> because: <strong><%= auto_link(emojify(@stack.lock_reason), html: { target: '_blank' }) %></strong>
+  </span>
+  <%= render 'commit_count_warning' if too_many_commits?(params[:commits].to_i) %>
+</div>

data/app/views/shipit/merge_status/logged_out.erb

@@ -0,0 +1,11 @@
+<div class="branch-action-item">
+  <div class="branch-action-item-icon completeness-indicator">
+    <%= render 'anchor', color: '#bd2c00' %>
+  </div>
+  <h4 class="status-heading text-red">
+    Please log in to <%= link_to 'Shipit', '/', target: '_blank', rel: 'noopener' %>
+  </h4>
+  <span class="status-meta">
+    Here Comes The Walrus is unable to check merge status.
+  </span>
+</div>

data/app/views/shipit/merge_status/success.html.erb

@@ -0,0 +1,24 @@
+<div class="branch-action-item js-details-container" <% if queue_enabled? %>data-queue-enabled<% end %> data-merge-status="<%= stack_status %>">
+  <%= render 'merge_queue_button' if queue_enabled? %>
+  <div class="branch-action-item-icon completeness-indicator">
+    <%= render 'anchor', color: '#2cbe4e' %>
+  </div>
+
+  <h4 class="status-heading">
+    <% if pull_request.waiting? %>
+      <% if pull_request.all_status_checks_passed? %>
+        Will be merged shortly!
+      <% else %>
+        Will be merged when required checks are passing.
+      <% end %>
+    <% else %>
+      Ready to ship!
+    <% end %>
+  </h4>
+
+  <span class="status-meta">
+    <%= link_to @stack.to_param, stack_url(@stack), target: '_blank', rel: 'noopener' %> is clear.
+  </span>
+
+  <%= render 'commit_count_warning' if too_many_commits?(params[:commits].to_i) %>
+</div>

data/app/views/shipit/tasks/_task.html.erb

@@ -13,7 +13,7 @@
     <div class="commit-details">
       <span class="commit-title">
         <a href="<%= stack_task_path(@stack, task) %>">
-          <%= task.definition.action %>
+          <%= task.title %>
         </a>
       </span>
       <p class="commit-meta">

data/app/views/shipit/tasks/_task_output.html.erb

@@ -8,7 +8,7 @@
   <div class="sidebar-plugins"></div>
 </div>
 
-<div class="deploy-main" data-task="<%= {repo: @stack.github_repo_name, description: task_description(task)}.to_json %>">
+<div class="deploy-main" data-task="<%= {repo: @stack.github_repo_name, description: task.title}.to_json %>">
   <span class="deploy-tasks"></span>
   <div class="deploy-banner" data-status="<%= task.status %>">
     <div class="deploy-banner-status"></div>

data/config/routes.rb

@@ -38,6 +38,11 @@ Shipit::Engine.routes.draw do
     get '/' => 'ccmenu_url#fetch'
   end
 
+  # Browser extension
+  get '/merge_status', action: :show, controller: :merge_status, as: :merge_status
+  put '/merge_status/*stack_id/pull/:number', action: :enqueue, controller: :merge_status, id: stack_id_format, as: :enqueue_pull_request
+  delete '/merge_status/*stack_id/pull/:number', action: :dequeue, controller: :merge_status, id: stack_id_format, as: :dequeue_pull_request
+
   # Humans
   resources :stacks, only: %i(new create index)
 

data/lib/shipit.rb

@@ -26,8 +26,6 @@ require 'redis-objects'
 require 'redis-namespace'
 
 require 'octokit'
-require 'shipit/octokit_bot_users_patch'
-
 require 'faraday-http-cache'
 
 require 'shipit/version'
@@ -81,7 +79,7 @@ module Shipit
 
   def legacy_github_api
     if secrets&.github_api.present?
-      @legacy_github_api ||= Octokit::Client.new(access_token: secrets.github_api['access_token'])
+      @legacy_github_api ||= github.new_client(access_token: secrets.github_api['access_token'])
     end
   end
 
@@ -121,6 +119,10 @@ module Shipit
     secrets.host.presence
   end
 
+  def default_merge_method
+    secrets.default_merge_method || 'merge'
+  end
+
   def enforce_publish_config
     secrets.enforce_publish_config.presence
   end

data/lib/shipit/engine.rb

@@ -15,6 +15,8 @@ module Shipit
         task.js
         shipit.js
         shipit.css
+        merge_status.js
+        merge_status.css
       )
       app.config.assets.precompile << proc do |path|
         path =~ %r{\Aplugins/[\-\w]+\.(js|css)\Z}

data/lib/shipit/github_app.rb

@@ -22,7 +22,7 @@ module Shipit
     end
 
     def api
-      @client = new_client if !defined?(@client) || @client.access_token != token
+      @client = new_client(access_token: token) if !defined?(@client) || @client.access_token != token
       @client
     end
 
@@ -40,7 +40,7 @@ module Shipit
       return unless private_key && app_id && installation_id
 
       Rails.cache.fetch('github:integration:token', expires_in: 50.minutes, race_condition_ttl: 10.minutes) do
-        token = Octokit::Client.new(bearer_token: authentication_payload).create_app_installation_access_token(
+        token = new_client(bearer_token: authentication_payload).create_app_installation_access_token(
           installation_id,
           accept: 'application/vnd.github.machine-man-preview+json',
         ).token
@@ -84,6 +84,12 @@ module Shipit
       domain != DOMAIN
     end
 
+    def new_client(options = {})
+      client = Octokit::Client.new(options.reverse_merge(api_endpoint: api_endpoint))
+      client.middleware = Shipit.new_faraday_stack
+      client
+    end
+
     private
 
     attr_reader :webhook_secret, :oauth_id, :oauth_secret
@@ -100,15 +106,6 @@ module Shipit
       @private_key ||= @config.fetch(:private_key)
     end
 
-    def new_client
-      client = Octokit::Client.new(
-        access_token: token,
-        api_endpoint: api_endpoint,
-      )
-      client.middleware = Shipit.new_faraday_stack
-      client
-    end
-
     def authentication_payload
       payload = {
         iat: Time.now.to_i,

data/lib/shipit/stack_commands.rb

@@ -16,15 +16,6 @@ module Shipit
       end
     end
 
-    def fetched?(commit)
-      git_dir = File.join(@stack.git_path, '.git')
-      if Dir.exist?(git_dir)
-        git('rev-parse', '--quiet', '--verify', "#{commit.sha}^{commit}", env: env, chdir: @stack.git_path)
-      else
-        Command.new('test', '-d', git_dir, env: env, chdir: @stack.deploys_path)
-      end
-    end
-
     def fetch_deployed_revision
       with_temporary_working_directory(commit: @stack.commits.last) do |dir|
         spec = DeploySpec::FileSystem.new(dir, @stack.environment)

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.22.0'.freeze
+  VERSION = '0.23.0'.freeze
 end

data/lib/snippets/misconfigured-npm-publish-config

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 
-echo -e "\033[1;31m Misconfigured package.json, please ensure the following has been met:\n \033[0m"
+echo -e "\033[1;31m Issue(s) found in package.json. Ensure the following conditions are met and try again.\n \033[0m"
 
-echo -e "\033[1;31m * Please add a publishConfig with an access setting in your package.json.  e.g.,\033[0m"
-echo -e "\n\033[1;31m\t\"publishConfig:\" {\n\t   \"access\": \"<public|restricted>\" \n\t} \033[0m"
-echo -e "\n\033[1;31m * If your package is private, ensure your the package name is scoped (@organization/package) \033[0m"
+echo -e "\033[1;31m * Set the appropriate access in publishConfig:\033[0m"
+echo -e "\n\033[1;31m\t\"publishConfig\": {\n\t   \"access\": \"<public|restricted>\" \n\t}\033[0m"
+echo -e "\n\033[1;31m * If the package is private, its name must be scoped (@organization-scope/package)\033[0m"
 exit 1

data/test/controllers/merge_status_controller_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Shipit
+  class MergeStatusControllerTest < ActionController::TestCase
+    setup do
+      request.env['HTTPS'] = 'on'
+      @request.host = URI(Shipit.host).host
+      session[:user_id] = shipit_users(:walrus).id
+    end
+
+    test "GET show" do
+      get :show, params: {referrer: 'https://github.com/Shopify/shipit-engine/pull/42', branch: 'master'}
+      assert_response :ok
+      assert_includes response.body, 'Ready to ship!'
+    end
+
+    test "GET show when there is no matching stacks" do
+      get :show, params: {referrer: 'https://github.com/Shopify/unknown-repo/pull/42', branch: 'master'}
+      assert_response :ok
+      assert_predicate response.body, :blank?
+    end
+
+    test "GET anonymous show returns a login message" do
+      session.delete(:user_id)
+      get :show, params: {referrer: 'https://github.com/Shopify/shipit-engine/pull/42', branch: 'master'}
+      assert_response :ok
+      assert_includes response.body.downcase, 'please log in'
+    end
+
+    test "GET anonymous show when there is no matching stack is blank" do
+      session.delete(:user_id)
+      get :show, params: {referrer: 'https://github.com/Shopify/unknown-repo/pull/42', branch: 'master'}
+      assert_response :ok
+      assert_predicate response.body, :blank?
+    end
+  end
+end

data/test/fixtures/shipit/tasks.yml

@@ -134,3 +134,30 @@ soc_deploy:
   created_at: <%= (60 - 1).minutes.ago.to_s(:db) %>
   started_at: <%= (60 - 1).minutes.ago.to_s(:db) %>
   ended_at: <%= (60 - 3).minutes.ago.to_s(:db) %>
+
+shipit_rendered_failover:
+  id: 10
+  user: walrus
+  since_commit_id: 2 # second
+  until_commit_id: 2 # second
+  type: Shipit::Task
+  stack: shipit
+  status: success
+  definition: >
+    {
+      "id": "failover",
+      "action": "Failover a pod",
+      "title": "Failover pod %{POD_ID}",
+      "description": "Restart app and job servers",
+      "variables": [
+        {"name": "POD_ID", "title": "Id of the pod to failover"}
+      ],
+      "steps": [
+        "cap $ENVIRONMENT pod:failover"
+      ]
+    }
+  env:
+    POD_ID: "12"
+  created_at: <%= (60 - 3).minutes.ago.to_s(:db) %>
+  started_at: <%= (60 - 3).minutes.ago.to_s(:db) %>
+  ended_at: <%= (60 - 4).minutes.ago.to_s(:db) %>

data/test/jobs/perform_task_job_test.rb

@@ -14,7 +14,6 @@ module Shipit
       @commands = stub(:commands)
       Commands.expects(:for).with(@deploy).returns(@commands)
 
-      @commands.expects(:fetched?).once.returns(false)
       @commands.expects(:fetch).once
       @commands.expects(:clone).once
       @commands.expects(:checkout).with(@deploy.until_commit).once

data/test/models/deploy_spec_test.rb

@@ -295,6 +295,7 @@ module Shipit
           'require' => [],
           'ignore' => [],
           'revalidate_after' => nil,
+          'method' => nil,
           'max_divergence' => {
             'commits' => nil,
             'age' => nil,
@@ -442,6 +443,29 @@ module Shipit
       assert_equal %w(ci/circleci soc/compliance), @spec.required_statuses
     end
 
+    test "pull_request_merge_method defaults to `nil`" do
+      @spec.expects(:load_config).returns({})
+      assert_nil @spec.pull_request_merge_method
+    end
+
+    test "pull_request_merge_method returns `merge.method`" do
+      @spec.expects(:load_config).returns(
+        'merge' => {
+          'method' => 'squash',
+        },
+      )
+      assert_equal 'squash', @spec.pull_request_merge_method
+    end
+
+    test "pull_request_merge_method returns `nil` if `merge.method` is invalid" do
+      @spec.expects(:load_config).returns(
+        'merge' => {
+          'method' => 'squashing',
+        },
+      )
+      assert_nil @spec.pull_request_merge_method
+    end
+
     test "pull_request_ignored_statuses defaults to the union of ci.hide and ci.allow_failures" do
       @spec.expects(:load_config).returns(
         'ci' => {

data/test/models/task_definitions_test.rb

@@ -6,6 +6,7 @@ module Shipit
       @definition = TaskDefinition.new(
         'restart',
         'action' => 'Restart application',
+        'title' => 'Restart application %{FOO}',
         'description' => 'Restart app and job servers',
         'steps' => ['touch tmp/restart'],
         'allow_concurrency' => true,
@@ -36,6 +37,7 @@ module Shipit
       as_json = {
         id: 'restart',
         action: 'Restart application',
+        title: "Restart application %{FOO}",
         description: 'Restart app and job servers',
         steps: ['touch tmp/restart'],
         checklist: [],

data/test/models/tasks_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+module Shipit
+  class TasksTest < ActiveSupport::TestCase
+    test "#title interpolates env" do
+      task = shipit_tasks(:shipit_rendered_failover)
+      assert_equal({'POD_ID' => '12'}, task.env)
+      assert_equal 'Failover pod 12', task.title
+    end
+
+    test "#title returns the task action if title is not defined" do
+      task = shipit_tasks(:shipit_restart)
+      assert_equal 'Restart application', task.title
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2018-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -170,28 +170,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.9.0
 - !ruby/object:Gem::Dependency
   name: omniauth-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: pubsubstub
   requirement: !ruby/object:Gem::Requirement
@@ -428,6 +428,7 @@ files:
 - app/assets/images/validation/invalid.png
 - app/assets/images/validation/required.png
 - app/assets/images/validation/valid.png
+- app/assets/javascripts/merge_status.coffee
 - app/assets/javascripts/shipit.js.coffee
 - app/assets/javascripts/shipit/checklist.js.coffee
 - app/assets/javascripts/shipit/deploy.js.coffee
@@ -460,6 +461,7 @@ files:
 - app/assets/stylesheets/_structure/_layout.scss
 - app/assets/stylesheets/_structure/_main.scss
 - app/assets/stylesheets/_structure/_navigation.scss
+- app/assets/stylesheets/merge_status.scss
 - app/assets/stylesheets/shipit.scss
 - app/assets/webfonts/CheckoutSymbols-Regular.eot
 - app/assets/webfonts/CheckoutSymbols-Regular.svg
@@ -485,6 +487,7 @@ files:
 - app/controllers/shipit/commits_controller.rb
 - app/controllers/shipit/deploys_controller.rb
 - app/controllers/shipit/github_authentication_controller.rb
+- app/controllers/shipit/merge_status_controller.rb
 - app/controllers/shipit/pull_requests_controller.rb
 - app/controllers/shipit/rollbacks_controller.rb
 - app/controllers/shipit/shipit_controller.rb
@@ -495,6 +498,7 @@ files:
 - app/helpers/shipit/chunks_helper.rb
 - app/helpers/shipit/deploys_helper.rb
 - app/helpers/shipit/github_url_helper.rb
+- app/helpers/shipit/merge_status_helper.rb
 - app/helpers/shipit/shipit_helper.rb
 - app/helpers/shipit/stacks_helper.rb
 - app/helpers/shipit/tasks_helper.rb
@@ -578,6 +582,7 @@ files:
 - app/serializers/shipit/user_serializer.rb
 - app/validators/ascii_only_validator.rb
 - app/validators/subset_validator.rb
+- app/views/layouts/merge_status.html.erb
 - app/views/layouts/shipit.html.erb
 - app/views/shipit/_variables.html.erb
 - app/views/shipit/ccmenu/project.xml.builder
@@ -593,6 +598,15 @@ files:
 - app/views/shipit/deploys/rollback.html.erb
 - app/views/shipit/deploys/show.html.erb
 - app/views/shipit/github_authentication/failed.html.erb
+- app/views/shipit/merge_status/_anchor.html.erb
+- app/views/shipit/merge_status/_commit_count_warning.html.erb
+- app/views/shipit/merge_status/_merge_queue_button.html.erb
+- app/views/shipit/merge_status/_warning_icon.html.erb
+- app/views/shipit/merge_status/backlogged.html.erb
+- app/views/shipit/merge_status/failure.html.erb
+- app/views/shipit/merge_status/locked.html.erb
+- app/views/shipit/merge_status/logged_out.erb
+- app/views/shipit/merge_status/success.html.erb
 - app/views/shipit/missing_settings.html.erb
 - app/views/shipit/pull_requests/_pull_request.html.erb
 - app/views/shipit/pull_requests/index.html.erb
@@ -676,7 +690,6 @@ files:
 - lib/shipit/first_parent_commits_iterator.rb
 - lib/shipit/github_app.rb
 - lib/shipit/null_serializer.rb
-- lib/shipit/octokit_bot_users_patch.rb
 - lib/shipit/octokit_iterator.rb
 - lib/shipit/paginator.rb
 - lib/shipit/rollback_commands.rb
@@ -717,6 +730,7 @@ files:
 - test/controllers/commits_controller_test.rb
 - test/controllers/deploys_controller_test.rb
 - test/controllers/github_authentication_controller_test.rb
+- test/controllers/merge_status_controller_test.rb
 - test/controllers/pull_requests_controller_test.rb
 - test/controllers/rollbacks_controller_test.rb
 - test/controllers/stacks_controller_test.rb
@@ -839,6 +853,7 @@ files:
 - test/models/status/missing_test.rb
 - test/models/status_test.rb
 - test/models/task_definitions_test.rb
+- test/models/tasks_test.rb
 - test/models/team_test.rb
 - test/models/undeployed_commits_test.rb
 - test/models/users_test.rb
@@ -960,6 +975,7 @@ test_files:
 - test/models/delivery_test.rb
 - test/models/commit_deployment_status_test.rb
 - test/models/api_client_test.rb
+- test/models/tasks_test.rb
 - test/models/hook_test.rb
 - test/models/task_definitions_test.rb
 - test/models/status/group_test.rb
@@ -1012,6 +1028,7 @@ test_files:
 - test/controllers/stacks_controller_test.rb
 - test/controllers/commits_controller_test.rb
 - test/controllers/github_authentication_controller_test.rb
+- test/controllers/merge_status_controller_test.rb
 - test/controllers/ccmenu_controller_test.rb
 - test/controllers/commit_checks_controller_test.rb
 - test/controllers/pull_requests_controller_test.rb

data/lib/shipit/octokit_bot_users_patch.rb

@@ -1,25 +0,0 @@
-require 'octokit'
-
-# https://github.com/octokit/octokit.rb/pull/1006
-if Octokit::VERSION >= '5'
-  raise 'This patch should be removed'
-else
-  module Octokit
-    module Connection
-      protected
-
-      def request(method, path, data, options = {})
-        if data.is_a?(Hash)
-          options[:query] = data.delete(:query) || {}
-          options[:headers] = data.delete(:headers) || {}
-          if accept = data.delete(:accept)
-            options[:headers][:accept] = accept
-          end
-        end
-
-        @last_response = response = agent.call(method, Addressable::URI.parse(path.to_s).normalize.to_s, data, options)
-        response.data
-      end
-    end
-  end
-end