shipit-engine 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ed7609bec0e259e4962046f8d6107263c7429db
-  data.tar.gz: 835c09964fcd482736103a6d8e40f59bd2aa1f0e
+  metadata.gz: 728cef09e4ae36c728e2a5d933f5967f4dcbe757
+  data.tar.gz: e35599675982e893d70e0c25d678da7e8910e7f4
 SHA512:
-  metadata.gz: cacebc0ec7fcce7a0af8feefa79d7d48878548bd07b8a75b02878383ed89d7db4364e9b623f910bf9090b5bbbd7e4d201926f86309f265ef279ac40a1b554ee9
-  data.tar.gz: 6ef2234ef1e1be3d462572a817edeab7ad042a0ca47639834ad349b88308a7d9541c0d3527f63697752735b9e4c3528b597197de2e882c569db9b9ef9fbc6521
+  metadata.gz: bc3ecc88e8e13e99dca6f5789d364de99a21374fa566cd0273ed013f2f2b8da1c9a007fe9931daa76f66c12ba0ff9890cd2c8b4110d28f35510a7e3d29a3cef0
+  data.tar.gz: fde31379bbe98eb1dfb6af272a54a1b6b9e1a3e171d1dcc1588f8e67a257fe633117d1c35251f3543d3a5d585039c68e0e21dcd2ce8f945f009deee0bd722695

data/README.md

@@ -268,9 +268,10 @@ deploy:
 ```
 <br>
 
-**<code>deploy.max_commits</code>** allows you to set a limit to the number of commits being shipped per deploys.
+**<code>deploy.max_commits</code>** define the maximum number of commits that should be shipped per deploys. Defaults to `8`.
 
 Human users will be warned that they are not respecting the recommendation, but allowed to continue.
+However continuous delivery will respect this limit. If there is no deployable commits in this range, a human intervention will be required.
 
 For example:
 
@@ -393,6 +394,38 @@ ci:
     - ci/circleci
 ```
 
