shipit-engine 0.32.0 → 0.33.0

data/test/models/shipit/webhooks/handlers/pull_request/review_stack_adapter_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Shipit
+  module Webhooks
+    module Handlers
+      module PullRequest
+        class ReviewStackAdapterTest < ActiveSupport::TestCase
+          test "unarchive! on an unarchived stack is a no-op" do
+            stack = create_stack
+            review_stack = Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter.new(
+              params_for(stack),
+              scope: stack.repository.stacks
+            )
+            Shipit::ReviewStack.any_instance.expects(:unarchive!).never
+            Shipit::ReviewStackProvisioningQueue.expects(:add).never
+
+            review_stack.unarchive!
+          end
+
+          test "archive! on an archived stack is a no-op" do
+            stack = create_archived_stack
+            review_stack = Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter.new(
+              params_for(stack),
+              scope: stack.repository.stacks
+            )
+            Shipit::Stack.any_instance.expects(:archive!).never
+
+            review_stack.archive!
+          end
+
+          test "archive! removes stacks awaiting provisioning from the provisioning queue" do
+            stack = create_stack
+            stack.enqueue_for_provisioning
+            review_stack = Shipit::Webhooks::Handlers::PullRequest::ReviewStackAdapter.new(
+              params_for(stack),
+              scope: stack.repository.stacks
+            )
+
+            assert_changes -> { stack.reload.awaiting_provision }, from: true, to: false do
+              review_stack.archive!
+            end
+          end
+
+          def params_for(stack)
+            OpenStruct.new(
+              number: pr_number,
+              repository: {
+                "full_name" => stack.github_repo_name,
+              },
+              sender: { login: shipit_users(:walrus).login }
+            )
+          end
+
+          def create_stack
+            stack = shipit_stacks(:review_stack)
+            stack.environment = environment
+
+            stack.save!
+
+            stack
+          end
+
+          def create_archived_stack
+            stack = create_stack
+            stack.archive!(shipit_users(:walrus))
+
+            stack
+          end
+
+          def pr_number
+            1
+          end
+
+          def environment
+            "pr#{pr_number}"
+          end
+        end
+      end
+    end
+  end
+end

data/test/models/shipit/webhooks/handlers/pull_request/unlabeled_handler_test.rb

