shipit-engine 0.25.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fc984a73561067126bdfb062310f453acadeda6
-  data.tar.gz: 45bd1783e2aff0f6a17179181070372d9f69737c
+  metadata.gz: 84e2ecaebc907d7522d77553a552bafefa65cc7f
+  data.tar.gz: 59cd29bbf69566d7a0c2fa82ed3ad0f0086d307b
 SHA512:
-  metadata.gz: 8a6acb0b4acab4a16a5b143c944f90e8dc628c4464a490ed1b316dce08a91e7d265b99482e3697cb677f420b1ef11d91c89e634c476e116b51760a9fc7fa0734
-  data.tar.gz: db7fcd010f4e2c1403c17b318e4dd241c3a40973842bc614d7141f3f6236dacae155753264c9ff6a43d6b344378c67615ee3775132423d86467850180ebb8309
+  metadata.gz: fa96c8e445ac42b2b3138d6fbc00b3f61a290f06d491547ee6e1a83c09bf5f322a716af4539cf138bbc586d31e19944fc43438338722fc144ec0ce4113c11ae3
+  data.tar.gz: dab317ea37e1211b7cc765a2e30521bc7ca2054880f3df11402570d86fcc0326baf1e832e7182d647dc9c2f7f56f52f85ddc1e1b317546170862e077b4ae0eaa

data/app/controllers/shipit/merge_status_controller.rb

@@ -60,7 +60,7 @@ module Shipit
       @stack ||= if params[:stack_id]
         Stack.from_param!(params[:stack_id])
       else
-        scope = Stack.order(id: :asc).where(
+        scope = Stack.order(merge_queue_enabled: :desc, id: :asc).where(
           repo_owner: referrer_parser.repo_owner,
           repo_name: referrer_parser.repo_name,
         )

data/app/controllers/shipit/stacks_controller.rb

@@ -17,7 +17,7 @@ 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) }
+      @commits = @stack.undeployed_commits { |scope| scope.preload(:author, :statuses, :check_runs) }
     end
 
     def lookup
@@ -43,6 +43,7 @@ module Shipit
 
     def refresh
       RefreshStatusesJob.perform_later(stack_id: @stack.id)
+      RefreshCheckRunsJob.perform_later(stack_id: @stack.id)
       GithubSyncJob.perform_later(stack_id: @stack.id)
       flash[:success] = 'Refresh scheduled'
       redirect_to request.referer.presence || stack_path(@stack)

data/app/controllers/shipit/webhooks_controller.rb

@@ -70,6 +70,20 @@ module Shipit
       end
     end
 
+    class CheckSuiteHandler < Handler
+      params do
+        requires :check_suite do
+          requires :head_sha, String
+          requires :head_branch, String
+        end
+      end
+      def process
+        stacks.where(branch: params.check_suite.head_branch).each do |stack|
+          stack.commits.where(sha: params.check_suite.head_sha).each(&:schedule_refresh_check_runs!)
+        end
+      end
+    end
+
     class MembershipHandler < Handler
       params do
         requires :action, String
@@ -114,6 +128,7 @@ module Shipit
       'push' => PushHandler,
       'status' => StatusHandler,
       'membership' => MembershipHandler,
+      'check_suite' => CheckSuiteHandler,
     }.freeze
 
     def create

data/app/jobs/shipit/cache_deploy_spec_job.rb

@@ -1,6 +1,7 @@
 module Shipit
   class CacheDeploySpecJob < BackgroundJob
     include BackgroundJob::Unique
+    on_duplicate :drop
 
     queue_as :deploys
 

data/app/jobs/shipit/perform_task_job.rb

@@ -60,8 +60,10 @@ module Shipit
     end
 
     def checkout_repository
-      @task.acquire_git_cache_lock do
-        capture! @commands.fetch
+      unless @commands.fetched?(@task.until_commit).tap(&:run).success?
+        @task.acquire_git_cache_lock do
+          capture! @commands.fetch
+        end
       end
       capture_all! @commands.clone
       capture! @commands.checkout(@task.until_commit)

data/app/jobs/shipit/refresh_check_runs_job.rb

