shipit-engine 0.12.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a30e953800b45a4493e91c7e8caa2ad53f3dc447
-  data.tar.gz: 16b5dabad1863d6982dbd8736152e37e19a3a671
+  metadata.gz: 982c05d52c22af2e2e26f352efc805d9ef961759
+  data.tar.gz: 3a43a97130cc13814c6368ec89e219cb5face2c9
 SHA512:
-  metadata.gz: cb4027d810267d4c983dd26fa0a602af2db1a5015e3371b2b02e2d8d8636d791a596517a5528df4c89b9d95cc6b638a2ee7676a14215eae60fa2cfa9b8e67d27
-  data.tar.gz: 10ff1beb9b067253a7814300ec69b9f7ef7e3c312d3c3b2c122183d0d90a0a97e84f8f267249dc393866fc9374986ce8b0c874d8a97d040e060c64d872ced214
+  metadata.gz: 2579172befb2eb5054a42935b8bf4fd97bfc53098291468a881171faa708b10f538c3ddbedc2b0560dd0a597bc9f64cee2066d2045ba46d9d66d60e152c38d13
+  data.tar.gz: 72f2f25e93719769e1ceeffe3c952cbd460a80864151ba9a5761b813114791aadbc6888cebd48e24fb552384ce3943250d698f2ef195ed1c3f304e5bd10d206c

data/README.md

