shipit-engine 0.28.0 → 0.32.0

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  module Webhooks
+    class HandlersTest < ActiveSupport::TestCase
+      test 'custom handlers do not replace default shipit handlers' do
+        event = 'push'
+        mock_handler = mock
+        Shipit::Webhooks.register_handler(event, mock_handler)
+
+        assert_includes Shipit::Webhooks.for_event(event), mock_handler
+        assert_includes Shipit::Webhooks.for_event(event), Shipit::Webhooks::Handlers::PushHandler
+
+        Shipit::Webhooks.reset_handlers!
+      end
+
+      test "unknown events have no handlers" do
+        event = '_'
+
+        handlers = Shipit::Webhooks.for_event(event)
+
+        assert_equal [], handlers
+      end
+    end
+  end
+end

data/test/models/stacks_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 require 'securerandom'
 
@@ -9,43 +10,6 @@ module Shipit
       GithubHook.any_instance.stubs(:teardown!)
     end
 
-    test "repo_owner, repo_name and environment uniqueness is enforced" do
-      clone = Stack.new(@stack.attributes.except('id'))
-      refute clone.save
-      assert_equal ["cannot be used more than once with this environment"], clone.errors[:repo_name]
-    end
-
-    test "repo_owner, repo_name, and environment can only be ASCII" do
-      @stack.update(repo_owner: 'héllò', repo_name: 'wørld', environment: 'pródüctïòn')
-      refute_predicate @stack, :valid?
-    end
-
-    test "repo_owner and repo_name are case insensitive" do
-      assert_no_difference -> { Stack.count } do
-        error = assert_raises ActiveRecord::RecordInvalid do
-          Stack.create!(
-            repo_owner: @stack.repo_owner.upcase,
-            repo_name: @stack.repo_name.upcase,
-            environment: @stack.environment,
-          )
-        end
-        assert_equal 'Validation failed: Repo name cannot be used more than once with this environment', error.message
-      end
-
-      new_stack = Stack.create!(repo_owner: 'FOO', repo_name: 'BAR')
-      assert_equal new_stack, Stack.find_by(repo_owner: 'foo', repo_name: 'bar')
-    end
-
-    test "repo_owner is automatically downcased" do
-      @stack.repo_owner = 'George'
-      assert_equal 'george', @stack.repo_owner
-    end
-
-    test "repo_name is automatically downcased" do
-      @stack.repo_name = 'Cyclim.se'
-      assert_equal 'cyclim.se', @stack.repo_name
-    end
-
     test "branch defaults to master" do
       @stack.branch = ""
       assert @stack.save
@@ -64,18 +28,6 @@ module Shipit
       assert_equal 'foo:bar', @stack.environment
     end
 
-    test "repo_owner cannot contain a `/`" do
-      assert @stack.valid?
-      @stack.repo_owner = 'foo/bar'
-      refute @stack.valid?
-    end
-
-    test "repo_name cannot contain a `/`" do
-      assert @stack.valid?
-      @stack.repo_name = 'foo/bar'
-      refute @stack.valid?
-    end
-
     test "repo_http_url" do
       assert_equal "https://github.com/#{@stack.repo_owner}/#{@stack.repo_name}", @stack.repo_http_url
     end
@@ -104,6 +56,30 @@ module Shipit
       assert_equal shipit_deploys(:shipit_complete).until_commit_id, deploy.since_commit_id
     end
 
+    test "#trigger_deploy emits a hook" do
+      original_receivers = Shipit.internal_hook_receivers
+
+      FakeReceiver = Module.new do
+        mattr_accessor :hooks
+        self.hooks = []
+
+        def self.deliver(event, stack, payload)
+          hooks << [event, stack, payload]
+        end
+      end
+      Shipit.internal_hook_receivers = [FakeReceiver]
+
+      last_commit = shipit_commits(:third)
+      deploy = @stack.trigger_deploy(last_commit, AnonymousUser.new)
+      assert_includes(FakeReceiver.hooks, [
+        :deploy,
+        @stack,
+        { deploy: deploy, status: "pending", stack: @stack },
+      ])
+    ensure
+      Shipit.internal_hook_receivers = original_receivers
+    end
+
     test "#trigger_deploy deploy until the commit passed in argument" do
       last_commit = shipit_commits(:third)
       deploy = @stack.trigger_deploy(last_commit, AnonymousUser.new)
