shipit-engine 0.28.1 → 0.33.0

data/lib/tasks/teams.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 namespace :teams do
   desc "Import the members of each team configured through the github.oauth.teams config"
   task fetch: :environment do

data/test/controllers/api/base_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -6,7 +7,7 @@ module Shipit
       test "authentication is required" do
         get :index
         assert_response :unauthorized
-        assert_equal({message: 'Bad credentials'}.to_json, response.body)
+        assert_equal({ message: 'Bad credentials' }.to_json, response.body)
       end
 
       test "with proper credentials the request is processed" do
@@ -17,7 +18,7 @@ module Shipit
       test "#index respond with a list of endpoints" do
         authenticate!
         get :index, format: :json
-        assert_equal({stacks_url: api_stacks_url}.to_json, response.body)
+        assert_equal({ stacks_url: api_stacks_url }.to_json, response.body)
       end
     end
   end

data/test/controllers/api/ccmenu_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -10,26 +11,26 @@ module Shipit
 
       test "a request with insufficient permissions will render a 403" do
         @client.update!(permissions: [])
-        get :show, params: {stack_id: @stack.to_param}
+        get :show, params: { stack_id: @stack.to_param }
         assert_response :forbidden
         assert_json 'message', 'This operation requires the `read:stack` permission'
       end
 
       test "#show renders the xml" do
-        get :show, params: {stack_id: @stack.to_param}
+        get :show, params: { stack_id: @stack.to_param }
         assert_response :ok
         assert_payload 'name', @stack.to_param
       end
 
       test "can authenticate with query string token" do
         request.headers['Authorization'] = 'bleh'
-        get :show, params: {stack_id: @stack.to_param, token: @client.authentication_token}
+        get :show, params: { stack_id: @stack.to_param, token: @client.authentication_token }
         assert_response :ok
         assert_payload 'name', @stack.to_param
       end
 
       test "xml contains required attributes" do
-        get :show, params: {stack_id: @stack.to_param}
+        get :show, params: { stack_id: @stack.to_param }
         project = get_project_from_xml(response.body)
         %w(name activity lastBuildStatus lastBuildLabel lastBuildTime webUrl).each do |attribute|
           assert_includes project, attribute, "Response missing required attribute: #{attribute}"
@@ -38,13 +39,13 @@ module Shipit
 
       test "locked stacks show as failed" do
         @stack.lock('test', @user)
-        get :show, params: {stack_id: @stack.to_param}
+        get :show, params: { stack_id: @stack.to_param }
         assert_payload 'lastBuildStatus', 'Failure'
       end
 
       test "stacks with no deploys render correctly" do
-        stack = Stack.create!(repo_owner: 'foo', repo_name: 'bar')
-        get :show, params: {stack_id: stack.to_param}
+        stack = Stack.create!(repository: Repository.new(owner: "foo", name: "bar"))
+        get :show, params: { stack_id: stack.to_param }
         assert_payload 'lastBuildStatus', 'Success'
       end
 
@@ -56,7 +57,7 @@ module Shipit
 
       def assert_payload(k, v)
         @project ||= get_project_from_xml(response.body)
-        assert_equal v, @project[k]
+        assert_equal(v, @project[k])
       end
     end
   end

data/test/controllers/api/commits_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -11,7 +12,7 @@ module Shipit
       test "#index returns a list of commits" do
         commit = @stack.commits.reachable.last
 
-        get :index, params: {stack_id: @stack.to_param}
+        get :index, params: { stack_id: @stack.to_param }
         assert_response :ok
         assert_json '0.sha', commit.sha
       end
@@ -19,7 +20,7 @@ module Shipit
       test "#index with undeployed=1 returns a list of undeployed commits" do
         commits = @stack.undeployed_commits.pluck(:sha)
 
-        get :index, params: {stack_id: @stack.to_param, undeployed: 1}
+        get :index, params: { stack_id: @stack.to_param, undeployed: 1 }
         assert_response :ok
         JSON.parse(response.body).each do |commit|
           assert commits.include?(commit.fetch("sha"))

data/test/controllers/api/deploys_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -13,7 +14,7 @@ module Shipit
       test "#deploys returns the deploys and revisions for a given stack" do
         tasks = @stack.deploys_and_rollbacks.order(id: :desc)
 