@@ -0,0 +1,14 @@
+module Shipit
+  class RefreshCheckRunsJob < BackgroundJob
+    queue_as :default
+
+    def perform(params)
+      if params[:commit_id]
+        Commit.find(params[:commit_id]).refresh_check_runs!
+      else
+        stack = Stack.find(params[:stack_id])
+        stack.commits.order(id: :desc).limit(30).each(&:refresh_check_runs!)
+      end
+    end
+  end
+end

data/app/models/shipit/check_run.rb

@@ -0,0 +1,71 @@
+module Shipit
+  class CheckRun < ApplicationRecord
+    CONCLUSIONS = %w(success failure neutral cancelled timed_out action_required).freeze
+    include DeferredTouch
+    include Status::Common
+
+    belongs_to :stack, required: true
+    belongs_to :commit, required: true
+
+    deferred_touch commit: :updated_at
+
+    validates :conclusion, inclusion: {in: CONCLUSIONS, allow_nil: true}
+
+    class << self
+      def create_or_update_by!(selector:, attributes: {})
+        create!(selector.merge(attributes))
+      rescue ActiveRecord::RecordNotUnique
+        record = find_by!(selector)
+        record.update!(attributes)
+        record
+      end
+
+      def create_or_update_from_github!(stack_id, github_check_run)
+        create_or_update_by!(
+          selector: {
+            github_id: github_check_run.id,
+          },
+          attributes: {
+            stack_id: stack_id,
+            name: github_check_run.name,
+            conclusion: github_check_run.conclusion,
+            title: github_check_run.output.title.to_s.truncate(1_000),
+            details_url: github_check_run.details_url,
+            html_url: github_check_run.html_url,
+          },
+        )
+      end
+    end
+
+    def state
+      case conclusion
+      when nil, 'action_required'
+        'pending'
+      when 'success', 'neutral'
+        'success'
+      when 'failure', 'cancelled'
+        'failure'
+      when 'timed_out'
+        'error'
+      else
+        'unknown'
+      end
+    end
+
+    def context
+      name
+    end
+
+    def target_url
+      html_url
+    end
+
+    def description
+      title
+    end
+
+    def to_partial_path
+      'shipit/statuses/status'
+    end
+  end
+end

data/app/models/shipit/commit.rb

@@ -7,6 +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 :commit_deployments, dependent: :destroy
     has_many :release_statuses, dependent: :destroy
     belongs_to :pull_request, inverse_of: :merge_commit, optional: true
@@ -17,7 +18,8 @@ module Shipit
     after_commit { broadcast_update }
     after_create { stack.update_undeployed_commits_count }
 
-    after_commit :schedule_refresh_statuses!, :schedule_fetch_stats!, :schedule_continuous_delivery, on: :create
+    after_commit :schedule_refresh_statuses!, :schedule_refresh_check_runs!, :schedule_fetch_stats!,
+                 :schedule_continuous_delivery, on: :create
 
     belongs_to :author, class_name: 'User', inverse_of: :authored_commits
     belongs_to :committer, class_name: 'User', inverse_of: :commits
@@ -101,10 +103,18 @@ module Shipit
       record
     end
 
+    def statuses_and_check_runs
+      statuses + check_runs
+    end
+
     def schedule_refresh_statuses!
       RefreshStatusesJob.perform_later(commit_id: id)
     end
 
+    def schedule_refresh_check_runs!
+      RefreshCheckRunsJob.perform_later(commit_id: id)
+    end
+
     def refresh_statuses!
       github_statuses = stack.handle_github_redirections { Shipit.github.api.statuses(github_repo_name, sha) }
       github_statuses.each do |status|
@@ -118,6 +128,19 @@ module Shipit
       end
     end
 
+    def refresh_check_runs!
+      response = stack.handle_github_redirections do
+        Shipit.github.api.check_runs(github_repo_name, sha)
+      end
+      response.check_runs.each do |check_run|
+        create_or_update_check_run_from_github!(check_run)
+      end
+    end
+
+    def create_or_update_check_run_from_github!(github_check_run)
+      check_runs.create_or_update_from_github!(stack_id, github_check_run)
+    end
+
     def last_release_status
       @last_release_status ||= release_statuses.last || Status::Unknown.new(self)
     end
@@ -216,7 +239,7 @@ module Shipit
     end
 
     def status
-      @status ||= Status::Group.compact(self, statuses)
+      @status ||= Status::Group.compact(self, statuses_and_check_runs)
     end
 
     def deployed?

