shipit-engine 0.31.0 → 0.32.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,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -247,6 +248,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!
@@ -301,6 +304,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
@@ -429,6 +446,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
@@ -865,9 +896,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 +907,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
@@ -50,22 +51,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("stack.lock_author.anonymous", true, document: serialized)
     end
   end
 end

data/test/models/membership_test.rb

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

data/test/models/output_chunk_test.rb

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

data/test/models/pull_request_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -271,7 +272,7 @@ module Shipit
           behind_by: 10,
         ),
       )
-      spec = {'merge' => {'max_divergence' => {'commits' => 1}}}
+      spec = { 'merge' => { 'max_divergence' => { 'commits' => 1 } } }
       @pr.stack.cached_deploy_spec = DeploySpec.new(spec)
       assert_predicate @pr, :stale?
     end
@@ -279,14 +280,14 @@ module Shipit
     test "#stale? returns true when the branch falls behind the maximum age" do
       @pr.base_commit = shipit_commits(:second)
       @pr.head.committed_at = 2.hours.ago
-      spec = {'merge' => {'max_divergence' => {'age' => '1h'}}}
+      spec = { 'merge' => { 'max_divergence' => { 'age' => '1h' } } }
       @pr.stack.cached_deploy_spec = DeploySpec.new(spec)
       assert_predicate @pr, :stale?
     end
 
     test "#stale? is false when base_commit information is missing" do
       @pr.base_commit = nil
-      spec = {'merge' => {'max_divergence' => {'age' => '1h', 'commits' => 10}}}
+      spec = { 'merge' => { 'max_divergence' => { 'age' => '1h', 'commits' => 10 } } }
       @pr.stack.cached_deploy_spec = DeploySpec.new(spec)
       refute_predicate @pr, :stale?
     end

data/test/models/release_statuses_test.rb

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

data/test/models/rollbacks_test.rb

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

data/test/models/shipit/check_run_test.rb

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

data/test/models/shipit/repository_test.rb

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

data/test/models/shipit/wehbooks/handlers_test.rb

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

data/test/models/stacks_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'securerandom'
 
@@ -70,11 +71,11 @@ module Shipit
 
       last_commit = shipit_commits(:third)
       deploy = @stack.trigger_deploy(last_commit, AnonymousUser.new)
-      assert_includes FakeReceiver.hooks, [
+      assert_includes(FakeReceiver.hooks, [
         :deploy,
         @stack,
-        {deploy: deploy, status: "pending", stack: @stack},
-      ]
+        { deploy: deploy, status: "pending", stack: @stack },
+      ])
     ensure
       Shipit.internal_hook_receivers = original_receivers
     end
@@ -306,7 +307,7 @@ module Shipit
     end
 
     test "#monitoring returns deploy_spec's content" do
-      assert_equal [{'image' => 'https://example.com/monitor.png', 'width' => 200, 'height' => 300}], @stack.monitoring
+      assert_equal [{ 'image' => 'https://example.com/monitor.png', 'width' => 200, 'height' => 300 }], @stack.monitoring
     end
 
     test "#destroy deletes the related commits" do
@@ -338,7 +339,7 @@ module Shipit
         time = Time.current
         @stack.update(lock_reason: "Just for fun", lock_author: shipit_users(:walrus))
         travel 1.day
-        expect_hook(:lock, @stack, locked: false, lock_details: {from: time, until: Time.current}, stack: @stack) do
+        expect_hook(:lock, @stack, locked: false, lock_details: { from: time, until: Time.current }, stack: @stack) do
           @stack.update(lock_reason: nil)
         end
       end
@@ -389,7 +390,7 @@ module Shipit
 
     test "updating the stack emit a hook" do
       expect_hook(:stack, @stack, action: :updated, stack: @stack) do
-        @stack.update(repo_name: 'foo')
+        @stack.update(environment: 'foo')
       end
     end
 
@@ -483,7 +484,9 @@ module Shipit
 
       assert_no_enqueued_jobs do
         assert_no_difference -> { Deploy.count } do
-          @stack.trigger_continuous_delivery
+          value = @stack.trigger_continuous_delivery
+
+          assert_nil value
         end
       end
     end