-        get :index, params: {stack_id: @stack.to_param}
+        get :index, params: { stack_id: @stack.to_param }
         assert_response :ok
 
         (0...tasks.length).each do |i|
@@ -23,60 +24,60 @@ module Shipit
 
       test "#create triggers a new deploy for the stack" do
         assert_difference -> { @stack.deploys.count }, 1 do
-          post :create, params: {stack_id: @stack.to_param, sha: @commit.sha}
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
         end
         assert_response :accepted
         assert_json 'status', 'pending'
       end
 
       test "#create triggers a new deploy for whitelisted variables" do
-        correct_env = {'SAFETY_DISABLED' => 1}
-        post :create, params: {stack_id: @stack.to_param, sha: @commit.sha, env: correct_env}
+        correct_env = { 'SAFETY_DISABLED' => 1 }
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, env: correct_env }
         assert_response :accepted
         assert_json 'type', 'deploy'
         assert_json 'status', 'pending'
       end
 
       test "#create refuses to trigger a new deploy with incorrect variables" do
-        incorrect_env = {'DANGEROUS_VARIABLE' => 1}
-        post :create, params: {stack_id: @stack.to_param, sha: @commit.sha, env: incorrect_env}
+        incorrect_env = { 'DANGEROUS_VARIABLE' => 1 }
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, env: incorrect_env }
         assert_response :unprocessable_entity
         assert_json 'message', 'Variables DANGEROUS_VARIABLE have not been whitelisted'
       end
 
       test "#create use the claimed user as author" do
         request.headers['X-Shipit-User'] = @user.login
-        post :create, params: {stack_id: @stack.to_param, sha: @commit.sha}
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
         deploy = Deploy.last
         deploy.user == @user
       end
 
       test "#create normalises the claimed user" do
         request.headers['X-Shipit-User'] = @user.login.swapcase
-        post :create, params: {stack_id: @stack.to_param, sha: @commit.sha}
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
         deploy = Deploy.last
         assert_equal deploy.user, @user
       end
 
       test "#create renders a 422 if the sha isn't found" do
-        post :create, params: {stack_id: @stack.to_param, sha: '123443543545'}
+        post :create, params: { stack_id: @stack.to_param, sha: '123443543545' }
         assert_response :unprocessable_entity
         assert_json 'errors', 'sha' => ['Unknown revision']
       end
 
       test "#create renders a 422 if the sha format is invalid" do
-        post :create, params: {stack_id: @stack.to_param, sha: '1'}
+        post :create, params: { stack_id: @stack.to_param, sha: '1' }
         assert_response :unprocessable_entity
         assert_json 'errors', 'sha' => ['is too short (minimum is 6 characters)']
       end
 
       test "#create renders a 409 if a concurrent task is already running" do
         assert_difference -> { @stack.deploys.count }, 1 do
-          post :create, params: {stack_id: @stack.to_param, sha: @commit.sha}
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
         end
 
         assert_no_difference -> { @stack.deploys.count } do
-          post :create, params: {stack_id: @stack.to_param, sha: @commit.sha}
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
         end
 
         assert_response :conflict
@@ -86,7 +87,7 @@ module Shipit
         @stack.update!(lock_reason: 'Something broken')
 
         assert_no_difference -> { @stack.deploys.count } do
-          post :create, params: {stack_id: @stack.to_param, sha: @commit.sha}
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
         end
         assert_response :unprocessable_entity
         assert_json 'errors.force', ["Can't deploy a locked stack"]
@@ -96,7 +97,7 @@ module Shipit
         @stack.update!(lock_reason: 'Something broken')
 
         assert_difference -> { @stack.deploys.count }, 1 do
-          post :create, params: {stack_id: @stack.to_param, sha: @commit.sha, force: 'true'}
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, force: 'true' }
         end
         assert_response :accepted
         assert_json 'status', 'pending'

data/test/controllers/api/hooks_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -9,7 +10,7 @@ module Shipit
       end
 
       test "the route has priority over stacks one" do
-        assert_recognizes({controller: 'shipit/api/hooks', action: 'show', id: '42'}, '/api/hooks/42')
+        assert_recognizes({ controller: 'shipit/api/hooks', action: 'show', id: '42' }, '/api/hooks/42')
       end
 
       test "#index without a stack_id returns the list of global hooks" do
