Merge branch 'bw-graphql-encapsulate-error-expects-1' into 'master'

Encapsulate checking for GraphQL error (part 1)

See merge request gitlab-org/gitlab!82535

spec/graphql/mutations/boards/issues/issue_move_list_spec.rb

@@ -43,11 +43,10 @@ RSpec.describe Mutations::Boards::Issues::IssueMoveList do
       context "when we only pass #{arg_name}" do
         let(:move_params) { { arg_name => list1.id } }
 
-        it 'raises an error' do
-          expect { subject }.to raise_error(
-            Gitlab::Graphql::Errors::ArgumentError,
-            'Both fromListId and toListId must be present'
-          )
+        it 'generates an error' do
+          expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ArgumentError, 'Both fromListId and toListId must be present') do
+            subject
+          end
         end
       end
     end
@@ -55,11 +54,10 @@ RSpec.describe Mutations::Boards::Issues::IssueMoveList do
     context 'when required arguments are missing' do
       let(:move_params) { {} }
 
-      it 'raises an error' do
-        expect { subject }.to raise_error(
-          Gitlab::Graphql::Errors::ArgumentError,
-          "At least one of the arguments fromListId, toListId, afterId or beforeId is required"
-        )
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ArgumentError, 'At least one of the arguments fromListId, toListId, afterId or beforeId is required') do
+          subject
+        end
       end
     end
 

spec/graphql/mutations/ci/runner/delete_spec.rb

@@ -22,8 +22,10 @@ RSpec.describe Mutations::Ci::Runner::Delete do
     end
 
     context 'when the user cannot admin the runner' do
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+          subject
+        end
       end
     end
 

spec/graphql/mutations/ci/runner/update_spec.rb

@@ -26,8 +26,10 @@ RSpec.describe Mutations::Ci::Runner::Update do
     end
 
     context 'when the user cannot admin the runner' do
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+          subject
+        end
       end
     end
 

spec/graphql/mutations/release_asset_links/create_spec.rb

@@ -63,7 +63,9 @@ RSpec.describe Mutations::ReleaseAssetLinks::Create do
         let!(:protected_tag) { create(:protected_tag, :maintainers_can_create, name: '*', project: project) }
 
         it 'has an access error' do
-          expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+          expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+            subject
+          end
         end
       end
     end
@@ -71,16 +73,20 @@ RSpec.describe Mutations::ReleaseAssetLinks::Create do
     context "when the user doesn't have access to the project" do
       let(:current_user) { reporter }
 
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+          subject
+        end
       end
     end
 
     context "when the project doesn't exist" do
       let(:project_path) { 'project/that/does/not/exist' }
 
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+          subject
+        end
       end
     end
 

spec/graphql/resolvers/ci/job_token_scope_resolver_spec.rb

@@ -54,10 +54,8 @@ RSpec.describe Resolvers::Ci::JobTokenScopeResolver do
         project.add_user(current_user, :developer)
       end
 
-      it 'raises error' do
-        expect do
-          resolve_scope
-        end.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) { resolve_scope }
       end
     end
   end

spec/graphql/resolvers/group_milestones_resolver_spec.rb

@@ -101,38 +101,38 @@ RSpec.describe Resolvers::GroupMilestonesResolver do
     context 'by timeframe' do
       context 'when start_date and end_date are present' do
         context 'when start date is after end_date' do
-          it 'raises error' do
-            expect do
+          it 'generates an error' do
+            expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ArgumentError, "startDate is after endDate") do
               resolve_group_milestones(start_date: now, end_date: now - 2.days)
-            end.to raise_error(Gitlab::Graphql::Errors::ArgumentError, "startDate is after endDate")
+            end
           end
         end
       end
 
       context 'when only start_date is present' do
-        it 'raises error' do
-          expect do
+        it 'generates an error' do
+          expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ArgumentError, /Both startDate and endDate/) do
             resolve_group_milestones(start_date: now)
-          end.to raise_error(Gitlab::Graphql::Errors::ArgumentError, /Both startDate and endDate/)
+          end
         end
       end
 
       context 'when only end_date is present' do
-        it 'raises error' do
-          expect do
+        it 'generates an error' do
+          expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ArgumentError, /Both startDate and endDate/) do
             resolve_group_milestones(end_date: now)
-          end.to raise_error(Gitlab::Graphql::Errors::ArgumentError, /Both startDate and endDate/)
+          end
         end
       end
     end
 
     context 'when user cannot read milestones' do
-      it 'raises error' do
+      it 'generates an error' do
         unauthorized_user = create(:user)
 
-        expect do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
           resolve_group_milestones({}, { current_user: unauthorized_user })
-        end.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+        end
       end
     end
 

spec/support/helpers/graphql_helpers.rb

@@ -552,6 +552,12 @@ module GraphqlHelpers
     expect(flattened_errors).to be_empty
   end
 
+  # Helps migrate to the new GraphQL interpreter,
+  # https://gitlab.com/gitlab-org/gitlab/-/issues/210556
+  def expect_graphql_error_to_be_created(error_class, match_message = nil)
+    expect { yield }.to raise_error(error_class, match_message)
+  end
+
   def flattened_errors
     Array.wrap(graphql_errors).flatten.compact
   end

spec/support/shared_examples/graphql/mutations/security/ci_configuration_shared_examples.rb

@@ -29,8 +29,10 @@ RSpec.shared_examples_for 'graphql mutations security ci configuration' do
   describe '#resolve' do
     let(:result) { subject }
 
-    it 'raises an error if the resource is not accessible to the user' do
-      expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+    it 'generates an error if the resource is not accessible to the user' do
+      expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+        subject
+      end
     end
 
     context 'when user does not have enough permissions' do
@@ -38,8 +40,10 @@ RSpec.shared_examples_for 'graphql mutations security ci configuration' do
         project.add_guest(user)
       end
 
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+          subject
+        end
       end
     end
 
@@ -48,8 +52,10 @@ RSpec.shared_examples_for 'graphql mutations security ci configuration' do
         create(:project_empty_repo).add_maintainer(user)
       end
 
-      it 'raises an error' do
-        expect { subject }.to raise_error(Gitlab::Graphql::Errors::ResourceNotAvailable)
+      it 'generates an error' do
+        expect_graphql_error_to_be_created(Gitlab::Graphql::Errors::ResourceNotAvailable) do
+          subject
+        end
       end
     end