shipit-engine 0.28.0 → 0.32.0

data/test/models/commit_deployment_test.rb

@@ -1,33 +1,31 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
   class CommitDeploymentTest < ActiveSupport::TestCase
     setup do
       @deployment = shipit_commit_deployments(:shipit_pending_fourth)
-      @commit = @deployment.commit
       @task = @deployment.task
       @stack = @task.stack
       @author = @deployment.author
     end
 
-    test "there can only be one record per deploy and commit pair" do
-      assert_raises ActiveRecord::RecordNotUnique do
-        CommitDeployment.create!(task: @deployment.task, commit: @deployment.commit)
-      end
-    end
-
     test "creation on GitHub" do
-      pull_request_response = stub(head: stub(sha: '6dcb09b5b57875f334f61aebed695e2e4193db5e'))
-      @author.github_api.expects(:pull_request).with('shopify/shipit-engine', 7).returns(pull_request_response)
-
       deployment_response = stub(id: 42, url: 'https://example.com')
       @author.github_api.expects(:create_deployment).with(
         'shopify/shipit-engine',
-        pull_request_response.head.sha,
+        @deployment.sha,
         auto_merge: false,
         required_contexts: [],
         description: "Via Shipit",
         environment: @stack.environment,
+        payload: {
+          shipit: {
+            task_id: 4,
+            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
@@ -8,6 +9,12 @@ module Shipit
       @pr.message = "Merge pull request #31 from Shopify/improve-polling\n\nSeveral improvements to polling"
       @stack.reload
       @commit = shipit_commits(:first)
+
+      stub_request(:get, "https://api.github.com/user/emails").to_return(
+        status: %w(200 OK),
+        body: {}.to_json,
+        headers: { "Content-Type" => "application/json" },
+      )
     end
 
     test '.create_from_github handle unknown users' do
@@ -62,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!(
@@ -90,6 +130,46 @@ 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.bytesize
+    end
+
     test "#pull_request? detect pull request based on message format" do
       assert @pr.pull_request?
       refute @commit.pull_request?
@@ -137,7 +217,7 @@ module Shipit
 
     test "updating broadcasts an update event" do
       expect_event(@stack)
-      @commit.update_attributes(message: "toto")
+      @commit.update(message: "toto")
     end
 
     test "updating state to success triggers new deploy when stack has continuous deployment" do
@@ -184,12 +264,14 @@ module Shipit
         committed_at: Time.now,
       )
 
-      @stack.deploys.create!(
+      deploy = @stack.deploys.build(
         user_id: walrus.id,
         since_commit: @stack.commits.first,
         until_commit: new_commit,
         status: 'success',
       )
+      deploy.stubs(:pull_request_head_for_commit).returns(nil)
+      deploy.save!
 
       assert_no_difference "Deploy.count" do
         @commit.statuses.create!(stack_id: @stack.id, state: 'success')
@@ -242,7 +324,7 @@ module Shipit
         target_url: 'http://example.com',
         created_at: 1.day.ago,
       )
-      Shipit.github.api.expects(:statuses).with(@stack.github_repo_name, @commit.sha).returns([status])
+      Shipit.github.api.expects(:statuses).with(@stack.github_repo_name, @commit.sha, per_page: 100).returns([status])
       assert_difference '@commit.statuses.count', 1 do
         @commit.refresh_statuses!
       end
@@ -379,10 +461,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
@@ -512,7 +594,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'
@@ -531,7 +613,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))
@@ -767,6 +849,16 @@ module Shipit
       assert_equal commit.deploy_requested_at, commit.created_at
     end
 
+    test "#recently_pushed?" do
+      freeze_time do
+        commit = Commit.new(message: "abcd", created_at: Time.now.utc)
+        assert_predicate commit, :recently_pushed?
+
+        commit = Commit.new(message: "abcd", created_at: 10.minutes.ago)
+        refute_predicate commit, :recently_pushed?
+      end
+    end
+
     private
 
     def expect_event(stack)

data/test/models/delivery_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -23,8 +24,8 @@ module Shipit
     end
 
     test "#send! post the payload and update the status to `sent`" do
-      headers = {'content-type' => 'text/plain', 'content-length' => '2'}
-      FakeWeb.register_uri(:post, @delivery.url, headers.merge(body: 'OK'))
+      headers = { 'content-type' => 'text/plain', 'content-length' => '2' }
+      stub_request(:post, @delivery.url).to_return(headers: headers, body: 'OK')
 
       assert_equal 'scheduled', @delivery.status
       @delivery.send!

data/test/models/deploy_spec_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -22,7 +23,7 @@ module Shipit
     end
 
     test '#supports_rollback? returns true if steps are defined' do
-      @spec.stubs(:load_config).returns('rollback' => {'override' => ['rm -rf /usr /lib/nvidia-current/xorg/xorg']})
+      @spec.stubs(:load_config).returns('rollback' => { 'override' => ['rm -rf /usr /lib/nvidia-current/xorg/xorg'] })
       assert @spec.supports_rollback?
     end
 
@@ -32,7 +33,7 @@ module Shipit
     end
 
     test '#dependencies_steps returns `dependencies.override` if present' do
-      @spec.stubs(:load_config).returns('dependencies' => {'override' => %w(foo bar baz)})
+      @spec.stubs(:load_config).returns('dependencies' => { 'override' => %w(foo bar baz) })
       assert_equal %w(foo bar baz), @spec.dependencies_steps
     end
 
@@ -43,7 +44,7 @@ module Shipit
     end
 
     test "#dependencies_steps prepend and append pre and post steps" do
-      @spec.stubs(:load_config).returns('dependencies' => {'pre' => ['before'], 'post' => ['after']})
+      @spec.stubs(:load_config).returns('dependencies' => { 'pre' => ['before'], 'post' => ['after'] })
       @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:bundle_install).returns(['bundle install'])
       assert_equal ['before', 'bundle install', 'after'], @spec.dependencies_steps