@@ -26,7 +27,7 @@ module Shipit
       test "#index with a stack_id returns the list of scoped hooks" do
         hook = Hook.scoped_to(@stack).first
 
-        get :index, params: {stack_id: @stack.to_param}
+        get :index, params: { stack_id: @stack.to_param }
         assert_response :ok
         assert_json '0.id', hook.id
         assert_json '0.delivery_url', hook.delivery_url
@@ -37,7 +38,7 @@ module Shipit
       test "#show returns the hooks" do
         hook = Hook.scoped_to(@stack).first
 
-        get :show, params: {stack_id: @stack.to_param, id: hook.id}
+        get :show, params: { stack_id: @stack.to_param, id: hook.id }
         assert_response :ok
 
         assert_json 'id', hook.id
@@ -48,7 +49,7 @@ module Shipit
 
       test "#create adds a new hook" do
         assert_difference -> { Hook.count }, 1 do
-          post :create, params: {delivery_url: 'https://example.com/hook', events: %w(deploy rollback)}
+          post :create, params: { delivery_url: 'https://example.com/hook', events: %w(deploy rollback) }
         end
         hook = Hook.last
         assert_json 'delivery_url', 'https://example.com/hook'
@@ -66,21 +67,21 @@ module Shipit
       end
 
       test "#create returns validation errors" do
-        post :create, params: {delivery_url: '../etc/passwd', events: %w(deploy)}
+        post :create, params: { delivery_url: '../etc/passwd', events: %w(deploy) }
         assert_response :unprocessable_entity
         assert_json 'errors', 'delivery_url' => ['is not a valid URL']
       end
 
       test "#update changes an existing hook" do
         hook = Hook.global.first
-        patch :update, params: {id: hook.id, delivery_url: 'https://shipit.com/'}
+        patch :update, params: { id: hook.id, delivery_url: 'https://shipit.com/' }
         assert_response :ok
         assert_json 'delivery_url', 'https://shipit.com/'
       end
 
       test "#destroy removes an existing hook" do
         hook = Hook.global.first
-        delete :destroy, params: {id: hook.id}
+        delete :destroy, params: { id: hook.id }
         assert_response :no_content
       end
     end

data/test/controllers/api/locks_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -9,7 +10,7 @@ module Shipit
       end
 
       test "#create sets a lock" do
-        post :create, params: {stack_id: @stack.to_param, reason: 'Just for fun!'}
+        post :create, params: { stack_id: @stack.to_param, reason: 'Just for fun!' }
         assert_response :ok
         assert_json 'is_locked', true
         assert_json 'lock_reason', 'Just for fun!'
@@ -18,12 +19,12 @@ module Shipit
 
       test "#create fails if already locked" do
         @stack.update!(lock_reason: "Don't forget me")
-        post :create, params: {stack_id: @stack.to_param, reason: 'Just for fun!'}
+        post :create, params: { stack_id: @stack.to_param, reason: 'Just for fun!' }
         assert_response :conflict
       end
 
       test "#update sets a lock" do
-        put :update, params: {stack_id: @stack.to_param, reason: 'Just for fun!'}
+        put :update, params: { stack_id: @stack.to_param, reason: 'Just for fun!' }
         assert_response :ok
         assert_json 'is_locked', true
         assert_json 'lock_reason', 'Just for fun!'
@@ -31,7 +32,7 @@ module Shipit
 
       test "#update can override a previous lock" do
         @stack.update!(lock_reason: 'Meh...')
-        put :update, params: {stack_id: @stack.to_param, reason: 'Just for fun!'}
+        put :update, params: { stack_id: @stack.to_param, reason: 'Just for fun!' }
         assert_response :ok
         assert_json 'is_locked', true
         assert_json 'lock_reason', 'Just for fun!'
@@ -40,14 +41,14 @@ module Shipit
       test "#update does not override previous locked_since" do
         since = Time.current.round
         @stack.update!(lock_reason: 'Meh...', locked_since: since)
-        put :update, params: {stack_id: @stack.to_param, reason: 'Just for fun!'}
+        put :update, params: { stack_id: @stack.to_param, reason: 'Just for fun!' }
         assert_response :ok
         assert_json 'locked_since', since.utc.iso8601(3)
       end
 
       test "#destroy clears the lock" do
         @stack.update!(lock_reason: 'Meh...', locked_since: Time.current)