@@ -551,7 +554,24 @@ module Shipit
       end
     end
 
+    test "#trigger_continuous_delivery bails out if no DeploySpec has been cached" do
+      @stack = shipit_stacks(:check_deploy_spec)
+      deploy_spec = @stack.cached_deploy_spec
+
+      assert_predicate @stack, :deployable?
+      refute_predicate @stack, :deployed_too_recently?
+      assert(deploy_spec.blank?, "DeploySpec blank? returned false")
+
+      assert_no_enqueued_jobs(only: Shipit::PerformTaskJob) do
+        assert_no_difference -> { Deploy.count } do
+          @stack.trigger_continuous_delivery
+        end
+      end
+    end
+
     test "#trigger_continuous_delivery enqueues deployment ref update job" do
+      Shipit.stubs(:update_latest_deployed_ref).returns(true)
+
       @stack = shipit_stacks(:shipit_canaries)
       shipit_tasks(:canaries_running).delete
 
@@ -567,6 +587,8 @@ module Shipit
     end
 
     test "#trigger_continuous_delivery executes ref update job with correct sha" do
+      Shipit.stubs(:update_latest_deployed_ref).returns(true)
+
       @stack = shipit_stacks(:shipit_canaries)
       shipit_tasks(:canaries_running).delete
 
@@ -598,7 +620,7 @@ module Shipit
       @stack.tasks.delete_all
 
       deploy = @stack.trigger_continuous_delivery
-      assert_equal({'SAFETY_DISABLED' => '0'}, deploy.env)
+      assert_equal({ 'SAFETY_DISABLED' => '0' }, deploy.env)
     end
 
     test "#continuous_delivery_delayed! bumps updated_at" do

data/test/models/status/group_test.rb

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

data/test/models/status/missing_test.rb

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

data/test/models/status_test.rb

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

data/test/models/task_definitions_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -11,10 +12,10 @@ module Shipit
         'steps' => ['touch tmp/restart'],
         'allow_concurrency' => true,
         'variables' => [
-          {'name' => 'FOO', 'title' => 'Set to 0 to foo', 'default' => '1'},
-          {'name' => 'BAR', 'title' => 'Set to 1 to bar', 'default' => '0'},
-          {'name' => 'WALRUS', 'title' => 'Use with caution', 'default' => ' '},
-          {'name' => 'NODEFAULT', 'title' => 'Variable without default'},
+          { 'name' => 'FOO', 'title' => 'Set to 0 to foo', 'default' => '1' },
+          { 'name' => 'BAR', 'title' => 'Set to 1 to bar', 'default' => '0' },
+          { 'name' => 'WALRUS', 'title' => 'Use with caution', 'default' => ' ' },
+          { 'name' => 'NODEFAULT', 'title' => 'Variable without default' },
         ],
       )
     end
@@ -43,10 +44,10 @@ module Shipit
         checklist: [],
         allow_concurrency: true,
         variables: [
-          {'name' => 'FOO', 'title' => 'Set to 0 to foo', 'default' => '1', 'select' => nil},
-          {'name' => 'BAR', 'title' => 'Set to 1 to bar', 'default' => '0', 'select' => nil},
-          {'name' => 'WALRUS', 'title' => 'Use with caution', 'default' => ' ', 'select' => nil},
-          {'name' => 'NODEFAULT', 'title' => 'Variable without default', 'default' => '', 'select' => nil},
+          { 'name' => 'FOO', 'title' => 'Set to 0 to foo', 'default' => '1', 'select' => nil },
+          { 'name' => 'BAR', 'title' => 'Set to 1 to bar', 'default' => '0', 'select' => nil },
+          { 'name' => 'WALRUS', 'title' => 'Use with caution', 'default' => ' ', 'select' => nil },
+          { 'name' => 'NODEFAULT', 'title' => 'Variable without default', 'default' => '', 'select' => nil },
         ],
       }
       assert_equal as_json, TaskDefinition.load(TaskDefinition.dump(@definition)).as_json

