shipit-engine 0.31.0 → 0.35.0

data/test/models/shipit/{wehbooks → webhooks}/handlers_test.rb

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

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,84 @@ module Shipit
 
       task.write("hello\nworld")
     end
+
+    test "#chunk_output truncates output exceeding the storage limit" do
+      task = shipit_tasks(:shipit)
+      Shipit.redis.del(task.send(:output_key))
+
+      task.write('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
+
+    test "#retry_if_necessary creates a duplicated task object with pending status and nil created_at and ended_at" do
+      task = shipit_tasks(:shipit)
+      task_stack = task.stack
+      task.retry_if_necessary
+
+      retried_task = task_stack.deploys.last
+
+      assert_not_equal task.id, retried_task.id
+      assert_nil retried_task.started_at
+      assert_nil retried_task.ended_at
+      assert_equal 'pending', retried_task.status
+    end
+
+    test "#retry_if_necessary does not create a new task object if max_retries is nil" do
+      task = shipit_tasks(:shipit2)
+
+      assert_no_difference 'Task.count', 'No new task should be created' do
+        task.retry_if_necessary
+      end
+    end
+
+    test "#retry_if_necessary does not create a new task object if the stack is locked" do
+      task = shipit_tasks(:shipit2)
+      task.stack.lock("test", task.user)
+
+      assert_no_difference 'Task.count', 'No new task should be created' do
+        task.retry_if_necessary
+      end
+    end
+
+    test "#retries_configured? returns true when max_retries is not nil and is greater than zero" do
+      task_with_three_retries = shipit_tasks(:shipit)
+      assert_predicate task_with_three_retries, :retries_configured?
+
+      task_with_nil_retries = shipit_tasks(:shipit2)
+      refute_predicate task_with_nil_retries, :retries_configured?
+
+      task_with_zero_retries = shipit_tasks(:shipit_restart)
+      refute_predicate task_with_zero_retries, :retries_configured?
+    end
+
+    test ".due_for_rollup includes tasks in successful terminal states" do
+      task = shipit_tasks(:shipit)
+      task.update(
+        rolled_up: false,
+        created_at: (60 + 1).minutes.ago.to_s(:db),
+        status: "success",
+      )
+
+      assert_includes Shipit::Task.due_for_rollup, task
+    end
+
+    test ".due_for_rollup includes tasks in unsuccessful terminal states" do
+      task = shipit_tasks(:shipit)
+      task.update(
+        rolled_up: false,
+        created_at: (60 + 1).minutes.ago.to_s(:db),
+        status: "error",
+      )
+
+      assert_includes Shipit::Task.due_for_rollup, task
+    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
 

data/test/serializers/shipit/pull_request_serializer_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Shipit
+  class PulLRequestSerializerTest < ActiveSupport::TestCase
+    test "structure" do
+      pull_request = shipit_pull_requests(:review_stack_review)
+
+      serialized = serializer.new(pull_request).as_json
+
+      assert_includes serialized.keys, :id
+      assert_includes serialized.keys, :number
+      assert_includes serialized.keys, :title
+      assert_includes serialized.keys, :github_id
+      assert_includes serialized.keys, :additions
+      assert_includes serialized.keys, :deletions
+      assert_includes serialized.keys, :state
+      assert_includes serialized.keys, :html_url
+      assert_includes serialized.keys, :user
+      assert_includes serialized.keys, :assignees
+      assert_includes serialized.keys, :head
+    end
+
+    def serializer
+      Shipit::PullRequestSerializer
+    end
+  end
+end

data/test/test_command_integration.rb

@@ -1,8 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 path = './fixtures/timeout'
 buffer = []
-command = Shipit::Command.new({path => {'timeout' => 2}}, env: {}, chdir: __dir__)
+command = Shipit::Command.new({ path => { 'timeout' => 2 } }, env: {}, chdir: __dir__)
 begin
   command.stream! do |chunk|
     buffer << chunk
@@ -24,5 +25,5 @@ unless buffer.join == expected_output.join
   puts "Got: ------------"
   puts buffer.map(&:inspect).join("\n")
   puts "-----------------"
-  exit 1
+  exit(1)
 end

data/test/test_helper.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
 ENV["RAILS_ENV"] ||= "test"
 
+if Warning.respond_to?(:[]=)
+  Warning[:deprecated] = true
+end
+
 require 'simplecov'
-SimpleCov.start 'rails' do
+SimpleCov.start('rails') do
   enable_coverage :branch
 end
 
@@ -19,7 +24,7 @@ require 'spy/integration'
 # Load fixtures from the engine
 if ActiveSupport::TestCase.respond_to?(:fixture_path=)
   ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-  ActiveSupport::TestCase.fixtures :all
+  ActiveSupport::TestCase.fixtures(:all)
 end
 
 Dir[File.expand_path('../helpers/**/*.rb', __FILE__)].each do |helper|
@@ -31,41 +36,54 @@ begin
 rescue LoadError
 end
 
-class ActiveSupport::TestCase
-  include PayloadsHelper
-  include FixtureAliasesHelper
-  include QueriesHelper
-  include JSONHelper
-  include LinksHelper
-  include ApiHelper
-  include HooksHelper
-  include ActiveJob::TestHelper
-
-  setup do
-    @routes = Shipit::Engine.routes
-    Shipit.github.api.stubs(:login).returns('shipit')
+# FIXME: We need to get rid of active_model_serializers
+# This is a monkey patch for Ruby 2.7+ compatibility
+module ActionController
+  module SerializationAssertions
+    def process(*, **)
+      @serializers = Hash.new(0)
+      super
+    end
   end
+end
 
-  teardown do
-    Shipit.redis.flushdb
-    Shipit.instance_variable_names.each do |name|
-      next if %w(@mocha @redis).include?(name)
-      Shipit.remove_instance_variable(name)
+module ActiveSupport
+  class TestCase
+    include PayloadsHelper
+    include FixtureAliasesHelper
+    include QueriesHelper
+    include JSONHelper
+    include LinksHelper
+    include ApiHelper
+    include HooksHelper
+    include ActiveJob::TestHelper
+
+    setup do
+      @routes = Shipit::Engine.routes
+      Shipit.github.api.stubs(:login).returns('shipit')
     end
-  end
 
-  ActiveRecord::Migration.check_pending!
+    teardown do
+      Shipit.redis.flushdb
+      Shipit.instance_variable_names.each do |name|
+        next if %w(@mocha @redis).include?(name)
+        Shipit.remove_instance_variable(name)
+      end
+    end
 
-  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
-  #
-  # Note: You'll currently still have to declare fixtures explicitly in integration tests
-  # -- they do not yet inherit this setting
-  fixtures :all
+    ActiveRecord::Migration.check_pending!
 
-  # Add more helper methods to be used by all tests here...
-  private
+    # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+    #
+    # Note: You'll currently still have to declare fixtures explicitly in integration tests
+    # -- they do not yet inherit this setting
+    fixtures :all
 
-  def resource(data)
-    Sawyer::Resource.new(Sawyer::Agent.new('http://example.com'), data)
+    # Add more helper methods to be used by all tests here...
+    private
+
+    def resource(data)
+      Sawyer::Resource.new(Sawyer::Agent.new('http://example.com'), data)
+    end
   end
 end

data/test/unit/anonymous_user_serializer_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class AnonymousUserSerializerTest < ActiveSupport::TestCase
+    test 'sets anonymous to true' do
+      user = AnonymousUser.new
+      serializer = ActiveModel::Serializer.serializer_for(user)
+      assert_equal AnonymousUserSerializer, serializer
+      serialized = serializer.new(user).to_json
+      assert_json_document(serialized, "anonymous", true)
+    end
+  end
+end

data/test/unit/command_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -9,32 +10,37 @@ module Shipit
     end
 
     test "#interpolate_environment_variables replace environment variables by their value" do
-      command = Command.new('cap $ENVIRONMENT deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
+      command = Command.new('cap $ENVIRONMENT deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
       assert_equal [%(cap production deploy)], command.interpolated_arguments
     end
 
     test "#interpolate_environment_variables coerce nil to empty string" do
-      command = Command.new('cap $FOO deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
+      command = Command.new('cap $FOO deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
       assert_equal [%(cap '' deploy)], command.interpolated_arguments
     end
 
     test '#interpolate_environment_variables escape the variable contents' do
       malicious_string = '$(echo pwnd)'
-      command = Command.new('echo $FOO', env: {'FOO' => malicious_string}, chdir: '.')
+      command = Command.new('echo $FOO', env: { 'FOO' => malicious_string }, chdir: '.')
       assert_equal malicious_string, command.run.chomp
     end
 
     test "#interpolate_environment_variables fallback to ENV" do
       previous = ENV['SHIPIT_TEST']
       ENV['SHIPIT_TEST'] = 'quux'
-      command = Command.new('cap $SHIPIT_TEST deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
-      assert_equal [%(cap quux deploy)], command.interpolated_arguments
+      command = Command.new('cap $SHIPIT_TEST deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
+      assert_equal([%(cap quux deploy)], command.interpolated_arguments)
     ensure
       ENV['SHIPIT_TEST'] = previous
     end
 
+    test "#env cast to strings except for `nil`" do
+      command = Command.new('echo foo', env: { 'SOME_PATH' => Pathname.new('/foo'), 'HOST' => nil }, chdir: '.')
+      assert_equal({ 'SOME_PATH' => '/foo', 'HOST' => nil }, command.env)
+    end
+
     test "#timeout is 5 minutes by default" do
-      command = Command.new('cap $LANG deploy', env: {'ENVIRONMENT' => 'production'}, chdir: '.')
+      command = Command.new('cap $LANG deploy', env: { 'ENVIRONMENT' => 'production' }, chdir: '.')
       assert_equal 5.minutes.to_i, command.timeout
     end
 
@@ -44,7 +50,7 @@ module Shipit
     end
 
     test "#timeout returns the command option timeout over the `default_timeout` if present" do
-      command = Command.new({'cap $LANG deploy' => {'timeout' => 10}}, default_timeout: 5, env: {}, chdir: '.')
+      command = Command.new({ 'cap $LANG deploy' => { 'timeout' => 10 } }, default_timeout: 5, env: {}, chdir: '.')
       assert_equal 10, command.timeout
     end
 
@@ -58,14 +64,14 @@ module Shipit
     end
 
     test "command not found" do
-      error = assert_raises Command::NotFound do
+      error = assert_raises(Command::NotFound) do
         Command.new('does-not-exist foo bar', env: {}, chdir: '.').run
       end
       assert_equal 'does-not-exist: command not found', error.message
     end
 
     test "permission denied" do
-      error = assert_raises Command::Denied do
+      error = assert_raises(Command::Denied) do
         Command.new('/etc/passwd foo bar', env: {}, chdir: '.').run
       end
       assert_equal '/etc/passwd: Permission denied', error.message
@@ -120,7 +126,7 @@ module Shipit
             signalled = true
             break
           end
-          sleep 0.1
+          sleep(0.1)
         end
         signalled
       end