@@ -0,0 +1,324 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module Shipit
+  module Webhooks
+    module Handlers
+      module PullRequest
+        class UnlabeledHandlerTest < ActiveSupport::TestCase
+          test "validates payload" do
+            assert_raise(StandardError) { UnlabeledHandler.new(payload_parsed(:invalid_pull_request)) }
+          end
+
+          test "ignores Github webhooks when the event is NOT 'unlabeled'" do
+            assert_no_difference -> { Shipit::Stack.not_archived.count } do
+              UnlabeledHandler.new(payload_parsed(:pull_request_opened).merge(action: "assigned")).process
+            end
+          end
+
+          test "ignores Github PullRequest webhooks by default" do
+            UnlabeledHandler.new(payload_parsed(:pull_request_with_no_repo).merge(action: "closed")).process
+          end
+
+          test "ignores Github PullRequest webhooks when the Repository has disabled the Review Stacks feature" do
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              provisioning_enabled: false,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+
+            assert_no_difference -> { Shipit::Stack.count } do
+              UnlabeledHandler.new(payload_parsed(:pull_request_unlabeled)).process
+            end
+          end
+
+          test "ignores Github PullRequest webhooks when the repository allows_all PullRequests to create ReviewStacks" do
+            assert_no_difference -> { Shipit::Stack.count } do
+              UnlabeledHandler.new(payload_parsed(:pull_request_unlabeled)).process
+            end
+          end
+
+          test "archives existing review stack when the repository creates ReviewStacks with allow_with_label and the label is absent" do
+            stack = create_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+
+            UnlabeledHandler.new(payload_parsed(:pull_request_unlabeled)).process
+
+            assert stack.reload.archived?, "Expected stack to be archived"
+          end
+
+          test "deprovisions existing review stack when the repository creates ReviewStacks with allow_with_label and the label is absent" do
+            stack = create_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+
+            UnlabeledHandler.new(payload_parsed(:pull_request_unlabeled)).process
+
+            assert_equal stack.reload.provision_status, "deprovisioning"
+          end
+
+          test "ignores Github PullRequest webhooks when the repository allow_with_label to create ReviewStacks and the label is absent" do
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+
+            assert_no_difference -> { Shipit::Stack.count } do
+              UnlabeledHandler.new(payload_parsed(:pull_request_unlabeled)).process
+            end
+          end
+
+          test "unarchives existing review stack when the repository creates ReviewStacks with allow_with_label and the label is present" do
+            stack = create_archived_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] << { "name" => "pull-requests-label" }
+
+            UnlabeledHandler.new(payload).process
+
+            assert_not stack.reload.archived?, "Expected stack to NOT be archived"
+            assert_pending_provision(stack)
+          end
+
+          test "creates and provisions a new review stack when the repository creates ReviewStacks with allow_with_label and the label is present" do
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] << { "name" => "pull-requests-label" }
+
+            UnlabeledHandler.new(payload).process
+
+            stack = shipit_repositories(:shipit).stacks.last
+            assert_equal stack.environment, "pr#{payload['number']}"
+            assert_equal stack.continuous_deployment, false
+            assert_equal stack.ignore_ci, false
+            assert_equal stack.branch, payload["pull_request"]["head"]["ref"]
+            assert_not stack.archived?, "Expected stack to be NOT be archived"
+            assert_pending_provision(stack)
+          end
+
+          test "archives an existing review stack when the repository creates ReviewStacks with prevent_with_label and the label is present" do
+            stack = create_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :prevent_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] << { "name" => "pull-requests-label" }
+
+            UnlabeledHandler.new(payload).process
+
+            assert stack.reload.archived?, "Expected stack to be archived"
+          end
+
+          test "deprovisions an existing review stack when the repository creates ReviewStacks with prevent_with_label and the label is present" do
+            stack = create_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :prevent_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] << { "name" => "pull-requests-label" }
+
+            UnlabeledHandler.new(payload).process
+
+            assert_equal stack.reload.provision_status, "deprovisioning"
+          end
+
+          test "ignores Github PullRequest webhooks when the repository prevent_with_label to create ReviewStacks and the label is present" do
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :prevent_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] << { "name" => "pull-requests-label" }
+
+            assert_no_difference -> { Shipit::Stack.count } do
+              UnlabeledHandler.new(payload).process
+            end
+          end
+
+          test "unarchives an existing review stack when the repository creates ReviewStacks with prevent_with_label and the label is absent" do
+            stack = create_archived_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :prevent_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] = []
+
+            UnlabeledHandler.new(payload).process
+
+            assert_not stack.reload.archived?, "Expected stack to NOT be archived"
+            assert_pending_provision(stack)
+          end
+
+          test "creates and provisions a new review stack when the repository creates ReviewStacks with prevent_with_label and the label is absent" do
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :prevent_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] = []
+
+            UnlabeledHandler.new(payload).process
+
+            stack = shipit_repositories(:shipit).stacks.last
+            assert_equal stack.environment, "pr#{payload['number']}"
+            assert_equal stack.continuous_deployment, false
+            assert_equal stack.ignore_ci, false
+            assert_equal stack.branch, payload["pull_request"]["head"]["ref"]
+            assert_not stack.archived?, "Expected stack to be NOT be archived"
+            assert_pending_provision(stack)
+          end
+
+          test "assigns the PullRequest to newly created stacks" do
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :prevent_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] = []
+
+            assert_difference -> { Shipit::PullRequest.count } do
+              UnlabeledHandler.new(payload).process
+            end
+          end
+
+          test "ignores Github Webhooks for closed PullRequests" do
+            create_archived_stack
+            repository = shipit_repositories(:shipit)
+            configure_provisioning_behavior(
+              repository: repository,
+              behavior: :allow_with_label,
+              label: "pull-requests-label"
+            )
+            payload = payload_parsed(:pull_request_unlabeled)
+            payload["pull_request"]["labels"] << { "name" => "pull-requests-label" }
+            payload["pull_request"]["state"] = "closed"
+
+            Shipit::ReviewStackProvisioningQueue.expects(:add).never
+
+            UnlabeledHandler.new(payload).process
+          end
+
+          def configure_provisioning_behavior(repository:, provisioning_enabled: true, behavior: :allow_all, label: nil)
+            repository.review_stacks_enabled = provisioning_enabled
+            repository.provisioning_behavior = behavior
+            repository.provisioning_label_name = label
+            repository.save!
+
+            repository
+          end
+
+          def create_archived_stack
+            stack = create_stack
+            stack.update(provision_status: :deprovisioned)
+            stack.archive!(shipit_users(:codertocat))
+
+            stack
+          end
+
+          def create_stack
+            repository = shipit_repositories(:shipit)
+            repository.provisioning_behavior = :allow_all
+            repository.save!
+
+            payload = payload_parsed(:pull_request_labeled)
+            payload["action"] = "opened"
+
+            OpenedHandler.new(payload).process
+
+            stack = repository.stacks.last
+            stack.update(provision_status: :provisioned)
+            complete_active_tasks(stack)
+
+            stack
+          end
+
+          def complete_active_tasks(stack)
+            active_tasks = stack
+              .tasks
+              .active
+
+            active_tasks.map(&:run)
+            active_tasks.reload
+            active_tasks.map(&:complete)
+          end
+
+          def assert_pending_provision(stack)
+            stack.reload
+
+            assert(stack.awaiting_provision?, "Stack #{stack.environment} should be in the provisioning queue")
+            assert(stack.deprovisioned?, "Stack #{stack.environment} should be pending provision")
+          end
+
+          setup do
+            Shipit.github.api.stubs(:commit)
+              .with("shopify/shipit-engine", "ec26c3e57ca3a959ca5aad62de7213c562f8c821")
+              .returns(
+                resource(
+                  {
+                    sha: "ec26c3e57ca3a959ca5aad62de7213c562f8c821",
+                    commit: {
+                      author: {
+                        name: "Codertocat",
+                        email: "21031067+Codertocat@users.noreply.github.com",
+                        date: "2019-05-15 15:20:30",
+                      },
+                      committer: {
+                        name: "Codertocat",
+                        email: "21031067+Codertocat@users.noreply.github.com",
+                        date: "2019-05-15 15:20:30",
+                      },
+                      message: "Update README.md",
+                    },
+                    stats: {
+                      total: 2,
+                      additions: 1,
+                      deletions: 1,
+                    },
+                  }
+                )
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/test/models/tasks_test.rb

@@ -34,9 +34,9 @@ module Shipit
 
     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))
+      Shipit.redis.del(task.send(:output_key))
+
+      task.write('a' * (Task::OUTPUT_SIZE_LIMIT * 1.1))
 
       output = task.chunk_output
 
@@ -47,5 +47,46 @@ module Shipit
         "'#{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
   end
 end