@@ -20,7 +20,7 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 
 * [Installation](#installation)
 * [Configuring shipit.yml and secrets.yml](#configuring-ymls)
-* [Updating and existing installation](#updating-shipit)
+* [Updating an existing installation](#updating-shipit)
 
 **II. USING SHIPIT**
 
@@ -45,8 +45,8 @@ This guide aims to help you [set up](#installation-and-setup), [use](#using-ship
 
 Shipit provides you with a Rails template. To bootstrap your Shipit installation:
 
-1. If you don't have Rails installed, run this command: `gem install rails -v 4.2.6`
-2. Run this command:  `rails _4.2.6_ new shipit -m https://raw.githubusercontent.com/Shopify/shipit-engine/master/template.rb`
+1. If you don't have Rails installed, run this command: `gem install rails -v 5.0.0.1`
+2. Run this command:  `rails _5.0.0.1_ new shipit --skip-action-cable --skip-turbolinks --skip-action-mailer -m https://raw.githubusercontent.com/Shopify/shipit-engine/master/template.rb`
 3. Enter your **Client ID**, **Client Secret**, and **GitHub API access token** when prompted. These can be found on your application's GitHub page.
 4. To setup the database, run this command: `rake db:setup`
 
@@ -551,6 +551,7 @@ Your deploy scripts have access to the following environment variables:
 * `ENVIRONMENT`: The stack environment (e.g `production` / `staging`)
 * `BRANCH`: The stack branch (e.g `master`)
 * `LAST_DEPLOYED_SHA`: The git SHA of the last deployed commit
+* `DIFF_LINK`: URL to the diff on GitHub.
 * All the content of the `secrets.yml` `env` key
 * All the content of the `shipit.yml` `machine.environment` key
 

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

@@ -54,7 +54,7 @@
   }
 }
 
-.task-output-container {
+.task-output-container.task-output-container-main-page {
   height: calc(100vh - 9rem - 4rem - 1px); // .header and .deploy-banner. -1px is to floor the result
 }
 

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

@@ -0,0 +1,38 @@
+module Shipit
+  module Authentication
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :force_github_authentication
+      helper_method :current_user
+    end
+
+    module ClassMethods
+      def skip_authentication(*args)
+        skip_before_action(:force_github_authentication, *args)
+      end
+    end
+
+    private
+
+    def force_github_authentication
+      if current_user.logged_in?
+        unless current_user.authorized?
+          team_handles = Shipit.github_teams.map(&:handle)
+          team_list = team_handles.to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')
+          render plain: "You must be a member of #{team_list} to access this application.", status: :forbidden
+        end
+      else
+        redirect_to Shipit::Engine.routes.url_helpers.github_authentication_path(origin: request.original_url)
+      end
+    end
+
+    def current_user
+      @current_user ||= find_current_user || AnonymousUser.new
+    end
+
+    def find_current_user
+      session[:user_id].present? && User.find_by_id(session[:user_id])
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Shipit
+  module Api
+    class CommitsController < BaseController
+      require_permission :read, :stack
+
+      def index
+        render_resources stack.commits.reachable.includes(:statuses)
+      end
+    end
+  end
+end

data/app/controllers/shipit/deploys_controller.rb

@@ -3,7 +3,7 @@ module Shipit
     include ChunksHelper
 
     before_action :load_stack
-    before_action :load_deploy, only: %i(show rollback)
+    before_action :load_deploy, only: %i(show rollback revert)
     before_action :load_until_commit, only: :create
 
     def new
@@ -30,6 +30,11 @@ module Shipit
       @rollback = @deploy.build_rollback
     end
 
+    def revert
+      previous_deploy = @stack.deploys.success.where(until_commit_id: @deploy.since_commit_id).order(id: :desc).first!
+      redirect_to rollback_stack_deploy_path(@stack, previous_deploy)
+    end
+
     private
 
     def load_deploy

data/app/controllers/shipit/shipit_controller.rb

@@ -11,12 +11,9 @@ module Shipit
     helper Shipit::Engine.routes.url_helpers
     include Shipit::Engine.routes.url_helpers
 
-    before_action(
-      :toogle_bootstrap_feature,
-      :ensure_required_settings,
-      :force_github_authentication,
-      :set_variant,
-    )
+    before_action :toogle_bootstrap_feature, :ensure_required_settings
+
+    include Shipit::Authentication
 
     # Respond to HTML by default
     respond_to :html
@@ -36,35 +33,5 @@ module Shipit
 
       render 'shipit/missing_settings'
     end
-
-    def force_github_authentication
-      if current_user.logged_in?
-        teams = Shipit.github_teams
-        unless teams.empty? || current_user.teams.where(id: teams).exists?
-          team_list = teams.map(&:handle).to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')
-          render plain: "You must be a member of #{team_list} to access this application.", status: :forbidden
-        end
-      else
-        redirect_to Shipit::Engine.routes.url_helpers.github_authentication_path(origin: request.original_url)
-      end
-    end
-
-    def current_user
-      @current_user ||= find_current_user || AnonymousUser.new
-    end
-    helper_method :current_user
-
-    def find_current_user
-      return unless session[:user_id].present?
-      User.find(session[:user_id])
-    rescue ActiveRecord::RecordNotFound
-    end
-
-    def set_variant
-      return unless request.negotiate_mime('text/partial+html')
-
-      request.format = :html
-      request.variant = :partial
-    end
   end
 end

data/app/helpers/shipit/github_url_helper.rb

@@ -18,10 +18,12 @@ module Shipit
     def github_commit_range_url(stack, since_commit, until_commit)
       github_repo_url(stack.repo_owner, stack.repo_name, 'compare', "#{since_commit.sha}...#{until_commit.sha}")
     end
+    module_function :github_commit_range_url
 
     def github_user_url(user, *args)
       [Shipit.github_url, user, *args].join('/')
     end
+    module_function :github_user_url
 
     def render_github_user(user)
       link_to(github_user_url(user.login), class: 'user main-user') do
@@ -32,6 +34,7 @@ module Shipit
     def github_repo_url(owner, repo, *args)
       github_user_url(owner, repo, *args)
     end
+    module_function :github_repo_url
 
     def github_commit_url(commit)
       github_repo_url(commit.stack.repo_owner, commit.stack.repo_name, 'commit', commit.sha)

data/app/models/shipit/anonymous_user.rb

@@ -23,6 +23,10 @@ module Shipit
       false
     end
 
+    def authorized?
+      false
+    end
+
     def stacks_contributed_to
       []
     end

data/app/models/shipit/github_status.rb

@@ -9,6 +9,7 @@ module Shipit
 
       def refresh_status
         Rails.cache.write(CACHE_KEY, Shipit.github_api.github_status)
+      rescue Net::OpenTimeout, Octokit::ServerError
       end
     end
   end

data/app/models/shipit/user.rb

@@ -61,6 +61,10 @@ module Shipit
       true
     end
 
+    def authorized?
+      @authorized ||= Shipit.github_teams.empty? || teams.where(id: Shipit.github_teams.map(&:id)).exists?
+    end
+
     def stacks_contributed_to
       return [] unless id
       Commit.where('author_id = :id or committer_id = :id', id: id).distinct.pluck(:stack_id)

data/app/serializers/shipit/commit_serializer.rb

@@ -6,7 +6,15 @@ module Shipit
     has_one :author
     has_one :committer
 
-    attributes :additions, :deletions, :authored_at, :committed_at, :html_url, :pull_request
+    attributes :additions, :deletions, :authored_at, :committed_at, :html_url, :pull_request, :status, :deployed
+
+    def deployed
+      object.deployed?
+    end
+
+    def status
+      object.significant_status.state
+    end
 
     def html_url
       github_commit_url(object)

data/app/serializers/shipit/deploy_serializer.rb

@@ -4,7 +4,7 @@ module Shipit
 
     has_many :commits
 
-    attributes :compare_url, :additions, :deletions
+    attributes :compare_url, :rollback_url, :additions, :deletions
 
     def html_url
       stack_deploy_url(object.stack, object)
@@ -14,6 +14,10 @@ module Shipit
       github_commit_range_url(object.stack, object.since_commit, object.until_commit)
     end
 
+    def rollback_url
+      revert_stack_deploy_url(object.stack, object)
+    end
+
     def type
       :deploy
     end

data/app/serializers/shipit/rollback_serializer.rb

@@ -3,5 +3,9 @@ module Shipit
     def type
       :rollback
     end
+
+    def include_rollback_url?
+      false
+    end
   end
 end

data/app/serializers/shipit/task_serializer.rb

@@ -18,6 +18,7 @@ module Shipit
       ended_at
       updated_at
       created_at
+      env
     ))
 
     def revision

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

@@ -32,8 +32,10 @@
       <div class="banner__inner wrapper">
         <div class="banner__content">
           <h2 class="banner__title">GitHub is having issues</h2>
-            "<i><%= github_status[:body] %></i>"
-            <% unless github_status[:last_updated].nil? %>
+            <% if github_status[:body].present? %>
+              "<i><%= github_status[:body] %></i>"
+            <% end %>
+            <% if github_status[:last_updated].present? %>
               <%= time_ago_in_words(github_status[:last_updated]) %> ago
             <% end %>
         </div>

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

@@ -42,7 +42,7 @@
     <input type="search" class="search-input" />
   </div>
 
-  <div class="clusterize-scroll task-output-container">
+  <div class="clusterize-scroll task-output-container task-output-container-main-page">
     <pre class="nowrap" data-status="<%= task.status %>"><code class="clusterize-content" data-output="<%= task.chunk_output %>" data-next-chunks-url="<%= next_chunks_url(task) %>"></code></pre>
   </div>
 </div>

data/config/routes.rb

@@ -35,6 +35,7 @@ Shipit::Engine.routes.draw do
         resource :output, only: :show
       end
       resources :deploys, only: %i(create)
+      resources :commits, only: %i(index)
       post '/task/:task_name' => 'tasks#trigger', as: :trigger_task
       resources :hooks, only: %i(index create show update destroy)
     end
@@ -83,6 +84,7 @@ Shipit::Engine.routes.draw do
       get ':sha', sha: sha_format, on: :new, action: :new, as: ''
       member do
         get :rollback
+        get :revert
       end
     end
   end

data/lib/shipit/deploy_commands.rb

@@ -9,11 +9,16 @@ module Shipit
       super.merge(
         'SHA' => commit.sha,
         'REVISION' => commit.sha,
+        'DIFF_LINK' => diff_url,
       )
     end
 
     protected
 
+    def diff_url
+      Shipit::GithubUrlHelper.github_commit_range_url(@stack, *@task.commit_range)
+    end
+
     def permalink
       Shipit::Engine.routes.url_helpers.stack_deploy_url(@stack, @task)
     end

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.12.1'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/test/controllers/api/commits_controller_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+module Shipit
+  module Api
+    class CommitsControllerTest < ActionController::TestCase
+      setup do
+        @stack = shipit_stacks(:shipit)
+        authenticate!
+      end
+
+      test "#index returns a list of commits" do
+        commit = @stack.commits.last
+
+        get :index, params: {stack_id: @stack.to_param}
+        assert_response :ok
+        assert_json '0.sha', commit.sha
+      end
+    end
+  end
+end

data/test/controllers/deploys_controller_test.rb

@@ -99,5 +99,10 @@ module Shipit
       end
       assert_select '#new_rollback #force', 1
     end
+
+    test ":revert redirect to the proper rollback page" do
+      get :revert, params: {stack_id: @stack.to_param, id: shipit_deploys(:shipit2).id}
+      assert_redirected_to rollback_stack_deploy_path(@stack, shipit_deploys(:shipit))
+    end
   end
 end

data/test/models/users_test.rb

@@ -123,6 +123,25 @@ module Shipit
       assert_equal 't0k3n', legacy.github_access_token
     end
 
+    test "users are always logged_in?" do
+      assert_predicate @user, :logged_in?
+    end
+
+    test "users are always authorized? if Shipit.github_teams is empty" do
+      Shipit.stubs(:github_teams).returns([])
+      assert_predicate @user, :authorized?
+    end
+
+    test "users are not authorized? if they aren't part of any Shipit.github_teams" do
+      Shipit.stubs(:github_teams).returns([shipit_teams(:cyclimse_cooks)])
+      refute_predicate @user, :authorized?
+    end
+
+    test "users are authorized? if they are part of any Shipit.github_teams" do
+      Shipit.stubs(:github_teams).returns([shipit_teams(:shopify_developers)])
+      assert_predicate @user, :authorized?
+    end
+
     private
 
     def fetch_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipit-engine
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -282,28 +282,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.3
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.3
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -565,8 +565,10 @@ files:
 - app/controllers/concerns/shipit/api/cacheable.rb
 - app/controllers/concerns/shipit/api/paginable.rb
 - app/controllers/concerns/shipit/api/rendering.rb
+- app/controllers/concerns/shipit/authentication.rb
 - app/controllers/concerns/shipit/pagination.rb
 - app/controllers/shipit/api/base_controller.rb
+- app/controllers/shipit/api/commits_controller.rb
 - app/controllers/shipit/api/deploys_controller.rb
 - app/controllers/shipit/api/hooks_controller.rb
 - app/controllers/shipit/api/locks_controller.rb
@@ -745,6 +747,7 @@ files:
 - lib/tasks/teams.rake
 - lib/tasks/webhook.rake
 - test/controllers/api/base_controller_test.rb
+- test/controllers/api/commits_controller_test.rb
 - test/controllers/api/deploys_controller_test.rb
 - test/controllers/api/hooks_controller_test.rb
 - test/controllers/api/locks_controller_test.rb
@@ -912,6 +915,7 @@ specification_version: 4
 summary: Application deployment software
 test_files:
 - test/controllers/api/base_controller_test.rb
+- test/controllers/api/commits_controller_test.rb
 - test/controllers/api/deploys_controller_test.rb
 - test/controllers/api/hooks_controller_test.rb
 - test/controllers/api/locks_controller_test.rb