@@ -225,7 +201,7 @@ module Shipit
 
     test "#create queues a GithubSyncJob" do
       assert_enqueued_with(job: GithubSyncJob) do
-        Stack.create!(repo_name: 'rails', repo_owner: 'rails')
+        Stack.create!(repository: shipit_repositories(:rails))
       end
     end
 
@@ -273,7 +249,10 @@ module Shipit
     end
 
     test ".run_deploy_in_foreground triggers a deploy" do
-      stack = Stack.create!(repo_owner: 'foo', repo_name: 'bar', environment: 'production')
+      stack = Stack.create!(
+        repository: Repository.new(owner: "foo", name: "bar"),
+        environment: 'production',
+      )
       commit = shipit_commits(:first)
       stack.commits << commit
 
@@ -328,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
@@ -360,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
@@ -411,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
 
@@ -505,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
@@ -573,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
 
@@ -589,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
 
@@ -620,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
@@ -870,6 +870,56 @@ module Shipit
       )
     end
 
+    test "#trigger_continuous_delivery sets delay if commit was pushed recently" do
+      freeze_time do
+        @stack.tasks.delete_all
+
+        commit = @stack.next_commit_to_deploy
+        commit.touch(:created_at)
+
+        assert_no_enqueued_jobs(only: Shipit::PerformTaskJob) do
+          assert_no_difference -> { Deploy.count } do
+            @stack.trigger_continuous_delivery
+          end
+        end
+      end
+    end
+
+    test "#links performs template substitutions" do
+      @stack.repo_name = "expected-repository-name"
+      @stack.environment = "expected-environment"
+      @stack.cached_deploy_spec = create_deploy_spec(
+        "links" => {
+          "logs" => "http://logs.$GITHUB_REPO_NAME.$ENVIRONMENT.domain.com",
+          "monitoring" => "https://graphs.$GITHUB_REPO_NAME.$ENVIRONMENT.domain.com",
+        },
+      )
+
+      assert_equal(
+        {
+          "logs" => "http://logs.expected-repository-name.expected-environment.domain.com",
+          "monitoring" => "https://graphs.expected-repository-name.expected-environment.domain.com",
+        },
+        @stack.links,
+      )
+    end
+
+    test "#env includes the stack's environment" do
+      expected_environment = {
+        'ENVIRONMENT' => @stack.environment,
+        'LAST_DEPLOYED_SHA' => @stack.last_deployed_commit.sha,
+        'GITHUB_REPO_OWNER' => @stack.repository.owner,
+        'GITHUB_REPO_NAME' => @stack.repository.name,
+        'DEPLOY_URL' => @stack.deploy_url,
+        'BRANCH' => @stack.branch,
+      }
+
+      assert_equal(
+        @stack.env,
+        expected_environment,
+      )
+    end
+
     private
 
     def generate_revert_commit(stack:, reverted_commit:, author: reverted_commit.author)
@@ -882,5 +932,9 @@ module Shipit
         committed_at: Time.zone.now,
       )
     end
+
+    def create_deploy_spec(spec)
+      Shipit::DeploySpec.new(spec.stringify_keys)
+    end
   end
 end

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
@@ -52,6 +53,19 @@ module Shipit
       assert_predicate undeployed_commit, :expected_to_be_deployed?
     end
 
+    test "#expected_to_be_deployed? returns true if the active task has no commit range" do
+      commit = shipit_commits(:task_no_commits)
+      next_expected_commit_to_deploy = commit.stack.next_expected_commit_to_deploy
+      undeployed_commit = UndeployedCommit.new(commit, index: 1, next_expected_commit_to_deploy: next_expected_commit_to_deploy)
+
+      refute_predicate next_expected_commit_to_deploy, :nil?
+      assert_predicate undeployed_commit.stack, :continuous_deployment
+      assert next_expected_commit_to_deploy.id >= undeployed_commit.id
+      refute_predicate undeployed_commit, :active?
+
+      assert_predicate undeployed_commit, :expected_to_be_deployed?
+    end
+
     test "#expected_to_be_deployed? returns false if the stack has continuous deployment disabled" do
       commit = shipit_commits(:cyclimse_first)
       next_expected_commit_to_deploy = commit.stack.next_expected_commit_to_deploy

