Merge branch 'fix/gitpushservice-complexity-issue' into 'master'

Reduce code complexity on GitPushService#execute

Code complexity for gitlab-ce after this has been refactored:
```
  27.3: GitPushService#execute
```
This still needs to be merged into `gitlab-ee` presumably with conflicts... Perhaps we should create another issue for doing that?

I left the code sort of similar to what it was... If I could, I would have refactored most of the code into separate classes, etc. as it breaks probably all SOLID principles.

Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/13327


See merge request !2784

1 files changed, 41 insertions, 32 deletions

diff --git a/spec/services/git_push_service_spec.rb b/spec/services/git_push_service_spec.rb
index eb3a5fe43f5..994585fb32c 100644
--- a/spec/services/git_push_service_spec.rb
+++ b/spec/services/git_push_service_spec.rb
@@ -5,7 +5,6 @@ describe GitPushService, services: true do
 
   let(:user)          { create :user }
   let(:project)       { create :project }
-  let(:service) { GitPushService.new }
 
   before do
     @blankrev = Gitlab::Git::BLANK_SHA
@@ -15,10 +14,17 @@ describe GitPushService, services: true do
   end
 
   describe 'Push branches' do
+
+    let(:oldrev) { @oldrev }
+    let(:newrev) { @newrev }
+
+    subject do
+      execute_service(project, user, oldrev, newrev, @ref )
+    end
+
     context 'new branch' do
-      subject do
-        service.execute(project, user, @blankrev, @newrev, @ref)
-      end
+
+      let(:oldrev) { @blankrev }
 
       it { is_expected.to be_truthy }
 
@@ -36,9 +42,6 @@ describe GitPushService, services: true do
     end
 
     context 'existing branch' do
-      subject do
-        service.execute(project, user, @oldrev, @newrev, @ref)
-      end
 
       it { is_expected.to be_truthy }
 
@@ -50,9 +53,8 @@ describe GitPushService, services: true do
     end
 
     context 'rm branch' do
-      subject do
-        service.execute(project, user, @oldrev, @blankrev, @ref)
-      end
+
+      let(:newrev) { @blankrev }
 
       it { is_expected.to be_truthy }
 
@@ -72,7 +74,7 @@ describe GitPushService, services: true do
 
   describe "Git Push Data" do
     before do
-      service.execute(project, user, @oldrev, @newrev, @ref)
+      service = execute_service(project, user, @oldrev, @newrev, @ref )
       @push_data = service.push_data
       @commit = project.commit(@newrev)
     end
@@ -134,20 +136,21 @@ describe GitPushService, services: true do
 
   describe "Push Event" do
     before do
-      service.execute(project, user, @oldrev, @newrev, @ref)
+      service = execute_service(project, user, @oldrev, @newrev, @ref )
       @event = Event.last
+      @push_data = service.push_data
     end
 
     it { expect(@event).not_to be_nil }
     it { expect(@event.project).to eq(project) }
     it { expect(@event.action).to eq(Event::PUSHED) }
-    it { expect(@event.data).to eq(service.push_data) }
+    it { expect(@event.data).to eq(@push_data) }
 
     context "Updates merge requests" do
       it "when pushing a new branch for the first time" do
         expect(project).to receive(:update_merge_requests).
                                with(@blankrev, 'newrev', 'refs/heads/master', user)
-        service.execute(project, user, @blankrev, 'newrev', 'refs/heads/master')
+        execute_service(project, user, @blankrev, 'newrev', 'refs/heads/master' )
       end
     end
   end
@@ -158,7 +161,7 @@ describe GitPushService, services: true do
         expect(project).to receive(:execute_hooks)
         expect(project.default_branch).to eq("master")
         expect(project.protected_branches).to receive(:create).with({ name: "master", developers_can_push: false })
-        service.execute(project, user, @blankrev, 'newrev', 'refs/heads/master')
+        execute_service(project, user, @blankrev, 'newrev', 'refs/heads/master' )
       end
 
       it "when pushing a branch for the first time with default branch protection disabled" do
@@ -167,7 +170,7 @@ describe GitPushService, services: true do
         expect(project).to receive(:execute_hooks)
         expect(project.default_branch).to eq("master")
         expect(project.protected_branches).not_to receive(:create)
-        service.execute(project, user, @blankrev, 'newrev', 'refs/heads/master')
+        execute_service(project, user, @blankrev, 'newrev', 'refs/heads/master' )
       end
 
       it "when pushing a branch for the first time with default branch protection set to 'developers can push'" do
@@ -176,12 +179,12 @@ describe GitPushService, services: true do
         expect(project).to receive(:execute_hooks)
         expect(project.default_branch).to eq("master")
         expect(project.protected_branches).to receive(:create).with({ name: "master", developers_can_push: true })
-        service.execute(project, user, @blankrev, 'newrev', 'refs/heads/master')
+        execute_service(project, user, @blankrev, 'newrev', 'refs/heads/master' )
       end
 
       it "when pushing new commits to existing branch" do
         expect(project).to receive(:execute_hooks)
-        service.execute(project, user, 'oldrev', 'newrev', 'refs/heads/master')
+        execute_service(project, user, 'oldrev', 'newrev', 'refs/heads/master' )
       end
     end
   end
