shipit-engine 0.31.0 → 0.35.0

data/test/models/deploy_stats_test.rb

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

data/test/models/deploys_test.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
   class DeploysTest < ActiveSupport::TestCase
     def setup
       @deploy = shipit_deploys(:shipit)
+      @deploy.write("dummy output")
       @deploy.pid = 42
       @stack = shipit_stacks(:shipit)
       @user = shipit_users(:walrus)
@@ -59,6 +61,146 @@ module Shipit
       assert_equal [], @deploy.commits
     end
 
+    test "deploys retry up to limit upon timeout when configured" do
+      runnable_deploy = shipit_deploys(:shipit_pending)
+      deploy_stack = runnable_deploy.stack
+
+      Shipit::Deploy.any_instance.expects(:acquire_git_cache_lock).twice
+        .raises(Shipit::Command::TimedOut, 'Deploy timed out')
+        .then.raises(Shipit::Command::Error, "Second command error failure")
+
+      perform_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        runnable_deploy.enqueue
+      end
+      assert_performed_jobs 2
+
+      runnable_deploy.reload
+      assert_equal 'timedout', runnable_deploy.status
+
+      retried_deploy = deploy_stack.deploys.last
+      assert_not_equal runnable_deploy.id, retried_deploy.id
+      assert_equal runnable_deploy.since_commit, retried_deploy.since_commit
+      assert_equal runnable_deploy.until_commit, retried_deploy.until_commit
+      assert_equal 'failed', retried_deploy.status
+      assert_equal 1, retried_deploy.retry_attempt
+    end
+
+    test "deploys retry up to limit upon failure when configured" do
+      runnable_deploy = shipit_deploys(:shipit_pending)
+      deploy_stack = runnable_deploy.stack
+
+      Shipit::Deploy.any_instance.expects(:acquire_git_cache_lock).twice
+        .raises(Shipit::Command::Error, 'Deploy failed')
+        .then.raises(Shipit::Command::Error, "Second deploy failed")
+
+      perform_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        runnable_deploy.enqueue
+      end
+      assert_performed_jobs 2
+
+      runnable_deploy.reload
+      assert_equal 'failed', runnable_deploy.status
+
+      retried_deploy = deploy_stack.deploys.last
+      assert_not_equal runnable_deploy.id, retried_deploy.id
+      assert_equal runnable_deploy.since_commit, retried_deploy.since_commit
+      assert_equal runnable_deploy.until_commit, retried_deploy.until_commit
+      assert_equal 'failed', retried_deploy.status
+      assert_equal 1, retried_deploy.retry_attempt
+    end
+
+    test "deploys retry up to limit upon error when configured" do
+      runnable_deploy = shipit_deploys(:shipit_pending)
+      deploy_stack = runnable_deploy.stack
+
+      Shipit::Deploy.any_instance.expects(:acquire_git_cache_lock).twice
+        .raises(StandardError, 'Deploy failed')
+        .then.raises(StandardError, "Second deploy failed")
+
+      perform_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        runnable_deploy.enqueue
+      end
+      assert_performed_jobs 2
+
+      runnable_deploy.reload
+      assert_equal 'error', runnable_deploy.status
+
+      retried_deploy = deploy_stack.deploys.last
+      assert_not_equal runnable_deploy.id, retried_deploy.id
+      assert_equal runnable_deploy.since_commit, retried_deploy.since_commit
+      assert_equal runnable_deploy.until_commit, retried_deploy.until_commit
+      assert_equal 'error', retried_deploy.status
+      assert_equal 1, retried_deploy.retry_attempt
+    end
+
+    test "deploys do not retry upon timeout when not configured" do
+      runnable_deploy = shipit_deploys(:shipit_pending)
+      runnable_deploy.update!(retry_attempt: 0, max_retries: 0)
+
+      Shipit::Deploy.any_instance.expects(:acquire_git_cache_lock)
+        .raises(Shipit::Command::TimedOut, 'Deploy timed out')
+
+      perform_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        runnable_deploy.enqueue
+      end
+      assert_performed_jobs 1
+
+      runnable_deploy.reload
+
+      assert_equal 'timedout', runnable_deploy.status
+    end
+
+    test "rollbacks retry on timeouts if configured" do
+      deploy = shipit_deploys(:shipit)
+      deploy_stack = deploy.stack
+
+      DeploySpec.any_instance.expects(:retries_on_rollback).returns(1)
+
+      Shipit::Command.any_instance.expects(:run).twice
+        .raises(Shipit::Command::TimedOut, 'Rollback timed out')
+        .then.raises(Shipit::Command::Error, "Second command error failure")
+
+      first_rollback = nil
+
+      perform_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        first_rollback = deploy.trigger_rollback(@user, force: true)
+      end
+      assert_performed_jobs 2
+
+      first_rollback.reload
+
+      assert_equal 'timedout', first_rollback.status
+      retried_rollback = deploy_stack.deploys_and_rollbacks.last
+
+      assert_not_equal first_rollback.id, retried_rollback.id
+      assert_equal first_rollback.since_commit, retried_rollback.since_commit
+      assert_equal first_rollback.until_commit, retried_rollback.until_commit
+      assert_equal 'failed', retried_rollback.status
+      assert_equal 1, retried_rollback.max_retries
+    end
+
+    test "rollbacks do not retry if not configured" do
+      deploy_stack = @deploy.stack
+
+      DeploySpec.any_instance.expects(:retries_on_rollback).returns(0)
+
+      Shipit::Command.any_instance.expects(:run).once
+        .raises(Shipit::Command::TimedOut, 'Rollback timed out')
+        .then.raises(Shipit::Command::Error, "Second command error failure")
+
+      first_rollback = nil
+
+      perform_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        first_rollback = @deploy.trigger_rollback(@user, force: true)
+      end
+      assert_performed_jobs 1
+
+      first_rollback.reload
+
+      assert_equal 'timedout', first_rollback.status
+      assert_equal first_rollback, deploy_stack.deploys_and_rollbacks.last
+    end
+
     test "additions and deletions are denormalized on before create" do
       stack = shipit_stacks(:shipit)
       first = shipit_commits(:first)
