shipit-engine 0.28.1 → 0.33.0

data/test/models/shipit/repository_test.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  class RepositoryTest < ActiveSupport::TestCase
+    setup do
+      @repository = shipit_repositories(:shipit)
+    end
+
+    test "owner, and name uniqueness is enforced" do
+      clone = Repository.new(@repository.attributes.except('id'))
+      refute clone.save
+      assert_equal ["cannot be used more than once"], clone.errors[:name]
+    end
+
+    test "owner, name, and environment can only be ASCII" do
+      @repository.update(owner: 'héllò', name: 'wørld')
+      refute_predicate @repository, :valid?
+    end
+
+    test "owner and name are case insensitive" do
+      assert_no_difference -> { Repository.count } do
+        error = assert_raises(ActiveRecord::RecordInvalid) do
+          Repository.create!(
+            owner: @repository.owner.upcase,
+            name: @repository.name.upcase,
+          )
+        end
+        assert_equal 'Validation failed: Name cannot be used more than once', error.message
+      end
+
+      new_repository = Repository.create!(owner: 'FOO', name: 'BAR')
+      assert_equal new_repository, Repository.find_by(owner: 'foo', name: 'bar')
+    end
+
+    test "owner is automatically downcased" do
+      @repository.owner = 'George'
+      assert_equal 'george', @repository.owner
+    end
+
+    test "name is automatically downcased" do
+      @repository.name = 'Cyclim.se'
+      assert_equal 'cyclim.se', @repository.name
+    end
+
+    test "owner cannot contain a `/`" do
+      assert @repository.valid?
+      @repository.owner = 'foo/bar'
+      refute @repository.valid?
+    end
+
+    test "name cannot contain a `/`" do
+      assert @repository.valid?
+      @repository.name = 'foo/bar'
+      refute @repository.valid?
+    end
+
+    test "http_url" do
+      assert_equal "https://github.com/#{@repository.owner}/#{@repository.name}", @repository.http_url
+    end
+
+    test "git_url" do
+      assert_equal "https://github.com/#{@repository.owner}/#{@repository.name}.git", @repository.git_url
+    end
+
+    test "review_stacks_enabled defaults to false" do
+      assert_equal false, Repository.new.review_stacks_enabled
+    end
+
+    test "from_github_repo_name" do
+      owner = "repository-owner"
+      name = "repository-name"
+      github_repo_name = [owner, name].join("/")
+      expected_repository = Repository.create(owner: owner, name: name)
+
+      found_repository = Repository.from_github_repo_name(github_repo_name)
+
+      assert_equal(expected_repository, found_repository)
+    end
+  end
+end

data/test/models/shipit/review_stack_provision_status_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Shipit
+  class ReviewStackProvisionStatusTest < ActiveSupport::TestCase
+    test "stacks default to deprovisioned state" do
+      stack = Shipit::ReviewStack.new
+
+      assert_equal 'deprovisioned', stack.provision_status
+    end
+
+    test "non-review stacks don't transition" do
+      stack = Shipit::ReviewStack.new
+      stack.provision
+
+      assert_equal 'deprovisioned', stack.provision_status
+    end
+
+    test "review stacks that are deprovisioned can be provisioned" do
+      stack = review_stack(provision_status: :deprovisioned)
+
+      stack.provision
+
+      assert_equal 'provisioning', stack.provision_status
+    end
+
+    test "review stacks that are provisioning can succeed" do
+      stack = review_stack(provision_status: :provisioning)
+
+      stack.provision_success
+
+      assert_equal 'provisioned', stack.provision_status
+    end
+
+    test "review stacks that are provisioning can fail" do
+      stack = review_stack(provision_status: :provisioning)
+
+      stack.provision_failure
+
+      assert_equal 'deprovisioned', stack.provision_status
+    end
+
+    test "review stacks are provisioned can be deprovisioned" do
+      stack = review_stack(provision_status: :provisioned)
+
+      stack.deprovision
+
+      assert 'deprovisioning', stack.provision_status
+    end
+
+    test "review stacks that are deprovisioning can succeed" do
+      stack = review_stack(provision_status: :deprovisioning)
+
+      stack.deprovision_success
+
+      assert_equal 'deprovisioned', stack.provision_status
+    end
+
+    test "review stacks that are deprovisioning can fail" do
+      stack = review_stack(provision_status: :deprovisioning)
+
+      stack.deprovision_failure
+
+      assert_equal 'provisioned', stack.provision_status
+    end
+
+    def review_stack(provision_status: :deprovisioned)
+      stack = shipit_stacks(:review_stack)
+      stack.provision_status = provision_status
+
+      stack.save!
+
+      stack
+    end
+  end
+end