@@ -204,7 +207,7 @@ describe GitPushService, services: true do
     it "creates a note if a pushed commit mentions an issue" do
       expect(SystemNoteService).to receive(:cross_reference).with(issue, commit, commit_author)
 
-      service.execute(project, user, @oldrev, @newrev, @ref)
+      execute_service(project, user, @oldrev, @newrev, @ref )
     end
 
     it "only creates a cross-reference note if one doesn't already exist" do
@@ -212,7 +215,7 @@ describe GitPushService, services: true do
 
       expect(SystemNoteService).not_to receive(:cross_reference).with(issue, commit, commit_author)
 
-      service.execute(project, user, @oldrev, @newrev, @ref)
+      execute_service(project, user, @oldrev, @newrev, @ref )
     end
 
     it "defaults to the pushing user if the commit's author is not known" do
@@ -222,7 +225,7 @@ describe GitPushService, services: true do
       )
       expect(SystemNoteService).to receive(:cross_reference).with(issue, commit, user)
 
-      service.execute(project, user, @oldrev, @newrev, @ref)
+      execute_service(project, user, @oldrev, @newrev, @ref )
     end
 
     it "finds references in the first push to a non-default branch" do
@@ -231,7 +234,7 @@ describe GitPushService, services: true do
 
       expect(SystemNoteService).to receive(:cross_reference).with(issue, commit, commit_author)
 
-      service.execute(project, user, @blankrev, @newrev, 'refs/heads/other')
+      execute_service(project, user, @blankrev, @newrev, 'refs/heads/other' )
     end
   end
 
@@ -255,18 +258,18 @@ describe GitPushService, services: true do
 
     context "to default branches" do
       it "closes issues" do
-        service.execute(project, user, @oldrev, @newrev, @ref)
+        execute_service(project, user, @oldrev, @newrev, @ref )
         expect(Issue.find(issue.id)).to be_closed
       end
 
       it "adds a note indicating that the issue is now closed" do
         expect(SystemNoteService).to receive(:change_status).with(issue, project, commit_author, "closed", closing_commit)
-        service.execute(project, user, @oldrev, @newrev, @ref)
+        execute_service(project, user, @oldrev, @newrev, @ref )
       end
 
       it "doesn't create additional cross-reference notes" do
         expect(SystemNoteService).not_to receive(:cross_reference)
-        service.execute(project, user, @oldrev, @newrev, @ref)
+        execute_service(project, user, @oldrev, @newrev, @ref )
       end
 
       it "doesn't close issues when external issue tracker is in use" do
@@ -274,7 +277,7 @@ describe GitPushService, services: true do
 
         # The push still shouldn't create cross-reference notes.
         expect do
-          service.execute(project, user, @oldrev, @newrev, 'refs/heads/hurf')
+          execute_service(project, user, @oldrev, @newrev,  'refs/heads/hurf' )
         end.not_to change { Note.where(project_id: project.id, system: true).count }
       end
     end
@@ -287,11 +290,11 @@ describe GitPushService, services: true do
 
       it "creates cross-reference notes" do
         expect(SystemNoteService).to receive(:cross_reference).with(issue, closing_commit, commit_author)
-        service.execute(project, user, @oldrev, @newrev, @ref)
+        execute_service(project, user, @oldrev, @newrev, @ref )
       end
 
       it "doesn't close issues" do
-        service.execute(project, user, @oldrev, @newrev, @ref)
+        execute_service(project, user, @oldrev, @newrev, @ref )
         expect(Issue.find(issue.id)).to be_opened
       end
     end
@@ -328,7 +331,7 @@ describe GitPushService, services: true do
         let(:message) { "this is some work.\n\nrelated to JIRA-1" }
 
         it "should initiate one api call to jira server to mention the issue" do
-          service.execute(project, user, @oldrev, @newrev, @ref)
+          execute_service(project, user, @oldrev, @newrev, @ref )
 
           expect(WebMock).to have_requested(:post, jira_api_comment_url).with(
             body: /mentioned this issue in/
@@ -346,7 +349,7 @@ describe GitPushService, services: true do
             }
           }.to_json
 
-          service.execute(project, user, @oldrev, @newrev, @ref)
+          execute_service(project, user, @oldrev, @newrev, @ref )
           expect(WebMock).to have_requested(:post, jira_api_transition_url).with(
             body: transition_body
           ).once
@@ -357,7 +360,7 @@ describe GitPushService, services: true do
             body: "Issue solved with [#{closing_commit.id}|http://localhost/#{project.path_with_namespace}/commit/#{closing_commit.id}]."
           }.to_json
 
-          service.execute(project, user, @oldrev, @newrev, @ref)
+          execute_service(project, user, @oldrev, @newrev, @ref )
           expect(WebMock).to have_requested(:post, jira_api_comment_url).with(
             body: comment_body
           ).once
@@ -376,7 +379,13 @@ describe GitPushService, services: true do
     end
 
     it 'push to first branch updates HEAD' do
-      service.execute(project, user, @blankrev, @newrev, new_ref)
+      execute_service(project, user, @blankrev, @newrev, new_ref )
     end
   end
+
+  def execute_service(project, user, oldrev, newrev, ref)
+    service = described_class.new(project, user, oldrev: oldrev, newrev: newrev, ref: ref )
+    service.execute
+    service
+  end
 end