data/test/models/users_test.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
   class UsersTest < ActiveSupport::TestCase
     setup do
+      @previous_preferred_org_emails = Shipit.preferred_org_emails
       @user = shipit_users(:walrus)
       @github_user = stub(
         id: 42,
@@ -12,6 +14,8 @@ module Shipit
         avatar_url: 'https://avatars.githubusercontent.com/u/42?v=3',
         url: 'https://api.github.com/user/george',
       )
+      @org_domain = "shopify.com"
+      @emails_url = "https://api.github.com/user/emails"
       @minimal_github_user = stub(
         id: 43,
         name: nil,
@@ -23,6 +27,10 @@ module Shipit
       )
     end
 
+    teardown do
+      Shipit.preferred_org_emails = @previous_preferred_org_emails
+    end
+
     test "find_or_create_from_github persist a new user if he is unknown" do
       assert_difference 'User.count', 1 do
         fetch_user
@@ -58,13 +66,113 @@ module Shipit
     end
 
     test "find_or_create_from_github accepts minimal users without name nor email" do
+      Shipit.preferred_org_emails = [].freeze
       user = User.find_or_create_from_github(@minimal_github_user)
       assert_equal @minimal_github_user.login, user.login
     end
 
+    test "find_or_create_from_github selects any email when org email is unspecified" do
+      github_org_user = stub(
+        id: 42,
+        name: 'Jim Jones',
+        login: 'jim',
+        email: "jim@#{@org_domain}",
+        avatar_url: 'https://avatars.githubusercontent.com/u/42?v=3',
+        url: 'https://api.github.com/user/jim',
+      )
+
+      Shipit.preferred_org_emails = [].freeze
+      user = User.find_or_create_from_github(github_org_user)
+      assert_equal github_org_user.email, user.email
+    end
+
+    test "find_or_create_from_github selects org email for user" do
+      Shipit.preferred_org_emails = [@org_domain]
+      expected_email = "myuser@#{@org_domain}"
+
+      stub_request(:get, @emails_url).to_return(
+        status: %w(200 OK),
+        body: [{ email: expected_email }].to_json,
+        headers: { "Content-Type" => "application/json" },
+      )
+
+      user = User.find_or_create_from_github(@github_user)
+      assert_equal expected_email, user.email
+    end
+
+    test "find_or_create_from_github selects private and primary org email for user when necessary" do
+      Shipit.preferred_org_emails = [@org_domain]
+      expected_email = "myuser@#{@org_domain}"
+      result_email_records = [
+        {
+          email: "notmyuser1@#{@org_domain}",
+          primary: false,
+        },
+        {
+          email: "notmyuser2@#{@org_domain}",
+        },
+        {
+          email: expected_email,
+          primary: true,
+        },
+      ]
+
+      stub_request(:get, @emails_url).to_return(
+        status: %w(200 OK),
+        body: result_email_records.to_json,
+        headers: { "Content-Type" => "application/json" },
+      )
+
+      user = User.find_or_create_from_github(@github_user)
+      assert_equal expected_email, user.email
+    end
+
+    test "find_or_create_from_github selects no email when org emails are provided but not found" do
+      Shipit.preferred_org_emails = [@org_domain]
+      result_email_records = [
+        {
+          email: "notmyuser1@not#{@org_domain}",
+          primary: false,
+        },
+        {
+          email: "notmyuser2@not#{@org_domain}",
+        },
+      ]
+
+      stub_request(:get, @emails_url).to_return(
+        status: %w(200 OK),
+        body: result_email_records.to_json,
+        headers: { "Content-Type" => "application/json" },
+      )
+
+      user = User.find_or_create_from_github(@github_user)
+      assert_nil user.email
+    end
+
+    test "find_or_create_from_github handles user 404" do
+      Shipit.preferred_org_emails = [@org_domain]
+      Octokit::Client.any_instance.expects(:emails).raises(Octokit::NotFound)
+      user = User.find_or_create_from_github(@minimal_github_user)
+      assert_nil user.email
+    end
+
+    test "find_or_create_from_github handles user 403" do
+      Shipit.preferred_org_emails = [@org_domain]
+      Octokit::Client.any_instance.expects(:emails).raises(Octokit::Forbidden)
+      user = User.find_or_create_from_github(@minimal_github_user)
+      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