data/app/models/shipit/deploy_spec.rb

@@ -235,7 +235,7 @@ module Shipit
     end
 
     def discover_task_definitions
-      {}
+      config('tasks') || {}
     end
 
     def discover_dependencies_steps

data/app/models/shipit/pull_request.rb

@@ -185,11 +185,11 @@ module Shipit
 
     def all_status_checks_passed?
       return false unless head
-      StatusChecker.new(head, head.statuses, stack.cached_deploy_spec).success?
+      StatusChecker.new(head, head.statuses_and_check_runs, stack.cached_deploy_spec).success?
     end
 
     def any_status_checks_failed?
-      status = StatusChecker.new(head, head.statuses, stack.cached_deploy_spec)
+      status = StatusChecker.new(head, head.statuses_and_check_runs, stack.cached_deploy_spec)
       status.failure? || status.error? || status.missing?
     end
 

data/app/models/shipit/status.rb

@@ -9,7 +9,7 @@ module Shipit
     belongs_to :stack, required: true
     belongs_to :commit, required: true
 
-    deferred_touch stack: :updated_at, commit: :updated_at
+    deferred_touch commit: :updated_at
 
     validates :state, inclusion: {in: STATES, allow_blank: true}, presence: true
 

data/app/views/shipit/commits/_commit.html.erb

@@ -9,7 +9,7 @@
       <span class="commit-title"><%= render_commit_message_with_link commit %></span>
       <p class="commit-meta">
         <span class="sha"><%= render_commit_id_link(commit) %></span>
-        <% if commit.additions? && commit.deletions? %>
+        <% if commit.additions.present? && commit.deletions.present? %>
           <span class="code-additions">+<%= commit.additions %></span>
           <span class="code-deletions">-<%= commit.deletions %></span>
         <% end %>

data/db/migrate/20181010150947_create_shipit_check_runs.rb

@@ -0,0 +1,17 @@
+class CreateShipitCheckRuns < ActiveRecord::Migration[5.1]
+  def change
+    create_table :check_runs do |t|
+      t.references :stack, foreign_key: false, null: false
+      t.references :commit, foreign_key: false, null: false
+      t.bigint :github_id, null: false
+      t.string :name, null: false
+      t.string :conclusion, limit: 20, null: true
+      t.string :title, limit: 1024
+      t.string :details_url
+      t.string :html_url
+      t.timestamps
+
+      t.index %i(github_id commit_id), unique: true
+    end
+  end
+end

data/lib/shipit.rb

@@ -30,6 +30,7 @@ require 'faraday-http-cache'
 
 require 'shipit/version'
 
+require 'shipit/octokit_check_runs'
 require 'shipit/flock'
 require 'shipit/github_app'
 require 'shipit/paginator'

data/lib/shipit/octokit_check_runs.rb

@@ -0,0 +1,9 @@
+module OctokitCheckRuns
+  def check_runs(repo, sha, options = {})
+    paginate "#{Octokit::Repository.path repo}/commits/#{sha}/check-runs", options.reverse_merge(
+      accept: 'application/vnd.github.antiope-preview+json',
+    )
+  end
+end
+
+Octokit::Client.include(OctokitCheckRuns)

data/lib/shipit/stack_commands.rb

@@ -44,14 +44,19 @@ module Shipit
     def with_temporary_working_directory(commit: nil)
       commit ||= @stack.last_deployed_commit.presence || @stack.commits.last
 
-      @stack.acquire_git_cache_lock do
-        if !commit || !fetched?(commit).tap(&:run).success?
+      if !commit || !fetched?(commit).tap(&:run).success?
+        @stack.acquire_git_cache_lock do
           fetch.run!
         end
       end
 
       Dir.mktmpdir do |dir|
-        git('clone', @stack.git_path, @stack.repo_name, '--origin', 'cache', chdir: dir).run!
+        git(
+          'clone', @stack.git_path, @stack.repo_name,
+          '--origin', 'cache',
+          chdir: dir
+        ).run!
+
         git_dir = File.join(dir, @stack.repo_name)
         git('checkout', commit.sha, chdir: git_dir).run! if commit
         yield Pathname.new(git_dir)

data/lib/shipit/task_commands.rb