@@ -75,7 +76,7 @@ module Shipit
 
     test '#bundle_install use `dependencies.bundler.without` if present to build the --without argument' do
       @spec.stubs(:gemfile_lock_exists?).returns(true)
-      @spec.stubs(:load_config).returns('dependencies' => {'bundler' => {'without' => %w(some custom groups)}})
+      @spec.stubs(:load_config).returns('dependencies' => { 'bundler' => { 'without' => %w(some custom groups) } })
       command = %(
         bundle install
         --frozen
@@ -88,25 +89,25 @@ module Shipit
     end
 
     test '#bundle_install has --frozen option if Gemfile.lock is present' do
-      @spec.stubs(:load_config).returns('dependencies' => {'bundler' => {'without' => %w(some custom groups)}})
+      @spec.stubs(:load_config).returns('dependencies' => { 'bundler' => { 'without' => %w(some custom groups) } })
       @spec.stubs(:gemfile_lock_exists?).returns(true)
       assert @spec.bundle_install.last.include?('--frozen')
     end
 
     test '#bundle_install does not have --frozen option if Gemfile.lock is not present' do
-      @spec.stubs(:load_config).returns('dependencies' => {'bundler' => {'without' => %w(some custom groups)}})
+      @spec.stubs(:load_config).returns('dependencies' => { 'bundler' => { 'without' => %w(some custom groups) } })
       @spec.stubs(:gemfile_lock_exists?).returns(false)
       refute @spec.bundle_install.last.include?('--frozen')
     end
 
     test '#bundle_install does not have --frozen if overridden in shipit.yml' do
-      @spec.stubs(:load_config).returns('dependencies' => {'bundler' => {'frozen' => false}})
+      @spec.stubs(:load_config).returns('dependencies' => { 'bundler' => { 'frozen' => false } })
       @spec.stubs(:gemfile_lock_exists?).returns(true)
       refute @spec.bundle_install.last.include?('--frozen')
     end
 
     test '#deploy_steps returns `deploy.override` if present' do
-      @spec.stubs(:load_config).returns('deploy' => {'override' => %w(foo bar baz)})
+      @spec.stubs(:load_config).returns('deploy' => { 'override' => %w(foo bar baz) })
       assert_equal %w(foo bar baz), @spec.deploy_steps
     end
 
@@ -161,7 +162,7 @@ module Shipit
     end
 
     test "#deploy_steps prepend and append pre and post steps" do
-      @spec.stubs(:load_config).returns('deploy' => {'pre' => ['before'], 'post' => ['after']})
+      @spec.stubs(:load_config).returns('deploy' => { 'pre' => ['before'], 'post' => ['after'] })
       @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:capistrano?).returns(true)
       assert_equal ['before', 'bundle exec cap $ENVIRONMENT deploy', 'after'], @spec.deploy_steps
@@ -175,7 +176,7 @@ module Shipit
     end
 
     test '#rollback_steps returns `rollback.override` if present' do
-      @spec.stubs(:load_config).returns('rollback' => {'override' => %w(foo bar baz)})
+      @spec.stubs(:load_config).returns('rollback' => { 'override' => %w(foo bar baz) })
       assert_equal %w(foo bar baz), @spec.rollback_steps
     end
 
@@ -186,7 +187,7 @@ module Shipit
     end
 
     test "#rollback_steps prepend and append pre and post steps" do
-      @spec.stubs(:load_config).returns('rollback' => {'pre' => ['before'], 'post' => ['after']})
+      @spec.stubs(:load_config).returns('rollback' => { 'pre' => ['before'], 'post' => ['after'] })
       @spec.expects(:bundler?).returns(true).at_least_once
       @spec.expects(:capistrano?).returns(true)
       assert_equal ['before', 'bundle exec cap $ENVIRONMENT deploy:rollback', 'after'], @spec.rollback_steps