+<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.
+
+It can be customized via several `shipit.yml` properties:
+
+**<code>merge.revalidate_after</code>** a duration after which pull requests that couldn't be merged are rejected from the queue. Defaults to unlimited.
+
+For example:
+```yml
+merge:
+  revalidate_after: 12m30s
+```
+
+**<code>merge.require</code>** contains an array of the [statuses context](https://developer.github.com/v3/repos/statuses/) that you want Shipit to consider as failing if they aren't present on the pull request. Defaults to `ci.require` if present, or empty otherwise.
+
+For example:
+```yml
+merge:
+  require:
+    - continuous-integration/travis-ci/push
+```
+
+**<code>merge.ignore</code>** contains an array of the [statuses context](https://developer.github.com/v3/repos/statuses/) that you want Shipit not to consider when merging pull requests. Defaults to the union of `ci.allow_failures` and `ci.hide` if any is present or empty otherwise.
+
+For example:
+```yml
+merge:
+  ignore:
+    - codeclimate
+```
+
 <h3 id="custom-tasks">Custom tasks</h3>
 
 You can create custom tasks that users execute directly from a stack's overview page in Shipit. To create a new custom task, specify its parameters in the `tasks` section of the `shipit.yml` file. For example:

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

@@ -0,0 +1,63 @@
+class PageUpdater
+  DEBOUNCE = 100
+  RETRY_DELAY = 5000
+  MAX_RETRIES = 5
+
+  @callbacks: []
+  @afterUpdate: (callback) ->
+    @callbacks.push(callback)
+
+  constructor: (@channel, @selectors) ->
+    @parser = new DOMParser()
+    @source = @listen()
+    @previousLastModified = null
+
+  requestUpdate: =>
+    @updateRequested = true
+    @scheduleUpdate()
+
+  scheduleUpdate: =>
+    return if @updateScheduled
+    return unless @updateRequested
+    setTimeout(@fetchPage, DEBOUNCE)
+    @updateScheduled = true
+
+  fetchPage: (message) =>
+    @updateRequested = false
+    jQuery.get(window.location.toString()).done(@updatePage).fail(=> @updateScheduled = false)
+
+  updatePage: (html, status, response) =>
+    lastModified = response.getResponseHeader('last-modified')
+    if lastModified? and lastModified != @previousLastModified
+      @previousLastModified = lastModified
+
+      newDocument = @parser.parseFromString(html, 'text/html')
+      for selector in @selectors
+        $(selector).html(newDocument.querySelectorAll("#{selector} > *"))
+      for callback in PageUpdater.callbacks
+        callback()
+
+    @updateScheduled = false
+
+  listen: ->
+    @source = new EventSource(@channel)
+    @source.addEventListener('update', @requestUpdate)
+    @retries = MAX_RETRIES
+    @interval = setInterval =>
+      switch @source.readyState
+        when @source.CLOSED
+          clearInterval(@interval)
+          if @retries > 0
+            @retries -= 1
+            @listen()
+        else
+          @retries = MAX_RETRIES
+    , RETRY_DELAY
+
+jQuery ($) ->
+  PageUpdater.afterUpdate -> $('time[data-time-ago]').timeago()
+
+  channel = $('meta[name=subscription-channel]').attr('content')
+  selectors = (e.content for e in $('meta[name=subscription-selector]'))
+  if channel and selectors
+    new PageUpdater(channel, selectors)

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

@@ -20,24 +20,12 @@ jQuery ($) ->
 
   displayIgnoreCiMessage()
 
-  updatePage = (message) ->
-    payload = JSON.parse(message.data)
-    $('[data-layout-content]').load("#{payload.url} [data-layout-content] > *", -> $('time[data-time-ago]').timeago())
-
-  retries = 0
-  listenToEventSource = (url) ->
-    source = new EventSource(url)
-    source.addEventListener 'stack.update', updatePage
-    interval = setInterval ->
-      switch source.readyState
-        when source.CLOSED
-          clearInterval(interval)
-          if retries > 0
-            retries -= 1
-            listenToEventSource(url)
-        else
-          retries = 2
-    , 30000
-
-  $('[data-event-stream]').each ->
-    listenToEventSource($(this).data('event-stream'))
+  $(document).on 'click', '.setting-ccmenu input[type=submit]', (event) ->
+    event.preventDefault()
+    $(event.target).prop('disabled', true)
+    $.get(event.target.dataset.remote).done((data) ->
+      $('#ccmenu-url').val(data.ccmenu_url).removeClass('hidden')
+      $(event.target).addClass('hidden')
+    ).fail(->
+      $(event.target).prop('disabled', false)
+    )

data/app/assets/stylesheets/_base/_base.scss

@@ -105,9 +105,9 @@ p {
 a {
   text-decoration: none;
   cursor: pointer;
-  color: #248af2;
+  color: $blue;
     &.subdued { color: #999; }
-    &.subdued:hover { color: #248af2; }
+    &.subdued:hover { color: $blue; }
 }
 
 .more {

data/app/assets/stylesheets/_base/_colors.scss

@@ -2,7 +2,6 @@
 // COLORS
 // =============================================================================
 
-$orange: #EDAA4E;
 $banner-blue: #96A9BA;
 $banner-red: #EE6A6A;
 $blue: #248AF2;

data/app/assets/stylesheets/_base/_forms.scss

@@ -26,6 +26,20 @@ textarea {
 
 .field-wrapper {
   margin-bottom: 1.5rem;
+  input:focus {
+    border-color: $blue;
+  }
+  &.inline {
+    input {
+      &.btn {
+        height: 2.5rem;
+      }
+      display: inline;
+      &:focus {
+        padding-right: 30px;
+      }
+    }
+  }
 }
 
 .field_with_errors {

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

@@ -2,7 +2,7 @@
 // COMMIT LIST
 // =============================================================================
 
-.commit-list, .task-list {
+.commit-list, .task-list, .pr-list {
   list-style-type: none;
   margin: 0; padding: 0;
 }
@@ -11,7 +11,7 @@
   float: right;
 }
 
-.commit, .task {
+.commit, .task, .pr {
   padding: .75rem 0;
   display: flex;
   flex-direction: column;
@@ -70,7 +70,7 @@
 // COMMIT DETAILS
 // -----------------------------------------------------------------------------
 
-.commit-details {
+.commit-details, .pr-details {
   flex-grow: 1;
 
   @include media(tablet-down) {
@@ -88,11 +88,17 @@
   }
 }
 
-.commit-title a {
-  color: #333;
+.commit-title, .pr-title {
+  a {
+    color: #333;
+  }
+}
+
+.pr-details .pr-number .number {
+  color: $blue;
 }
 
-.commit-meta {
+.commit-meta, .pr-meta {
   font-size: 0.8em;
   color: #999;
   margin: 0;
@@ -100,6 +106,10 @@
   @include media(desktop) {
     @include truncate;
   }
+
+  .warning {
+    color: $orange;
+  }
 }
 
 .utc-timecode {

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

@@ -13,4 +13,12 @@
     font-size: smaller;
     font-style: italic;
   }
+
+  .ccmenu-url {
+    width: 85%;
+  }
+
+  .hidden {
+    display: none;
+  }
 }

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

@@ -154,7 +154,7 @@
     }
   }
   input:focus {
-    border-color: #248af2;
+    border-color: $blue;
   }
 }
 

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

@@ -25,9 +25,13 @@ module Shipit
       private
 
       def authenticate_api_client
-        @current_api_client = authenticate_with_http_basic do |*parts|
-          token = parts.select(&:present?).join('--')
-          ApiClient.authenticate(token)
+        @current_api_client = if Shipit.disable_api_authentication
+          UnlimitedApiClient.new
+        else
+          authenticate_with_http_basic do |*parts|
+            token = parts.select(&:present?).join('--')
+            ApiClient.authenticate(token)
+          end
         end
         return if @current_api_client
         headers['WWW-Authenticate'] = 'Basic realm="Authentication token"'

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

@@ -0,0 +1,33 @@
+module Shipit
+  module Api
+    class CCMenuController < BaseController
+      require_permission :read, :stack
+
+      class NoDeploy
+        def id
+          0
+        end
+
+        def ended_at
+          Time.now.utc
+        end
+      end
+
+      def show
+        latest_deploy = stack.deploys_and_rollbacks.last || NoDeploy.new
+        render 'shipit/ccmenu/project.xml.builder', formats: [:xml], locals: {stack: stack, deploy: latest_deploy}
+      end
+
+      private
+
+      def stack
+        @stack ||= Stack.from_param!(params[:stack_id])
+      end
+
+      def authenticate_api_client
+        @current_api_client = ApiClient.authenticate(params[:token])
+        super unless @current_api_client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Shipit
+  module Api
+    class PullRequestsController < BaseController
+      require_permission :read, :stack
+      require_permission :deploy, :stack, only: %i(update destroy)
+
+      def index
+        render_resources stack.pull_requests.includes(:head).order(id: :desc)
+      end
+
+      def show
+        render_resource stack.pull_requests.find_by_number!(params[:id])
+      end
+
+      def update
+        pull_request = PullRequest.request_merge!(stack, params[:id], current_user)
+        if pull_request.waiting?
+          head :accepted
+        elsif pull_request.merged?
+          render status: :method_not_allowed, json: {
+            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 pull_request = stack.pull_requests.where(number: params[:id]).first
+          pull_request.cancel! if pull_request.waiting?
+        end
+        head :no_content
+      end
+    end
+  end
+end

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

@@ -15,6 +15,7 @@ module Shipit
         accepts :branch, String
         accepts :deploy_url, String
         accepts :ignore_ci, Boolean
+        accepts :merge_queue_enabled, Boolean
       end
       def create
         render_resource Stack.create(params)

data/app/controllers/shipit/ccmenu_url_controller.rb

@@ -0,0 +1,22 @@
+require 'uri'
+
+module Shipit
+  class CCMenuUrlController < ShipitController
+    def fetch
+      uri = URI(api_stack_ccmenu_url(stack_id: stack.to_param))
+      uri.query = {'token' => client.authentication_token}.to_query
+      render json: {ccmenu_url: uri.to_s}
+    end
+
+    private
+
+    def client
+      @client ||= ApiClient.create_with(permissions: %w(read:stack))
+                           .find_or_create_by!(creator: current_user, name: 'CCMenu Client')
+    end
+
+    def stack
+      @stack ||= Stack.from_param!(params[:stack_id])
+    end
+  end
+end

data/app/controllers/shipit/pull_requests_controller.rb

@@ -0,0 +1,30 @@
+module Shipit
+  class PullRequestsController < ShipitController
+    def index
+      @pull_requests = stack.pull_requests.queued
+    end
+
+    def create
+      if pr_number = PullRequest.extract_number(stack, params[:number_or_url])
+        pull_request = PullRequest.request_merge!(stack, pr_number, current_user)
+        flash[:success] = "Pull request ##{pull_request.number} added to the queue."
+      else
+        flash[:warning] = "Invalid or missing pull request number."
+      end
+      redirect_to stack_pull_requests_path
+    end
+
+    def destroy
+      pull_request = stack.pull_requests.find(params[:id])
+      pull_request.cancel!
+      flash[:success] = 'Merge canceled'
+      redirect_to stack_pull_requests_path
+    end
+
+    private
+
+    def stack
+      @stack ||= Stack.from_param!(params[:stack_id])
+    end
+  end
+end

data/app/controllers/shipit/stacks_controller.rb

@@ -85,8 +85,13 @@ module Shipit
     end
 
     def update_params
-      params.require(:stack).permit(:deploy_url, :environment,
-                                    :continuous_deployment, :ignore_ci)
+      params.require(:stack).permit(
+        :deploy_url,
+        :environment,
+        :continuous_deployment,
+        :ignore_ci,
+        :merge_queue_enabled,
+      )
     end
   end
 end