-        delete :destroy, params: {stack_id: @stack.to_param}
+        delete :destroy, params: { stack_id: @stack.to_param }
         assert_response :ok
         assert_json 'is_locked', false
         assert_json { |json| assert_nil json['locked_since'] }

data/test/controllers/api/{pull_requests_controller_test.rb → merge_requests_controller_test.rb}

@@ -1,57 +1,58 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
   module Api
-    class PullRequestsControllerTest < ActionController::TestCase
+    class MergeRequestsControllerTest < ActionController::TestCase
       setup do
         @stack = shipit_stacks(:shipit)
-        @pull_request = shipit_pull_requests(:shipit_pending)
+        @merge_request = shipit_merge_requests(:shipit_pending)
         authenticate!
       end
 
       test "#index returns a list of pull requests" do
-        pull_request = @stack.pull_requests.last
+        merge_request = @stack.merge_requests.last
 
-        get :index, params: {stack_id: @stack.to_param}
+        get :index, params: { stack_id: @stack.to_param }
         assert_response :ok
-        assert_json '0.id', pull_request.id
+        assert_json '0.id', merge_request.id
       end
 
       test "#show returns a single pull requests" do
-        get :show, params: {stack_id: @stack.to_param, id: @pull_request.number.to_s}
+        get :show, params: { stack_id: @stack.to_param, id: @merge_request.number.to_s }
         assert_response :ok
-        assert_json 'id', @pull_request.id
+        assert_json 'id', @merge_request.id
       end
 
       test "#update responds with Accepted if the pull request was queued" do
-        assert_enqueued_with(job: RefreshPullRequestJob) do
-          put :update, params: {stack_id: @stack.to_param, id: '64'}
+        assert_enqueued_with(job: RefreshMergeRequestJob) do
+          put :update, params: { stack_id: @stack.to_param, id: '64' }
         end
         assert_response :accepted
       end
 
       test "#update responds with Accepted if the pull request was already queued" do
-        assert_enqueued_with(job: RefreshPullRequestJob) do
-          put :update, params: {stack_id: @stack.to_param, id: '65'}
+        assert_enqueued_with(job: RefreshMergeRequestJob) do
+          put :update, params: { stack_id: @stack.to_param, id: '65' }
         end
         assert_response :accepted
       end
 
       test "#update responds with method not allowed if the pull request was already merged" do
-        @pull_request.complete!
-        put :update, params: {stack_id: @stack.to_param, id: @pull_request.number.to_s}
+        @merge_request.complete!
+        put :update, params: { stack_id: @stack.to_param, id: @merge_request.number.to_s }
         assert_response :method_not_allowed
         assert_json 'message', 'This pull request was already merged.'
       end
 
       test "#destroy cancels the merge if the pull request was waiting" do
-        delete :destroy, params: {stack_id: @stack.to_param, id: @pull_request.number.to_s}
+        delete :destroy, params: { stack_id: @stack.to_param, id: @merge_request.number.to_s }
         assert_response :no_content
-        assert_predicate @pull_request.reload, :canceled?
+        assert_predicate @merge_request.reload, :canceled?
       end
 
       test "#destroy silently fail if the pull request was unknown" do
-        delete :destroy, params: {stack_id: @stack.to_param, id: '83453489'}
+        delete :destroy, params: { stack_id: @stack.to_param, id: '83453489' }
         assert_response :no_content
       end
     end

data/test/controllers/api/outputs_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -10,10 +11,11 @@ module Shipit
 
       test "#show returns the task output as plain text" do
         task = @stack.tasks.last
+        task.write("dummy output")
 
-        get :show, params: {stack_id: @stack.to_param, task_id: task.id}
+        get :show, params: { stack_id: @stack.to_param, task_id: task.id }
         assert_response :ok
-        assert_equal 'text/plain', response.content_type
+        assert_equal 'text/plain', response.media_type
         assert_equal task.chunk_output, response.body
       end
     end

data/test/controllers/api/release_statuses_controller_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 module Shipit
@@ -10,7 +11,7 @@ module Shipit
       end
 
       test "#create renders a 422 if status is not found" do