@@ -255,14 +256,14 @@ module Shipit
     end
 
     test '#machine_env returns an environment hash' do
-      @spec.stubs(:load_config).returns('machine' => {'environment' => {'GLOBAL' => '1'}})
-      assert_equal({'GLOBAL' => '1'}, @spec.machine_env)
+      @spec.stubs(:load_config).returns('machine' => { 'environment' => { 'GLOBAL' => '1' } })
+      assert_equal({ 'GLOBAL' => '1' }, @spec.machine_env)
     end
 
     test '#load_config can grab the env-specific shipit.yml file' do
       config = {}
       config.expects(:exist?).returns(true)
-      config.expects(:read).returns({'dependencies' => {'override' => %w(foo bar baz)}}.to_yaml)
+      config.expects(:read).returns({ 'dependencies' => { 'override' => %w(foo bar baz) } }.to_yaml)
       spec = DeploySpec::FileSystem.new('.', 'staging')
       spec.expects(:file).with('shipit.staging.yml', root: true).returns(config)
       assert_equal %w(foo bar baz), spec.dependencies_steps
@@ -274,7 +275,7 @@ module Shipit
 
       config = {}
       config.expects(:exist?).returns(true)
-      config.expects(:read).returns({'dependencies' => {'override' => %w(foo bar baz)}}.to_yaml)
+      config.expects(:read).returns({ 'dependencies' => { 'override' => %w(foo bar baz) } }.to_yaml)
 
       spec = DeploySpec::FileSystem.new('.', 'staging')
       spec.expects(:file).with('shipit.staging.yml', root: true).returns(not_config)
@@ -352,16 +353,16 @@ module Shipit
           'blocking' => [],
         },
         'machine' => {
-          'environment' => {'BUNDLE_PATH' => @spec.bundle_path.to_s},
+          'environment' => { 'BUNDLE_PATH' => @spec.bundle_path.to_s },
           'directory' => nil,
           'cleanup' => true,
         },
-        'review' => {'checklist' => [], 'monitoring' => [], 'checks' => []},
+        'review' => { 'checklist' => [], 'monitoring' => [], 'checks' => [] },
         'status' => {
           'context' => nil,
           'delay' => 0,
         },
-        'dependencies' => {'override' => []},
+        'dependencies' => { 'override' => [] },
         'plugins' => {},
         'deploy' => {
           'override' => nil,
@@ -369,7 +370,7 @@ module Shipit
           'max_commits' => 8,
           'interval' => 0,
         },
-        'rollback' => {'override' => nil},
+        'rollback' => { 'override' => nil },
         'fetch' => nil,
         'tasks' => {},
       }
@@ -381,11 +382,11 @@ module Shipit
     end
 
     test "#deploy_variables returns an array of VariableDefinition instances" do
-      @spec.stubs(:load_config).returns('deploy' => {'variables' => [{
+      @spec.stubs(:load_config).returns('deploy' => { 'variables' => [{
         'name' => 'SAFETY_DISABLED',
         'title' => 'Set to 1 to do dangerous things',
         'default' => 0,
-      }]})
+      }] })
 
       assert_equal 1, @spec.deploy_variables.size
       variable_definition = @spec.deploy_variables.first
@@ -393,13 +394,13 @@ module Shipit
     end
 
     test "task definitions don't prepend bundle exec by default" do
-      @spec.expects(:load_config).returns('tasks' => {'restart' => {'steps' => %w(foo)}})
+      @spec.expects(:load_config).returns('tasks' => { 'restart' => { 'steps' => %w(foo) } })
       definition = @spec.find_task_definition('restart')
       assert_equal ['foo'], definition.steps
     end
 
     test "task definitions don't bundle exec before serialization" do
-      @spec.expects(:discover_task_definitions).returns('restart' => {'steps' => %w(foo)})
+      @spec.expects(:discover_task_definitions).returns('restart' => { 'steps' => %w(foo) })
       @spec.expects(:bundler?).returns(true).at_least_once
 
       cached_spec = DeploySpec.load(DeploySpec.dump(@spec))
@@ -418,18 +419,18 @@ module Shipit
       module TestTaskDiscovery
         def discover_task_definitions
           {
-            'config_task' => {'steps' => %w(bar)},
+            'config_task' => { 'steps' => %w(bar) },
           }.merge!(super)
         end
       end
 
       # Include the module in our new test class
-      DuplicateCustomizedDeploySpec.include TestTaskDiscovery
+      DuplicateCustomizedDeploySpec.include(TestTaskDiscovery)
 
       # Setup the spec as we would normally, but use the customized version
       @spec = DuplicateCustomizedDeploySpec.new(@app_dir, 'env')
       @spec.stubs(:load_config).returns(
-        'tasks' => {'config_task' => {'steps' => %w(foo)}},
+        'tasks' => { 'config_task' => { 'steps' => %w(foo) } },
       )
       tasks = @spec.task_definitions
 