data/test/models/shipit/review_stack_provisioning_queue_test.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Shipit
+  class ReviewStackProvisioningQueueTest < ActiveSupport::TestCase
+    test ".add en-queues a stack for provisioning" do
+      review_stack = shipit_stacks(:review_stack)
+      review_stack.update(lock_reason: nil)
+
+      assert_changes -> { review_stack.awaiting_provision }, from: false, to: true do
+        queue.add(review_stack)
+      end
+    end
+
+    test ".work provisions resource stacks when they are provision-able" do
+      review_stack = provisionable_review_stack
+      setup_provisioning_handler(for_stack: review_stack, provision: true)
+      queue.add(review_stack)
+
+      assert_changes -> { review_stack.reload.provision_status }, from: "deprovisioned", to: "provisioning" do
+        queue.work
+      end
+    end
+
+    test ".work does not provision resource stacks when they are not provisionable" do
+      review_stack = provisionable_review_stack
+      setup_provisioning_handler(for_stack: review_stack, provision: false)
+      queue.add(review_stack)
+
+      assert_equal "deprovisioned", review_stack.provision_status
+      assert_no_changes -> { review_stack.reload.provision_status } do
+        queue.work
+      end
+    end
+
+    private
+
+    def setup_provisioning_handler(for_stack:, provision:)
+      provisioning_handler_instance = mock("ProvisioningHandler instance")
+      provisioning_handler_instance.expects(:provision?).returns(provision)
+      provisioning_handler_instance.expects(:up).returns(true) if !!provision
+      provisioning_handler_class = mock("ProvisioningHandler class")
+      provisioning_handler_class.expects(:new).at_least_once.with(for_stack).returns(provisioning_handler_instance)
+      Shipit::ProvisioningHandler.expects(:fetch).at_least_once.returns(provisioning_handler_class)
+
+      provisioning_handler_instance
+    end
+
+    def provisionable_review_stack
+      review_stack = shipit_stacks(:review_stack)
+      review_stack.update(
+        provision_status: :deprovisioned,
+      )
+
+      review_stack
+    end
+
+    def queue
+      ReviewStackProvisioningQueue
+    end
+  end
+end

data/test/models/shipit/review_stack_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Shipit
+  class ReviewStackTest < ActiveSupport::TestCase
+    setup do
+      @review_stack = shipit_stacks(:review_stack)
+    end
+
+    test "clearing stale caches" do
+      # Asserting that :archived_25hours_ago, :archived_30minutes_ago and :shipit are not queued.
+      assert_enqueued_jobs 1 do
+        assert_enqueued_with(job: Shipit::ClearGitCacheJob, args: [shipit_stacks(:archived_6hours_ago)]) do
+          ReviewStack.clear_stale_caches
+        end
+      end
+    end
+
+    test "creating a review stack emits a hook" do
+      new_review_stack = @review_stack.dup
+      new_review_stack.environment = "new-review-stack-environment"
+
+      expect_hook(:review_stack, new_review_stack, action: :added, review_stack: new_review_stack) do
+        new_review_stack.save!
+      end
+    end
+
+    test "updating a review stack emit a hook" do
+      expect_hook(:review_stack, @review_stack, action: :updated, review_stack: @review_stack) do
+        @review_stack.update(environment: 'foo')
+      end
+    end
+
+    test "updating a review stack doesn't emit a hook if only `updated_at` is changed" do
+      # force a save to make sure `cached_deploy_spec` serialization is consistent with how Active Record would
+      # serialize it.
+      @review_stack.update(updated_at: 2.days.ago)
+
+      expect_no_hook(:review_stack) do
+        @review_stack.update(updated_at: Time.zone.now)
+      end
+    end
+
+    test "deleteing a review stack emits a hook" do
+      expect_hook(:review_stack, @review_stack, action: :removed, review_stack: @review_stack) do
+        @review_stack.destroy!
+      end
+    end
+
+    test "#env includes the stack's pull request labels" do
+      stack = shipit_stacks(:review_stack)
+      stack.pull_request.labels = ["wip", "bug"]
+
+      assert_equal stack.env["WIP"], "true"
+      assert_equal stack.env["BUG"], "true"
+    end
+  end
+end

data/test/models/{stacks_test.rb → shipit/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
 
@@ -288,8 +267,9 @@ module Shipit
       end
     end
 
-    test "#deployable? returns true if the stack is not locked and is not deploying" do
+    test "#deployable? returns true if the stack is not locked, not awaiting provision, and is not deploying" do
       @stack.deploys.destroy_all
+      @stack.update!(lock_reason: nil, awaiting_provision: false)
       assert_predicate @stack, :deployable?
     end
 
@@ -303,6 +283,11 @@ module Shipit
       refute_predicate @stack, :deployable?
     end
 
+    test "#deployable? returns false if the stack is awaiting provisioning" do
+      @stack.update!(lock_reason: nil, awaiting_provision: true)
+      refute_predicate @stack, :deployable?
+    end
+
     test "#allows_merges? returns true if the stack is not locked and the branch is green" do
       assert_predicate @stack, :allows_merges?
     end
@@ -328,7 +313,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,18 +345,18 @@ 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
     end
 
-    test "unlocking the stack triggers a MergePullRequests job" do
-      assert_no_enqueued_jobs(only: MergePullRequestsJob) do
+    test "unlocking the stack triggers a MergeMergeRequests job" do
+      assert_no_enqueued_jobs(only: ProcessMergeRequestsJob) do
         @stack.update(lock_reason: "Just for fun", lock_author: shipit_users(:walrus))
       end
 
-      assert_enqueued_with(job: MergePullRequestsJob, args: [@stack]) do
+      assert_enqueued_with(job: ProcessMergeRequestsJob, args: [@stack]) do
         @stack.update(lock_reason: nil)
       end
     end
@@ -411,7 +396,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 +490,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 +560,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 +593,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 +626,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 +876,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 +938,9 @@ module Shipit
         committed_at: Time.zone.now,
       )
     end
+
+    def create_deploy_spec(spec)
+      Shipit::DeploySpec.new(spec.stringify_keys)
+    end
   end
 end