@@ -199,7 +341,7 @@ module Shipit
         since_commit: shipit.commits.first,
         until_commit: shipit.commits.last,
       )
-      deploy.stubs(:pull_request_head_for_commit).returns(nil)
+      deploy.stubs(:merge_request_head_for_commit).returns(nil)
 
       expect_event(deploy)
       deploy.save!
@@ -247,6 +389,8 @@ module Shipit
     end
 
     test "transitioning to success enqueues a last-deployed git reference update" do
+      Shipit.stubs(:update_latest_deployed_ref).returns(true)
+
       @deploy = shipit_deploys(:shipit_running)
       assert_enqueued_with(job: UpdateGithubLastDeployedRefJob, args: [@deploy.stack]) do
         @deploy.complete!
@@ -260,9 +404,9 @@ module Shipit
       assert_in_delta @deploy.ended_at, @stack.last_deployed_at, 2
     end
 
-    test "transitioning to success schedule a MergePullRequests job" do
+    test "transitioning to success schedule a MergeMergeRequests job" do
       @deploy = shipit_deploys(:shipit_running)
-      assert_enqueued_with(job: MergePullRequestsJob, args: [@deploy.stack]) do
+      assert_enqueued_with(job: ProcessMergeRequestsJob, args: [@deploy.stack]) do
         @deploy.complete!
       end
     end
@@ -301,6 +445,20 @@ module Shipit
       end
     end
 
+    test "transitioning to aborted schedule a rollback to the designated deploy if set" do
+      @rollback_to = shipit_deploys(:shipit_pending)
+      @deploy = shipit_deploys(:shipit_running)
+      @deploy.ping
+      @deploy.pid = 42
+      @deploy.abort!(rollback_once_aborted: true, rollback_once_aborted_to: @rollback_to, aborted_by: @user)
+
+      assert_difference -> { @stack.rollbacks.count }, 1 do
+        assert_enqueued_with(job: PerformTaskJob) do
+          @deploy.aborted!
+        end
+      end
+    end
+
     test "#build_rollback returns an unsaved record" do
       assert @deploy.build_rollback.new_record?
     end
@@ -376,7 +534,7 @@ module Shipit
     # Check that the next item in the series is 1 greater than the last.
     def assert_generated_record_ids_are_sequential(record_id_series)
       record_id_series[0..-2].each_with_index do |id_element, index|
-        assert_equal id_element + 1, record_id_series[index + 1]
+        assert_equal(id_element + 1, record_id_series[index + 1])
       end
     end
 
@@ -429,6 +587,20 @@ module Shipit
       assert_equal "Shipit::Rollback", last_deploy.type
     end
 