@@ -448,18 +449,18 @@ module Shipit
       module TestTaskDiscovery
         def discover_task_definitions
           {
-            'module_task' => {'steps' => %w(bar)},
+            'module_task' => { 'steps' => %w(bar) },
           }.merge(super)
         end
       end
 
       # Include the module in our new test class
-      CustomizedDeploySpec.include TestTaskDiscovery
+      CustomizedDeploySpec.include(TestTaskDiscovery)
 
       # Setup the spec as we would normally, but use the customized version
       @spec = CustomizedDeploySpec.new(@app_dir, 'env')
       @spec.stubs(:load_config).returns(
-        'tasks' => {'config_task' => {'steps' => %w(foo)}},
+        'tasks' => { 'config_task' => { 'steps' => %w(foo) } },
         'kubernetes' => {
           'namespace' => 'foo',
           'context' => 'bar',
@@ -484,7 +485,7 @@ module Shipit
 
     test "task definitions returns an array of VariableDefinition instances" do
       @spec.expects(:load_config).returns('tasks' =>
-        {'restart' =>
+        { 'restart' =>
           {
             'variables' => [
               {
@@ -499,8 +500,7 @@ module Shipit
               },
             ],
             'steps' => %w(foo),
-          },
-        })
+          } })
 
       assert_equal 2, @spec.task_definitions.first.variables.size
       variable_definition = @spec.task_definitions.first.variables.first
@@ -512,7 +512,7 @@ module Shipit
     end
 
     test "#review_checklist returns an array" do
-      @spec.expects(:load_config).returns('review' => {'checklist' => %w(foo bar)})
+      @spec.expects(:load_config).returns('review' => { 'checklist' => %w(foo bar) })
       assert_equal %w(foo bar), @spec.review_checklist
     end
 
@@ -521,13 +521,13 @@ module Shipit
     end
 
     test "#review_monitoring returns an array of hashes" do
-      @spec.expects(:load_config).returns('review' => {'monitoring' => [
-        {'image' => 'http://example.com/foo.png', 'width' => 200, 'height' => 400},
-        {'iframe' => 'http://example.com/', 'width' => 200, 'height' => 400},
-      ]})
+      @spec.expects(:load_config).returns('review' => { 'monitoring' => [
+        { 'image' => 'http://example.com/foo.png', 'width' => 200, 'height' => 400 },
+        { 'iframe' => 'http://example.com/', 'width' => 200, 'height' => 400 },
+      ] })
       assert_equal [
-        {'image' => 'http://example.com/foo.png', 'width' => 200, 'height' => 400},
-        {'iframe' => 'http://example.com/', 'width' => 200, 'height' => 400},
+        { 'image' => 'http://example.com/foo.png', 'width' => 200, 'height' => 400 },
+        { 'iframe' => 'http://example.com/', 'width' => 200, 'height' => 400 },
       ], @spec.review_monitoring
     end
 
@@ -540,12 +540,12 @@ module Shipit
     end
 
     test "#hidden_statuses is an array even if the value is a string" do
-      @spec.expects(:load_config).returns('ci' => {'hide' => 'ci/circleci'})
+      @spec.expects(:load_config).returns('ci' => { 'hide' => 'ci/circleci' })
       assert_equal %w(ci/circleci), @spec.hidden_statuses
     end
 
     test "#hidden_statuses is an array even if the value is present" do
-      @spec.expects(:load_config).returns('ci' => {'hide' => %w(ci/circleci ci/jenkins)})
+      @spec.expects(:load_config).returns('ci' => { 'hide' => %w(ci/circleci ci/jenkins) })
       assert_equal %w(ci/circleci ci/jenkins), @spec.hidden_statuses
     end
 
@@ -677,7 +677,7 @@ module Shipit
 
     test "#file is impacted by `machine.directory`" do
       subdir = '/foo/bar'
-      @spec.stubs(:load_config).returns('machine' => {'directory' => subdir})
+      @spec.stubs(:load_config).returns('machine' => { 'directory' => subdir })
       assert_instance_of Pathname, @spec.file('baz')
       assert_equal File.join(@app_dir, subdir, 'baz'), @spec.file('baz').to_s
     end
@@ -1084,5 +1084,10 @@ module Shipit
       )
       assert_nil @spec.max_divergence_age
     end
+
+    test "serialised deploy specs are normalised" do
+      stack = shipit_stacks(:shipit)
+      assert_equal stack.cached_deploy_spec_before_type_cast, DeploySpec.dump(stack.cached_deploy_spec)
+    end
   end
 end