GraphQL mutations for managing Notes

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

2 files changed, 75 insertions, 1 deletions

diff --git a/spec/support/helpers/graphql_helpers.rb b/spec/support/helpers/graphql_helpers.rb
index 1a09d48f4cd..ec3c460cd37 100644
--- a/spec/support/helpers/graphql_helpers.rb
+++ b/spec/support/helpers/graphql_helpers.rb
@@ -57,7 +57,8 @@ module GraphqlHelpers
   end
 
   def variables_for_mutation(name, input)
-    graphql_input = input.map { |name, value| [GraphqlHelpers.fieldnamerize(name), value] }.to_h
+    graphql_input = prepare_input_for_mutation(input)
+
     result = { input_variable_name_for_mutation(name) => graphql_input }
 
     # Avoid trying to serialize multipart data into JSON
@@ -68,6 +69,18 @@ module GraphqlHelpers
     end
   end
 
+  # Recursively convert a Hash with Ruby-style keys to GraphQL fieldname-style keys
+  #
+  # prepare_input_for_mutation({ 'my_key' => 1 })
+  #   => { 'myKey' => 1}
+  def prepare_input_for_mutation(input)
+    input.map do |name, value|
+      value = prepare_input_for_mutation(value) if value.is_a?(Hash)
+
+      [GraphqlHelpers.fieldnamerize(name), value]
+    end.to_h
+  end
+
   def input_variable_name_for_mutation(mutation_name)
     mutation_name = GraphqlHelpers.fieldnamerize(mutation_name)
     mutation_field = GitlabSchema.mutation.fields[mutation_name]
diff --git a/spec/support/shared_examples/graphql/notes_creation_shared_examples.rb b/spec/support/shared_examples/graphql/notes_creation_shared_examples.rb
new file mode 100644
index 00000000000..f2e1a95345b
--- /dev/null
+++ b/spec/support/shared_examples/graphql/notes_creation_shared_examples.rb
@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a Note mutation that does not create a Note' do
+  it do
+    expect do
+      post_graphql_mutation(mutation, current_user: current_user)
+    end.not_to change { Note.count }
+  end
+end
+
+RSpec.shared_examples 'a Note mutation that creates a Note' do
+  it do
+    expect do
+      post_graphql_mutation(mutation, current_user: current_user)
+    end.to change { Note.count }.by(1)
+  end
+end
+
+RSpec.shared_examples 'a Note mutation when the user does not have permission' do
+  it_behaves_like 'a Note mutation that does not create a Note'
+
+  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']
+end
+
+RSpec.shared_examples 'a Note mutation when there are active record validation errors' do |model: Note|
+  before do
+    expect_next_instance_of(model) do |note|
+      expect(note).to receive(:valid?).at_least(:once).and_return(false)
+      expect(note).to receive_message_chain(
+        :errors,
+        :full_messages
+      ).and_return(['Error 1', 'Error 2'])
+    end
+  end
+
+  it_behaves_like 'a Note mutation that does not create a Note'
+
+  it_behaves_like 'a mutation that returns errors in the response', errors: ['Error 1', 'Error 2']
+
+  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
+
+RSpec.shared_examples 'a Note mutation when the given resource id is not for a Noteable' do
+  let(:noteable) { create(:label, project: project) }
+
+  it_behaves_like 'a Note mutation that does not create a Note'
+
+  it_behaves_like 'a mutation that returns top-level errors', errors: ['Cannot add notes to this resource']
+end
+
+RSpec.shared_examples 'a Note mutation when the given resource id is not for a Note' do
+  let(:note) { create(:issue) }
+
+  it_behaves_like 'a mutation that returns top-level errors', errors: ['Resource is not a note']
+end