+    test "#trigger_revert uses rollback_to if set" do
+      test_stack = create_test_stack
+      test_stack.save
+      test_stack.reload
+
+      running_deploy = shipit_deploys(:shipit_running)
+      rollback_to = shipit_deploys(:shipit_pending)
+
+      final_rollback = running_deploy.trigger_revert(rollback_to: rollback_to)
+
+      assert_equal "Shipit::Rollback", final_rollback.type
+      assert_equal 4, final_rollback.until_commit_id
+    end
+
     test "#trigger_revert skips unsuccessful deploys when reverting" do
       user_id = @user.id
       test_stack = create_test_stack
@@ -630,6 +802,12 @@ module Shipit
       assert_equal @user, @stack.lock_author
     end
 
+    test "#trigger_rollback does not lock the stack if not requested" do
+      refute @stack.locked?
+      @deploy.trigger_rollback(@user, lock: false)
+      refute @stack.reload.locked?
+    end
+
     test "#trigger_rollback marks the rollback as `ignored_safeties` if the force option was used" do
       rollback = @deploy.trigger_rollback(@user, force: true)
       assert_predicate rollback, :ignored_safeties?
@@ -668,20 +846,13 @@ module Shipit
       assert_predicate @deploy, :error?
     end
 
-    test "destroy deletes the related output chunks" do
-      assert_difference -> { @deploy.chunks.count }, -@deploy.chunks.count do
-        @deploy.destroy
-      end
-    end
-
-    test "#chunk_output joins all chunk test if logs not rolled up" do
-      assert_equal @deploy.chunks.count, @deploy.chunks.count
-      assert_equal @deploy.chunks.pluck(:text).join, @deploy.chunk_output
+    test "#chunk_output fetches from Redis if logs not rolled up" do
+      assert_equal Shipit.redis.get(@deploy.send(:output_key)), @deploy.chunk_output
       refute @deploy.rolled_up
     end
 
     test "#chunk_output returns logs from records if rolled up" do
-      expected_output = @deploy.chunks.pluck(:text).join
+      expected_output = Shipit.redis.get(@deploy.send(:output_key))
       @deploy.rollup_chunks
 
       assert_no_queries do
@@ -802,6 +973,18 @@ module Shipit
       end
     end
 
+    test "succeeding a deploy sets the release status as pending and does not schedule job if the status delay is negative (-1)" do
+      @deploy = shipit_deploys(:canaries_running)
+      @deploy.stack.expects(:release_status_delay).at_least_once.returns(Duration.parse(-1))
+
+      assert_difference -> { ReleaseStatus.count }, +1 do
+        assert_not_equal 'success', @deploy.last_release_status.state
+        @deploy.report_complete!
+        assert_equal 'validating', @deploy.status
+        assert_equal 'pending', @deploy.last_release_status.state
+      end
+    end
+
     test "triggering a rollback via abort! sets the release status as failure" do
       @deploy = shipit_deploys(:canaries_running)
       @deploy.ping
@@ -847,6 +1030,28 @@ module Shipit
       end
     end
 
+    test "manually triggered rollbacks sets rollbacked deploys as faulty and not the rollback task" do
+      @deploy = shipit_deploys(:canaries_validating)
+      @middle_deploy = shipit_deploys(:canaries_faulty)
+      @rollback_to_deploy = shipit_deploys(:canaries_success)
+
+      @rollback_task = @rollback_to_deploy.trigger_rollback(force: true)
+
+      @rollback_task.run!
+      @rollback_task.complete!
+      @rollback_task.reload
+      @deploy.reload
+      @middle_deploy.reload
+
+      assert_equal 'faulty', @deploy.status
+      assert_equal 'failure', @deploy.last_release_status.state
+
+      assert_equal 'faulty', @middle_deploy.status
+      assert_equal 'failure', @middle_deploy.last_release_status.state
+
+      assert_equal 'success', @rollback_task.status
+    end
+
     test "succeeding a deploy creates CommitDeploymentStatuses" do
       @deploy = shipit_deploys(:shipit_running)
       refute_empty @deploy.commit_deployments
@@ -865,9 +1070,6 @@ module Shipit
         until_commit: template_task.until_commit,
       )
 
-      pull_request_response = stub(head: stub(sha: '6dcb09b5b57875f334f61aebed695e2e4193db5e'))
-      Shipit.github.api.expects(:pull_request).with('shopify/shipit-engine', 7).returns(pull_request_response)
-
       expected_delta = deploy.commits.select(&:pull_request?).size + 1
       assert_difference -> { CommitDeployment.count }, expected_delta do
         assert_difference -> { CommitDeploymentStatus.count }, expected_delta do