@@ -53,11 +53,10 @@ module Shipit
         git(
           'clone',
           '--local',
-          '--origin',
-          'cache',
+          '--origin', 'cache',
           @stack.git_path,
           @task.working_directory,
-          chdir: @stack.deploys_path,
+          chdir: @stack.deploys_path
         ),
         git('remote', 'add', 'origin', @stack.repo_git_url, chdir: @task.working_directory),
       ]

data/lib/shipit/version.rb

@@ -1,3 +1,3 @@
 module Shipit
-  VERSION = '0.25.1'.freeze
+  VERSION = '0.26.0'.freeze
 end

data/test/controllers/merge_status_controller_test.rb

@@ -33,5 +33,20 @@ module Shipit
       assert_response :ok
       assert_predicate response.body, :blank?
     end
+
+    test "GET show prefers stacks with merge_queue_enabled" do
+      existing = shipit_stacks(:shipit)
+      Shipit::Stack.create(
+        repo_owner: existing.repo_owner,
+        repo_name: existing.repo_name,
+        environment: 'foo',
+        branch: existing.branch,
+        merge_queue_enabled: true,
+      )
+      existing.update!(merge_queue_enabled: false)
+      get :show, params: {referrer: 'https://github.com/Shopify/shipit-engine/pull/42', branch: 'master'}
+      assert_response :ok
+      assert_includes response.body, 'shipit-engine/foo'
+    end
   end
 end

data/test/controllers/stacks_controller_test.rb

@@ -51,6 +51,14 @@ module Shipit
       assert_response :ok
     end
 
+    test "#show with a single CheckRun is successful" do
+      @stack = shipit_stacks(:check_runs)
+      assert_not_equal 0, CheckRun.where(stack_id: @stack.id).count
+
+      get :show, params: {id: @stack.to_param}
+      assert_response :ok
+    end
+
     test "#show handles locked stacks without a lock_author" do
       @stack.update!(lock_reason: "I am a lock with no author")
       get :show, params: {id: @stack.to_param}
@@ -120,8 +128,10 @@ module Shipit
       request.env['HTTP_REFERER'] = stack_settings_path(@stack)
 
       assert_enqueued_with(job: RefreshStatusesJob, args: [stack_id: @stack.id]) do
-        assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id]) do
-          post :refresh, params: {id: @stack.to_param}
+        assert_enqueued_with(job: RefreshCheckRunsJob, args: [stack_id: @stack.id]) do
+          assert_enqueued_with(job: GithubSyncJob, args: [stack_id: @stack.id]) do
+            post :refresh, params: {id: @stack.to_param}
+          end
         end
       end
 

data/test/controllers/webhooks_controller_test.rb

@@ -55,6 +55,15 @@ module Shipit
       assert_response :ok
     end
 
+    test ":check_suite with the target branch queues a RefreshCheckRunsJob" do
+      request.headers['X-Github-Event'] = 'check_suite'
+
+      assert_enqueued_with(job: RefreshCheckRunsJob) do
+        post :create, body: payload(:check_suite_master), as: :json
+        assert_response :ok
+      end
+    end
+
     test "returns head :ok if request is ping" do
       @request.headers['X-Github-Event'] = 'ping'
 

data/test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20180906083930) do
+ActiveRecord::Schema.define(version: 20181010150947) do
 
   create_table "api_clients", force: :cascade do |t|
     t.text "permissions", limit: 65535
@@ -22,6 +22,22 @@ ActiveRecord::Schema.define(version: 20180906083930) do
     t.index ["creator_id"], name: "index_api_clients_on_creator_id"
   end
 
+  create_table "check_runs", force: :cascade do |t|
+    t.integer "stack_id", null: false
+    t.integer "commit_id", null: false
+    t.bigint "github_id", null: false
+    t.string "name", null: false
+    t.string "conclusion", limit: 20
+    t.string "title", limit: 1024
+    t.string "details_url"
+    t.string "html_url"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["commit_id"], name: "index_check_runs_on_commit_id"
+    t.index ["github_id", "commit_id"], name: "index_check_runs_on_github_id_and_commit_id", unique: true
+    t.index ["stack_id"], name: "index_check_runs_on_stack_id"
+  end
+
   create_table "commit_deployment_statuses", force: :cascade do |t|
     t.integer "commit_deployment_id"
     t.string "status"