GraphQL mutations for managing Notes

https://gitlab.com/gitlab-org/gitlab-ce/issues/62826

5 files changed, 301 insertions, 0 deletions

diff --git a/spec/requests/api/graphql/mutations/notes/create/diff_note_spec.rb b/spec/requests/api/graphql/mutations/notes/create/diff_note_spec.rb
new file mode 100644
index 00000000000..b04fcb9aece
--- /dev/null
+++ b/spec/requests/api/graphql/mutations/notes/create/diff_note_spec.rb
@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Adding a DiffNote' do
+  include GraphqlHelpers
+
+  set(:current_user) { create(:user) }
+  let(:noteable) { create(:merge_request, source_project: project, target_project: project) }
+  let(:project) { create(:project, :repository) }
+  let(:diff_refs) { noteable.diff_refs }
+  let(:mutation) do
+    variables = {
+      noteable_id: GitlabSchema.id_from_object(noteable).to_s,
+      body: 'Body text',
+      position: {
+        paths: {
+          old_path: 'files/ruby/popen.rb',
+          new_path: 'files/ruby/popen2.rb'
+        },
+        new_line: 14,
+        base_sha: diff_refs.base_sha,
+        head_sha: diff_refs.head_sha,
+        start_sha: diff_refs.start_sha
+      }
+    }
+
+    graphql_mutation(:create_diff_note, variables)
+  end
+
+  def mutation_response
+    graphql_mutation_response(:create_diff_note)
+  end
+
+  it_behaves_like 'a Note mutation when the user does not have permission'
+
+  context 'when the user has permission' do
+    before do
+      project.add_developer(current_user)
+    end
+
+    it_behaves_like 'a Note mutation that creates a Note'
+
+    it_behaves_like 'a Note mutation when there are active record validation errors', model: DiffNote
+
+    context do
+      let(:diff_refs) { build(:merge_request).diff_refs } # Allow fake diff refs so arguments are valid
+
+      it_behaves_like 'a Note mutation when the given resource id is not for a Noteable'
+    end
+
+    it 'returns the note with the correct position' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(mutation_response['note']['body']).to eq('Body text')
+      mutation_position_response = mutation_response['note']['position']
+      expect(mutation_position_response['positionType']).to eq('text')
+      expect(mutation_position_response['filePath']).to eq('files/ruby/popen2.rb')
+      expect(mutation_position_response['oldPath']).to eq('files/ruby/popen.rb')
+      expect(mutation_position_response['newPath']).to eq('files/ruby/popen2.rb')
+      expect(mutation_position_response['newLine']).to eq(14)
+    end
+  end
+end
diff --git a/spec/requests/api/graphql/mutations/notes/create/image_diff_note_spec.rb b/spec/requests/api/graphql/mutations/notes/create/image_diff_note_spec.rb
new file mode 100644
index 00000000000..3ba6c689024
--- /dev/null
+++ b/spec/requests/api/graphql/mutations/notes/create/image_diff_note_spec.rb
@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Adding an image DiffNote' do
+  include GraphqlHelpers
+
+  set(:current_user) { create(:user) }
+  let(:noteable) { create(:merge_request, source_project: project, target_project: project) }
+  let(:project) { create(:project, :repository) }
+  let(:diff_refs) { noteable.diff_refs }
+  let(:mutation) do
+    variables = {
+      noteable_id: GitlabSchema.id_from_object(noteable).to_s,
+      body: 'Body text',
+      position: {
+        paths: {
+          old_path: 'files/images/any_image.png',
+          new_path: 'files/images/any_image2.png'
+        },
+        width: 100,
+        height: 200,
+        x: 1,
+        y: 2,
+        base_sha: diff_refs.base_sha,
+        head_sha: diff_refs.head_sha,
+        start_sha: diff_refs.start_sha
+      }
+    }
+
+    graphql_mutation(:create_image_diff_note, variables)
+  end
+
+  def mutation_response
+    graphql_mutation_response(:create_image_diff_note)
+  end
+
+  it_behaves_like 'a Note mutation when the user does not have permission'
+
+  context 'when the user has permission' do
+    before do
+      project.add_developer(current_user)
+    end
+
+    it_behaves_like 'a Note mutation that creates a Note'
+
+    it_behaves_like 'a Note mutation when there are active record validation errors', model: DiffNote
+
+    context do
+      let(:diff_refs) { build(:merge_request).diff_refs } # Allow fake diff refs so arguments are valid
+
+      it_behaves_like 'a Note mutation when the given resource id is not for a Noteable'
+    end
+
+    it 'returns the note with the correct position' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(mutation_response['note']['body']).to eq('Body text')
+      mutation_position_response = mutation_response['note']['position']
+      expect(mutation_position_response['filePath']).to eq('files/images/any_image2.png')
+      expect(mutation_position_response['oldPath']).to eq('files/images/any_image.png')
+      expect(mutation_position_response['newPath']).to eq('files/images/any_image2.png')
+      expect(mutation_position_response['positionType']).to eq('image')
+      expect(mutation_position_response['width']).to eq(100)
+      expect(mutation_position_response['height']).to eq(200)
+      expect(mutation_position_response['x']).to eq(1)
+      expect(mutation_position_response['y']).to eq(2)
+    end
+  end
+end
diff --git a/spec/requests/api/graphql/mutations/notes/create/note_spec.rb b/spec/requests/api/graphql/mutations/notes/create/note_spec.rb
new file mode 100644
index 00000000000..17aed69b650
--- /dev/null
+++ b/spec/requests/api/graphql/mutations/notes/create/note_spec.rb
@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Adding a Note' do
+  include GraphqlHelpers
+
+  set(:current_user) { create(:user) }
+  let(:noteable) { create(:merge_request, source_project: project, target_project: project) }
+  let(:project) { create(:project, :repository) }
+  let(:mutation) do
+    variables = {
+      noteable_id: GitlabSchema.id_from_object(noteable).to_s,
+      body: 'Body text'
+    }
+
+    graphql_mutation(:create_note, variables)
+  end
+
+  def mutation_response
+    graphql_mutation_response(:create_note)
+  end
+
+  it_behaves_like 'a Note mutation when the user does not have permission'
+
+  context 'when the user has permission' do
+    before do
+      project.add_developer(current_user)
+    end
+
+    it_behaves_like 'a Note mutation that creates a Note'
+
+    it_behaves_like 'a Note mutation when there are active record validation errors'
+
+    it_behaves_like 'a Note mutation when the given resource id is not for a Noteable'
+
+    it 'returns the note' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(mutation_response['note']['body']).to eq('Body text')
+    end
+  end
+end
diff --git a/spec/requests/api/graphql/mutations/notes/destroy_spec.rb b/spec/requests/api/graphql/mutations/notes/destroy_spec.rb
new file mode 100644
index 00000000000..337a6e6f6e6
--- /dev/null
+++ b/spec/requests/api/graphql/mutations/notes/destroy_spec.rb
@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Destroying a Note' do
+  include GraphqlHelpers
+
+  let!(:note) { create(:note) }
+  let(:mutation) do
+    variables = {
+      id: GitlabSchema.id_from_object(note).to_s
+    }
+
+    graphql_mutation(:destroy_note, variables)
+  end
+
+  def mutation_response
+    graphql_mutation_response(:destroy_note)
+  end
+
+  context 'when the user does not have permission' do
+    let(:current_user) { create(:user) }
+
+    it_behaves_like 'a mutation that returns top-level errors',
+                    errors: ['The resource that you are attempting to access does not exist or you don\'t have permission to perform this action']
+
+    it 'does not destroy the Note' do
+      expect do
+        post_graphql_mutation(mutation, current_user: current_user)
+      end.not_to change { Note.count }
+    end
+  end
+
+  context 'when the user has permission' do
+    let(:current_user) { note.author }
+
+    it_behaves_like 'a Note mutation when the given resource id is not for a Note'
+
+    it 'destroys the Note' do
+      expect do
+        post_graphql_mutation(mutation, current_user: current_user)
+      end.to change { Note.count }.by(-1)
+    end
+
+    it 'returns an empty Note' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(mutation_response).to have_key('note')
+      expect(mutation_response['note']).to be_nil
+    end
+  end
+end
diff --git a/spec/requests/api/graphql/mutations/notes/update_spec.rb b/spec/requests/api/graphql/mutations/notes/update_spec.rb
new file mode 100644
index 00000000000..958f640995a
--- /dev/null
+++ b/spec/requests/api/graphql/mutations/notes/update_spec.rb
@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Updating a Note' do
+  include GraphqlHelpers
+
+  let!(:note) { create(:note, note: original_body) }
+  let(:original_body) { 'Initial body text' }
+  let(:updated_body) { 'Updated body text' }
+  let(:mutation) do
+    variables = {
+      id: GitlabSchema.id_from_object(note).to_s,
+      body: updated_body
+    }
+
+    graphql_mutation(:update_note, variables)
+  end
+
+  def mutation_response
+    graphql_mutation_response(:update_note)
+  end
+
+  context 'when the user does not have permission' do
+    let(:current_user) { create(:user) }
+
+    it_behaves_like 'a mutation that returns top-level errors',
+                    errors: ['The resource that you are attempting to access does not exist or you don\'t have permission to perform this action']
+
+    it 'does not update the Note' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(note.reload.note).to eq(original_body)
+    end
+  end
+
+  context 'when the user has permission' do
+    let(:current_user) { note.author }
+
+    it_behaves_like 'a Note mutation when the given resource id is not for a Note'
+
+    it 'updates the Note' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(note.reload.note).to eq(updated_body)
+    end
+
+    it 'returns the updated Note' do
+      post_graphql_mutation(mutation, current_user: current_user)
+
+      expect(mutation_response['note']['body']).to eq(updated_body)
+    end
+
+    context 'when there are ActiveRecord validation errors' do
+      let(:updated_body) { '' }
+
+      it_behaves_like 'a mutation that returns errors in the response', errors: ["Note can't be blank"]
+
+      it 'does not update the Note' do
+        post_graphql_mutation(mutation, current_user: current_user)
+
+        expect(note.reload.note).to eq(original_body)
+      end
+
+      it 'returns the Note with its original body' do
+        post_graphql_mutation(mutation, current_user: current_user)
+
+        expect(mutation_response['note']['body']).to eq(original_body)
+      end
+    end
+  end
+end