@@ -879,25 +1081,6 @@ module Shipit
       refute_nil CommitDeployment.find_by(sha: deploy.until_commit.sha)
     end
 
-    test "#create_commit_deployments handles API errors when loading pull request details" do
-      template_task = shipit_tasks(:shipit_pending)
-      deploy = template_task.stack.deploys.build(
-        since_commit: template_task.since_commit,
-        until_commit: template_task.until_commit,
-      )
-
-      Shipit.github.api.expects(:pull_request).with('shopify/shipit-engine', 7).raises(Octokit::NotFound)
-
-      expected_delta = 1 # Only the batch head
-      assert_difference -> { CommitDeployment.count }, expected_delta do
-        assert_difference -> { CommitDeploymentStatus.count }, expected_delta do
-          deploy.save!
-        end
-      end
-
-      refute_nil CommitDeployment.find_by(sha: deploy.until_commit.sha)
-    end
-
     private
 
     def expect_event(deploy)

data/test/models/duration_test.rb

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

data/test/models/github_hook_test.rb

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

data/test/models/hook_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -35,6 +36,35 @@ module Shipit
       end
     end
 
+    test ".deliver! sends request with correct method, headers, and body" do
+      stub_request(:post, @hook.delivery_url).to_return(body: 'OK')
+      body = { 'foo' => 42 }
+      expected_body = JSON.pretty_generate(body)
+      expected_signature = Hook::DeliverySigner.new(@hook.secret).sign(expected_body)
+
+      perform_enqueued_jobs(only: DeliverHookJob) do
+        @hook.deliver!(:deploy, body)
+      end
+      assert_performed_jobs 1
+      assert_requested :post, @hook.delivery_url do |req|
+        req.headers['X-Shipit-Signature'] == expected_signature
+      end
+    end
+
+    test ".deliver! sends without signature if no secret is configured" do
+      stub_request(:post, @hook.delivery_url).to_return(body: 'OK')
+      @hook.update!(secret: '')
+      body = { 'foo' => 42 }
+
+      perform_enqueued_jobs(only: DeliverHookJob) do
+        @hook.deliver!(:deploy, body)
+      end
+      assert_performed_jobs 1
+      assert_requested :post, @hook.delivery_url do |req|
+        !req.headers.key?('X-Shipit-Signature')
+      end
+    end
+
     test ".scoped? returns true if the hook has a stack_id" do
       @hook.stack_id = nil
       refute @hook.scoped?
@@ -50,22 +80,29 @@ module Shipit
     end
 
     test ".emit calls #deliver on internal hooks" do
-        original_receivers = Shipit.internal_hook_receivers
-        FakeReceiver = Module.new
-        FakeReceiver.expects(:deliver).with(:deploy, @stack, 'foo' => 42)
+      original_receivers = Shipit.internal_hook_receivers
+      FakeReceiver = Module.new
+      FakeReceiver.expects(:deliver).with(:deploy, @stack, 'foo' => 42)
 
-        Shipit.internal_hook_receivers << FakeReceiver
-        Hook.emit(:deploy, @stack, 'foo' => 42)
+      Shipit.internal_hook_receivers << FakeReceiver
+      Hook.emit(:deploy, @stack, 'foo' => 42)
     ensure
-        Shipit.internal_hook_receivers = original_receivers
+      Shipit.internal_hook_receivers = original_receivers
     end
 
     test ".emit calls no internal hooks if there are no internal_hook_receivers" do
-        original_receivers = Shipit.internal_hook_receivers
-        Shipit.internal_hook_receivers = nil
-        Hook.emit(:deploy, @stack, 'foo' => 42)
+      original_receivers = Shipit.internal_hook_receivers
+      Shipit.internal_hook_receivers = nil
+      Hook.emit(:deploy, @stack, 'foo' => 42)
     ensure
-        Shipit.internal_hook_receivers = original_receivers
+      Shipit.internal_hook_receivers = original_receivers
+    end
+
+    test ".coerce_payload coerces anonymous user correctly" do
+      locked_stack = Stack.first
+      locked_stack.lock("Some Reason", nil)
+      serialized = Hook.coerce_payload(stack: locked_stack)
+      assert_json_document(serialized, "stack.lock_author.anonymous", true)
     end
   end
 end