data/test/models/tasks_test.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
   class TasksTest < ActiveSupport::TestCase
     test "#title interpolates env" do
       task = shipit_tasks(:shipit_rendered_failover)
-      assert_equal({'POD_ID' => '12'}, task.env)
+      assert_equal({ 'POD_ID' => '12' }, task.env)
       assert_equal 'Failover pod 12', task.title
     end
 
@@ -30,5 +31,21 @@ module Shipit
 
       task.write("hello\nworld")
     end
+
+    test "#chunk_output truncates output exceeding the storage limit" do
+      task = shipit_tasks(:shipit)
+      task.chunks.delete_all
+      # Dont persist the chunk to the DB, as it may exceed the MySQL max packet size on CI
+      task.chunks.build(text: 'a' * (Task::OUTPUT_SIZE_LIMIT * 1.1))
+
+      output = task.chunk_output
+
+      assert output.size <= Task::OUTPUT_SIZE_LIMIT, "Output was not truncated to the limit"
+      # We don't use assert_includes because it will print the whole message
+      assert(
+        output.include?(Task::OUTPUT_TRUNCATED_MESSAGE),
+        "'#{Task::OUTPUT_TRUNCATED_MESSAGE.chomp}' was not present in the output",
+      )
+    end
   end
 end

data/test/models/team_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -11,16 +12,17 @@ module Shipit
     end
 
     test ".find_or_create_by_handle fetch the team from github if it's not in the db already" do
-      Shipit.github.api.expects(:org_teams).with('shopify', per_page: 100)
       response = stub(rels: {}, data: [new_team])
+      Shipit.github.api.expects(:org_teams).with('shopify', per_page: 100).returns(response.data)
       Shipit.github.api.expects(:last_response).returns(response)
+
       assert_difference -> { Team.count }, 1 do
         Team.find_or_create_by_handle('Shopify/new-team')
       end
     end
 
     test "#refresh_members! fetch all the team members from github" do
-      response = stub(rels: {members: members_resource})
+      response = stub(rels: { members: members_resource })
       Shipit.github.api.expects(:get).with(@team.api_url).returns(response)
       assert_difference -> { User.count }, 1 do
         @team.refresh_members!

data/test/models/undeployed_commits_test.rb

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

data/test/models/users_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -91,8 +92,8 @@ module Shipit
 
       stub_request(:get, @emails_url).to_return(
         status: %w(200 OK),
-        body: [{email: expected_email}].to_json,
-        headers: {"Content-Type" => "application/json"},
+        body: [{ email: expected_email }].to_json,
+        headers: { "Content-Type" => "application/json" },
       )
 
       user = User.find_or_create_from_github(@github_user)
@@ -119,7 +120,7 @@ module Shipit
       stub_request(:get, @emails_url).to_return(
         status: %w(200 OK),
         body: result_email_records.to_json,
-        headers: {"Content-Type" => "application/json"},
+        headers: { "Content-Type" => "application/json" },
       )
 
       user = User.find_or_create_from_github(@github_user)
@@ -141,7 +142,7 @@ module Shipit
       stub_request(:get, @emails_url).to_return(
         status: %w(200 OK),
         body: result_email_records.to_json,
-        headers: {"Content-Type" => "application/json"},
+        headers: { "Content-Type" => "application/json" },
       )
 
       user = User.find_or_create_from_github(@github_user)
@@ -162,9 +163,16 @@ module Shipit
       assert_nil user.email
     end
 
+    test "find_or_create_from_github handles user 401" do
+      Shipit.preferred_org_emails = [@org_domain]
+      Octokit::Client.any_instance.expects(:emails).raises(Octokit::Unauthorized)
+      user = User.find_or_create_from_github(@minimal_github_user)
+      assert_nil user.email
+    end
+
     test "#identifiers_for_ping returns a hash with the user's github_id, name, email and github_login" do
       user = shipit_users(:bob)
-      expected_ouput = {github_id: user.github_id, name: user.name, email: user.email, github_login: user.login}
+      expected_ouput = { github_id: user.github_id, name: user.name, email: user.email, github_login: user.login }
       assert_equal expected_ouput, user.identifiers_for_ping
     end