-        post :create, params: {stack_id: @stack.to_param, deploy_id: @deploy.id}
+        post :create, params: { stack_id: @stack.to_param, deploy_id: @deploy.id }
         assert_response :unprocessable_entity
         assert_json 'errors', 'status' => ['is required', 'is not included in the list']
       end

data/test/controllers/api/rollback_controller_test.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module Shipit
+  module Api
+    class RollbacksControllerTest < ActionController::TestCase
+      setup do
+        authenticate!
+        @user = shipit_users(:walrus)
+        @stack = shipit_stacks(:shipit)
+        @commit = shipit_commits(:fourth)
+      end
+
+      test "#create triggers a new rollback for the stack" do
+        assert_difference -> { @stack.deploys.count }, 1 do
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
+        end
+        assert_response :accepted
+        assert_json 'status', 'pending'
+      end
+
+      test "#create triggers a new rollback for whitelisted variables" do
+        correct_env = { 'SAFETY_DISABLED' => 1 }
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, env: correct_env }
+        assert_response :accepted
+        assert_json 'type', 'rollback'
+        assert_json 'status', 'pending'
+      end
+
+      test "#create refuses to trigger a new rollback with incorrect variables" do
+        incorrect_env = { 'DANGEROUS_VARIABLE' => 1 }
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, env: incorrect_env }
+        assert_response :unprocessable_entity
+        assert_json 'message', 'Variables DANGEROUS_VARIABLE have not been whitelisted'
+      end
+
+      test "#create use the claimed user as author" do
+        request.headers['X-Shipit-User'] = @user.login
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
+        rollback = Rollback.last
+        rollback.user == @user
+      end
+
+      test "#create normalises the claimed user" do
+        request.headers['X-Shipit-User'] = @user.login.swapcase
+        post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
+        rollback = Rollback.last
+        rollback.user == @user
+      end
+
+      test "#create renders a 422 if the sha isn't found" do
+        post :create, params: { stack_id: @stack.to_param, sha: '123443543545' }
+        assert_response :unprocessable_entity
+        assert_json 'errors', 'sha' => ['Unknown revision']
+      end
+
+      test "#create renders a 422 if the sha format is invalid" do
+        post :create, params: { stack_id: @stack.to_param, sha: '1' }
+        assert_response :unprocessable_entity
+        assert_json 'errors', 'sha' => ['is too short (minimum is 6 characters)']
+      end
+
+      test "#create renders a 422 if deploy attached to sha isn't found" do
+        post :create, params: { stack_id: @stack.to_param, sha: shipit_commits(:fifth).sha }
+        assert_response :unprocessable_entity
+        assert_json 'errors', 'sha' => ['Cant find associated deploy']
+      end
+
+      test "#create refuses to rollback on locked stacks" do
+        @stack.update!(lock_reason: 'Something broken')
+
+        assert_no_difference -> { @stack.deploys.count } do
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
+        end
+        assert_response :unprocessable_entity
+        assert_json 'errors.force', ["Can't rollback a locked stack"]
+      end
+
+      test "#create rollbacks on locked stack if force mode is enabled" do
+        @stack.update!(lock_reason: 'Something broken')
+
+        assert_difference -> { @stack.deploys.count }, 1 do
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, force: 'true' }
+        end
+        assert_response :accepted
+        assert_json 'status', 'pending'
+      end
+
+      test "#create refuses to rollback if active task" do
+        @stack.deploys.last.update!(status: 'running')
+
+        assert_no_difference -> { @stack.deploys.count } do
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha }
+        end
+        assert_response :unprocessable_entity
+        assert_json 'errors.force', ["Can't rollback, deploy in progress"]
+      end
+
+      test "#create aborts active task and sets rollback to" do
+        last_deploy = @stack.deploys.last
+        last_deploy.update!(status: 'running')
+
+        assert_no_difference -> { @stack.deploys.count } do
+          post :create, params: { stack_id: @stack.to_param, sha: @commit.sha, force: 'true' }
+        end
+        last_deploy.reload
+        assert_response :accepted
+        refute_predicate last_deploy, :active?
+        assert_json 'rollback_once_aborted_to.revision.sha', @commit.sha
+      end
+    end
+  end
+end