shipit-engine 0.31.0 → 0.35.0

data/test/jobs/{merge_pull_requests_job_test.rb → process_merge_requests_job_test.rb}

@@ -1,22 +1,23 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
-  class MergePullRequestsJobTest < ActiveSupport::TestCase
+  class ProcessMergeRequestsJobTest < ActiveSupport::TestCase
     setup do
       @stack = shipit_stacks(:shipit)
-      @job = MergePullRequestsJob.new
+      @job = ProcessMergeRequestsJob.new
 
-      @pending_pr = shipit_pull_requests(:shipit_pending)
-      @unmergeable_pr = shipit_pull_requests(:shipit_pending_unmergeable)
-      @not_ready_pr = shipit_pull_requests(:shipit_pending_not_mergeable_yet)
-      @closed_pr = shipit_pull_requests(:shipit_pending_closed)
-      @merged_pr = shipit_pull_requests(:shipit_pending_merged)
-      @expired_pr = shipit_pull_requests(:shipit_pending_expired)
-      @mergable_pending_ci = shipit_pull_requests(:shipit_mergeable_pending_ci)
+      @pending_pr = shipit_merge_requests(:shipit_pending)
+      @unmergeable_pr = shipit_merge_requests(:shipit_pending_unmergeable)
+      @not_ready_pr = shipit_merge_requests(:shipit_pending_not_mergeable_yet)
+      @closed_pr = shipit_merge_requests(:shipit_pending_closed)
+      @merged_pr = shipit_merge_requests(:shipit_pending_merged)
+      @expired_pr = shipit_merge_requests(:shipit_pending_expired)
+      @mergable_pending_ci = shipit_merge_requests(:shipit_mergeable_pending_ci)
     end
 
     test "#perform rejects unmergeable PRs and merge the others" do
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       stub_request(:put, "#{@pending_pr.api_url}/merge").to_return(status: %w(200 OK), body: {
         sha: "6dcb09b5b57875f334f61aebed695e2e4193db5e",
         merged: true,
@@ -34,7 +35,7 @@ module Shipit
     end
 
     test "#perform rejects PRs if the merge attempt fails" do
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       stub_request(:put, "#{@pending_pr.api_url}/merge").to_return(status: %w(405 Method not allowed), body: {
         message: "Pull Request is not mergeable",
         documentation_url: "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button",
@@ -46,24 +47,24 @@ module Shipit
     end
 
     test "#perform rejects PRs but do not attempt to merge any if the stack doesn't allow merges" do
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       @stack.update!(lock_reason: 'Maintenance')
       @job.perform(@stack)
       assert_predicate @pending_pr.reload, :pending?
     end
 
     test "#perform revalidate PRs but do not attempt to merge any if the stack doesn't allow merges" do
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       @stack.update!(lock_reason: 'Maintenance')
       @job.perform(@stack)
       assert_predicate @expired_pr.reload, :revalidating?
     end
 
     test "#perform schedules a new job if the first PR in the queue is not mergeable yet" do
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
 
       @pending_pr.update!(mergeable: nil)
-      assert_enqueued_with(job: MergePullRequestsJob) do
+      assert_enqueued_with(job: ProcessMergeRequestsJob) do
         @job.perform(@stack)
       end
       assert_predicate @pending_pr.reload, :pending?
@@ -71,21 +72,21 @@ module Shipit
 
     test "#perform cancels merge requests for closed PRs" do
       @pending_pr.cancel!
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       @job.perform(@stack)
       assert_predicate @closed_pr.reload, :canceled?
     end
 
     test "#perform cancels merge requests for manually merged PRs" do
       @pending_pr.cancel!
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       @job.perform(@stack)
       assert_predicate @merged_pr.reload, :canceled?
     end
 
     test "#perform does not reject pull requests with pending statuses" do
       @pending_pr.cancel!
-      PullRequest.any_instance.stubs(:refresh!)
+      MergeRequest.any_instance.stubs(:refresh!)
       @job.perform(@stack)
       refute_predicate @mergable_pending_ci.reload, :rejected?
       refute_predicate @mergable_pending_ci.reload, :merged?

data/test/jobs/purge_old_deliveries_job_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/jobs/reap_dead_tasks_job_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class ReapDeadTasksJobTest < ActiveSupport::TestCase
+    setup do
+      Task.where(status: Task::ACTIVE_STATUSES).update_all(status: 'success')
+
+      not_recently = Shipit::Task.recently_created_at - 1.minute
+      @deploy = shipit_deploys(:shipit)
+      @deploy.status = 'success'
+      @deploy.created_at = not_recently
+      @deploy.save!
+
+      @rollback = @deploy.build_rollback
+      @rollback.status = 'running'
+      @rollback.created_at = not_recently
+      @rollback.save!
+
+      @zombie_deploy = shipit_deploys(:shipit2)
+      @zombie_deploy.status = 'running'
+      @zombie_deploy.created_at = not_recently
+      @zombie_deploy.save!
+    end
+
+    test 'reaps only zombie tasks' do
+      refute_predicate @zombie_deploy, :error?
+
+      Shipit::Deploy.any_instance.expects(:alive?).returns(false)
+      Shipit::Rollback.any_instance.expects(:alive?).returns(true)
+      ReapDeadTasksJob.perform_now
+
+      @zombie_deploy.reload
+      assert_predicate @zombie_deploy, :error?
+
+      @deploy.reload
+      assert_predicate @deploy, :finished?
+
+      @rollback.reload
+      assert_predicate @rollback, :running?
+    end
+
+    test "does reap recently created tasks" do
+      Task.where(status: Task::ACTIVE_STATUSES).update_all(status: 'success')
+      recently = Time.current
+      @deploy = shipit_deploys(:shipit)
+      @deploy.created_at = recently
+      @deploy.status = 'running'
+      @deploy.save!
+      Shipit::Deploy.any_instance.expects(:alive?).never
+
+      ReapDeadTasksJob.perform_now
+
+      @deploy.reload
+      assert_predicate @deploy, :running?
+    end
+
+    test 'reaps zombie aborting tasks' do
+      deploy = shipit_deploys(:shipit2)
+      deploy.status = 'aborting'
+      deploy.save!
+
+      ReapDeadTasksJob.perform_now
+
+      assert_predicate deploy.reload, :error?
+    end
+  end
+end

data/test/jobs/refresh_github_user_job_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/jobs/refresh_status_job_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/jobs/unique_job_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/jobs/update_github_last_deployed_ref_job_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/lib/shipit/deploy_commands_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class DeployCommandsTest < ActiveSupport::TestCase
+  test "#env includes the stack's pull request labels" do
+    stack = shipit_stacks(:review_stack)
+    deploy = stack.trigger_continuous_delivery
+    stack.pull_request.labels = ["wip", "bug"]
+
+    env = Shipit::DeployCommands.new(deploy).env
+
+    assert_equal env["WIP"], "true"
+    assert_equal env["BUG"], "true"
+  end
+end

data/test/lib/shipit/task_commands_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TaskCommandsTest < ActiveSupport::TestCase
+  test "#env includes a ReviewStack's pull request labels" do
+    stack = shipit_stacks(:review_stack)
+    stack.pull_request.labels = ["wip", "bug"]
+    task = shipit_tasks(:shipit_restart)
+    task.stack = stack
+
+    env = Shipit::TaskCommands.new(task).env
+
+    assert_equal env["WIP"], "true"
+    assert_equal env["BUG"], "true"
+  end
+end

data/test/middleware/same_site_cookie_middleware_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class SameSiteCookieMiddlewareTest < ActiveSupport::TestCase
+    def app
+      Rack::Lint.new(lambda { |_env|
+        response = Rack::Response.new("", 200, "Content-Type" => "text/yaml")
+
+        response.set_cookie("session_test", value: "session_test", domain: ".test.com", path: "/")
+        response.set_cookie("another_cookie", value: "123abc", domain: ".test.com", path: "/")
+        response.finish
+      })
+    end
+
+    def env_for_url(url)
+      env = Rack::MockRequest.env_for(url)
+      env
+    end
+
+    def middleware
+      Shipit::SameSiteCookieMiddleware.new(app)
+    end
+
+    test 'SameSite cookie attributes should be added on SSL' do
+      env = env_for_url("https://test.com/")
+
+      _status, headers, _body = middleware.call(env)
+
+      assert_includes headers['Set-Cookie'], 'SameSite'
+    end
+
+    test 'SameSite cookie attributes should be added when multiple cookies are present' do
+      env = env_for_url("https://test.com/")
+
+      _status, headers, _body = middleware.call(env)
+
+      session_cookie, other_cookie = headers['Set-Cookie'].split("\n")
+
+      assert_includes session_cookie, 'SameSite'
+      assert_includes other_cookie, 'SameSite'
+    end
+
+    test 'SameSite cookie attributes should not be added on non SSL requests' do
+      env = env_for_url("http://test.com/")
+
+      _status, headers, _body = middleware.call(env)
+
+      assert_not_includes headers['Set-Cookie'], 'SameSite'
+    end
+  end
+end

data/test/models/api_client_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit

data/test/models/commit_checks_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'tmpdir'
 

data/test/models/commit_deployment_status_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -11,7 +12,7 @@ module Shipit
 
     test 'creation on GitHub' do
       response = stub(id: 44, url: 'https://example.com')
-      @author.github_api.expects(:create_deployment_status).with(
+      @author.github_api.class.any_instance.expects(:create_deployment_status).with(
         @deployment.api_url,
         'in_progress',
         accept: "application/vnd.github.flash-preview+json",
@@ -32,7 +33,7 @@ module Shipit
       status = deployment.statuses.create!(status: 'success')
       status.stubs(:description).returns('desc' * limit)
       create_status_response = stub(id: 'abcd', url: 'https://github.com/status/abcd')
-      status.author.github_api.expects(:create_deployment_status).with do |*_args, **kwargs|
+      status.author.github_api.class.any_instance.expects(:create_deployment_status).with do |_url, _status, kwargs|
         kwargs[:description].size <= limit
       end.returns(create_status_response)
 
@@ -46,7 +47,7 @@ module Shipit
       stack = status.stack
       stack.deploy_url = "stack-deploy-url"
       create_status_response = stub(id: 'abcd', url: 'https://github.com/status/abcd')
-      status.author.github_api.expects(:create_deployment_status).with do |*_args, **kwargs|
+      status.author.github_api.class.any_instance.expects(:create_deployment_status).with do |_url, _status, kwargs|
         kwargs[:environment_url] == 'stack-deploy-url'
       end.returns(create_status_response)
 

data/test/models/commit_deployment_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -24,7 +25,7 @@ module Shipit
             from_sha: 'f890fd8b5f2be05d1fedb763a3605ee461c39074',
             to_sha: '467578b362bf2b4df5903e1c7960929361c3435a',
           },
-        },
+        }.to_json,
       ).returns(deployment_response)
 
       @deployment.create_on_github!

data/test/models/commits_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -12,7 +13,7 @@ module Shipit
       stub_request(:get, "https://api.github.com/user/emails").to_return(
         status: %w(200 OK),
         body: {}.to_json,
-        headers: {"Content-Type" => "application/json"},
+        headers: { "Content-Type" => "application/json" },
       )
     end
 
@@ -68,6 +69,39 @@ module Shipit
       refute_predicate commit, :revert?
     end
 
+    test '.create_from_github truncates long messages' do
+      message = 'ABCDEFGHIJ' * 7000
+
+      assert_difference -> { Commit.count }, +1 do
+        @stack.commits.create_from_github!(
+          resource(
+            sha: '2adaad1ad30c235d3a6e7981dfc1742f7ecb1e85',
+            author: {},
+            committer: {},
+            commit: {
+              author: {
+                name: 'Lando Walrussian',
+                email: 'walrus@shopify.com',
+                date: Time.now,
+              },
+              committer: {
+                name: 'Lando Walrussian',
+                email: 'walrus@shopify.com',
+                date: Time.now,
+              },
+              message: message,
+            },
+          ),
+        )
+      end
+
+      max_message_size = Shipit::Commit.columns_hash["message"].limit
+      commit = Commit.last
+
+      refute_predicate commit.message, :blank?
+      assert(commit.message.length <= Shipit::Commit.columns_hash["message"].limit) if max_message_size
+    end
+
     test '.create_from_github handle PRs merged by another Shipit stacks' do
       assert_difference -> { Commit.count }, +1 do
         @stack.commits.create_from_github!(
@@ -96,12 +130,53 @@ module Shipit
       assert_equal shipit_users(:walrus), commit.author
     end
 
+    test '.create_from_github stores pull_request_head_sha' do
+      assert_difference -> { Commit.count }, +1 do
+        @stack.commits.create_from_github!(
+          resource(
+            sha: '2adaad1ad30c235d3a6e7981dfc1742f7ecb1e85',
+            author: {},
+            committer: {},
+            commit: {
+              author: {
+                name: 'Shipit',
+                email: '',
+                date: Time.now,
+              },
+              committer: {
+                name: 'Shipit',
+                email: '',
+                date: Time.now,
+              },
+              message: "Merge pull request #62 from shipit-engine/yoloshipit\n\nyoloshipit!",
+            },
+            parents: [
+              { sha: "1864542e3d2f8a41916a2dec0f2b4d3c1bf4899b", url: '', html_url: '' },
+              { sha: "63d7e03e517fd2ae1caeb1b7a9f21767f84d671a", url: '', html_url: '' },
+            ],
+          ),
+        )
+      end
+
+      commit = Commit.last
+      assert_equal '63d7e03e517fd2ae1caeb1b7a9f21767f84d671a', commit.pull_request_head_sha
+    end
+
     test "#message= truncates the message" do
       skip unless Shipit::Commit.columns_hash['message'].limit
       limit = Shipit::Commit.columns_hash['message'].limit
 
       @commit.update!(message: 'a' * limit * 2)
-      assert_equal limit, @commit.message.size
+      assert_equal limit, @commit.message.bytesize
+    end
+
+    test "#message= truncates multibyte messages" do
+      skip unless Shipit::Commit.columns_hash['message'].limit
+      limit = Shipit::Commit.columns_hash['message'].limit
+
+      @commit.update!(message: '国' * limit)
+      assert_operator @commit.message.length, :<=, limit
+      assert_operator @commit.message.bytesize, :<=, limit
     end
 
     test "#pull_request? detect pull request based on message format" do
@@ -275,6 +350,8 @@ module Shipit
         output: mock(
           title: 'Tests build ran successfully',
         ),
+        completed_at: Time.now,
+        started_at: Time.now - 1.minute,
       )
       response = mock(
         check_runs: [check_run],
@@ -395,10 +472,10 @@ module Shipit
       commit = shipit_commits(:second)
       assert_predicate commit.status, :group?
       assert_equal 3, commit.status.size
-      commit.stack.update!(cached_deploy_spec: DeploySpec.new('ci' => {'hide' => [
+      commit.stack.update!(cached_deploy_spec: DeploySpec.new('ci' => { 'hide' => [
         'Travis CI',
         'metrics/coveralls',
-      ]}))
+      ] }))
       commit.reload
       refute_predicate commit.status, :group?
     end
@@ -528,7 +605,7 @@ module Shipit
       'error' => %w(success),
     }
     expected_webhook_transitions.each do |initial_state, firing_states|
-      initial_status_attributes = {state: initial_state, description: 'abc', context: 'ci/travis'}
+      initial_status_attributes = { state: initial_state, description: 'abc', context: 'ci/travis' }
       (expected_webhook_transitions.keys - %w(unknown)).each do |new_state|
         should_fire = firing_states.include?(new_state)
         action = should_fire ? 'fires' : 'does not fire'
@@ -547,7 +624,7 @@ module Shipit
           end
           assert_equal initial_state, commit.state
 
-          expected_status_attributes = {state: new_state, description: initial_state, context: 'ci/travis'}
+          expected_status_attributes = { state: new_state, description: initial_state, context: 'ci/travis' }
           add_status = lambda do
             attrs = expected_status_attributes.merge(created_at: 1.day.ago.to_s(:db))
             commit.create_status_from_github!(OpenStruct.new(attrs))
@@ -612,7 +689,7 @@ module Shipit
       end
     end
 
-    test "#add_status schedule a MergePullRequests job if the commit transition to `pending` or `success`" do
+    test "#add_status schedule a MergeMergeRequests job if the commit transition to `pending` or `success`" do
       commit = shipit_commits(:second)
       github_status = OpenStruct.new(
         state: 'success',
@@ -622,7 +699,7 @@ module Shipit
       )
 
       assert_equal 'failure', commit.state
-      assert_enqueued_with(job: MergePullRequestsJob, args: [@commit.stack]) do
+      assert_enqueued_with(job: ProcessMergeRequestsJob, args: [@commit.stack]) do
         commit.create_status_from_github!(github_status)
         assert_equal 'success', commit.state
       end
@@ -663,12 +740,12 @@ module Shipit
         sha: '5590fd8b5f2be05d1fedb763a3605ee461c39074',
         message: "Merge pull request #62 from shipit-engine/yoloshipit\n\nyoloshipit!",
       )
-      pull_request = shipit_pull_requests(:shipit_pending)
+      merge_request = shipit_merge_requests(:shipit_pending)
 
       assert_predicate commit, :pull_request?
       assert_equal 62, commit.pull_request_number
-      assert_equal pull_request.title, commit.pull_request_title
-      assert_equal pull_request, commit.pull_request
+      assert_equal merge_request.title, commit.pull_request_title
+      assert_equal merge_request, commit.merge_request
     end
 
     test "merge commits infer pull request number and title from the message if it's not a known pull request" do
@@ -684,7 +761,7 @@ module Shipit
       assert_predicate commit, :pull_request?
       assert_equal 99, commit.pull_request_number
       assert_equal 'yoloshipit!', commit.pull_request_title
-      assert_nil commit.pull_request
+      assert_nil commit.merge_request
     end
 
     test "the merge requester if known overrides the commit author" do
@@ -713,7 +790,7 @@ module Shipit
       refute_predicate commit, :pull_request?
       assert_nil commit.pull_request_number
       assert_nil commit.pull_request_title
-      assert_nil commit.pull_request
+      assert_nil commit.merge_request
     end
 
     test "#revert? returns false if the message doesn't follow the revert convention" do
@@ -772,12 +849,12 @@ module Shipit
     test "when merged via the queue, deploy_requested_at is merge_requested_at" do
       commit = shipit_commits(:cyclimse_merged)
       assert_predicate commit, :pull_request?
-      assert_equal commit.pull_request, shipit_pull_requests(:cyclimse_pending_merged)
-      assert_equal commit.deploy_requested_at, commit.pull_request.merge_requested_at
+      assert_equal commit.merge_request, shipit_merge_requests(:cyclimse_pending_merged)
+      assert_equal commit.deploy_requested_at, commit.merge_request.merge_requested_at
     end
 
     test "when merged manually after being queued, deploy_requested_at is created_at" do
-      pr = shipit_pull_requests(:cyclimse_pending_merged)
+      pr = shipit_merge_requests(:cyclimse_pending_merged)
       pr.cancel!
       commit = shipit_commits(:cyclimse_merged)
       assert_equal commit.deploy_requested_at, commit.created_at
@@ -804,9 +881,9 @@ module Shipit
 
     def expect_hook_emit(commit, event, status_attributes, &block)
       matches = lambda do |payload|
-        assert_equal commit, payload[:commit]
-        assert_equal commit.stack, payload[:stack]
-        assert_equal status_attributes[:state], payload[:status]
+        assert_equal(commit, payload[:commit])
+        assert_equal(commit.stack, payload[:stack])
+        assert_equal(status_attributes[:state], payload[:status])
       end
       expect_hook(event, commit.stack, matches, &block)
     end